onfido 1.1.0 → 2.1.0

data/lib/onfido/api.rb

@@ -1,47 +1,53 @@
+# frozen_string_literal: true
+
 module Onfido
   class API
-    def initialize(options = {})
-      @api_key = options[:api_key]
+    def initialize(api_key:, region:, **extra_options)
+      @options = Onfido::Options.new(api_key: api_key, region: region, **extra_options)
     end
 
     def applicant
-      Onfido::Applicant.new(@api_key)
+      @applicant ||= Onfido::Applicant.new(options)
     end
 
     def check
-      Onfido::Check.new(@api_key)
+      @check ||= Onfido::Check.new(options)
     end
 
     def document
-      Onfido::Document.new(@api_key)
+      @document ||= Onfido::Document.new(options)
     end
 
     def live_photo
-      Onfido::LivePhoto.new(@api_key)
+      @live_photo ||= Onfido::LivePhoto.new(options)
     end
 
     def live_video
-      Onfido::LiveVideo.new(@api_key)
+      @live_video ||= Onfido::LiveVideo.new(options)
     end
 
     def report
-      Onfido::Report.new(@api_key)
+      @report ||= Onfido::Report.new(options)
     end
 
     def sdk_token
-      Onfido::SdkToken.new(@api_key)
+      @sdk_token ||= Onfido::SdkToken.new(options)
     end
 
     def webhook
-      Onfido::Webhook.new(@api_key)
+      @webhook ||= Onfido::Webhook.new(options)
     end
 
     def address
-      Onfido::Address.new(@api_key)
+      @address ||= Onfido::Address.new(options)
     end
 
     def extraction
-      Onfido::Extraction.new(@api_key)
+      @extraction ||= Onfido::Extraction.new(options)
     end
+
+    private
+
+    attr_reader :options
   end
 end

data/lib/onfido/errors/connection_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class ConnectionError < OnfidoError
   end

data/lib/onfido/errors/onfido_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class OnfidoError < StandardError
     attr_accessor :response_code, :response_body

data/lib/onfido/errors/request_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class RequestError < OnfidoError
   end

data/lib/onfido/errors/server_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class ServerError < OnfidoError
   end

data/lib/onfido/options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Onfido
+  class Options
+    REGIONS = %w[eu us ca].freeze
+
+    def initialize(api_key:, region:, open_timeout: 10, read_timeout: 30, unknown_api_url: nil)
+      @api_key = api_key
+      @region = region.to_s.downcase
+      @open_timeout = open_timeout
+      @read_timeout = read_timeout
+      @unknown_api_url = unknown_api_url
+
+      raise "Unknown region #{@region}" unless REGIONS.include?(@region)
+    end
+
+    def rest_client
+      @rest_client ||= RestClient::Resource.new(
+        base_url,
+        read_timeout: read_timeout,
+        open_timeout: open_timeout,
+        headers: {
+          'Authorization' => "Token token=#{api_key}",
+          'Accept' => 'application/json',
+          'User-Agent' => "onfido-ruby/#{Onfido::VERSION}"
+        }
+      )
+    end
+
+    private
+
+    attr_reader :api_key, :open_timeout, :read_timeout
+
+    def base_url
+      @unknown_api_url || "https://api.#{@region}.onfido.com/v3.2/"
+    end
+  end
+end

data/lib/onfido/resource.rb

@@ -1,55 +1,52 @@
+# frozen_string_literal: true
+
 module Onfido
-  class Resource
-    VALID_HTTP_METHODS = %i(get post put delete).freeze
+  class Resource # rubocop:todo Metrics/ClassLength
+    VALID_HTTP_METHODS = %i[get post put delete].freeze
     REQUEST_TIMEOUT_HTTP_CODE = 408
 
-    def initialize(api_key = nil)
-      @api_key = api_key || Onfido.api_key
+    def initialize(options)
+      @rest_client = options.rest_client
     end
 
-    VALID_HTTP_METHODS.each do |method|
-      define_method method do |*args|
-        make_request(
-          method: method.to_sym,
-          url: Onfido.endpoint + args.first.fetch(:path),
-          payload: build_query(args.first.fetch(:payload, {}))
-        )
-      end
+    private
+
+    attr_reader :rest_client
+
+    def get(path:)
+      handle_request { rest_client[path].get }
     end
 
-    private
+    def post(path:, payload: nil)
+      handle_request { rest_client[path].post(payload) }
+    end
 
-    def make_request(options)
-      url = options.fetch(:url)
-      payload = options.fetch(:payload)
-      method = options.fetch(:method)
+    def put(path:, payload: nil)
+      handle_request { rest_client[path].put(payload) }
+    end
 
-      request_options = {
-        url: url,
-        payload: payload,
-        method: method,
-        headers: headers,
-        open_timeout: Onfido.open_timeout,
-        timeout: Onfido.read_timeout
-      }
+    def delete(path:)
+      handle_request { rest_client[path].delete }
+    end
 
-      response = RestClient::Request.execute(request_options)
+    def handle_request
+      response = yield
 
       # response should be parsed only when there is a response expected
       parse(response) unless response.code == 204 # no_content
-    rescue RestClient::ExceptionWithResponse => error
-      if error.response && !timeout_response?(error.response)
-        handle_api_error(error.response)
+    rescue RestClient::ExceptionWithResponse => e
+      if e.response && !timeout_response?(e.response)
+        handle_api_error(e.response)
       else
-        handle_restclient_error(error, url)
+        handle_restclient_error(e)
       end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => error
-      handle_restclient_error(error, url)
+    rescue RestClient::Exception, Errno::ECONNREFUSED => e
+      handle_restclient_error(e)
     end
 
     def parse(response)
       content_type = response.headers[:content_type]
-      if content_type && content_type.include?("application/json")
+      if content_type&.include?('application/json')
         JSON.parse(response.body.to_s)
       else
         response.body
@@ -62,14 +59,6 @@ module Onfido
       response.code.to_i == REQUEST_TIMEOUT_HTTP_CODE
     end
 
-    def headers
-      {
-        'Authorization' => "Token token=#{@api_key}",
-        'Accept' => "application/json",
-        'User-Agent' => "onfido-ruby/#{Onfido::VERSION}"
-      }
-    end
-
     # There seems to be a serialization issue with the HTTP client
     # which does not serialize the payload properly.
     # Have a look here https://gist.github.com/PericlesTheo/cb35139c57107ab3c84a
@@ -85,12 +74,12 @@ module Onfido
     def handle_api_error(response)
       parsed_response = parse(response)
 
-      general_api_error(response.code, response.body) unless parsed_response["error"]
+      general_api_error(response.code, response.body) unless parsed_response['error']
 
       error_class = response.code.to_i >= 500 ? ServerError : RequestError
 
       raise error_class.new(
-        parsed_response["error"]['message'],
+        parsed_response['error']['message'],
         response_code: response.code,
         response_body: response.body
       )
@@ -107,46 +96,46 @@ module Onfido
       )
     end
 
-    def handle_restclient_error(error, url)
+    def handle_restclient_error(error) # rubocop:todo Metrics/MethodLength
       connection_message =
-        "Please check your internet connection and try again. " \
-        "If this problem persists, you should let us know at info@onfido.com."
+        'Please check your internet connection and try again. ' \
+        'If this problem persists, you should let us know at info@onfido.com.'
 
       message =
         case error
         when RestClient::RequestTimeout
-          "Could not connect to Onfido (#{url}). #{connection_message}"
+          "Could not connect to Onfido . #{connection_message}"
 
         when RestClient::ServerBrokeConnection
-          "The connection to the server (#{url}) broke before the " \
-          "request completed. #{connection_message}"
+          "The connection to the server broke before the request completed. #{connection_message}"
 
         when RestClient::SSLCertificateNotVerified
           "Could not verify Onfido's SSL certificate. Please make sure " \
-          "that your network is not intercepting certificates. " \
-          "(Try going to #{Onfido.endpoint} in your browser.) " \
-          "If this problem persists, let us know at info@onfido.com."
+          'that your network is not intercepting certificates. '
+
+        when RestClient::BadGateway
+          "Could not connect to Onfido. Server may be overloaded." \
 
         when SocketError
-          "Unexpected error when trying to connect to Onfido. " \
-          "You may be seeing this message because your DNS is not working. " \
+          'Unexpected error when trying to connect to Onfido. ' \
+          'You may be seeing this message because your DNS is not working. ' \
           "To check, try running 'host onfido.com' from the command line."
 
         else
-          "Unexpected error communicating with Onfido. " \
-          "If this problem persists, let us know at info@onfido.com."
+          'Unexpected error communicating with Onfido. ' \
+          'If this problem persists, let us know at info@onfido.com.'
         end
 
       full_message = message + "\n\n(Network error: #{error.message})"
 
-      raise ConnectionError.new(full_message)
+      raise ConnectionError, full_message
     end
 
     def validate_file!(file)
       return if file.respond_to?(:read) && file.respond_to?(:path)
 
-      raise ArgumentError, "File must be a `File`-like object which responds to " \
-                           "`#read` and `#path`"
+      raise ArgumentError, 'File must be a `File`-like object which responds to ' \
+                           '`#read` and `#path`'
     end
   end
 end

data/lib/onfido/resources/address.rb

@@ -1,10 +1,9 @@
+# frozen_string_literal: true
+
 module Onfido
   class Address < Resource
     def all(postcode)
-      get(
-        path: 'addresses/pick',
-        payload: { postcode: postcode.delete(' ') }
-      )
+      get(path: "addresses/pick?postcode=#{postcode.delete(' ')}")
     end
   end
 end

data/lib/onfido/resources/applicant.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class Applicant < Resource
     def create(payload)

data/lib/onfido/resources/check.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class Check < Resource
     def create(applicant_id:, report_names:, **payload)
@@ -18,5 +20,9 @@ module Onfido
     def resume(check_id)
       post(path: "checks/#{check_id}/resume")
     end
+
+    def download(check_id)
+      get(path: "checks/#{check_id}/download")
+    end
   end
 end

data/lib/onfido/resources/document.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class Document < Resource
     # with open-uri the file can be a link or an actual file

data/lib/onfido/resources/extraction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class Extraction < Resource
     def create(document_id:)

data/lib/onfido/resources/live_photo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class LivePhoto < Resource
     # with open-uri the file can be a link or an actual file

data/lib/onfido/resources/live_video.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class LiveVideo < Resource
     def find(live_video_id)

data/lib/onfido/resources/report.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class Report < Resource
     def find(report_id)

data/lib/onfido/resources/sdk_token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class SdkToken < Resource
     def create(applicant_id:, **payload)

data/lib/onfido/resources/webhook.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
   class Webhook < Resource
     def create(url:, **payload)
@@ -22,8 +24,8 @@ module Onfido
     # request to one computed from the body
     def self.valid?(request_body, request_signature, token)
       if [request_body, request_signature, token].any?(&:nil?)
-        raise ArgumentError, "A request body, request signature and token " \
-                             "must be provided"
+        raise ArgumentError, 'A request body, request signature and token ' \
+                             'must be provided'
       end
 
       computed_signature = generate_signature(request_body, token)

data/lib/onfido/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Onfido
-  VERSION = '1.1.0'.freeze
+  VERSION = '2.1.0'
 end

data/onfido.gemspec

@@ -1,4 +1,4 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -12,8 +12,8 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A wrapper for Onfido API'
   spec.description   = "A thin wrapper for Onfido's API. This gem only supports "\
                        "v3 of the Onfido API. Refer to Onfido's "\
-                       "API documentation for details of the expected "\
-                       "requests and responses."
+                       'API documentation for details of the expected '\
+                       'requests and responses.'
   spec.homepage      = 'http://github.com/onfido/onfido-ruby'
   spec.license       = 'MIT'
 
@@ -21,12 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-  spec.required_ruby_version = ">= 2.2.0"
+  spec.required_ruby_version = '>= 2.4.0'
 
-  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
-  spec.add_development_dependency 'rubocop', '~> 0.57.0'
+  spec.add_development_dependency 'rubocop', '~> 1.11'
   spec.add_development_dependency 'sinatra', '~> 1.4'
   spec.add_development_dependency 'webmock', '~> 3.0'