onfido 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d9c4bbfbd0e30678c1610b989dd5c4781d64483a
-  data.tar.gz: 057b01dbcd8de22093ce863f585e580d3766adba
+SHA256:
+  metadata.gz: 54ef7de51857895f39c1b960c7959828ff7d36a502a13a1a62db5f76d811ce64
+  data.tar.gz: 495241aeaaa859d1b2b8aed6a250df2519d9df5a2a7624741949156aa9ea7cce
 SHA512:
-  metadata.gz: 107daaa415c0ca71c5094563f746b7202a6a50d47c814a556bdcb81e03ca9b6e3cbc98e2035a9f6d2196a99af511bcd8084f95dc3e2db069cfc19f3132394fac
-  data.tar.gz: 22b36441e76b5c51b295764a63c6183d35f2a4bb71d0d0fcef0cac18cde862f318351f74e507f0cf64e80db93fb29e91208fd371a4ecd833f4381e11525bbfee
+  metadata.gz: 5d86bab77e16c80dc43fa0269d427814ab3fad06701b95eacfba17794409acd9abe29ccced71388c4a2ecf678268c6b50d952fe90e0abf93188eb3ae6e1a910a
+  data.tar.gz: 7f40677b7801251f9ef247e10c2d0a796e6ce9120d864874bc49eb3d0eca27cc73de0a8e64b479f607011e0d4d8d7d48ab6ad97b9dce30705fa19cacc4f9588d

data/.rubocop.yml

@@ -1,6 +1,7 @@
 # For all options see https://github.com/bbatsov/rubocop/tree/master/config
 
 AllCops:
+  DisplayCopNames: true
   Include:
     - Rakefile
     - lib/tasks/*.rake
@@ -12,16 +13,27 @@ AllCops:
 Style/StringLiterals:
   Enabled: false
 
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
 Style/SignalException:
   EnforcedStyle: only_raise
 
+Style/FileName:
+  Exclude:
+    - Gemfile
+
 Metrics/MethodLength:
   CountComments: false
   Max: 25
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
 Metrics/AbcSize:
   Max: 25
 
@@ -35,7 +47,7 @@ Metrics/LineLength:
 Metrics/ClassLength:
   Enabled: false
 
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: trailing
 
 # Allow class and message or instance raises

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.8.3, 16 January 2018
+
+Add support for `Onfido::SdkToken` resource
+
 ## v0.8.2, 21 April 2017
 
 - Relax [Rack](https://github.com/rack/rack) dependency to allow all versions where `Rack::Utils.secure_compare` is available (@metade)

data/README.md

@@ -12,7 +12,7 @@ This gem supports both `v1` and `v2` of the Onfido API. Refer to Onfido's [API d
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'onfido', '~> 0.8.2'
+gem 'onfido', '~> 0.8.3'
 ```
 
 ## Configuration
@@ -112,6 +112,7 @@ 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.
 
@@ -141,6 +142,15 @@ api.webhook.find('webhook_id')      # => Finds a single webhook endpoint
 api.webhook.all                     # => Returns all webhook endpoints
 ```
 
+#### SDK Tokens
+
+Onfido allows you to generate JSON Web Tokens via the API in order to authenticate
+with Onfido's [JavaScript SDK](https://github.com/onfido/onfido-sdk-ui).
+
+```ruby
+api.sdk_token.create(applicant_id: 'applicant_id', referrer: 'referrer')
+```
+
 ### Pagination
 
 All resources that support an `all` method also support pagination. By default,
@@ -148,7 +158,7 @@ the first 20 records are fetched.
 
 ### Error Handling
 
-There are three classes of errors raised by the library, all of which subclass `Onfido::Error`:
+There are three classes of errors raised by the library, all of which subclass `Onfido::OnfidoError`:
 - `Onfido::ServerError` is raised whenever Onfido returns a `5xx` response
 - `Onfido::RequestError` is raised whenever Onfido returns any other kind of error
 - `Onfido::ConnectionError` is raised whenever a network error occurs (e.g., a timeout)

data/lib/onfido.rb

@@ -20,6 +20,7 @@ require 'onfido/resources/document'
 require 'onfido/resources/live_photo'
 require 'onfido/resources/report'
 require 'onfido/resources/report_type_group'
+require 'onfido/resources/sdk_token'
 require 'onfido/resources/webhook'
 
 module Onfido

data/lib/onfido/configuration.rb

@@ -19,11 +19,11 @@ module Onfido
     end
 
     def logger=(log)
-      if log.respond_to?(:<<)
-        RestClient.log = log
-      else
+      unless log.respond_to?(:<<)
         raise "#{log.class} doesn't seem to behave like a logger!"
       end
+
+      RestClient.log = log
     end
 
     def logger

data/lib/onfido/null_logger.rb

@@ -1,6 +1,5 @@
 module Onfido
   class NullLogger
-    def <<(*args)
-    end
+    def <<(*args); end
   end
 end

data/lib/onfido/resource.rb

@@ -88,9 +88,7 @@ module Onfido
     def handle_api_error(response)
       parsed_response = parse(response)
 
-      unless parsed_response["error"]
-        general_api_error(response.code, response.body)
-      end
+      general_api_error(response.code, response.body) unless parsed_response["error"]
 
       error_class = response.code.to_i >= 500 ? ServerError : RequestError
 

data/lib/onfido/resources/sdk_token.rb

@@ -0,0 +1,10 @@
+module Onfido
+  class SdkToken < Resource
+    def create(payload)
+      post(
+        url: url_for("sdk_token"),
+        payload: payload
+      )
+    end
+  end
+end

data/lib/onfido/version.rb

@@ -1,3 +1,3 @@
 module Onfido
-  VERSION = '0.8.2'.freeze
+  VERSION = '0.8.3'.freeze
 end

data/onfido.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'onfido/version'
@@ -8,8 +9,11 @@ Gem::Specification.new do |spec|
   spec.version       = Onfido::VERSION
   spec.authors       = ['Pericles Theodorou', 'Grey Baker']
   spec.email         = ['periclestheo@gmail.com', 'grey@gocardless.com']
-  spec.summary       = %q{A wrapper for Onfido API}
-  spec.description   = %q{A thin wrapper for Onfido's API. This gem supports both v1 and v2 of the Onfido API. Refer to Onfido's API documentation for details of the expected requests and responses for both.}
+  spec.summary       = 'A wrapper for Onfido API'
+  spec.description   = "A thin wrapper for Onfido's API. This gem supports "\
+                       "both v1 and v2 of the Onfido API. Refer to Onfido's "\
+                       "API documentation for details of the expected "\
+                       "requests and responses for both."
   spec.homepage      = 'http://github.com/hvssle/onfido'
   spec.license       = 'MIT'
 
@@ -19,13 +23,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'webmock', '~> 2.3'
-  spec.add_development_dependency 'rubocop', '~> 0.37.0'
+  spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
+  spec.add_development_dependency 'rubocop', '~> 0.52.0'
   spec.add_development_dependency 'sinatra', '~> 1.4'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 
-  spec.add_dependency 'rest-client', '~> 2.0'
   spec.add_dependency 'rack', '>= 1.6.0'
+  spec.add_dependency 'rest-client', '~> 2.0'
 end

data/spec/integrations/sdk_token_spec.rb

@@ -0,0 +1,14 @@
+describe Onfido::SdkToken do
+  subject(:sdk_token) { described_class.new }
+  let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
+  let(:referrer) { 'http://*.mywebsite.com/*' }
+
+  describe '#create' do
+    let(:params) { { applicant_id: applicant_id, referrer: referrer } }
+
+    it 'creates a new SDK token for the applicant' do
+      response = sdk_token.create(params)
+      expect(response['token']).not_to be_nil
+    end
+  end
+end

data/spec/onfido/resource_spec.rb

@@ -70,7 +70,8 @@ describe Onfido::Resource do
           headers: {
             'Authorization' => "Token token=#{specific_api_key}",
             'Accept' => "application/json"
-          })
+          }
+        )
       end
     end
 
@@ -84,7 +85,8 @@ describe Onfido::Resource do
           headers: {
             'Authorization' => "Token token=#{api_key}",
             'Accept' => "application/json"
-          })
+          }
+        )
       end
     end
   end

data/spec/support/fake_onfido_api.rb

@@ -98,6 +98,10 @@ class FakeOnfidoAPI < Sinatra::Base
     json_response(200, 'report_type_groups.json')
   end
 
+  post '/v2/sdk_token' do
+    json_response(201, 'sdk_token.json')
+  end
+
   post '/v2/webhooks' do
     json_response(201, 'webhook.json')
   end

data/spec/support/fixtures/sdk_token.json

@@ -0,0 +1,3 @@
+{
+  "token": "header.payload.signature"
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - Pericles Theodorou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,112 +31,112 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.52.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.52.0
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '2.0'
 description: A thin wrapper for Onfido's API. This gem supports both v1 and v2 of
   the Onfido API. Refer to Onfido's API documentation for details of the expected
   requests and responses for both.
@@ -172,6 +172,7 @@ files:
 - lib/onfido/resources/live_photo.rb
 - lib/onfido/resources/report.rb
 - lib/onfido/resources/report_type_group.rb
+- lib/onfido/resources/sdk_token.rb
 - lib/onfido/resources/webhook.rb
 - lib/onfido/version.rb
 - onfido.gemspec
@@ -183,6 +184,7 @@ files:
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/report_spec.rb
 - spec/integrations/report_type_group_spec.rb
+- spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
@@ -206,6 +208,7 @@ files:
 - spec/support/fixtures/report_type_group.json
 - spec/support/fixtures/report_type_groups.json
 - spec/support/fixtures/reports.json
+- spec/support/fixtures/sdk_token.json
 - spec/support/fixtures/unexpected_error_format.json
 - spec/support/fixtures/webhook.json
 - spec/support/fixtures/webhooks.json
@@ -229,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A wrapper for Onfido API
@@ -242,6 +245,7 @@ test_files:
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/report_spec.rb
 - spec/integrations/report_type_group_spec.rb
+- spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
@@ -265,7 +269,7 @@ test_files:
 - spec/support/fixtures/report_type_group.json
 - spec/support/fixtures/report_type_groups.json
 - spec/support/fixtures/reports.json
+- spec/support/fixtures/sdk_token.json
 - spec/support/fixtures/unexpected_error_format.json
 - spec/support/fixtures/webhook.json
 - spec/support/fixtures/webhooks.json
-has_rdoc: