onfido 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c94c63515711a15cc138b42a1121f9e1e5d023a1bc40419502c8aa11cd8f3a23
-  data.tar.gz: 6868c52e39f8cc35ec28acd396cb0cc94f63093fe6a1c773891cf8d6170dd8fd
+  metadata.gz: 74a5e178fa210205846555dbb0f870b21830bae9a44bbf36bd2f095f4c12bc7e
+  data.tar.gz: 605d4d740f4a73db842ca05592d34d1170e565ccbc5ee2c580a1f131968673fa
 SHA512:
-  metadata.gz: a21c2254adb0f552b319a26dc4916415c8c4a74e5681c51ee95084aa01e77b3ec72816b47f9d8bfbf0f89b24c5f2f4796fc6e38f45cce184b9ad035ff6c42339
-  data.tar.gz: bf96b5f01ff6acf63b2e7534a0047759415c7a2c08d45f43c95b525efbded114ceb88c97171c385a7073a87483aed74801b7db9f6f849a27a7fe6330bb704b90
+  metadata.gz: e31930f8a4e9a856e72753420801ada047f159ae6444648440cde21008270f068ccce793974c5361cd26f538ec51b52ceb2a76ea63af2249629e8d27c056ca8f
+  data.tar.gz: 03dd7a20bb4d1e6fcad6b1f9a3a79c1238bc2e966395f35bb4509ce5987f10eb1d602a2327f19a15bad558be1491d9f3f2137022785909352a5c028f8c9f6e99

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v2.6.0, 22 November 2022
+
+- Added support for [Monitors](https://documentation.onfido.com/#monitors)
+
+## v2.5.0, 22 October 2022
+
+- Added Motion capture support
+
 ## v2.4.0, 05 October 2022
 
 - Updated to use API v3.5, for more details please see our [release notes](https://developers.onfido.com/release-notes#api-v35). 

data/lib/onfido/api.rb

@@ -26,6 +26,14 @@ module Onfido
       @live_video ||= Onfido::LiveVideo.new(options)
     end
 
+    def monitor
+      @monitor ||= Onfido::Monitor.new(options)
+    end
+
+    def motion_capture
+      @motion_capture ||= Onfido::MotionCapture.new(options)
+    end
+
     def report
       @report ||= Onfido::Report.new(options)
     end

data/lib/onfido/resources/monitor.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Onfido
+  class Monitor < Resource
+    def create(applicant_id:, report_name:, **payload)
+      payload[:applicant_id] = applicant_id
+      payload[:report_name] = report_name
+
+      post(path: 'watchlist_monitors', payload: payload)
+    end
+
+    def find(monitor_id)
+      get(path: "watchlist_monitors/#{monitor_id}")
+    end
+
+    def all(applicant_id)
+      get(path: "watchlist_monitors?applicant_id=#{applicant_id}")
+    end
+
+    def destroy(monitor_id)
+      delete(path: "watchlist_monitors/#{monitor_id}")
+    end
+  end
+end

data/lib/onfido/resources/motion_capture.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Onfido
+  class MotionCapture < Resource
+    def find(motion_capture_id)
+      get(path: "motion_captures/#{motion_capture_id}")
+    end
+
+    def download(motion_capture_id)
+      get(path: "motion_captures/#{motion_capture_id}/download")
+    end
+
+    def frame(motion_capture_id)
+      get(path: "motion_captures/#{motion_capture_id}/frame")
+    end
+
+    def all(applicant_id)
+      get(path: "motion_captures?applicant_id=#{applicant_id}")
+    end
+  end
+end

data/lib/onfido/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Onfido
-  VERSION = '2.4.0'
+  VERSION = '2.6.0'
 end

data/lib/onfido.rb

@@ -20,6 +20,8 @@ require 'onfido/resources/document'
 require 'onfido/resources/extraction'
 require 'onfido/resources/live_photo'
 require 'onfido/resources/live_video'
+require 'onfido/resources/monitor'
+require 'onfido/resources/motion_capture'
 require 'onfido/resources/report'
 require 'onfido/resources/sdk_token'
 require 'onfido/resources/webhook'

data/spec/integrations/monitor_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+describe Onfido::Monitor do
+  include_context 'fake onfido api'
+
+  subject(:monitor) { onfido.monitor }
+
+  let(:monitor_id) { '2748c4fc-c6b8-4c1e-a383-21efa241ce1e' }
+
+  describe '#create' do
+    let(:applicant_id) { '61f659cb-c90b-4067-808a-6136b5c01351' }
+    let(:report_name) { 'watchlist_standard' }
+
+    it 'creates a monitor for the applicant' do
+      response = monitor.create(applicant_id: applicant_id, report_name: report_name)
+      expect(response).to be_a(Hash).and include('id' => monitor_id, 'report_name' => report_name)
+    end
+  end
+
+  describe '#find' do
+    it 'returns the expected monitor' do
+      response = monitor.find(monitor_id)
+
+      expect(response).to be_a(Hash).and include('id' => monitor_id)
+    end
+  end
+
+  describe '#all' do
+    it 'returns a list of monitors' do
+      applicant_id = '1030303-123123-123123'
+      response = monitor.all(applicant_id)
+
+      expect(response['monitors']).to be_an(Array).and contain_exactly(an_instance_of(Hash))
+    end
+  end
+
+  it 'returns success code' do
+    expect { monitor.destroy(monitor_id) }.not_to raise_error
+  end
+end

data/spec/integrations/motion_capture_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+describe Onfido::MotionCapture do
+  include_context 'fake onfido api'
+
+  subject(:motion_capture) { onfido.motion_capture }
+
+  let(:motion_capture_id) { 'b1ae05b7-fb12-47c3-971c-311b56fc8de6' }
+
+  describe '#find' do
+    it 'returns the expected motion capture' do
+      response = motion_capture.find(motion_capture_id)
+
+      expect(response['id']).to eq(motion_capture_id)
+    end
+  end
+
+  describe '#all' do
+    it 'returns list of motion captures' do
+      applicant_id = '1030303-123123-123123'
+      response = motion_capture.all(applicant_id)
+
+      expect(response['motion_captures']).not_to be_empty
+    end
+  end
+
+  describe '#download' do
+    it 'returns the file data' do
+      response = motion_capture.download(motion_capture_id)
+
+      expect(response).not_to be_nil
+    end
+  end
+
+  describe '#frame' do
+    it 'returns the frame data' do
+      response = motion_capture.frame(motion_capture_id)
+
+      expect(response).not_to be_nil
+    end
+  end
+end

data/spec/support/fake_onfido_api.rb

@@ -114,6 +114,50 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     "\x01\x02\x03" # acts as binary file data
   end
 
+  post '/v3.5/watchlist_monitors' do
+    json_response(201, 'monitor.json')
+  end
+
+  get '/v3.5/watchlist_monitors/:id' do
+    json_response(200, 'monitor.json')
+  end
+
+  get '/v3.5/watchlist_monitors' do
+    if params['applicant_id'] == '1030303-123123-123123'
+      json_response(200, 'monitors.json')
+    else
+      status 404
+    end
+  end
+
+  delete '/v3.5/watchlist_monitors/:id' do
+    status 204
+  end
+
+  get '/v3.5/motion_captures/:id' do
+    json_response(200, 'motion_capture.json')
+  end
+
+  get '/v3.5/motion_captures' do
+    if params['applicant_id'] == '1030303-123123-123123'
+      json_response(200, 'motion_captures.json')
+    else
+      status 404
+    end
+  end
+
+  get '/v3.5/motion_captures/:id/download' do
+    status 200
+    content_type 'video/mp4'
+    "\x01\x02\x03" # acts as binary file data
+  end
+
+  get '/v3.5/motion_captures/:id/frame' do
+    status 200
+    content_type 'image/jpeg'
+    "\x01\x02\x03" # acts as binary file data
+  end
+
   post '/v3.5/checks' do
     params['applicant_id'].nil? ? status(422) : json_response(201, 'check.json')
   end

data/spec/support/fixtures/monitor.json

@@ -0,0 +1,8 @@
+{
+  "id": "2748c4fc-c6b8-4c1e-a383-21efa241ce1e",
+  "report_name": "watchlist_standard",
+  "created_at": "2022-09-01T15:01:36.921Z",
+  "deleted_at": null,
+  "sandbox": false,
+  "tags": []
+}

data/spec/support/fixtures/monitors.json

@@ -0,0 +1,12 @@
+{
+  "monitors": [
+    {
+      "id": "2748c4fc-c6b8-4c1e-a383-21efa241ce1e",
+      "report_name": "watchlist_standard",
+      "created_at": "2022-09-01T15:01:36.921Z",
+      "deleted_at": null,
+      "sandbox": false,
+      "tags": []
+    }
+  ]
+}

data/spec/support/fixtures/motion_capture.json

@@ -0,0 +1,9 @@
+{
+  "id" : "b1ae05b7-fb12-47c3-971c-311b56fc8de6",
+  "created_at" : "2022-11-22T10:22:45Z",
+  "file_name" : "motion_capture.mp4",
+  "file_type" : "video/mp4",
+  "file_size" : 2437112,
+  "href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
+  "download_href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
+}

data/spec/support/fixtures/motion_captures.json

@@ -0,0 +1,13 @@
+{
+  "motion_captures": [
+    {
+      "id" : "b1ae05b7-fb12-47c3-971c-311b56fc8de6",
+      "created_at" : "2022-11-22T10:22:45Z",
+      "file_name" : "motion_capture.mp4",
+      "file_type" : "video/mp4",
+      "file_size" : 2437112,
+      "href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6",
+      "download_href" : "/v3.5/motion_captures/b1ae05b7-fb12-47c3-971c-311b56fc8de6/download"
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Onfido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-11 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -141,6 +141,8 @@ files:
 - lib/onfido/resources/extraction.rb
 - lib/onfido/resources/live_photo.rb
 - lib/onfido/resources/live_video.rb
+- lib/onfido/resources/monitor.rb
+- lib/onfido/resources/motion_capture.rb
 - lib/onfido/resources/report.rb
 - lib/onfido/resources/sdk_token.rb
 - lib/onfido/resources/webhook.rb
@@ -153,6 +155,8 @@ files:
 - spec/integrations/extraction_spec.rb
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/live_video_spec.rb
+- spec/integrations/monitor_spec.rb
+- spec/integrations/motion_capture_spec.rb
 - spec/integrations/report_spec.rb
 - spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
@@ -176,6 +180,10 @@ files:
 - spec/support/fixtures/live_photos.json
 - spec/support/fixtures/live_video.json
 - spec/support/fixtures/live_videos.json
+- spec/support/fixtures/monitor.json
+- spec/support/fixtures/monitors.json
+- spec/support/fixtures/motion_capture.json
+- spec/support/fixtures/motion_captures.json
 - spec/support/fixtures/not_scheduled_for_deletion_error.json
 - spec/support/fixtures/report.json
 - spec/support/fixtures/reports.json
@@ -214,6 +222,8 @@ test_files:
 - spec/integrations/extraction_spec.rb
 - spec/integrations/live_photo_spec.rb
 - spec/integrations/live_video_spec.rb
+- spec/integrations/monitor_spec.rb
+- spec/integrations/motion_capture_spec.rb
 - spec/integrations/report_spec.rb
 - spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
@@ -237,6 +247,10 @@ test_files:
 - spec/support/fixtures/live_photos.json
 - spec/support/fixtures/live_video.json
 - spec/support/fixtures/live_videos.json
+- spec/support/fixtures/monitor.json
+- spec/support/fixtures/monitors.json
+- spec/support/fixtures/motion_capture.json
+- spec/support/fixtures/motion_captures.json
 - spec/support/fixtures/not_scheduled_for_deletion_error.json
 - spec/support/fixtures/report.json
 - spec/support/fixtures/reports.json