onfido 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02ec5c2316de975b17ee9818699d45f47eff8e9f93bb89400e7ef4dd9d6b5170
-  data.tar.gz: ed1a1accb7575b5483eb17cd5631d0abe98641a5c34922b79a9c26bce13eab53
+  metadata.gz: 3230fbefefe2fe6a65813be33aa6025503aebea8d2959290702d18874d265d0e
+  data.tar.gz: 12bcea5a6c837d30aa1c5ea9ba2e62c4d1d5a7d6c65824fbec55943d941f572c
 SHA512:
-  metadata.gz: b51ceca16f8c19c95234e8ba5b5e5e86c3cca098273a79e3880c46175861c6efd9d97858bc463d6a8ad029268d66866306792b5dea822473cd89100c5f4a9b75
-  data.tar.gz: 0f149d1be7d19d1c3f4edbef29d80d0ac5ebfd4ed26e17a29b66e44afbc2e9aa4d473e5ce770d7247284d993a054e6349f043cce62f6d7c9315525b1b6558b92
+  metadata.gz: 8e179be06571269bba33d62efb85523f26cd43a1df4b1f43dc90bf6b430c68d40d5140d6141686efcd90a5898a285ade72ac51a5215a48dd6115e5232e69658e
+  data.tar.gz: 15a6b1d68484a3174c8fabb49a4f097ba1c3f82766865707351eac513c7c617423468824758f976070bfd0a42f47cb78fdbc135d20984ecf1ec3bfde0f293c72

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.10.0, 3 April 2018
+
+- Add support for download, find and retrieve all for live_photo resource (@kirsis)
+
 ## v0.9.0, 8 March 2018
 
 - Remove the ability to create Documents and Live Photos from a remote URL or local path, mitigating a potential security vulnerability (see #45 for details) (@timrogers)

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.9.0'
+gem 'onfido', '~> 0.10.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.
@@ -82,10 +82,12 @@ to `#create`.
 #### Live Photos
 
 Live Photos, like documents, can provide supporting evidence for Onfido checks.
-They can only be created - the Onfido does not support finding or listing them.
 
 ```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.all(applicant_id) # => Returns all applicant's live photos
 ```
 
 **Note:** The file parameter must be a `File`-like object which responds to `#read` and `#path`.

data/lib/onfido/resources/live_photo.rb

@@ -11,5 +11,20 @@ module Onfido
         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}"))
+    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}"))
+    end
+
+    def all(applicant_id)
+      query_string = "applicant_id=#{applicant_id}"
+      get(url: url_for("live_photos?#{query_string}"))
+    end
   end
 end

data/lib/onfido/version.rb

@@ -1,3 +1,3 @@
 module Onfido
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/spec/integrations/live_photo_spec.rb

@@ -29,4 +29,33 @@ describe Onfido::LivePhoto do
       end
     end
   end
+
+  describe '#find' do
+    let(:applicant_id) { '1030303-123123-123123' }
+    let(:live_photo_id) { '3538c8f6-fdce-4745-9d34-fc246bc05aa1' }
+
+    it 'returns the expected live photo' do
+      response = live_photo.find(applicant_id, live_photo_id)
+      expect(response['id']).to eq(live_photo_id)
+    end
+  end
+
+  describe '#all' do
+    let(:applicant_id) { '1030303-123123-123123' }
+
+    it 'returns list of documents' do
+      response = live_photo.all(applicant_id)
+      expect(response['live_photos']).not_to be_empty
+    end
+  end
+
+  describe '#download' do
+    let(:applicant_id) { '1030303-123123-123123' }
+    let(:live_photo_id) { '3538c8f6-fdce-4745-9d34-fc246bc05aa1' }
+
+    it 'returns the file data' do
+      response = live_photo.download(applicant_id, live_photo_id)
+      expect(response).not_to be_nil
+    end
+  end
 end

data/spec/support/fake_onfido_api.rb

@@ -48,6 +48,32 @@ class FakeOnfidoAPI < Sinatra::Base
     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
+  end
+
+  get '/v2/live_photos' do
+    if params["applicant_id"] != "1030303-123123-123123"
+      status 404
+    else
+      json_response(200, 'live_photos.json')
+    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
+  end
+
   post '/v2/applicants/:id/checks' do
     json_response(201, 'check.json')
   end

data/spec/support/fixtures/live_photo.json

@@ -1,4 +1,9 @@
 {
-  "id": "7410A943-8F00-43D8-98DE-36A774196D86",
-  "created_at": "2014-05-23 13:50:33Z"
+  "id": "3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+  "created_at": "2014-05-23 13:50:33Z",
+  "file_name": "onfido_captured_image.jpg",
+  "file_type": "image/jpeg",
+  "file_size": 47544,
+  "href": "/v2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+  "download_href": "/v2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
 }

data/spec/support/fixtures/live_photos.json

@@ -0,0 +1,22 @@
+{
+  "live_photos": [
+    {
+      "id": "3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+      "created_at": "2014-05-23 13:50:33Z",
+      "file_name": "onfido_captured_image.jpg",
+      "file_type": "image/jpeg",
+      "file_size": 47544,
+      "href": "/v2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1",
+      "download_href": "/v2/live_photos/3538c8f6-fdce-4745-9d34-fc246bc05aa1/download"
+    },
+    {
+        "id": "5134c12a-555a-1234-5e12-9d34fcbc11ba",
+        "created_at": "2014-05-23 13:50:33Z",
+        "file_name": "onfido_captured_image.jpg",
+        "file_type": "image/jpeg",
+        "file_size": 47544,
+        "href": "/v2/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba",
+        "download_href": "/v2/live_photos/5134c12a-555a-1234-5e12-9d34fcbc11ba/download"
+      }
+  ]
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Pericles Theodorou
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,6 +204,7 @@ files:
 - spec/support/fixtures/document.json
 - spec/support/fixtures/documents.json
 - spec/support/fixtures/live_photo.json
+- spec/support/fixtures/live_photos.json
 - spec/support/fixtures/report.json
 - spec/support/fixtures/report_type_group.json
 - spec/support/fixtures/report_type_groups.json
@@ -265,6 +266,7 @@ test_files:
 - spec/support/fixtures/document.json
 - spec/support/fixtures/documents.json
 - spec/support/fixtures/live_photo.json
+- spec/support/fixtures/live_photos.json
 - spec/support/fixtures/report.json
 - spec/support/fixtures/report_type_group.json
 - spec/support/fixtures/report_type_groups.json