trusona 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60739d2fd6bfd4db4b0e43b06aa314a857e46660
-  data.tar.gz: 49b452b94a0dcff871d2c6d8d3e8a18feb48177e
+  metadata.gz: 8493dc6973da717a55a1dd6d7bc9e27cbfbbeb79
+  data.tar.gz: f5499e8a6a766f4357268506e6a4c414b7c9b04f
 SHA512:
-  metadata.gz: 5fa55cbf9abe02741f48f82516371c1406e494189f6365521ab3aa0b4e99274e5e0907983cdfe0efdd908d7f9ca15261c39bb56a8091b35c9791814a8406b7ed
-  data.tar.gz: 4d0eb3dc425a90ca2eb367bc3bcabc6651749ca2fe01115efa853afb6f63b9681c12618f1d28922f696cf44072db429d03424dc00f1161b5c7b735dc95d8a64d
+  metadata.gz: 9762a0980e163dc0bddf95b4a77ca3670eb8a9e4b7b6d9a73223e34c85740e967394bc5754fdf7988381a4d5b3c9ed762128c495502337a6363a1ff5782c4f97
+  data.tar.gz: 4bbfca2beab08cb3dcdb4cfbea42cce6c9d33fda916b7baf03750baf9434f61cd3f6bb424b56a928a03ffe2978ff96b9bf4b03375c7d067b091a08cb3d9fa53b

data/README.md

@@ -171,8 +171,9 @@ Note that the custom fields are not used in the case that the Trusonafication is
 | Prompt            | `prompt`            |    N     | Should the user be prompted to Accept or Reject this Trusonafication? Defaults to `true`.                                         |
 | Expiration        | `expires_at`        |    N     | The ISO-8601 UTC timestamp of the Trusonafication's expiration. Defaults to 90 seconds from creation.                             |
 | Custom Fields     | `custom_fields`     |    N     | Arbitrary key-value data fields made available to the Trusonafication. Amount of data in the hash is limited to 1MB               |
+| Callback URL      | `callback_url`      |    N     | An HTTPS URL to call when the trusonafication has been completed (accepted, rejected, or expired).<br>The request will be a POST and the body will be the same JSON format as sending a GET request to /api/v2/trusonafications/{id}.<br><br> **NOTE:** The URL should include a randomized segment so it cannot be guessed and abused by third-parties (i.e https://your.domain.com/completed_authentications/f8abe61d-4e51-493f-97b1-464c157624f2). |
 
-[^1]: You must provide at least one field that would allow Trusona to determine which user to authenticate. The identifier fields are `device_identifier`, `user_identifier`, and `trucode_id`.
+[^1]: You must provide at least one field that would allow Trusona to determine which user to authenticate. The identifier fields are `device_identifier`, `user_identifier`, `email`, and `trucode_id`.
 
 #### Retrieving an existing Trusonafication
 
@@ -255,7 +256,7 @@ end
 
 ### TruCodes
 
-After a user has scanned a TruCode, it's possible to acquire that user's information by getting the 
+After a user has scanned a TruCode, it's possible to acquire that user's information by getting the
 scanned TruCode from the server. The code sample below shows how to do that:
 
 ```ruby

data/integrations/buster.rb

@@ -0,0 +1,15 @@
+require 'httparty'
+
+class Buster
+  def initialize
+    @url = 'https://buster.staging.trusona.net'
+  end
+
+  def callback_url(id)
+    "#{@url}/callbacks/#{id}"
+  end
+
+  def callback_result(id)
+    HTTParty.get(callback_url(id))
+  end
+end

data/integrations/spec_helper.rb

@@ -7,9 +7,12 @@ SimpleCov.start do
 end
 
 require 'bundler/setup'
+require 'active_support/core_ext/numeric/time'
+require 'rspec/wait'
 require 'trusona'
 require 'securerandom'
 require 'webmock/rspec'
+require_relative 'buster'
 
 WebMock.allow_net_connect!
 

data/integrations/trusonafication_spec.rb

@@ -12,6 +12,8 @@ RSpec.describe 'Trusonafications' do
     }
 
     @timeout = 5
+
+    @buster = Buster.new
   end
   describe 'creating a trusonafication for a known trusona user' do
     before do
@@ -40,10 +42,8 @@ RSpec.describe 'Trusonafications' do
       end
     end
   end
-  describe 'creating a trusonafication for an unknown trusona user' do
+  describe 'creating a trusonafication without a level' do
     it 'as expected, does not work' do
-      @parameters[:email] = "#{Time.now.to_i}@example.com"
-
       expect {
         Trusona::Trusonafication.create(
           params: @parameters, timeout: @timeout
@@ -51,5 +51,20 @@ RSpec.describe 'Trusonafications' do
       }.to raise_error(Trusona::InvalidResourceError)
     end
   end
+  describe 'creating a trusonafication with a callback url' do
+    it 'should POST to the URL when the trusonafication is completed' do
+      callback_id = SecureRandom.uuid
+
+      @parameters[:callback_url] = @buster.callback_url(callback_id)
+      @parameters[:expires_at] = 1.second.from_now
+
+      Trusona::EssentialTrusonafication.create(params: @parameters, timeout: @timeout)
+
+      wait_for do
+        callback_result = @buster.callback_result(callback_id)
+        callback_result.code
+      end.to eq(200)
+    end
+  end
 end
 # rubocop:enable Metrics/BlockLength

data/lib/trusona/resources/trusonafication.rb

@@ -11,7 +11,7 @@ module Trusona
       attr_accessor :device_identifier, :user_identifier, :trucode_id,
                     :resource, :action, :level, :id, :email,
                     :accepted_level, :trusona_id, :expires_at,
-                    :user_presence, :prompt, :custom_fields
+                    :user_presence, :prompt, :custom_fields, :callback_url
 
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/MethodLength
@@ -32,6 +32,7 @@ module Trusona
         self.prompt            = defaulting_to(true, @params[:prompt])
         self.user_presence     = defaulting_to(true, @params[:user_presence])
         self.custom_fields     = @params[:custom_fields]
+        self.callback_url      = @params[:callback_url]
 
         @status = @params[:status]
       end
@@ -44,20 +45,23 @@ module Trusona
 
       # rubocop:disable Metrics/MethodLength
       def to_json
-        JSON(device_identifier: device_identifier,
-             user_identifier: user_identifier,
-             trucode_id: trucode_id,
-             trusona_id: trusona_id,
-             email: email,
-             resource: resource,
-             action: action,
-             desired_level: level,
-             id: id,
-             status: @status,
-             prompt: prompt,
-             user_presence: user_presence,
-             custom_fields: custom_fields,
-             expires_at: expires_at&.iso8601)
+        JSON(
+          device_identifier: device_identifier,
+          user_identifier: user_identifier,
+          trucode_id: trucode_id,
+          trusona_id: trusona_id,
+          email: email,
+          resource: resource,
+          action: action,
+          desired_level: level,
+          id: id,
+          status: @status,
+          prompt: prompt,
+          user_presence: user_presence,
+          custom_fields: custom_fields,
+          expires_at: expires_at&.iso8601,
+          callback_url: callback_url
+        )
       end
       # rubocop:enable Metrics/MethodLength
 

data/lib/trusona/trusonafication.rb

@@ -55,12 +55,20 @@ module Trusona
     #  Accept or Reject this Trusonafication?
     # @option params [String] :expires_at ('90 seconds') The ISO-8601 UTC
     #  timestamp of the Trusonafication's expiration.
-    # @param timeout [Int] (30) The max amount of time, in seconds, to wait
-    #  for a response from the Trusona API when polling for a Trusonafication
-    #  result
     # @option params [Hash] :custom_fields Optional data to be associated with
     #  this Trusonafication and can be used to constomize any UX elements. Total
     #  size of data is limited to 1MB.
+    # @option params [String] :callback_url An HTTPS URL to call when the
+    #  trusonafication has been completed (accepted, rejected, or expired). The
+    #  request will be a POST and the body will be the same JSON format as
+    #  sending a GET request to /api/v2/trusonafications/{id}.
+    #
+    #  NOTE: The URL should include a randomized segment so it cannot be guessed
+    #  and abused by third-parties (i.e
+    #  https://your.domain.com/completed_authentications/f8abe61d-4e51-493f-97b1-464c157624f2).
+    # @param timeout [Int] (30) The max amount of time, in seconds, to wait
+    #  for a response from the Trusona API when polling for a Trusonafication
+    #  result
     # @yield [Trusona::Resources::Trusonafication] Yields the completed
     #  Trusonafication to the block
     # @raise [Trusona::InvalidResourceError] if the resource is not +valid?+

data/lib/trusona/version.rb

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

data/trusona.gemspec

@@ -28,8 +28,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata['yard.run'] = 'yri' # use "yard" to build full HTML docs.
 
+  spec.add_development_dependency 'activesupport', '~> 5.2'
   spec.add_development_dependency 'bump', '~> 0.5'
-  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'dotenv', '~> 2.2'
   spec.add_development_dependency 'guard', '~> 2.14'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
@@ -37,8 +37,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard-yard', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-wait', '~> 0.0'
   spec.add_development_dependency 'rubocop', '~> 0.49'
   spec.add_development_dependency 'simplecov', '~> 0.14'
   spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'webmock', '~> 3.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trusona
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Trusona
@@ -60,33 +60,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -185,6 +185,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-wait
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -231,16 +245,16 @@ dependencies:
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.5'
 description: Easily interact with the Trusona REST API
 email:
 - engineering@trusona.com
@@ -263,6 +277,7 @@ files:
 - bin/setup
 - certs/trusona.pem
 - checksum/trusona-0.16.0.gem.sha512
+- integrations/buster.rb
 - integrations/device_user_binding_integration_spec.rb
 - integrations/identity_documents_spec.rb
 - integrations/paired_tru_code_spec.rb