onfido 0.14.0 → 1.1.1

data/spec/onfido_spec.rb

@@ -11,7 +11,7 @@ describe Onfido do
 
       describe ".endpoint" do
         subject { onfido.endpoint }
-        it { is_expected.to eq('https://api.onfido.com/v2/') }
+        it { is_expected.to eq('https://api.onfido.com/v3/') }
       end
 
       describe ".logger" do
@@ -27,18 +27,17 @@ describe Onfido do
       end
     end
 
-    describe "setting the API version" do
-      it 'changes the configuration to the new value' do
-        onfido.api_version = 'v1'
-        expect(onfido.api_version).to eq('v1')
-        expect(onfido.endpoint).to eq('https://api.onfido.com/v1/')
+    describe 'using the US region' do
+      it 'should change endpoint' do
+        onfido.region = 'us'
+        expect(onfido.endpoint).to eq('https://api.us.onfido.com/v3/')
       end
     end
 
-    describe 'using the US region' do
+    describe 'using the CA region' do
       it 'should change endpoint' do
-        onfido.region = 'us'
-        expect(onfido.endpoint).to eq('https://api.us.onfido.com/v2/')
+        onfido.region = 'ca'
+        expect(onfido.endpoint).to eq('https://api.ca.onfido.com/v3/')
       end
     end
 
@@ -53,7 +52,7 @@ describe Onfido do
     describe 'using an old API token' do
       it 'should use old endpoint' do
         onfido.api_key = "live_asdfghjkl1234567890qwertyuiop"
-        expect(onfido.endpoint).to eq('https://api.onfido.com/v2/')
+        expect(onfido.endpoint).to eq('https://api.onfido.com/v3/')
       end
     end
 

data/spec/support/fake_onfido_api.rb

@@ -1,32 +1,32 @@
 require 'sinatra/base'
 
 class FakeOnfidoAPI < Sinatra::Base
-  get '/v2/addresses/pick' do
+  get '/v3/addresses/pick' do
     json_response(200, 'addresses.json')
   end
 
-  post '/v2/applicants' do
+  post '/v3/applicants' do
     json_response(201, 'applicant.json')
   end
 
-  put '/v2/applicants/:id' do
+  put '/v3/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v2/applicants/:id' do
+  get '/v3/applicants/:id' do
     json_response(200, 'applicant.json')
   end
 
-  get '/v2/applicants' do
+  get '/v3/applicants' do
     response = json_response(200, 'applicants.json')
     { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
   end
 
-  delete '/v2/applicants/:id' do
+  delete '/v3/applicants/:id' do
     status 204
   end
 
-  post '/v2/applicants/:id/restore' do
+  post '/v3/applicants/:id/restore' do
     if params["id"] == "a2fb9c62-ab10-4898-a8ec-342c4b552ad5"
       json_response(422, 'not_scheduled_for_deletion_error.json')
     else
@@ -34,37 +34,37 @@ class FakeOnfidoAPI < Sinatra::Base
     end
   end
 
-  post '/v2/applicants/:id/documents' do
+  post '/v3/documents' do
     json_response(201, 'document.json')
   end
 
-  get '/v2/applicants/:id/documents/:id' do
+  post '/v3/extractions' do
+    json_response(201, 'extraction.json')
+  end
+
+  get '/v3/documents/:id' do
     json_response(200, 'document.json')
   end
 
-  get '/v2/applicants/:id/documents' do
+  get '/v3/documents' do
     json_response(200, 'documents.json')
   end
 
-  get '/v2/applicants/:id/documents/:id/download' do
+  get '/v3/documents/:id/download' do
     status 200
     content_type 'application/octet-stream'
     "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v2/live_photos' do
+  post '/v3/live_photos' do
     json_response(201, 'live_photo.json')
   end
 
-  get '/v2/live_photos/:id' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      json_response(200, 'live_photo.json')
-    end
+  get '/v3/live_photos/:id' do
+    json_response(200, 'live_photo.json')
   end
 
-  get '/v2/live_photos' do
+  get '/v3/live_photos' do
     if params["applicant_id"] != "1030303-123123-123123"
       status 404
     else
@@ -72,25 +72,17 @@ class FakeOnfidoAPI < Sinatra::Base
     end
   end
 
-  get '/v2/live_photos/:id/download' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      status 200
-      content_type 'image/jpeg'
-      "\x01\x02\x03" # acts as binary file data
-    end
+  get '/v3/live_photos/:id/download' do
+    status 200
+    content_type 'image/jpeg'
+    "\x01\x02\x03" # acts as binary file data
   end
 
-  get '/v2/live_videos/:id' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      json_response(200, 'live_video.json')
-    end
+  get '/v3/live_videos/:id' do
+    json_response(200, 'live_video.json')
   end
 
-  get '/v2/live_videos' do
+  get '/v3/live_videos' do
     if params["applicant_id"] != "1030303-123123-123123"
       status 404
     else
@@ -98,91 +90,74 @@ class FakeOnfidoAPI < Sinatra::Base
     end
   end
 
-  get '/v2/live_videos/:id/download' do
-    if params["applicant_id"] != "1030303-123123-123123"
-      status 404
-    else
-      status 200
-      content_type 'video/quicktime'
-      "\x01\x02\x03" # acts as binary file data
-    end
+  get '/v3/live_videos/:id/download' do
+    status 200
+    content_type 'video/quicktime'
+    "\x01\x02\x03" # acts as binary file data
   end
 
-  post '/v2/applicants/:id/checks' do
-    json_response(201, 'check.json')
+  post '/v3/checks' do
+    params["applicant_id"].nil? ? status(422) : json_response(201, 'check.json')
   end
 
-  get '/v2/applicants/:id/checks/:id' do
-    if params["expand"] == "reports"
-      json_response(200, "check_with_expanded_reports.json")
-    else
-      json_response(200, "check.json")
-    end
+  get '/v3/checks/:id' do
+    json_response(200, "check.json")
   end
 
-  get '/v2/applicants/:id/checks' do
-    response = if params["expand"] == "reports"
-                 json_response(200, "checks_with_expanded_reports.json")
-               else
-                 json_response(200, "checks.json")
-               end
-
-    { checks: JSON.parse(response)['checks'][pagination_range] }.to_json
+  get '/v3/checks' do
+    json_response(200, "checks.json")
   end
 
-  post '/v2/checks/:id/resume' do
+  post '/v3/checks/:id/resume' do
     status 204 # no_content
   end
 
-  get '/v2/checks/:id/reports' do
+  get '/v3/reports' do
     json_response(200, 'reports.json')
   end
 
-  get '/v2/checks/:id/reports/:id' do
+  get '/v3/reports/:id' do
     json_response(200, 'report.json')
   end
 
-  post '/v2/checks/:id/reports/:id/resume' do
+  post '/v3/reports/:id/resume' do
     status 204
   end
 
-  post '/v2/checks/:id/reports/:id/cancel' do
+  post '/v3/reports/:id/cancel' do
     status 204
   end
 
-  get '/v2/report_type_groups/:id' do
-    json_response(200, 'report_type_group.json')
-  end
-
-  get '/v2/report_type_groups' do
-    json_response(200, 'report_type_groups.json')
-  end
-
-  post '/v2/sdk_token' do
+  post '/v3/sdk_token' do
     json_response(201, 'sdk_token.json')
   end
 
-  post '/v2/webhooks' do
+  post '/v3/webhooks' do
     json_response(201, 'webhook.json')
   end
 
-  get '/v2/webhooks/:id' do
+  get '/v3/webhooks/:id' do
     json_response(200, 'webhook.json')
   end
 
-  get '/v2/webhooks' do
+  delete '/v3/webhooks/:id' do
+    content_type "application/json; charset=utf-8"
+    status 204
+  end
+
+  get '/v3/webhooks' do
     json_response(200, 'webhooks.json')
   end
 
-  get '/v2/4xx_response' do
+  get '/v3/4xx_response' do
     json_response(422, '4xx_response.json')
   end
 
-  get '/v2/unexpected_error_format' do
+  get '/v3/unexpected_error_format' do
     json_response(400, 'unexpected_error_format.json')
   end
 
-  get '/v2/unparseable_response' do
+  get '/v3/unparseable_response' do
     content_type :json
     status 504
     ''

data/spec/support/fixtures/applicant.json

@@ -1,44 +1,23 @@
 {
-    "id":"61f659cb-c90b-4067-808a-6136b5c01351",
-    "created_at":"2015-04-10T13:16:01Z",
-    "title":"Mr",
-    "first_name":"Chandler",
-    "middle_name":"Muriel",
-    "last_name":"Bing",
-    "email":"chandler_bing_6@friends.com",
-    "gender":"Male",
-    "dob":"1968-04-08",
-    "telephone":"555555555",
-    "mobile":"77777777",
-    "country":"gbr",
-    "href":"/v2/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
-    "id_numbers":[],
-    "addresses": [
-        {
-            "flat_number":"4",
-            "building_number":"100",
-            "building_name":"Awesome Building",
-            "street":"Main Street",
-            "sub_street":"A sub street",
-            "town":"London",
-            "state":"",
-            "postcode":"SW4 6EH",
-            "country":"GBR",
-            "start_date":"",
-            "end_date":""
-        },
-        {
-            "flat_number":"1",
-            "building_number":"10",
-            "building_name":"Great Building",
-            "street":"Old Street",
-            "sub_street":"Sub Street",
-            "town":"London",
-            "state":"",
-            "postcode":"SW1 4NG",
-            "country":"GBR",
-            "start_date":"",
-            "end_date":""
-        }
-    ]
+  "id":"61f659cb-c90b-4067-808a-6136b5c01351",
+  "created_at":"2015-04-10T13:16:01Z",
+  "title":"Mr",
+  "first_name":"Chandler",
+  "middle_name":"Muriel",
+  "last_name":"Bing",
+  "email":"chandler_bing_6@friends.com",
+  "dob":"1968-04-08",
+  "href":"/v3/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
+  "id_numbers":[],
+  "address": {
+    "flat_number":"4",
+    "building_number":"100",
+    "building_name":"Awesome Building",
+    "street":"Main Street",
+    "sub_street":"A sub street",
+    "town":"London",
+    "state":"",
+    "postcode":"SW4 6EH",
+    "country":"GBR"
+  }
 }

data/spec/support/fixtures/check.json

@@ -1,11 +1,11 @@
 {
   "id": "8546921-123123-123123",
-  "created_at": "2014-05-23T13:50:33Z",
-  "href": "/v2/applicants/61f659cb-c90b-4067-808a-6136b5c01351/checks/8546921-123123-123123",
-  "type": "standard",
+  "created_at": "2019-05-23T13:50:33Z",
+  "href": "/v3/checks/8546921-123123-123123",
+  "applicant_provides_data": "false",
   "status": "pending",
   "result": "pending",
-  "reports": [
+  "report_ids": [
     "1030303-123123-375629",
     "1030303-123123-456789"
   ]

data/spec/support/fixtures/checks.json

@@ -2,12 +2,12 @@
     "checks": [
         {
             "id": "8546921-123123-123123",
-            "created_at": "2014-05-23T13:50:33Z",
-            "href": "/v2/applicants/61f659cb-c90b-4067-808a-6136b5c01351/checks/8546921-123123-123123",
-            "type": "standard",
+            "created_at": "2019-11-23T13:50:33Z",
+            "href": "/v3/checks/8546921-123123-123123",
+            "applicant_provides_data": "false",
             "status": "pending",
             "result": "pending",
-            "reports": [
+            "report_ids": [
               "1030303-123123-375629",
               "1030303-123123-456789"
             ]

data/spec/support/fixtures/document.json

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

data/spec/support/fixtures/documents.json

@@ -2,22 +2,22 @@
   "documents": [
     {
       "id": "7568415-123123-123123",
-      "created_at": "2014-05-23 13:50:33Z",
-      "href": "/v2/applicants/1030303-123123-123123/documents/7568415-123123-123123",
+      "created_at": "2019-11-23 13:50:33Z",
+      "href": "/v3/documents/7568415-123123-123123",
       "file_name": "passport.jpg",
       "file_type": "png",
       "file_size": 282870,
-      "type": "passport",
-      "side": "back"
+      "type": "passport"
     },
     {
       "id": "121122-123123-123123",
-      "created_at": "2014-05-23 13:50:33Z",
-      "href": "/v2/applicants/1030303-123123-123123/documents/7568415-123123-123123",
-      "file_name": "right_to_work.png",
+      "created_at": "2019-11-23 13:50:40Z",
+      "href": "/v3/documents/7568415-123123-123123",
+      "file_name": "driving_licence.png",
       "file_type": "png",
       "file_size": 282870,
-      "type": "right_to_work"
+      "type": "driving_licence",
+      "side": "front"
     }
   ]
 }

data/spec/support/fixtures/extraction.json

@@ -0,0 +1,23 @@
+{
+  "document_id": "7568415-123123-123123",
+  "document_classification": {
+    "issuing_country": "FRA",
+    "document_type": "national_identity_card"
+  },
+  "extracted_data": {
+    "date_of_birth": "1965-09-08",
+    "document_number": "400925733",
+    "first_name": "MARIE",
+    "gender": "Female",
+    "last_name": "MAVARINE",
+    "mrz_line1": "P<GBRDU<MARIE<<MAVARINE<<<<<<<<<<<<<<<<<<<<<",
+    "mrz_line2": "4009257333GBR6509088F1307072<<<<<<<<<<<<<<06",
+    "nationality": "BRITISH CITIZEN",
+    "full_name": "MAVARINE DU MARIE",
+    "date_of_expiry": "2013-07-07",
+    "middle_name": "DU",
+    "address_line_1": "52 RUE DES FLEURS",
+    "address_line_2": "33500 BORDEAUX",
+    "address_line_3": "FRANCE"
+  }
+}