onfido 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a735bab9e701c74ac67467bc518ddbf0c2cabf9a7dea65744fe497cac937ef6
-  data.tar.gz: b93c799294c06f6dcfc63f0973f896ef7090688219bd09e2bcf257b8a4f6fee1
+  metadata.gz: 74a5e178fa210205846555dbb0f870b21830bae9a44bbf36bd2f095f4c12bc7e
+  data.tar.gz: 605d4d740f4a73db842ca05592d34d1170e565ccbc5ee2c580a1f131968673fa
 SHA512:
-  metadata.gz: b95258294942d7f46c1c6614b3fbb73c27ad3b37d6b4f4fa8360b80b25e3744ab6c4db62892c258bedbcf99a9c699dc2e860b8439af53d28d2fbf2790d611fe1
-  data.tar.gz: 2c52abc70d6022a2a1e10fe02e413920fefea32eb6a6ef7e0b7cd0f5bb618ad5013b7733e722f99800e42b0f0fe40331b43061716fdb3402d5149ffe25faa744
+  metadata.gz: e31930f8a4e9a856e72753420801ada047f159ae6444648440cde21008270f068ccce793974c5361cd26f538ec51b52ceb2a76ea63af2249629e8d27c056ca8f
+  data.tar.gz: 03dd7a20bb4d1e6fcad6b1f9a3a79c1238bc2e966395f35bb4509ce5987f10eb1d602a2327f19a15bad558be1491d9f3f2137022785909352a5c028f8c9f6e99

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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

data/lib/onfido/api.rb

@@ -26,6 +26,10 @@ 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

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/version.rb

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

data/lib/onfido.rb

@@ -20,6 +20,7 @@ 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'

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/support/fake_onfido_api.rb

@@ -114,6 +114,26 @@ 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

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": []
+    }
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Onfido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -141,6 +141,7 @@ 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
@@ -154,6 +155,7 @@ 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
@@ -178,6 +180,8 @@ 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
@@ -218,6 +222,7 @@ 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
@@ -242,6 +247,8 @@ 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