onfido 0.15.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a3a4754fe9f0896451df78eed5bf0af851ddffad2d4992e59d68fd5a3dc5e1d
-  data.tar.gz: 4c51e178c11a4a60cda311c517803cd890d90c383b5fef10250e2064f372649b
+  metadata.gz: 7c2b7ace145ea9b4804afb24664f452851753bb15dca4221e94c43cf1db6f96e
+  data.tar.gz: c0477b41310dc691e99a218d03a40777c5e91d3e1cc72d90884f9d6d01772a3e
 SHA512:
-  metadata.gz: be9b5b35882b37be5d70e0004191c10ba67c069ac99b86b7382abb6924b8e6d29f557340d4ff18e38f9bcd8f898f0ae60c57daea5ebac1037e781aa551fc38ae
-  data.tar.gz: 5d2cd866567a2159a661ae3ec7af29d2d620b47f5ba44e681fb84e8ca1798c0c8b13c8eb0da829ccd9b46861038f0a89d6ccd1b4ec4de576b61d45fe78ea9c30
+  metadata.gz: 598a9e0fcf166be224cf0b28dd0f8ca92f8e285ac3955d7ff06ad450bd018741ce580f99de6e506100f879ef5002e485926fec8d741d7bb313d496486f4ffb48
+  data.tar.gz: 1786150e8f9b3d8d7b1bec8aad0ff35565c77e3000c70534757aec49ae85fff9c15deb398e53d2676337b3ff9432a25ed48a690833112304ad91d249ae82f550

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## v1.0.0, 13 Jan 2020
+
+- Support Onfido API version 3
+- Drop support for Onfido API version 2
+
 ## v0.15.0, 4 Feb 2019
 
 - Add Check#find_by_url method (@ctrlaltdylan)

data/LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Hassle
+Original work Copyright (c) 2015 Hassle
+Modified work Copyright 2019 Onfido
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,28 +3,30 @@
 A thin wrapper for Onfido's API.
 
 [![Gem Version](https://badge.fury.io/rb/onfido.svg)](http://badge.fury.io/rb/onfido)
-[![Build Status](https://travis-ci.org/hvssle/onfido.svg?branch=master)](https://travis-ci.org/hvssle/onfido)
+[![Build Status](https://travis-ci.org/onfido/onfido-ruby.svg?branch=master)](https://travis-ci.org/onfido/onfido-ruby)
+
+This gem supports only `v3` of Onfido's API from version `1.0.0` ownards.
+The latest version that supports `v2` of Onfido's API is `0.15.0`. `v1` of Onfido's API is deprecated
+Refer to Onfido's [API documentation](https://documentation.onfido.com) for details of the expected requests and responses.
 
-This gem supports both `v1` and `v2` of the Onfido API. Refer to Onfido's [API documentation](https://onfido.com/documentation#introduction) for details of the expected requests and responses for both.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'onfido', '~> 0.15.1'
+gem 'onfido', '~> 1.0.0'
 ```
 
 The gem is compatible with Ruby 2.2.0 and onwards. Earlier versions of Ruby have [reached end-of-life](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/), are no longer supported and no longer receive security fixes.
 
 ## Configuration
 
-There are 6 configuration options:
+There are 5 configuration options:
 
 ```ruby
 Onfido.configure do |config|
   config.api_key = 'MY_API_KEY'
-  config.api_version = 'v2'
   config.logger = Logger.new(STDOUT)
   config.open_timeout = 30
   config.read_timeout = 80
@@ -59,7 +61,7 @@ api = Onfido::API.new(api_key: 'API_KEY')
 
 All resources share the same interface when making API calls. Use `.create` to create a resource, `.find` to find one, and `.all` to fetch all resources.
 
-**Note:** *All param keys should be a symbol e.g. `{ type: 'express', reports: [{ name: 'identity' }] }`*
+**Note:** *All param keys should be a symbol e.g. `{ report_names: ['document'] }`*
 
 #### Applicants
 
@@ -83,8 +85,8 @@ Documents provide supporting evidence for Onfido checks.
 
 ```ruby
 api.document.create('applicant_id', file: 'http://example.com', type: 'passport') # => Creates a document
-api.document.find('applicant_id', 'document_id') # => Finds a document
-api.document.download('applicant_id', 'document_id') # => Downloads a document as a binary data
+api.document.find('document_id') # => Finds a document
+api.document.download('document_id') # => Downloads a document as a binary data
 api.document.all('applicant_id') # => Returns all applicant's documents
 ```
 
@@ -99,8 +101,8 @@ Live Photos, like documents, can provide supporting evidence for Onfido checks.
 
 ```ruby
 api.live_photo.create('applicant_id', file: 'http://example.com')
-api.live_photo.find(applicant_id, live_photo_id) # => Finds a live photo
-api.live_photo.download(applicant_id, live_photo_id) # => Downloads a live photo as binary data
+api.live_photo.find(live_photo_id) # => Finds a live photo
+api.live_photo.download(live_photo_id) # => Downloads a live photo as binary data
 api.live_photo.all(applicant_id) # => Returns all applicant's live photos
 ```
 
@@ -115,9 +117,8 @@ Checks are requests for Onfido to check an applicant, by commissioning one or
 more "reports" on them.
 
 ```ruby
-api.check.create('applicant_id', type: 'express', reports: [{ name: 'identity' }])
-api.check.find('applicant_id', 'check_id')
-api.check.find_by_url('applicants/a90e7a17-677a-49ab-a171-281f96c77bde/checks/c9f41bef-0610-4d2f-9982-ae9387876edc')
+api.check.create('applicant_id', report_names: ['document'])
+api.check.find('check_id')
 api.check.resume('check_id')
 api.check.all('applicant_id')
 ```
@@ -130,20 +131,10 @@ finding and listing them. For paused reports specifically, additional support fo
  cancelling reports is also available.
 
 ```ruby
-api.report.find('check_id', 'report_id')
+api.report.find('report_id')
 api.report.all('check_id')
-api.report.resume('check_id', 'report_id')
-api.report.cancel('check_id', 'report_id')
-```
-
-#### Report Type Groups
-
-Report type groups provide a convenient way to group and organize different types of reports.
- The Onfido API only provides support for finding and listing them.
-
-```ruby
-api.report_type_group.find('report_type_group_id')
-api.report_type_group.all()
+api.report.resume('report_id')
+api.report.cancel('report_id')
 ```
 
 #### Address Lookups
@@ -176,11 +167,6 @@ with Onfido's [JavaScript SDK](https://github.com/onfido/onfido-sdk-ui).
 api.sdk_token.create(applicant_id: 'applicant_id', referrer: 'referrer')
 ```
 
-### Pagination
-
-All resources that support an `all` method also support pagination. By default,
-the first 20 records are fetched.
-
 ### Error Handling
 
 There are three classes of errors raised by the library, all of which subclass `Onfido::OnfidoError`:
@@ -224,7 +210,7 @@ end
 
 ## Contributing
 
-1. Fork it ( https://github.com/hvssle/onfido/fork )
+1. Fork it ( https://github.com/onfido/onfido/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/onfido.rb

@@ -19,7 +19,6 @@ require 'onfido/resources/document'
 require 'onfido/resources/live_photo'
 require 'onfido/resources/live_video'
 require 'onfido/resources/report'
-require 'onfido/resources/report_type_group'
 require 'onfido/resources/sdk_token'
 require 'onfido/resources/webhook'
 

data/lib/onfido/api.rb

@@ -28,10 +28,6 @@ module Onfido
       Onfido::Report.new(@api_key)
     end
 
-    def report_type_group
-      Onfido::ReportTypeGroup.new(@api_key)
-    end
-
     def sdk_token
       Onfido::SdkToken.new(@api_key)
     end

data/lib/onfido/configuration.rb

@@ -4,7 +4,7 @@ module Onfido
       us: "api.us.onfido.com"
     }.freeze
 
-    attr_accessor :api_key, :region, :open_timeout, :read_timeout, :api_version
+    attr_accessor :api_key, :region, :open_timeout, :read_timeout
 
     def self.extended(base)
       base.reset
@@ -19,7 +19,6 @@ module Onfido
       self.region = nil
       self.open_timeout = 30
       self.read_timeout = 80
-      self.api_version = 'v2'
       RestClient.log = nil
     end
 
@@ -41,7 +40,7 @@ module Onfido
         raise "The region \"#{region.downcase}\" is not currently supported"
       end
 
-      "https://#{region_host}/#{api_version}/"
+      "https://#{region_host}/v3/"
     end
   end
 end

data/lib/onfido/resource.rb

@@ -7,15 +7,11 @@ module Onfido
       @api_key = api_key || Onfido.api_key
     end
 
-    def url_for(path)
-      Onfido.endpoint + path
-    end
-
     VALID_HTTP_METHODS.each do |method|
       define_method method do |*args|
         make_request(
           method: method.to_sym,
-          url: args.first.fetch(:url),
+          url: Onfido.endpoint + args.first.fetch(:path),
           payload: build_query(args.first.fetch(:payload, {}))
         )
       end

data/lib/onfido/resources/address.rb

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

data/lib/onfido/resources/applicant.rb

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

data/lib/onfido/resources/check.rb

@@ -1,32 +1,22 @@
 module Onfido
   class Check < Resource
-    def create(applicant_id, payload)
-      post(
-        url: url_for("applicants/#{applicant_id}/checks"),
-        payload: payload
-      )
-    end
+    def create(applicant_id:, report_names:, **payload)
+      payload[:applicant_id] = applicant_id
+      payload[:report_names] = report_names
 
-    def find(applicant_id, check_id, expand: nil)
-      querystring = "&expand=#{expand}" if expand
-      get(url: url_for("applicants/#{applicant_id}/checks/#{check_id}?" \
-                       "#{querystring}"))
+      post(path: 'checks', payload: payload)
     end
 
-    def find_by_url(url, expand: nil)
-      url_path = url.sub(%r/^https\:\/\/api\.onfido\.com\/v2\//, '')
-      querystring = "&expand=#{expand}" if expand
-      get(url: url_for("#{url_path}?#{querystring}"))
+    def find(check_id)
+      get(path: "checks/#{check_id}")
     end
 
-    def all(applicant_id, page: 1, per_page: 20, expand: nil)
-      querystring = "page=#{page}&per_page=#{per_page}"
-      querystring += "&expand=#{expand}" if expand
-      get(url: url_for("applicants/#{applicant_id}/checks?#{querystring}"))
+    def all(applicant_id)
+      get(path: "checks?applicant_id=#{applicant_id}")
     end
 
     def resume(check_id)
-      post(url: url_for("checks/#{check_id}/resume"))
+      post(path: "checks/#{check_id}/resume")
     end
   end
 end

data/lib/onfido/resources/document.rb

@@ -2,25 +2,25 @@ module Onfido
   class Document < Resource
     # with open-uri the file can be a link or an actual file
 
-    def create(applicant_id, payload)
-      validate_file!(payload.fetch(:file))
+    def create(applicant_id:, file:, type:, **payload)
+      validate_file!(file)
+      payload[:applicant_id] = applicant_id
+      payload[:file] = file
+      payload[:type] = type
 
-      post(
-        url: url_for("applicants/#{applicant_id}/documents"),
-        payload: payload
-      )
+      post(path: 'documents', payload: payload)
     end
 
-    def find(applicant_id, document_id)
-      get(url: url_for("applicants/#{applicant_id}/documents/#{document_id}"))
+    def find(document_id)
+      get(path: "documents/#{document_id}")
     end
 
-    def download(applicant_id, document_id)
-      get(url: url_for("applicants/#{applicant_id}/documents/#{document_id}/download"))
+    def download(document_id)
+      get(path: "documents/#{document_id}/download")
     end
 
     def all(applicant_id)
-      get(url: url_for("applicants/#{applicant_id}/documents"))
+      get(path: "documents?applicant_id=#{applicant_id}")
     end
   end
 end

data/lib/onfido/resources/live_photo.rb

@@ -2,29 +2,24 @@ module Onfido
   class LivePhoto < Resource
     # with open-uri the file can be a link or an actual file
 
-    def create(applicant_id, payload)
-      validate_file!(payload.fetch(:file))
+    def create(applicant_id:, file:, **payload)
+      validate_file!(file)
       payload[:applicant_id] = applicant_id
+      payload[:file] = file
 
-      post(
-        url: url_for("/live_photos"),
-        payload: payload
-      )
+      post(path: 'live_photos', payload: payload)
     end
 
-    def find(applicant_id, live_photo_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_photos/#{live_photo_id}?#{query_string}"))
+    def find(live_photo_id)
+      get(path: "live_photos/#{live_photo_id}")
     end
 
-    def download(applicant_id, live_photo_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_photos/#{live_photo_id}/download?#{query_string}"))
+    def download(live_photo_id)
+      get(path: "live_photos/#{live_photo_id}/download")
     end
 
     def all(applicant_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_photos?#{query_string}"))
+      get(path: "live_photos?applicant_id=#{applicant_id}")
     end
   end
 end

data/lib/onfido/resources/live_video.rb

@@ -1,18 +1,15 @@
 module Onfido
   class LiveVideo < Resource
-    def find(applicant_id, live_video_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_videos/#{live_video_id}?#{query_string}"))
+    def find(live_video_id)
+      get(path: "live_videos/#{live_video_id}")
     end
 
-    def download(applicant_id, live_video_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_videos/#{live_video_id}/download?#{query_string}"))
+    def download(live_video_id)
+      get(path: "live_videos/#{live_video_id}/download")
     end
 
     def all(applicant_id)
-      query_string = "applicant_id=#{applicant_id}"
-      get(url: url_for("live_videos?#{query_string}"))
+      get(path: "live_videos?applicant_id=#{applicant_id}")
     end
   end
 end

data/lib/onfido/resources/report.rb

@@ -1,20 +1,19 @@
 module Onfido
   class Report < Resource
-    def find(check_id, report_id)
-      get(url: url_for("checks/#{check_id}/reports/#{report_id}"))
+    def find(report_id)
+      get(path: "reports/#{report_id}")
     end
 
-    def all(check_id, page: 1, per_page: 20)
-      querystring = "page=#{page}&per_page=#{per_page}"
-      get(url: url_for("checks/#{check_id}/reports?#{querystring}"))
+    def all(check_id)
+      get(path: "reports?check_id=#{check_id}")
     end
 
-    def resume(check_id, report_id)
-      post(url: url_for("checks/#{check_id}/reports/#{report_id}/resume"))
+    def resume(report_id)
+      post(path: "reports/#{report_id}/resume")
     end
 
-    def cancel(check_id, report_id)
-      post(url: url_for("checks/#{check_id}/reports/#{report_id}/cancel"))
+    def cancel(report_id)
+      post(path: "reports/#{report_id}/cancel")
     end
   end
 end

data/lib/onfido/resources/sdk_token.rb

@@ -1,10 +1,8 @@
 module Onfido
   class SdkToken < Resource
-    def create(payload)
-      post(
-        url: url_for("sdk_token"),
-        payload: payload
-      )
+    def create(applicant_id:, **payload)
+      payload[:applicant_id] = applicant_id
+      post(path: 'sdk_token', payload: payload)
     end
   end
 end