onfido 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74a5e178fa210205846555dbb0f870b21830bae9a44bbf36bd2f095f4c12bc7e
-  data.tar.gz: 605d4d740f4a73db842ca05592d34d1170e565ccbc5ee2c580a1f131968673fa
+  metadata.gz: e2e3f3ecb736185d8fb0227413d125caacad919d755a3a61d855783d525082f3
+  data.tar.gz: f553f828aaf8273067417fb62a62d34a4727f0632f677d1751da34fa611288ca
 SHA512:
-  metadata.gz: e31930f8a4e9a856e72753420801ada047f159ae6444648440cde21008270f068ccce793974c5361cd26f538ec51b52ceb2a76ea63af2249629e8d27c056ca8f
-  data.tar.gz: 03dd7a20bb4d1e6fcad6b1f9a3a79c1238bc2e966395f35bb4509ce5987f10eb1d602a2327f19a15bad558be1491d9f3f2137022785909352a5c028f8c9f6e99
+  metadata.gz: 11cc9bf7b6f06b93d5cf7b68c3d6982359f762b88d9d59d9069d52b02ba7498511de545a11ad78cea358f7d9fd724fc2dc554f044f0ff206a7dd91502922b821
+  data.tar.gz: 19bf65314bc21d5d989eeb1102ae32de7e930a3cb665aca5b849c5405b611061fd67adb7eaab1ad899904626ccfbf08c39ef4495e0f9a8d6f315cf3366af8ea8

data/.github/workflows/gem-push.yml

@@ -15,9 +15,9 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+      uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 2.6
 
     - name: Publish to RubyGems
       run: |

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v2.7.0, 22 November 2022
+
+- Added support for [Workflow Runs](https://documentation.onfido.com/#workflow-runs)
+
 ## v2.6.0, 22 November 2022
 
 - Added support for [Monitors](https://documentation.onfido.com/#monitors)

data/lib/onfido/api.rb

@@ -54,6 +54,10 @@ module Onfido
       @extraction ||= Onfido::Extraction.new(options)
     end
 
+    def workflow_run
+      @workflow_run ||= Onfido::WorkflowRun.new(options)
+    end
+
     private
 
     attr_reader :options

data/lib/onfido/resource.rb

@@ -141,5 +141,9 @@ module Onfido
       raise ArgumentError, 'File must be a `File`-like object which responds to ' \
                            '`#read` and `#path`'
     end
+
+    def stringify_query_params(hashed_params)
+      URI.encode_www_form_component(hashed_params.map{ |k,v| "#{k}=#{v}" }.join("&"))
+    end
   end
 end

data/lib/onfido/resources/workflow_run.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Onfido
+  class WorkflowRun < Resource
+    def create(payload)
+      post(path: 'workflow_runs', payload: payload)
+    end
+
+    def find(workflow_run_id)
+      get(path: "workflow_runs/#{workflow_run_id}")
+    end
+
+    def all(query_params = {})
+      get(path: "workflow_runs?#{stringify_query_params(query_params)}")
+    end
+  end
+end

data/lib/onfido/version.rb

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

data/lib/onfido.rb

@@ -25,6 +25,7 @@ require 'onfido/resources/motion_capture'
 require 'onfido/resources/report'
 require 'onfido/resources/sdk_token'
 require 'onfido/resources/webhook'
+require 'onfido/resources/workflow_run'
 
 module Onfido
 end

data/spec/integrations/workflow_run_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+describe Onfido::WorkflowRun do
+  include_context 'fake onfido api'
+
+  subject(:workflow_run) { onfido.workflow_run }
+
+  let(:workflow_run_id) { 'fcb73186-0733-4f6f-9c57-d9d5ef979443' }
+  let(:params) do
+    {
+      'a' => 'b'
+    }
+  end
+
+  describe '#create' do
+    it 'serializes the payload correctly' do
+      WebMock.after_request do |request_signature, _response|
+        if request_signature.uri.path == 'v3.5/workflow_run'
+          expect(Rack::Utils.parse_nested_query(request_signature.body))
+            .to eq(params)
+        end
+      end
+    end
+
+    it 'creates a workflow run' do
+      response = workflow_run.create(params)
+      expect(response['id']).not_to be_nil
+    end
+  end
+
+  describe '#find' do
+    it 'returns the workflow run' do
+      response = workflow_run.find(workflow_run_id)
+
+      expect(response['id']).to eq(workflow_run_id)
+    end
+  end
+
+  describe '#all' do
+    it 'returns the workflow runs' do
+      response = workflow_run.all({ page: 1, sort: "asc" })
+
+      expect(response.count).to eq(2)
+    end
+  end
+end

data/spec/support/fake_onfido_api.rb

@@ -216,6 +216,18 @@ class FakeOnfidoAPI < Sinatra::Base # rubocop:disable Metrics/ClassLength
     json_response(200, 'webhooks.json')
   end
 
+  post '/v3.5/workflow_runs' do
+    json_response(201, 'workflow_run.json')
+  end
+
+  get '/v3.5/workflow_runs/:id' do
+    json_response(200, 'workflow_run.json')
+  end
+
+  get '/v3.5/workflow_runs' do
+    json_response(200, 'workflow_runs.json')
+  end
+
   get '/v3.5/4xx_response' do
     json_response(422, '4xx_response.json')
   end

data/spec/support/fixtures/workflow_run.json

@@ -0,0 +1,20 @@
+{
+  "id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "workflow_version_id": 11,
+  "status": "approved",
+  "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+  "output": {"prop1": "val_1", "prop2": 10}, 
+  "reasons": ["reason_1", "reason_2"],
+  "error": null,
+  "created_at": "2022-06-28T15:39:42Z",
+  "updated_at": "2022-07-28T15:40:42Z",
+  "link": {
+      "completed_redirect_url": "https://example.onfido.com",
+      "expired_redirect_url": "https://example.onfido.com",
+      "expires_at": "2022-10-17T14:40:50Z",
+      "language": "en_US",
+      "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
+  }
+}

data/spec/support/fixtures/workflow_runs.json

@@ -0,0 +1,42 @@
+[
+  {
+    "id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_version_id": 11,
+    "status": "approved",
+    "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "output": {"prop1": "val_1", "prop2": 10}, 
+    "reasons": ["reason_1", "reason_2"],
+    "error": null,
+    "created_at": "2022-06-28T15:39:42Z",
+    "updated_at": "2022-07-28T15:40:42Z",
+    "link": {
+        "completed_redirect_url": "https://example.onfido.com",
+        "expired_redirect_url": "https://example.onfido.com",
+        "expires_at": "2022-10-17T14:40:50Z",
+        "language": "en_US",
+        "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
+    }
+  },
+  {
+    "id": "fcb73186-0733-4f6f-9c57-d9d5ef979463",
+    "applicant_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_id": "fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "workflow_version_id": 11,
+    "status": "approved",
+    "dashboard_url":"https://dashboard.onfido.com/results/fcb73186-0733-4f6f-9c57-d9d5ef979443",
+    "output": {"prop1": "val_1", "prop2": 10}, 
+    "reasons": ["reason_1", "reason_2"],
+    "error": null,
+    "created_at": "2022-06-28T15:39:42Z",
+    "updated_at": "2022-07-28T15:40:42Z",
+    "link": {
+        "completed_redirect_url": "https://example.onfido.com",
+        "expired_redirect_url": "https://example.onfido.com",
+        "expires_at": "2022-10-17T14:40:50Z",
+        "language": "en_US",
+        "url": "https://eu.onfido.app/l/fcb73186-0733-4f6f-9c57-d9d5ef979443"
+    }
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: onfido
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Onfido
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-02 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -146,6 +146,7 @@ files:
 - lib/onfido/resources/report.rb
 - lib/onfido/resources/sdk_token.rb
 - lib/onfido/resources/webhook.rb
+- lib/onfido/resources/workflow_run.rb
 - lib/onfido/version.rb
 - onfido.gemspec
 - spec/integrations/address_spec.rb
@@ -161,6 +162,7 @@ files:
 - spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
+- spec/integrations/workflow_run_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
 - spec/onfido/options_spec.rb
@@ -191,6 +193,8 @@ files:
 - spec/support/fixtures/unexpected_error_format.json
 - spec/support/fixtures/webhook.json
 - spec/support/fixtures/webhooks.json
+- spec/support/fixtures/workflow_run.json
+- spec/support/fixtures/workflow_runs.json
 homepage: http://github.com/onfido/onfido-ruby
 licenses:
 - MIT
@@ -228,6 +232,7 @@ test_files:
 - spec/integrations/resource_spec.rb
 - spec/integrations/sdk_token_spec.rb
 - spec/integrations/webhook_spec.rb
+- spec/integrations/workflow_run_spec.rb
 - spec/onfido/api_spec.rb
 - spec/onfido/connection_error_spec.rb
 - spec/onfido/options_spec.rb
@@ -258,3 +263,5 @@ test_files:
 - spec/support/fixtures/unexpected_error_format.json
 - spec/support/fixtures/webhook.json
 - spec/support/fixtures/webhooks.json
+- spec/support/fixtures/workflow_run.json
+- spec/support/fixtures/workflow_runs.json