trusona 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86dadc0e339a0f3fab0224c8dcb277b751c7d9a27c08b3aca8cc476609056b3c
-  data.tar.gz: cfaf39cfbf6fa7cdde0ccf606bbeb0290d5494257abe38395123a5b0ba213904
+  metadata.gz: bdcf928f661f66469a27da5a6515b3b1ec68b3ce245faaa76158c061f17c1fe7
+  data.tar.gz: dc9389c4b77105a019ee0d0ffb6ca2de767f8eebca50b4fb75201424613b15ba
 SHA512:
-  metadata.gz: 2fa476090b8cf3241d6967aa0eab6db67d4d5e5d12231718619880896dab55362dbf31b74546e8c2b41bf51a06033e0da9852050dfef9896152bf60d5c2cab2b
-  data.tar.gz: d7ed5c8dcb5c67919b5b1565271fe13fdf5c9851e1964fee2bc4b1a1ee5a3480e1563144c6235f2cf84bf32a8994b1c65df6c86805e653870658d6ed6aa00848
+  metadata.gz: 5e44c1b04895ecf2b2678276b39b1eeeab62694354f649f688c4977563fc1da549fcb547606a0d9edda41a38d1d6133c0780f801ebf45b1f16aed4501c71e0cb
+  data.tar.gz: 04184f98a61b4fed7906ea170eed8e8dfb2a603ca9fab25bf99794274dc9aad6723995763b74166012616f9105cd443160c342d15d00e651d008d7343904c281

data/README.md

@@ -87,11 +87,9 @@ The binding requires two values, the user identifier that helps you identify the
   Trusona::DeviceUserBinding.activate(id: binding.id)
 ```
 
-### Trusonafications
+### Creating Trusonafications
 
-#### Creating a Trusonafication
-
-A simple Essential level Trusonafication
+#### Creating an Essential Trusonafication
 
 ```ruby
   Trusona::EssentialTrusonafication.create(params: {
@@ -101,29 +99,46 @@ A simple Essential level Trusonafication
    })
 ```
 
-An Executive level Trusonafication
+By default, Essential Trusonafications are built such that the user's presence is required and a prompt asking the user to "Accept" or "Reject" the Trusonafication is presented by the Trusona Mobile SDK. A user's presence is determined by their ability to interact with the device's OS Security, usually by using a biometric or entering the device passcode.
+
+#### Creating an Essential Trusonafication, without user presence or a prompt
 
 ```ruby
-  Trusona::ExecutiveTrusonafication.create(params: {
+  Trusona::EssentialTrusonafication.create(params: {
     action: 'login',
     resource: 'Acme Bank',
-    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI',
+    user_presence: false,
+    prompt: false
    })
 ```
 
-A more complex example, toggling optional fields
+In the above example, the addition of `user_presence: false` and `prompt: false` will result in a Trusonafication that can be accepted solely with possession of the device.
 
+#### Creating an Essential Trusonafication, with the user's email address
 ```ruby
   Trusona::EssentialTrusonafication.create(params: {
     action: 'login',
     resource: 'Acme Bank',
-    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI',
-    user_presence: false,
-    prompt: false
+    email: 'user@domain.com'
    })
 ```
+In some cases you may be able to send a Trusonafication to a user
+by specifying their email address. This is the case if one of the following is true:
+- You have verified ownership of a domain through the Trusona Developer's site
+- You have an agreement with Trusona allowing you to send Trusonafications to any email address.
+Creating a Trusonafication with an email address is similar to the other
+use cases, except you use the `email` parameter rather than `user_identifier` or `device_identifier`.
 
+#### An Executive level Trusonafication
 
+```ruby
+  Trusona::ExecutiveTrusonafication.create(params: {
+    action: 'login',
+    resource: 'Acme Bank',
+    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+   })
+```
 
 #### Trusonafication Options
 

data/lib/trusona/device_user_binding.rb

@@ -30,10 +30,10 @@ module Trusona
     #     device: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
     #   )
     #
-
     def self.create(user: nil, device: nil)
       raise ArgumentError, 'User is missing' if user.nil? || user.empty?
       raise ArgumentError, 'Device is missing' if device.nil? || device.empty?
+
       Trusona::Workers::DeviceUserBindingCreator.new.create(
         user: user, device: device
       )
@@ -50,6 +50,7 @@ module Trusona
 
     def self.activate(id: nil)
       raise ArgumentError if id.nil? || id.empty?
+
       Trusona::Workers::DeviceUserBindingActivator.new.activate(id: id)
     end
   end

data/lib/trusona/errors.rb

@@ -39,6 +39,10 @@ module Trusona
   # An error resulting from 400 errors from the Trusona REST API
   class BadRequestError < RequestError; end
 
+  ##
+  # An error resulting from 422 errors from the Trusona REST API
+  class UnprocessableEntityError < RequestError; end
+
   ##
   # An error resulting from 424 errors from the Trusona REST API
   class FailedDependencyError < RequestError; end

data/lib/trusona/identity_document.rb

@@ -30,6 +30,7 @@ module Trusona
     def self.all(user_identifier: nil)
       # rubocop:disable Metrics/LineLength
       raise ArgumentError, 'A user identifier is required.' unless user_identifier
+
       # rubocop:enable Metrics/LineLength
 
       Trusona::Workers::IdentityDocumentFinder.new.find_all(user_identifier)
@@ -56,6 +57,7 @@ module Trusona
     def self.find(id: nil)
       # rubocop:disable Metrics/LineLength
       raise ArgumentError, 'An Identity Document identifier is required.' unless id
+
       # rubocop:enable Metrics/LineLength
 
       Trusona::Workers::IdentityDocumentFinder.new.find(id)

data/lib/trusona/resources/trusonafication.rb

@@ -9,7 +9,7 @@ module Trusona
       include Trusona::Helpers::TimeNormalizer
 
       attr_accessor :device_identifier, :user_identifier, :trucode_id,
-                    :resource, :action, :level, :id,
+                    :resource, :action, :level, :id, :email,
                     :accepted_level, :trusona_id, :expires_at,
                     :user_presence, :callback_url, :prompt
 
@@ -23,6 +23,7 @@ module Trusona
         self.device_identifier = @params[:device_identifier]
         self.user_identifier   = @params[:user_identifier]
         self.trucode_id        = @params[:trucode_id]
+        self.email             = @params[:email]
         self.expires_at        = normalize_time(@params[:expires_at])
         self.id                = @params[:id]
         self.level             = @params[:level]
@@ -47,6 +48,7 @@ module Trusona
              user_identifier: user_identifier,
              trucode_id: trucode_id,
              trusona_id: trusona_id,
+             email: email,
              resource: resource,
              action: action,
              desired_level: level,
@@ -130,7 +132,7 @@ module Trusona
       end
 
       def identifier
-        device_identifier || user_identifier || trucode_id || trusona_id
+        device_identifier || user_identifier || trucode_id || trusona_id || email
       end
     end
   end

data/lib/trusona/services/base_service.rb

@@ -67,6 +67,8 @@ module Trusona
           not_found
         when 403
           unauthorized
+        when 422
+          unprocessable_entity
         when 424
           failed_dependency
         when 500..599
@@ -87,6 +89,10 @@ module Trusona
         raise Trusona::BadRequestError, readable_error
       end
 
+      def unprocessable_entity
+        raise Trusona::UnprocessableEntityError, readable_error
+      end
+
       def failed_dependency
         raise Trusona::FailedDependencyError, readable_error
       end

data/lib/trusona/trusonafication.rb

@@ -42,6 +42,9 @@ module Trusona
     # @option params [String] :user_identifier The user identifier,
     #  previously registered with Trusona, of the user to which this
     #  Trusonafication will be sent.
+    # @option params [String] :email The user email address,
+    #  previously registered with Trusona, of the user to which this
+    #  Trusonafication will be sent.
     # @option params [String] :trucode_id The TruCode ID that has either been
     #  scanned or will be scanned using the mobile SDK that will be used to
     #  determine which device to send the Trusonafication to.
@@ -86,7 +89,8 @@ module Trusona
       normalized_params[:user_identifier] ||
         normalized_params[:device_identifier] ||
         normalized_params[:trucode_id] ||
-        normalized_params[:trusona_id]
+        normalized_params[:trusona_id] ||
+        normalized_params[:email]
     end
   end
 

data/lib/trusona/version.rb

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

data/lib/trusona/workers/trusonafication_creator.rb

@@ -43,4 +43,4 @@ module Trusona
       # rubocop:enable Metrics/MethodLength
     end
   end
-end
+end

data/lib/trusona/workers/trusonafication_finder.rb

@@ -24,4 +24,4 @@ module Trusona
       end
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trusona
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Trusona
@@ -35,7 +35,7 @@ cert_chain:
   vbhUT8kOS+bZTalorEol37DD/P4Bbv0fMpw+ozetR2RmwhwTKPKJ5r0oQP6tiqHn
   hQ==
   -----END CERTIFICATE-----
-date: 2018-08-02 00:00:00.000000000 Z
+date: 2018-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty