onfido 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b036d234a60e209cbc230d2c4e59ae7cded8f49f8639b63f3d0589610043fc
-  data.tar.gz: 736290686f770587e2a270921d34a2a8b78015c2e3539be5a476980318314ad3
+  metadata.gz: 9e3f66215e580ff6d0348639303fc81984b8e2115179e74ef101787a8ac76fb7
+  data.tar.gz: bf0ab24f1cc95cf9339ce9554926093f1f175993e8b3151d86b80d31711e95db
 SHA512:
-  metadata.gz: afb5f59c5836aa78326f82adbcf05a3620a4bbce772e8f03a6b5e715550720eeaf511b267a9cbac5c800bec16edad0f7e6eba466d2bfbcd96746d8fc9f00efc2
-  data.tar.gz: 707e28800455819c2f2a1c1585f68a302d3d8e8e62ccc186838f37fc110345da8dcdd5310857ebe49e9f6ef218ae7122af1a4b9655e6356ace519c5ff42f17fd
+  metadata.gz: d6a0de780f828c458e26c0216471fc701eea61082ebbfd89f6cc4a0f11deb42005d8294a13893f59589b79f3a9182faba57ec9af887a1bb622b3001fceb4f223
+  data.tar.gz: 24505122f39fc8ff91243b399d8c9076689796d62ca47a0893f7d29e94fc53e76387b88d4afe5d084452c7e6d5983a4280d468705f30e0a86ad269f96cc543fa

data/.github/workflows/ruby.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v2

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## v2.3.0, 02 March 2022
+
+- Updated to use API v3.4, for more details please see our [release notes](https://developers.onfido.com/release-notes#api-v34). 
+
+## v2.2.0, 02 March 2022
+
+- Support Onfido API version 3.3
+
+## v2.1.1, 01 February 2022
+
+- Send params as json
+- Remove .travis.yml
+- Update README.md link
+
 ## v2.1.0, 23 June 2021
 
 - Support Onfido API version 3.2

data/README.md

@@ -7,7 +7,7 @@ The official Ruby library for integrating with the Onfido API.
 
 Documentation can be found at https://documentation.onfido.com
 
-This version uses Onfido API v3.2 and is compatible with Ruby 2.4 onwards. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
+This version uses Onfido API v3.4 and is compatible with Ruby 2.4 onwards. Refer to our [API versioning guide](https://developers.onfido.com/guide/api-versioning-policy#client-libraries) for details of which client library versions use which versions of the API.
 
 ## Installation
 
@@ -76,7 +76,7 @@ onfido = Onfido::API.new(
 
 ## Verifying webhooks
 
-Each webhook endpoint has a secret token, generated automatically and [exposed](https://onfido.com/documentation#register-webhook) in the API. When sending a request, Onfido includes a signature computed using the request body and this token in the `X-SHA2-Signature` header.
+Each webhook endpoint has a secret token, generated automatically and [exposed](https://documentation.onfido.com/#register-webhook) in the API. When sending a request, Onfido includes a signature computed using the request body and this token in the `X-SHA2-Signature` header.
 
 You should compare this provided signature to one you generate yourself with the token to verify that a webhook is a genuine request from Onfido.
 
@@ -90,7 +90,7 @@ else
 end
 ```
 
-Read more at https://onfido.com/documentation#webhook-security
+Read more at https://developers.onfido.com/guide/manual-webhook-signature-verification#webhook-security
 
 ## Contributing
 

data/lib/onfido/options.rb

@@ -32,7 +32,7 @@ module Onfido
     attr_reader :api_key, :open_timeout, :read_timeout
 
     def base_url
-      @unknown_api_url || "https://api.#{@region}.onfido.com/v3.2/"
+      @unknown_api_url || "https://api.#{@region}.onfido.com/v3.4/"
     end
   end
 end

data/lib/onfido/resource.rb

@@ -4,6 +4,7 @@ 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
@@ -14,19 +15,22 @@ module Onfido
     attr_reader :rest_client
 
     def get(path:)
-      handle_request { rest_client[path].get }
+      handle_request { rest_client[path].get(ADDITIONAL_HEADERS) }
     end
 
-    def post(path:, payload: nil)
-      handle_request { rest_client[path].post(payload) }
+    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) }
+      handle_request { rest_client[path].put(payload.to_json, ADDITIONAL_HEADERS) }
     end
 
     def delete(path:)
-      handle_request { rest_client[path].delete }
+      handle_request { rest_client[path].delete(ADDITIONAL_HEADERS) }
     end
 
     def handle_request

data/lib/onfido/resources/document.rb

@@ -10,7 +10,7 @@ module Onfido
       payload[:file] = file
       payload[:type] = type
 
-      post(path: 'documents', payload: payload)
+      post(path: 'documents', payload: payload, send_json: false)
     end
 
     def find(document_id)

data/lib/onfido/resources/live_photo.rb

@@ -9,7 +9,7 @@ module Onfido
       payload[:applicant_id] = applicant_id
       payload[:file] = file
 
-      post(path: 'live_photos', payload: payload)
+      post(path: 'live_photos', payload: payload, send_json: false)
     end
 
     def find(live_photo_id)

data/lib/onfido/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onfido
-  VERSION = '2.1.0'
+  VERSION = '2.3.0'
 end

data/spec/integrations/applicant_spec.rb

@@ -23,7 +23,12 @@ describe Onfido::Applicant do
         'town' => 'London',
         'postcode' => 'SW4 6EH',
         'country' => 'GBR'
-      }
+      },
+      'location' => {
+        'ip_address' => '127.0.0.1',
+        'country_of_residence' => 'GBR'
+      },
+      'phone_number' => '910100100'
     }
   end
 
@@ -34,7 +39,7 @@ describe Onfido::Applicant do
 
     it 'serializes the payload correctly' do
       WebMock.after_request do |request_signature, _response|
-        if request_signature.uri.path == 'v3.2/applicants'
+        if request_signature.uri.path == 'v3.4/applicants'
           expect(Rack::Utils.parse_nested_query(request_signature.body))
             .to eq(params)
         end

data/spec/integrations/document_spec.rb

@@ -13,7 +13,11 @@ describe Onfido::Document do
         applicant_id: '1030303-123123-123123',
         type: 'driving_licence',
         file: file,
-        side: 'front'
+        side: 'front',
+        location: {
+          ip_address: '127.0.0.1',
+          country_of_residence: 'GBR'
+        }
       }
     end
 

data/spec/onfido/options_spec.rb

@@ -26,7 +26,7 @@ describe Onfido::Options do
     end
 
     it 'configures with region' do
-      expect(rest_client.url).to eq 'https://api.us.onfido.com/v3.2/'
+      expect(rest_client.url).to eq 'https://api.us.onfido.com/v3.4/'
     end
 
     it 'configures with timeouts' do

data/spec/support/fake_onfido_api.rb

@@ -9,32 +9,42 @@ RSpec.shared_context 'fake onfido api' do
 end
 
 class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
-  get '/v3.2/addresses/pick' do
+  before do
+    begin
+      if request.content_type == "application/json; charset=utf-8"
+        body_parameters = JSON.parse(request.body.read)
+        params.merge!(body_parameters) if body_parameters
+      end
+    rescue JSON::ParserError
+    end
+  end
+
+  get '/v3.4/addresses/pick' do
     json_response(200, 'addresses.json')
   end
 
-  post '/v3.2/applicants' do
+  post '/v3.4/applicants' do
     json_response(201, 'applicant.json')
   end
 
-  put '/v3.2/applicants/:id' do
+  put '/v3.4/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v3.2/applicants/:id' do
+  get '/v3.4/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v3.2/applicants' do
+  get '/v3.4/applicants' do
     response = json_response(200, 'applicants.json')
     { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
   end
 
-  delete '/v3.2/applicants/:id' do
+  delete '/v3.4/applicants/:id' do
     status 204
   end
 
-  post '/v3.2/applicants/:id/restore' do
+  post '/v3.4/applicants/:id/restore' do
     if params['id'] == 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5'
       json_response(422, 'not_scheduled_for_deletion_error.json')
     else
@@ -42,37 +52,37 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  post '/v3.2/documents' do
+  post '/v3.4/documents' do
     json_response(201, 'document.json')
   end
 
-  post '/v3.2/extractions' do
+  post '/v3.4/extractions' do
     json_response(201, 'extraction.json')
   end
 
-  get '/v3.2/documents/:id' do
+  get '/v3.4/documents/:id' do
     json_response(200, 'document.json')
   end
 
-  get '/v3.2/documents' do
+  get '/v3.4/documents' do
     json_response(200, 'documents.json')
   end
 
-  get '/v3.2/documents/:id/download' do
+  get '/v3.4/documents/:id/download' do
     status 200
     content_type 'application/octet-stream'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v3.2/live_photos' do
+  post '/v3.4/live_photos' do
     json_response(201, 'live_photo.json')
   end
 
-  get '/v3.2/live_photos/:id' do
+  get '/v3.4/live_photos/:id' do
     json_response(200, 'live_photo.json')
   end
 
-  get '/v3.2/live_photos' do
+  get '/v3.4/live_photos' do
     if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'live_photos.json')
     else
@@ -80,17 +90,17 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  get '/v3.2/live_photos/:id/download' do
+  get '/v3.4/live_photos/:id/download' do
     status 200
     content_type 'image/jpeg'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v3.2/live_videos/:id' do
+  get '/v3.4/live_videos/:id' do
     json_response(200, 'live_video.json')
   end
 
-  get '/v3.2/live_videos' do
+  get '/v3.4/live_videos' do
     if params['applicant_id'] == '1030303-123123-123123'
       json_response(200, 'live_videos.json')
     else
@@ -98,80 +108,79 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     end
   end
 
-  get '/v3.2/live_videos/:id/download' do
+  get '/v3.4/live_videos/:id/download' do
     status 200
     content_type 'video/quicktime'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v3.2/checks' do
+  post '/v3.4/checks' do
     params['applicant_id'].nil? ? status(422) : json_response(201, 'check.json')
   end
 
-  get '/v3.2/checks/:id' do
+  get '/v3.4/checks/:id' do
     json_response(200, 'check.json')
   end
 
-  get '/v3.2/checks' do
+  get '/v3.4/checks' do
     json_response(200, 'checks.json')
   end
 
-  post '/v3.2/checks/:id/resume' do
+  post '/v3.4/checks/:id/resume' do
     status 204 # no_content
   end
 
-  get '/v3.2/checks/:id/download' do
+  get '/v3.4/checks/:id/download' do
     status 200
     content_type 'application/pdf'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v3.2/reports' do
+  get '/v3.4/reports' do
     json_response(200, 'reports.json')
   end
 
-  get '/v3.2/reports/:id' do
+  get '/v3.4/reports/:id' do
     json_response(200, 'report.json')
   end
 
-  post '/v3.2/reports/:id/resume' do
+  post '/v3.4/reports/:id/resume' do
     status 204
   end
 
-  post '/v3.2/reports/:id/cancel' do
+  post '/v3.4/reports/:id/cancel' do
     status 204
   end
 
-  post '/v3.2/sdk_token' do
+  post '/v3.4/sdk_token' do
     json_response(201, 'sdk_token.json')
   end
 
-  post '/v3.2/webhooks' do
+  post '/v3.4/webhooks' do
     json_response(201, 'webhook.json')
   end
 
-  get '/v3.2/webhooks/:id' do
+  get '/v3.4/webhooks/:id' do
     json_response(200, 'webhook.json')
   end
 
-  delete '/v3.2/webhooks/:id' do
-    content_type 'application/json; charset=utf-8'
+  delete '/v3.4/webhooks/:id' do
     status 204
   end
 
-  get '/v3.2/webhooks' do
+  get '/v3.4/webhooks' do
     json_response(200, 'webhooks.json')
   end
 
-  get '/v3.2/4xx_response' do
+  get '/v3.4/4xx_response' do
     json_response(422, '4xx_response.json')
   end
 
-  get '/v3.2/unexpected_error_format' do
+  get '/v3.4/unexpected_error_format' do
     json_response(400, 'unexpected_error_format.json')
   end
 
-  get '/v3.2/unparseable_response' do
+  get '/v3.4/unparseable_response' do
     content_type :json
     status 504
     ''

data/spec/support/fixtures/applicant.json

@@ -7,7 +7,7 @@
   "last_name":"Bing",
   "email":"chandler_bing_6@friends.com",
   "dob":"1968-04-08",
-  "href":"/v3.2/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
+  "href":"/v3.4/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
   "id_numbers":[],
   "address": {
     "flat_number":"4",
@@ -19,5 +19,10 @@
     "state":"",
     "postcode":"SW4 6EH",
     "country":"GBR"
-  }
+  },
+  "location": {
+    "ip_address": "127.0.0.1",
+    "country_of_residence": "GBR"
+  },
+  "phone_number": "910100100"
 }

data/spec/support/fixtures/check.json

@@ -1,7 +1,7 @@
 {
   "id": "8546921-123123-123123",
   "created_at": "2019-05-23T13:50:33Z",
-  "href": "/v3.2/checks/8546921-123123-123123",
+  "href": "/v3.4/checks/8546921-123123-123123",
   "applicant_provides_data": "false",
   "status": "pending",
   "result": "pending",

data/spec/support/fixtures/checks.json

@@ -3,7 +3,7 @@
         {
             "id": "8546921-123123-123123",
             "created_at": "2019-11-23T13:50:33Z",
-            "href": "/v3.2/checks/8546921-123123-123123",
+            "href": "/v3.4/checks/8546921-123123-123123",
             "applicant_provides_data": "false",
             "status": "pending",
             "result": "pending",

data/spec/support/fixtures/document.json

@@ -1,7 +1,7 @@
 {
   "id": "7568415-123123-123123",
   "created_at": "2019-11-23 13:50:33Z",
-  "href": "/v3.2/documents/7568415-123123-123123",
+  "href": "/v3.4/documents/7568415-123123-123123",
   "file_name": "passport.jpg",
   "file_type": "png",
   "file_size": 282870,

data/spec/support/fixtures/documents.json

@@ -3,7 +3,7 @@
     {
       "id": "7568415-123123-123123",
       "created_at": "2019-11-23 13:50:33Z",
-      "href": "/v3.2/documents/7568415-123123-123123",
+      "href": "/v3.4/documents/7568415-123123-123123",
       "file_name": "passport.jpg",
       "file_type": "png",
       "file_size": 282870,
@@ -12,7 +12,7 @@
     {
       "id": "121122-123123-123123",
       "created_at": "2019-11-23 13:50:40Z",
-      "href": "/v3.2/documents/7568415-123123-123123",
+      "href": "/v3.4/documents/7568415-123123-123123",
       "file_name": "driving_licence.png",
       "file_type": "png",
       "file_size": 282870,

data/spec/support/fixtures/live_photo.json

@@ -4,6 +4,6 @@
   "file_name": "onfido_captured_image.jpg",
   "file_type": "image/jpeg",
   "file_size": 47544,
-  "href": "/v3.2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
-  "download_href": "/v3.2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
+  "href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+  "download_href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
 }

data/spec/support/fixtures/live_photos.json

@@ -6,8 +6,8 @@
       "file_name": "onfido_captured_image.jpg",
       "file_type": "image/jpeg",
       "file_size": 47544,
-      "href": "/v3.2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
-      "download_href": "/v3.2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
+      "href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+      "download_href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
     },
     {
         "id": "5134c12a-555a-1234-5e12-9d34fcbc11ba",
@@ -15,8 +15,8 @@
         "file_name": "onfido_captured_image.jpg",
         "file_type": "image/jpeg",
         "file_size": 47544,
-        "href": "/v3.2/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
-        "download_href": "/v3.2/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
+        "href": "/v3.4/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
+        "download_href": "/v3.4/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
       }
   ]
 }

data/spec/support/fixtures/live_video.json

@@ -18,6 +18,6 @@
   "file_name" : "output-29-05-2018_11_00_24.mov",
   "file_type" : "video/quicktime",
   "file_size" : 3348421,
-  "href" : "/v3.2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
-  "download_href" : "/v3.2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
+  "href" : "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+  "download_href" : "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
 }

data/spec/support/fixtures/live_videos.json

@@ -16,11 +16,11 @@
         }
       ],
       "created_at": "2019-11-29T09:00:39Z",
-      "download_href": "/v3.2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
+      "download_href": "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
       "file_name": "output-29-11-2019_11_00_24.mov",
       "file_size": 3348421,
       "file_type": "video/quicktime",
-      "href": "/v3.2/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
+      "href": "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
       "id": "c9701e9b-83aa-442f-995b-20320ee8fb01"
     }
   ]

data/spec/support/fixtures/report.json

@@ -4,7 +4,7 @@
   "created_at": "2019-11-23T13:50:45Z",
   "status": "in_progress",
   "result": "pending",
-  "href": "/v3.2/reports/6951786-123123-422221",
+  "href": "/v3.4/reports/6951786-123123-422221",
   "breakdown": {},
   "properties": {}
 }

data/spec/support/fixtures/reports.json

@@ -6,7 +6,7 @@
       "created_at": "2019-11-23T13:50:45Z",
       "status": "in_progress",
       "result": "pending",
-      "href": "/v3.2/reports/6951786-123123-422221",
+      "href": "/v3.4/reports/6951786-123123-422221",
       "breakdown": {},
       "properties": {}
     },
@@ -16,7 +16,7 @@
       "created_at": "2019-11-23T13:50:45Z",
       "status": "in_progress",
       "result": "pending",
-      "href": "/v3.2/reports/6951786-123123-316712",
+      "href": "/v3.4/reports/6951786-123123-316712",
       "breakdown": {},
       "properties": {}
     }

data/spec/support/fixtures/webhook.json

@@ -3,7 +3,7 @@
   "url": "https://webhookendpoint.url",
   "token": "yV85IsmuYwmjQGlZ",
   "enabled": true,
-  "href": "/v3.2/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "href": "/v3.4/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
   "environments": [
     "live"
   ],

data/spec/support/fixtures/webhooks.json

@@ -4,7 +4,7 @@
       "id": "dd0a89e4-d44e-417a-aec4-01137d01ae59",
       "url": "https://demo.com",
       "enabled":false,
-      "href": "/v3.2/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
+      "href": "/v3.4/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
       "environments": [
         "live"
       ],
@@ -18,7 +18,7 @@
       "id": "bfc727a8-f7bf-4073-b123-ed70a70f58e5",
       "url": "https://demo2.com",
       "enabled": true,
-      "href": "/v3.2/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
+      "href": "/v3.4/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
       "environments": [
         "live"
       ],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Onfido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-24 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -122,7 +122,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE

data/.travis.yml

@@ -1,13 +0,0 @@
-language: ruby
-cache: bundler
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-
-script:
-  - bundle exec rubocop
-  - bundle exec rspec spec