onfido 2.8.0 → 3.0.0

data/.github/workflows/ruby.yml

@@ -1,25 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rspec spec

data/.gitignore

@@ -1,19 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.DS_Store
-.rspec
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,13 +0,0 @@
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.4.0
-
-Layout/LineLength:
-  Max: 100
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Style/Documentation:
-  Enabled: false

data/lib/onfido/api.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class API
-    def initialize(api_key:, region:, **extra_options)
-      @options = Onfido::Options.new(api_key: api_key, region: region, **extra_options)
-    end
-
-    def applicant
-      @applicant ||= Onfido::Applicant.new(options)
-    end
-
-    def check
-      @check ||= Onfido::Check.new(options)
-    end
-
-    def document
-      @document ||= Onfido::Document.new(options)
-    end
-
-    def live_photo
-      @live_photo ||= Onfido::LivePhoto.new(options)
-    end
-
-    def live_video
-      @live_video ||= Onfido::LiveVideo.new(options)
-    end
-
-    def monitor
-      @monitor ||= Onfido::Monitor.new(options)
-    end
-
-    def motion_capture
-      @motion_capture ||= Onfido::MotionCapture.new(options)
-    end
-
-    def report
-      @report ||= Onfido::Report.new(options)
-    end
-
-    def sdk_token
-      @sdk_token ||= Onfido::SdkToken.new(options)
-    end
-
-    def webhook
-      @webhook ||= Onfido::Webhook.new(options)
-    end
-
-    def address
-      @address ||= Onfido::Address.new(options)
-    end
-
-    def extraction
-      @extraction ||= Onfido::Extraction.new(options)
-    end
-
-    def workflow_run
-      @workflow_run ||= Onfido::WorkflowRun.new(options)
-    end
-
-    private
-
-    attr_reader :options
-  end
-end

data/lib/onfido/errors/connection_error.rb

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

data/lib/onfido/errors/onfido_error.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class OnfidoError < StandardError
-    attr_accessor :response_code, :response_body
-
-    def initialize(message = nil,
-                   response_code: nil,
-                   response_body: nil)
-      @response_code = response_code
-      @response_body = response_body
-
-      super(message)
-    end
-
-    def json_body
-      JSON.parse(response_body.to_s)
-    rescue JSON::ParserError
-      nil
-    end
-
-    def type
-      json_body && json_body['error'] && json_body['error']['type']
-    end
-
-    def fields
-      json_body && json_body['error'] && json_body['error']['fields']
-    end
-  end
-end

data/lib/onfido/errors/request_error.rb

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

data/lib/onfido/errors/server_error.rb

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

data/lib/onfido/options.rb

@@ -1,38 +0,0 @@
-# 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.6/"
-    end
-  end
-end

data/lib/onfido/resource.rb

@@ -1,153 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Resource # rubocop:todo Metrics/ClassLength
-    VALID_HTTP_METHODS = %i[get post put delete].freeze
-    REQUEST_TIMEOUT_HTTP_CODE = 408
-    ADDITIONAL_HEADERS = { 'Content-Type' => 'application/json; charset=utf-8' }.freeze
-
-    def initialize(options)
-      @rest_client = options.rest_client
-    end
-
-    private
-
-    attr_reader :rest_client
-
-    def get(path:)
-      handle_request { rest_client[path].get(ADDITIONAL_HEADERS) }
-    end
-
-    def post(path:, payload: nil, send_json: true)
-      parsed_payload = send_json ? payload.to_json : payload
-      additional_headers = send_json ? ADDITIONAL_HEADERS : {}
-
-      handle_request { rest_client[path].post(parsed_payload, additional_headers) }
-    end
-
-    def put(path:, payload: nil)
-      handle_request { rest_client[path].put(payload.to_json, ADDITIONAL_HEADERS) }
-    end
-
-    def patch(path:, payload: nil)
-      handle_request { rest_client[path].patch(payload.to_json, ADDITIONAL_HEADERS) }
-    end
-
-    def delete(path:)
-      handle_request { rest_client[path].delete(ADDITIONAL_HEADERS) }
-    end
-
-    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 => e
-      if e.response && !timeout_response?(e.response)
-        handle_api_error(e.response)
-      else
-        handle_restclient_error(e)
-      end
-    rescue RestClient::Exception, Errno::ECONNREFUSED => e
-      handle_restclient_error(e)
-    end
-
-    def parse(response)
-      content_type = response.headers[:content_type]
-      if content_type&.include?('application/json')
-        JSON.parse(response.body.to_s)
-      else
-        response.body
-      end
-    rescue JSON::ParserError
-      general_api_error(response.code, response.body)
-    end
-
-    def timeout_response?(response)
-      response.code.to_i == REQUEST_TIMEOUT_HTTP_CODE
-    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
-
-    def build_query(payload)
-      if payload[:file]
-        payload
-      else
-        Rack::Utils.build_nested_query(payload)
-      end
-    end
-
-    def handle_api_error(response)
-      parsed_response = parse(response)
-
-      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'],
-        response_code: response.code,
-        response_body: response.body
-      )
-    end
-
-    def general_api_error(response_code, response_body)
-      error_class = response_code.to_i >= 500 ? ServerError : RequestError
-
-      raise error_class.new(
-        "Invalid response object from API: #{response_body} " \
-        "(HTTP response code was #{response_code})",
-        response_code: response_code,
-        response_body: response_body
-      )
-    end
-
-    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.'
-
-      message =
-        case error
-        when RestClient::RequestTimeout
-          "Could not connect to Onfido . #{connection_message}"
-
-        when RestClient::ServerBrokeConnection
-          "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. '
-
-        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. ' \
-          "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.'
-        end
-
-      full_message = message + "\n\n(Network error: #{error.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`'
-    end
-
-    def stringify_query_params(hashed_params)
-      URI.encode_www_form_component(hashed_params.map{ |k,v| "#{k}=#{v}" }.join("&"))
-    end
-  end
-end

data/lib/onfido/resources/address.rb

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

data/lib/onfido/resources/applicant.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Applicant < Resource
-    def create(payload)
-      post(path: 'applicants', payload: payload)
-    end
-
-    def update(applicant_id, payload)
-      put(path: "applicants/#{applicant_id}", payload: payload)
-    end
-
-    def destroy(applicant_id)
-      delete(path: "applicants/#{applicant_id}")
-    end
-
-    def find(applicant_id)
-      get(path: "applicants/#{applicant_id}")
-    end
-
-    def all(page: 1, per_page: 20)
-      get(path: "applicants?page=#{page}&per_page=#{per_page}")
-    end
-
-    def restore(applicant_id)
-      post(path: "applicants/#{applicant_id}/restore")
-    end
-  end
-end

data/lib/onfido/resources/check.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Check < Resource
-    def create(applicant_id:, report_names:, **payload)
-      payload[:applicant_id] = applicant_id
-      payload[:report_names] = report_names
-
-      post(path: 'checks', payload: payload)
-    end
-
-    def find(check_id)
-      get(path: "checks/#{check_id}")
-    end
-
-    def all(applicant_id)
-      get(path: "checks?applicant_id=#{applicant_id}")
-    end
-
-    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,28 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Document < Resource
-    # with open-uri the file can be a link or an actual file
-
-    def create(applicant_id:, file:, type:, **payload)
-      validate_file!(file)
-      payload[:applicant_id] = applicant_id
-      payload[:file] = file
-      payload[:type] = type
-
-      post(path: 'documents', payload: payload, send_json: false)
-    end
-
-    def find(document_id)
-      get(path: "documents/#{document_id}")
-    end
-
-    def download(document_id)
-      get(path: "documents/#{document_id}/download")
-    end
-
-    def all(applicant_id)
-      get(path: "documents?applicant_id=#{applicant_id}")
-    end
-  end
-end

data/lib/onfido/resources/extraction.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Extraction < Resource
-    def create(document_id:)
-      payload = { document_id: document_id }
-
-      post(path: 'extractions', payload: payload)
-    end
-  end
-end

data/lib/onfido/resources/live_photo.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class LivePhoto < Resource
-    # with open-uri the file can be a link or an actual file
-
-    def create(applicant_id:, file:, **payload)
-      validate_file!(file)
-      payload[:applicant_id] = applicant_id
-      payload[:file] = file
-
-      post(path: 'live_photos', payload: payload, send_json: false)
-    end
-
-    def find(live_photo_id)
-      get(path: "live_photos/#{live_photo_id}")
-    end
-
-    def download(live_photo_id)
-      get(path: "live_photos/#{live_photo_id}/download")
-    end
-
-    def all(applicant_id)
-      get(path: "live_photos?applicant_id=#{applicant_id}")
-    end
-  end
-end

data/lib/onfido/resources/live_video.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class LiveVideo < Resource
-    def find(live_video_id)
-      get(path: "live_videos/#{live_video_id}")
-    end
-
-    def download(live_video_id)
-      get(path: "live_videos/#{live_video_id}/download")
-    end
-
-    def all(applicant_id)
-      get(path: "live_videos?applicant_id=#{applicant_id}")
-    end
-  end
-end

data/lib/onfido/resources/monitor.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Monitor < Resource
-    def create(applicant_id:, report_name:, **payload)
-      payload[:applicant_id] = applicant_id
-      payload[:report_name] = report_name
-
-      post(path: 'watchlist_monitors', payload: payload)
-    end
-
-    def find(monitor_id)
-      get(path: "watchlist_monitors/#{monitor_id}")
-    end
-
-    def all(applicant_id)
-      get(path: "watchlist_monitors?applicant_id=#{applicant_id}")
-    end
-
-    def destroy(monitor_id)
-      delete(path: "watchlist_monitors/#{monitor_id}")
-    end
-
-    def list_matches(monitor_id)
-      get(path: "watchlist_monitors/#{monitor_id}/matches")
-    end
-
-    def set_match_status(monitor_id, **payload)
-      patch(path: "watchlist_monitors/#{monitor_id}/matches", payload: payload)
-    end
-  end
-end

data/lib/onfido/resources/motion_capture.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class MotionCapture < Resource
-    def find(motion_capture_id)
-      get(path: "motion_captures/#{motion_capture_id}")
-    end
-
-    def download(motion_capture_id)
-      get(path: "motion_captures/#{motion_capture_id}/download")
-    end
-
-    def frame(motion_capture_id)
-      get(path: "motion_captures/#{motion_capture_id}/frame")
-    end
-
-    def all(applicant_id)
-      get(path: "motion_captures?applicant_id=#{applicant_id}")
-    end
-  end
-end

data/lib/onfido/resources/report.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Report < Resource
-    def find(report_id)
-      get(path: "reports/#{report_id}")
-    end
-
-    def all(check_id)
-      get(path: "reports?check_id=#{check_id}")
-    end
-
-    def resume(report_id)
-      post(path: "reports/#{report_id}/resume")
-    end
-
-    def cancel(report_id)
-      post(path: "reports/#{report_id}/cancel")
-    end
-  end
-end

data/lib/onfido/resources/sdk_token.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class SdkToken < Resource
-    def create(applicant_id:, **payload)
-      payload[:applicant_id] = applicant_id
-      post(path: 'sdk_token', payload: payload)
-    end
-  end
-end

data/lib/onfido/resources/webhook.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class Webhook < Resource
-    def create(url:, **payload)
-      payload[:url] = url
-      post(path: 'webhooks', payload: payload)
-    end
-
-    def find(webhooks_id)
-      get(path: "webhooks/#{webhooks_id}")
-    end
-
-    def all
-      get(path: 'webhooks')
-    end
-
-    def destroy(webhook_id)
-      delete(path: "webhooks/#{webhook_id}")
-    end
-
-    # As well as being a normal resource, Onfido::Webhook also supports
-    # verifying the authenticity of a webhook by comparing the signature on the
-    # 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'
-      end
-
-      computed_signature = generate_signature(request_body, token)
-      Rack::Utils.secure_compare(request_signature, computed_signature)
-    end
-
-    def self.generate_signature(request_body, token)
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), token, request_body)
-    end
-    private_class_method :generate_signature
-  end
-end

data/lib/onfido/resources/workflow_run.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Onfido
-  class WorkflowRun < Resource
-    def create(payload)
-      post(path: 'workflow_runs', payload: payload)
-    end
-
-    def find(workflow_run_id)
-      get(path: "workflow_runs/#{workflow_run_id}")
-    end
-
-    def all(query_params = {})
-      get(path: "workflow_runs?#{stringify_query_params(query_params)}")
-    end
-  end
-end