module Nurego
Constants
- VERSION
Attributes
api_base[RW]
api_key[RW]
api_version[RW]
external_ids[RW]
logger[RW]
verify_ssl_certs[RW]
Public Class Methods
api_url(url='')
click to toggle source
# File lib/nurego.rb, line 69 def self.api_url(url='') @api_base + url end
request(method, url, api_key, params={}, headers={})
click to toggle source
# File lib/nurego.rb, line 73 def self.request(method, url, api_key, params={}, headers={}) unless api_key ||= @api_key raise AuthenticationError.new('No API key provided. ' + 'Set your API key using "Nurego.api_key = <API-KEY>". ' + 'You can generate API keys from the Nurego web interface. ' + 'See https://www.nurego.com/api for details, or email support@nurego.com ' + 'if you have any questions.') end if api_key =~ /\s/ raise AuthenticationError.new('Your API key is invalid, as it contains ' + 'whitespace. (HINT: You can double-check your API key from the ' + 'Nurego web interface. See https://www.nurego.com/api for details, or ' + 'email support@nurego.com if you have any questions.)') end request_opts = { :verify_ssl => false } if ssl_preflight_passed? request_opts.update(:verify_ssl => OpenSSL::SSL::VERIFY_PEER, :ssl_ca_file => @ssl_bundle_path) end params[:external_ids] = @external_ids if @external_ids params = Util.objects_to_ids(params) url = api_url(url) case method.to_s.downcase.to_sym when :get, :head, :delete # Make params into GET parameters url += "#{URI.parse(url).query ? '&' : '?'}#{uri_encode(params)}" if params && params.any? payload = nil else payload = uri_encode(params) end request_opts.update(:headers => request_headers(api_key).update(headers), :method => method, :open_timeout => 30, :payload => payload, :url => url, :timeout => 80) begin response = execute_request(request_opts) rescue SocketError => e handle_restclient_error(e) rescue NoMethodError => e # Work around RestClient bug if e.message =~ /\WRequestFailed\W/ e = APIConnectionError.new('Unexpected HTTP response code') handle_restclient_error(e) else raise end rescue RestClient::ExceptionWithResponse => e if rcode = e.http_code and rbody = e.http_body handle_api_error(rcode, rbody) else handle_restclient_error(e) end rescue RestClient::Exception, Errno::ECONNREFUSED => e handle_restclient_error(e) end [parse(response), api_key] end
Private Class Methods
api_error(error, rcode, rbody, error_obj)
click to toggle source
# File lib/nurego.rb, line 278 def self.api_error(error, rcode, rbody, error_obj) APIError.new(error[:message], rcode, rbody, error_obj) end
authentication_error(error, rcode, rbody, error_obj)
click to toggle source
# File lib/nurego.rb, line 274 def self.authentication_error(error, rcode, rbody, error_obj) AuthenticationError.new(error[:message], rcode, rbody, error_obj) end
card_error(error, rcode, rbody, error_obj)
click to toggle source
# File lib/nurego.rb, line 270 def self.card_error(error, rcode, rbody, error_obj) CardError.new(error[:message], error[:param], rcode, rbody, error_obj) end
execute_request(opts)
click to toggle source
# File lib/nurego.rb, line 199 def self.execute_request(opts) opts[:headers][:x_request_id] = SecureRandom.uuid if @logger @logger.info("nurego-ruby execute_request") @logger.info(opts.inspect) end start_time = Time.now request_response = RestClient::Request.execute(opts) end_time = Time.now if @logger @logger.info("Request with id #{opts[:headers][:x_request_id]} to url #{opts[:url]} " + "took #{(end_time - start_time)} seconds") end request_response end
general_api_error(rcode, rbody)
click to toggle source
# File lib/nurego.rb, line 231 def self.general_api_error(rcode, rbody) APIError.new("Invalid response object from API: #{rbody.inspect} " + "(HTTP response code was #{rcode})", rcode, rbody) end
get_uname()
click to toggle source
# File lib/nurego.rb, line 171 def self.get_uname `uname -a 2>/dev/null`.strip if RUBY_PLATFORM =~ /linux|darwin/i rescue Errno::ENOMEM => ex # couldn't create subprocess "uname lookup failed" end
handle_api_error(rcode, rbody)
click to toggle source
# File lib/nurego.rb, line 236 def self.handle_api_error(rcode, rbody) begin error_obj = Nurego::JSON.load(rbody) error_obj = Util.symbolize_names(error_obj) # todo: remove creating :error from description when bss return is consistent if error_obj[:description] error_obj[:error] = { code:rcode, message:error_obj[:description]} end error = (error_obj && error_obj[:error]) or raise NuregoError.new # escape from parsing rescue MultiJson::DecodeError, NuregoError raise general_api_error(rcode, rbody) end case rcode when 402 raise card_error error, rcode, rbody, error_obj when 400, 404 raise invalid_request_error error, rcode, rbody, error_obj when 401 raise authentication_error error, rcode, rbody, error_obj else raise api_error error, rcode, rbody, error_obj end end
handle_restclient_error(e)
click to toggle source
# File lib/nurego.rb, line 282 def self.handle_restclient_error(e) case e when RestClient::ServerBrokeConnection, RestClient::RequestTimeout message = "Could not connect to Nurego (#{@api_base}). " + "Please check your internet connection and try again. " + "If this problem persists, you should check Nurego's service status at " + "https://twitter.com/nuregostatus, or let us know at support@nurego.com." when RestClient::SSLCertificateNotVerified message = "Could not verify Nurego's SSL certificate. " + "Please make sure that your network is not intercepting certificates. " + "(Try going to https://api.nurego.com/v1 in your browser.) " + "If this problem persists, let us know at support@nurego.com." when SocketError message = "Unexpected error communicating when trying to connect to Nurego. " + "You may be seeing this message because your DNS is not working. " + "To check, try running 'host nurego.com' from the command line." else message = "Unexpected error communicating with Nurego. " + "If this problem persists, let us know at support@nurego.com." end raise APIConnectionError.new(message + "\n\n(Network error: #{e.message})") end
invalid_request_error(error, rcode, rbody, error_obj)
click to toggle source
# File lib/nurego.rb, line 265 def self.invalid_request_error(error, rcode, rbody, error_obj) InvalidRequestError.new(error[:message], error[:param], rcode, rbody, error_obj) end
parse(response)
click to toggle source
# File lib/nurego.rb, line 219 def self.parse(response) begin # Would use :symbolize_names => true, but apparently there is # some library out there that makes symbolize_names not work. response = Nurego::JSON.load(response.body) rescue MultiJson::DecodeError raise general_api_error(response.code, response.body) end Util.symbolize_names(response) end
request_headers(api_key)
click to toggle source
# File lib/nurego.rb, line 181 def self.request_headers(api_key) headers = { :user_agent => "Nurego/v1 RubyBindings/#{Nurego::VERSION}", :x_nurego_authorization => "Bearer #{api_key}", :content_type => 'application/x-www-form-urlencoded' } headers[:nurego_version] = api_version if api_version headers[:authorization] = Nurego::Auth.header_token[:token] if Nurego::Auth.header_token begin headers.update(:x_nurego_client_user_agent => Nurego::JSON.dump(user_agent)) rescue => e headers.update(:x_nurego_client_raw_user_agent => user_agent.inspect, :error => "#{e} (#{e.class})") end end
ssl_preflight_passed?()
click to toggle source
# File lib/nurego.rb, line 139 def self.ssl_preflight_passed? if !verify_ssl_certs && !@no_verify $stderr.puts "WARNING: Running without SSL cert verification. " + "Execute 'Nurego.verify_ssl_certs = true' to enable verification." @no_verify = true elsif !Util.file_readable(@ssl_bundle_path) && !@no_bundle $stderr.puts "WARNING: Running without SSL cert verification " + "because #{@ssl_bundle_path} isn't readable" @no_bundle = true end !(@no_verify || @no_bundle) end
uri_encode(params)
click to toggle source
# File lib/nurego.rb, line 177 def self.uri_encode(params) params.to_query end
user_agent()
click to toggle source
# File lib/nurego.rb, line 156 def self.user_agent @uname ||= get_uname lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})" { :bindings_version => Nurego::VERSION, :lang => 'ruby', :lang_version => lang_version, :platform => RUBY_PLATFORM, :publisher => 'nurego', :uname => @uname } end