onfido 2.2.0 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 33080fe8a76369f014e7505bbc1597a6531f683374c958729f3a5aac6aa181c4
4
- data.tar.gz: 35f3beb4faa5fc70b8c7f9e40418f8befa943a39ff0801403ebd2bc307a8bdbf
3
+ metadata.gz: 9e3f66215e580ff6d0348639303fc81984b8e2115179e74ef101787a8ac76fb7
4
+ data.tar.gz: bf0ab24f1cc95cf9339ce9554926093f1f175993e8b3151d86b80d31711e95db
5
5
  SHA512:
6
- metadata.gz: 3910d5775649dc5091b49e3417ce6b89962799786026cc0f829e8cca88e2e86ea720e01570dd3b32630776d5e4007d76ed5773d473c6616a14ab7fd64f3e0740
7
- data.tar.gz: 1ea8c2e2a8147a207213d8ca41fa11c98c46393fcba383e242450621cd66210ac0edc0b464a75fa9c1328c136a4d34d49c9434d6aa22e651779989c05dc6ef0a
6
+ metadata.gz: d6a0de780f828c458e26c0216471fc701eea61082ebbfd89f6cc4a0f11deb42005d8294a13893f59589b79f3a9182faba57ec9af887a1bb622b3001fceb4f223
7
+ data.tar.gz: 24505122f39fc8ff91243b399d8c9076689796d62ca47a0893f7d29e94fc53e76387b88d4afe5d084452c7e6d5983a4280d468705f30e0a86ad269f96cc543fa
@@ -12,7 +12,7 @@ jobs:
12
12
  runs-on: ubuntu-latest
13
13
  strategy:
14
14
  matrix:
15
- ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
15
+ ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
16
16
 
17
17
  steps:
18
18
  - uses: actions/checkout@v2
data/CHANGELOG.md CHANGED
@@ -1,3 +1,7 @@
1
+ ## v2.3.0, 02 March 2022
2
+
3
+ - Updated to use API v3.4, for more details please see our [release notes](https://developers.onfido.com/release-notes#api-v34).
4
+
1
5
  ## v2.2.0, 02 March 2022
2
6
 
3
7
  - Support Onfido API version 3.3
data/README.md CHANGED
@@ -7,7 +7,7 @@ The official Ruby library for integrating with the Onfido API.
7
7
 
8
8
  Documentation can be found at https://documentation.onfido.com
9
9
 
10
- This version uses Onfido API v3.3 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.
10
+ 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.
11
11
 
12
12
  ## Installation
13
13
 
@@ -32,7 +32,7 @@ module Onfido
32
32
  attr_reader :api_key, :open_timeout, :read_timeout
33
33
 
34
34
  def base_url
35
- @unknown_api_url || "https://api.#{@region}.onfido.com/v3.3/"
35
+ @unknown_api_url || "https://api.#{@region}.onfido.com/v3.4/"
36
36
  end
37
37
  end
38
38
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Onfido
4
- VERSION = '2.2.0'
4
+ VERSION = '2.3.0'
5
5
  end
@@ -23,7 +23,12 @@ describe Onfido::Applicant do
23
23
  'town' => 'London',
24
24
  'postcode' => 'SW4 6EH',
25
25
  'country' => 'GBR'
26
- }
26
+ },
27
+ 'location' => {
28
+ 'ip_address' => '127.0.0.1',
29
+ 'country_of_residence' => 'GBR'
30
+ },
31
+ 'phone_number' => '910100100'
27
32
  }
28
33
  end
29
34
 
@@ -34,7 +39,7 @@ describe Onfido::Applicant do
34
39
 
35
40
  it 'serializes the payload correctly' do
36
41
  WebMock.after_request do |request_signature, _response|
37
- if request_signature.uri.path == 'v3.3/applicants'
42
+ if request_signature.uri.path == 'v3.4/applicants'
38
43
  expect(Rack::Utils.parse_nested_query(request_signature.body))
39
44
  .to eq(params)
40
45
  end
@@ -13,7 +13,11 @@ describe Onfido::Document do
13
13
  applicant_id: '1030303-123123-123123',
14
14
  type: 'driving_licence',
15
15
  file: file,
16
- side: 'front'
16
+ side: 'front',
17
+ location: {
18
+ ip_address: '127.0.0.1',
19
+ country_of_residence: 'GBR'
20
+ }
17
21
  }
18
22
  end
19
23
 
@@ -26,7 +26,7 @@ describe Onfido::Options do
26
26
  end
27
27
 
28
28
  it 'configures with region' do
29
- expect(rest_client.url).to eq 'https://api.us.onfido.com/v3.3/'
29
+ expect(rest_client.url).to eq 'https://api.us.onfido.com/v3.4/'
30
30
  end
31
31
 
32
32
  it 'configures with timeouts' do
@@ -19,32 +19,32 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
19
19
  end
20
20
  end
21
21
 
22
- get '/v3.3/addresses/pick' do
22
+ get '/v3.4/addresses/pick' do
23
23
  json_response(200, 'addresses.json')
24
24
  end
25
25
 
26
- post '/v3.3/applicants' do
26
+ post '/v3.4/applicants' do
27
27
  json_response(201, 'applicant.json')
28
28
  end
29
29
 
30
- put '/v3.3/applicants/:id' do
30
+ put '/v3.4/applicants/:id' do
31
31
  json_response(200, 'applicant.json')
32
32
  end
33
33
 
34
- get '/v3.3/applicants/:id' do
34
+ get '/v3.4/applicants/:id' do
35
35
  json_response(200, 'applicant.json')
36
36
  end
37
37
 
38
- get '/v3.3/applicants' do
38
+ get '/v3.4/applicants' do
39
39
  response = json_response(200, 'applicants.json')
40
40
  { applicants: JSON.parse(response)['applicants'][pagination_range] }.to_json
41
41
  end
42
42
 
43
- delete '/v3.3/applicants/:id' do
43
+ delete '/v3.4/applicants/:id' do
44
44
  status 204
45
45
  end
46
46
 
47
- post '/v3.3/applicants/:id/restore' do
47
+ post '/v3.4/applicants/:id/restore' do
48
48
  if params['id'] == 'a2fb9c62-ab10-4898-a8ec-342c4b552ad5'
49
49
  json_response(422, 'not_scheduled_for_deletion_error.json')
50
50
  else
@@ -52,37 +52,37 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
52
52
  end
53
53
  end
54
54
 
55
- post '/v3.3/documents' do
55
+ post '/v3.4/documents' do
56
56
  json_response(201, 'document.json')
57
57
  end
58
58
 
59
- post '/v3.3/extractions' do
59
+ post '/v3.4/extractions' do
60
60
  json_response(201, 'extraction.json')
61
61
  end
62
62
 
63
- get '/v3.3/documents/:id' do
63
+ get '/v3.4/documents/:id' do
64
64
  json_response(200, 'document.json')
65
65
  end
66
66
 
67
- get '/v3.3/documents' do
67
+ get '/v3.4/documents' do
68
68
  json_response(200, 'documents.json')
69
69
  end
70
70
 
71
- get '/v3.3/documents/:id/download' do
71
+ get '/v3.4/documents/:id/download' do
72
72
  status 200
73
73
  content_type 'application/octet-stream'
74
74
  "\x01\x02\x03" # acts as binary file data
75
75
  end
76
76
 
77
- post '/v3.3/live_photos' do
77
+ post '/v3.4/live_photos' do
78
78
  json_response(201, 'live_photo.json')
79
79
  end
80
80
 
81
- get '/v3.3/live_photos/:id' do
81
+ get '/v3.4/live_photos/:id' do
82
82
  json_response(200, 'live_photo.json')
83
83
  end
84
84
 
85
- get '/v3.3/live_photos' do
85
+ get '/v3.4/live_photos' do
86
86
  if params['applicant_id'] == '1030303-123123-123123'
87
87
  json_response(200, 'live_photos.json')
88
88
  else
@@ -90,17 +90,17 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
90
90
  end
91
91
  end
92
92
 
93
- get '/v3.3/live_photos/:id/download' do
93
+ get '/v3.4/live_photos/:id/download' do
94
94
  status 200
95
95
  content_type 'image/jpeg'
96
96
  "\x01\x02\x03" # acts as binary file data
97
97
  end
98
98
 
99
- get '/v3.3/live_videos/:id' do
99
+ get '/v3.4/live_videos/:id' do
100
100
  json_response(200, 'live_video.json')
101
101
  end
102
102
 
103
- get '/v3.3/live_videos' do
103
+ get '/v3.4/live_videos' do
104
104
  if params['applicant_id'] == '1030303-123123-123123'
105
105
  json_response(200, 'live_videos.json')
106
106
  else
@@ -108,79 +108,79 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
108
108
  end
109
109
  end
110
110
 
111
- get '/v3.3/live_videos/:id/download' do
111
+ get '/v3.4/live_videos/:id/download' do
112
112
  status 200
113
113
  content_type 'video/quicktime'
114
114
  "\x01\x02\x03" # acts as binary file data
115
115
  end
116
116
 
117
- post '/v3.3/checks' do
117
+ post '/v3.4/checks' do
118
118
  params['applicant_id'].nil? ? status(422) : json_response(201, 'check.json')
119
119
  end
120
120
 
121
- get '/v3.3/checks/:id' do
121
+ get '/v3.4/checks/:id' do
122
122
  json_response(200, 'check.json')
123
123
  end
124
124
 
125
- get '/v3.3/checks' do
125
+ get '/v3.4/checks' do
126
126
  json_response(200, 'checks.json')
127
127
  end
128
128
 
129
- post '/v3.3/checks/:id/resume' do
129
+ post '/v3.4/checks/:id/resume' do
130
130
  status 204 # no_content
131
131
  end
132
132
 
133
- get '/v3.3/checks/:id/download' do
133
+ get '/v3.4/checks/:id/download' do
134
134
  status 200
135
135
  content_type 'application/pdf'
136
136
  "\x01\x02\x03" # acts as binary file data
137
137
  end
138
138
 
139
- get '/v3.3/reports' do
139
+ get '/v3.4/reports' do
140
140
  json_response(200, 'reports.json')
141
141
  end
142
142
 
143
- get '/v3.3/reports/:id' do
143
+ get '/v3.4/reports/:id' do
144
144
  json_response(200, 'report.json')
145
145
  end
146
146
 
147
- post '/v3.3/reports/:id/resume' do
147
+ post '/v3.4/reports/:id/resume' do
148
148
  status 204
149
149
  end
150
150
 
151
- post '/v3.3/reports/:id/cancel' do
151
+ post '/v3.4/reports/:id/cancel' do
152
152
  status 204
153
153
  end
154
154
 
155
- post '/v3.3/sdk_token' do
155
+ post '/v3.4/sdk_token' do
156
156
  json_response(201, 'sdk_token.json')
157
157
  end
158
158
 
159
- post '/v3.3/webhooks' do
159
+ post '/v3.4/webhooks' do
160
160
  json_response(201, 'webhook.json')
161
161
  end
162
162
 
163
- get '/v3.3/webhooks/:id' do
163
+ get '/v3.4/webhooks/:id' do
164
164
  json_response(200, 'webhook.json')
165
165
  end
166
166
 
167
- delete '/v3.3/webhooks/:id' do
167
+ delete '/v3.4/webhooks/:id' do
168
168
  status 204
169
169
  end
170
170
 
171
- get '/v3.3/webhooks' do
171
+ get '/v3.4/webhooks' do
172
172
  json_response(200, 'webhooks.json')
173
173
  end
174
174
 
175
- get '/v3.3/4xx_response' do
175
+ get '/v3.4/4xx_response' do
176
176
  json_response(422, '4xx_response.json')
177
177
  end
178
178
 
179
- get '/v3.3/unexpected_error_format' do
179
+ get '/v3.4/unexpected_error_format' do
180
180
  json_response(400, 'unexpected_error_format.json')
181
181
  end
182
182
 
183
- get '/v3.3/unparseable_response' do
183
+ get '/v3.4/unparseable_response' do
184
184
  content_type :json
185
185
  status 504
186
186
  ''
@@ -7,7 +7,7 @@
7
7
  "last_name":"Bing",
8
8
  "email":"chandler_bing_6@friends.com",
9
9
  "dob":"1968-04-08",
10
- "href":"/v3.3/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
10
+ "href":"/v3.4/applicants/61f659cb-c90b-4067-808a-6136b5c01351",
11
11
  "id_numbers":[],
12
12
  "address": {
13
13
  "flat_number":"4",
@@ -19,5 +19,10 @@
19
19
  "state":"",
20
20
  "postcode":"SW4 6EH",
21
21
  "country":"GBR"
22
- }
22
+ },
23
+ "location": {
24
+ "ip_address": "127.0.0.1",
25
+ "country_of_residence": "GBR"
26
+ },
27
+ "phone_number": "910100100"
23
28
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "id": "8546921-123123-123123",
3
3
  "created_at": "2019-05-23T13:50:33Z",
4
- "href": "/v3.3/checks/8546921-123123-123123",
4
+ "href": "/v3.4/checks/8546921-123123-123123",
5
5
  "applicant_provides_data": "false",
6
6
  "status": "pending",
7
7
  "result": "pending",
@@ -3,7 +3,7 @@
3
3
  {
4
4
  "id": "8546921-123123-123123",
5
5
  "created_at": "2019-11-23T13:50:33Z",
6
- "href": "/v3.3/checks/8546921-123123-123123",
6
+ "href": "/v3.4/checks/8546921-123123-123123",
7
7
  "applicant_provides_data": "false",
8
8
  "status": "pending",
9
9
  "result": "pending",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "id": "7568415-123123-123123",
3
3
  "created_at": "2019-11-23 13:50:33Z",
4
- "href": "/v3.3/documents/7568415-123123-123123",
4
+ "href": "/v3.4/documents/7568415-123123-123123",
5
5
  "file_name": "passport.jpg",
6
6
  "file_type": "png",
7
7
  "file_size": 282870,
@@ -3,7 +3,7 @@
3
3
  {
4
4
  "id": "7568415-123123-123123",
5
5
  "created_at": "2019-11-23 13:50:33Z",
6
- "href": "/v3.3/documents/7568415-123123-123123",
6
+ "href": "/v3.4/documents/7568415-123123-123123",
7
7
  "file_name": "passport.jpg",
8
8
  "file_type": "png",
9
9
  "file_size": 282870,
@@ -12,7 +12,7 @@
12
12
  {
13
13
  "id": "121122-123123-123123",
14
14
  "created_at": "2019-11-23 13:50:40Z",
15
- "href": "/v3.3/documents/7568415-123123-123123",
15
+ "href": "/v3.4/documents/7568415-123123-123123",
16
16
  "file_name": "driving_licence.png",
17
17
  "file_type": "png",
18
18
  "file_size": 282870,
@@ -4,6 +4,6 @@
4
4
  "file_name": "onfido_captured_image.jpg",
5
5
  "file_type": "image/jpeg",
6
6
  "file_size": 47544,
7
- "href": "/v3.3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
8
- "download_href": "/v3.3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
7
+ "href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
8
+ "download_href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
9
9
  }
@@ -6,8 +6,8 @@
6
6
  "file_name": "onfido_captured_image.jpg",
7
7
  "file_type": "image/jpeg",
8
8
  "file_size": 47544,
9
- "href": "/v3.3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
10
- "download_href": "/v3.3/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
9
+ "href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
10
+ "download_href": "/v3.4/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
11
11
  },
12
12
  {
13
13
  "id": "5134c12a-555a-1234-5e12-9d34fcbc11ba",
@@ -15,8 +15,8 @@
15
15
  "file_name": "onfido_captured_image.jpg",
16
16
  "file_type": "image/jpeg",
17
17
  "file_size": 47544,
18
- "href": "/v3.3/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
19
- "download_href": "/v3.3/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
18
+ "href": "/v3.4/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
19
+ "download_href": "/v3.4/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
20
20
  }
21
21
  ]
22
22
  }
@@ -18,6 +18,6 @@
18
18
  "file_name" : "output-29-05-2018_11_00_24.mov",
19
19
  "file_type" : "video/quicktime",
20
20
  "file_size" : 3348421,
21
- "href" : "/v3.3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
22
- "download_href" : "/v3.3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
21
+ "href" : "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
22
+ "download_href" : "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download"
23
23
  }
@@ -16,11 +16,11 @@
16
16
  }
17
17
  ],
18
18
  "created_at": "2019-11-29T09:00:39Z",
19
- "download_href": "/v3.3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
19
+ "download_href": "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01/download",
20
20
  "file_name": "output-29-11-2019_11_00_24.mov",
21
21
  "file_size": 3348421,
22
22
  "file_type": "video/quicktime",
23
- "href": "/v3.3/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
23
+ "href": "/v3.4/live_videos/c9701e9b-83aa-442f-995b-20320ee8fb01",
24
24
  "id": "c9701e9b-83aa-442f-995b-20320ee8fb01"
25
25
  }
26
26
  ]
@@ -4,7 +4,7 @@
4
4
  "created_at": "2019-11-23T13:50:45Z",
5
5
  "status": "in_progress",
6
6
  "result": "pending",
7
- "href": "/v3.3/reports/6951786-123123-422221",
7
+ "href": "/v3.4/reports/6951786-123123-422221",
8
8
  "breakdown": {},
9
9
  "properties": {}
10
10
  }
@@ -6,7 +6,7 @@
6
6
  "created_at": "2019-11-23T13:50:45Z",
7
7
  "status": "in_progress",
8
8
  "result": "pending",
9
- "href": "/v3.3/reports/6951786-123123-422221",
9
+ "href": "/v3.4/reports/6951786-123123-422221",
10
10
  "breakdown": {},
11
11
  "properties": {}
12
12
  },
@@ -16,7 +16,7 @@
16
16
  "created_at": "2019-11-23T13:50:45Z",
17
17
  "status": "in_progress",
18
18
  "result": "pending",
19
- "href": "/v3.3/reports/6951786-123123-316712",
19
+ "href": "/v3.4/reports/6951786-123123-316712",
20
20
  "breakdown": {},
21
21
  "properties": {}
22
22
  }
@@ -3,7 +3,7 @@
3
3
  "url": "https://webhookendpoint.url",
4
4
  "token": "yV85IsmuYwmjQGlZ",
5
5
  "enabled": true,
6
- "href": "/v3.3/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
6
+ "href": "/v3.4/webhooks/fcb73186-0733-4f6f-9c57-d9d5ef979443",
7
7
  "environments": [
8
8
  "live"
9
9
  ],
@@ -4,7 +4,7 @@
4
4
  "id": "dd0a89e4-d44e-417a-aec4-01137d01ae59",
5
5
  "url": "https://demo.com",
6
6
  "enabled":false,
7
- "href": "/v3.3/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
7
+ "href": "/v3.4/webhooks/dd0a89e4-d44e-417a-aec4-01137d01ae59",
8
8
  "environments": [
9
9
  "live"
10
10
  ],
@@ -18,7 +18,7 @@
18
18
  "id": "bfc727a8-f7bf-4073-b123-ed70a70f58e5",
19
19
  "url": "https://demo2.com",
20
20
  "enabled": true,
21
- "href": "/v3.3/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
21
+ "href": "/v3.4/webhooks/bfc727a8-f7bf-4073-b123-ed70a70f58e5",
22
22
  "environments": [
23
23
  "live"
24
24
  ],
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: onfido
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.2.0
4
+ version: 2.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Onfido
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-03-02 00:00:00.000000000 Z
11
+ date: 2022-05-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rspec