trusona 0.16.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 519e854441d793e9eba067df4b8791dc70da7eaedc7859609233705654f88055
+  data.tar.gz: c6818b8b372c8c57fa4cd500fd28a3bab84ad8d16b01f57737f03be42a87c01a
+SHA512:
+  metadata.gz: 635cde4c085570d92b444ad4c14265fe5ee4d319107927786dd3e76aa52db26b5fed5da016b6d3fc2872a3b6cf1217e2ddab9e4581d6bf6a614b1008b28dbac5
+  data.tar.gz: d04c928ad5a57e644c3a65a5287c30a291ddb94054e96e8b5f1d3437b0c877ffbbd7973dc73692a8d3a02f5dc88aba0e8df8c64bf48d44cda63bae340ff37586

data/.env.example

@@ -0,0 +1,4 @@
+TRUSONA_TOKEN=
+TRUSONA_SECRET=
+TRUSONA_API_HOST=
+TRU_CODES_HOST=

data/.gitignore

@@ -0,0 +1,20 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status
+
+# dotenv
+.env
+.env.test
+
+test.rb
+.vscode

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--fail-fast

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+cache:
+- bundler
+rvm:
+- 2.4.3
+- 2.5.0
+
+before_install:
+- gem install bundler -v 1.15.1
+- curl -O https://s3-us-west-2.amazonaws.com/trusona-ci-config/trusona-gem-private_key.pem.enc
+- openssl aes-256-cbc -K $encrypted_e2185801d912_key -iv $encrypted_e2185801d912_iv -in trusona-gem-private_key.pem.enc -out trusona-gem-private_key.pem -d
+script:
+- bundle exec rspec spec -f p
+- bundle exec rubocop lib/**/*.rb -F
+- gem build trusona.gemspec
+before_deploy:
+- gem install bundler -v 1.15.1
+deploy:
+  skip_cleanup: true
+  provider: script
+  script: "./release-gem"
+  on:
+    tags: true

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trusona.gemspec
+gemspec
+
+gem 'pry'

data/Guardfile

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+# guard :rubocop, all_on_start: false, cli: ['-a'] do
+#   watch(%r{.+\.rb$})
+#   watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+# end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+  watch(%r{lib\/.+\.rb})
+end
+
+guard 'yard' do
+  watch(%r{lib\/.+\.rb})
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,234 @@
+# Trusona Ruby SDK
+
+Easily interact with the Trusona REST API.
+
+## Current Status
+
+[![Build Status](https://travis-ci.com/lighthauz/trusona-server-sdk-ruby.svg?token=2f2CMAnop6pxz1LFFPky&branch=master)](https://travis-ci.com/lighthauz/trusona-server-sdk-ruby)
+
+## Requirements
+The Trusona SDK requires Ruby version 2.4.0 or higher.
+
+## Examples
+
+* [Configuration](#configuration)
+* [Device and User Bindings](#device-and-user-bindings)
+* [Trusonafications](#trusonafications)
+* [Devices](#devices)
+
+### Configuration
+
+Configuring the Trusona gem is easy. We recommend using environment variables and a tool like [dotenv](https://github.com/bkeepers/dotenv) for managing those environment variables.
+
+```ruby
+Trusona.config do |c|
+  c.tru_codes_host = ENV['TRUCODES_HOST']
+  c.api_host       = ENV['TRUSONA_API_HOST']
+  c.secret         = ENV['TRUSONA_SECRET']
+  c.token          = ENV['TRUSONA_TOKEN']
+end
+```
+
+The value of each required configuration parameter are provided by Trusona.
+
+### Device and User Bindings
+
+Before Trusonafications can be created for a user, the device registered with the Trusona Mobile SDK must be bound to a **unique-to-you** user identifier. The user identifier can be any value that helps you uniquely identify the user in your system.
+
+Once this binding has been created, the user should be made to verify their account with your system. This may include:
+
+* Email verification
+* Logging in with existing credentials
+* Answering security questions
+
+Once the account has been verified, the Device and User Binding must be activated, which is your way of telling Trusona that this user is ready to accept Trusonafications.
+
+#### Creating a Device and User Binding
+
+The binding requires two values, the user identifier that helps you identify the user in your system and the device identifier as generated by the Trusona Mobile SDK on the user's device.
+
+```ruby
+
+  binding = Trusona::DeviceUserBinding.create(
+    user: '83452353-4F7B-4CA2-BBCD-57ACE7279EA0',
+    device: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+  )
+
+```
+
+#### Activating a Device and User Binding
+
+```ruby
+  # create the binding
+  binding = Trusona::DeviceUserBinding.create(
+    user: '83452353-4F7B-4CA2-BBCD-57ACE7279EA0',
+    device: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+  )
+
+  # go verify the user...
+
+  # activate the binding
+  Trusona::DeviceUserBinding.activate(id: binding.id)
+```
+
+### Trusonafications
+
+#### Creating a Trusonafication
+
+A simple Essential level Trusonafication
+
+```ruby
+  Trusona::EssentialTrusonafication.create(params: {
+    action: 'login',
+    resource: 'Acme Bank',
+    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+   })
+```
+
+An Executive level Trusonafication
+
+```ruby
+  Trusona::ExecutiveTrusonafication.create(params: {
+    action: 'login',
+    resource: 'Acme Bank',
+    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+   })
+```
+
+A more complex example, toggling optional fields
+
+```ruby
+  Trusona::EssentialTrusonafication.create(params: {
+    action: 'login',
+    resource: 'Acme Bank',
+    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI',
+    user_presence: false,
+    prompt: false
+   })
+```
+
+
+
+#### Trusonafication Options
+
+|       Name        |   Parameter Name    | Required |                                                            Description                                                            |
+| :---------------- | :------------------ | :------: | :-------------------------------------------------------------------------------------------------------------------------------- |
+| Action            | `action`            |    Y     | The action you want the user to take (e.g. 'login', 'verify')                                                                     |
+| Resource          | `resource`          |    Y     | The resource to which the user is performing the action (e.g. 'website', 'account')                                               |
+| Device Identifier | `device_identifier` |    N[^1] | The device identifier, retrieved from the mobile SDK, of the device to which this Trusonafication will be sent.                   |
+| User Identifier   | `user_identifier`   |    N[^1] | The user identifier that has been registered with Trusona.                                                                        |
+| Tru Code ID       | `trucode_id`        |    N[^1] | A Tru Code ID that has/will be paired by a device using the Trusona Mobile SDK that can be used to lookup the `device_identifier` |
+| User Presence     | `user_presence`     |    N     | Should the user be required to demonstrate presence (e.g. via Biometric) when accepting this Trusonafication? Defaults to `true`. |
+| Prompt            | `prompt`            |    N     | Should the user be prompted to Accept or Reject this Trusonafication? Defaults to `true`.                                         |
+| Callback URL      | `callback_url`      |    N     | A URL that will be called when the Trusonafication is completed.                                                                  |
+| Expiration        | `expires_at`        |    N     | The ISO-8601 UTC timestamp of the Trusonafication's expiration. Defaults to 90 seconds from creation.                             |
+
+[^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`.
+
+#### Retrieving an existing Trusonafication
+
+After creating a Trusonafication, you can fetch that Trusonafication using the `id`.
+
+```ruby
+  trusonafication = Trusona::EssentialTrusonafication.create(params: {
+    action: 'login',
+    resource: 'Acme Bank',
+    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+   })
+
+   # ...
+
+   updated = Trusona::Trusonafication.find(trusonafication.id)
+```
+
+#### Automatically polling for Trusonafication status
+
+Sometimes, you want to send a Trusonafication and wait for its completion by the user before proceeding. This can be accomplished by passing a block, and optional timeout, when creating a Trusonafication.
+
+```ruby
+  params = {
+    action: 'login',
+    resource: 'Acme Bank',
+    device_identifier: 'PBanKaajTmz_Cq1pDkrRzyeISBSBoGjExzp5r6-UjcI'
+  }
+
+  Trusona::EssentialTrusonafication.create(params: params) do | trusonafication |
+    # Block will be executed when the user has acted on the Trusonafication
+    # OR when the Trusonafication has expired.
+
+    if trusonafication.accepted?
+      # start the parade
+    end
+  end
+```
+
+### Devices
+
+#### Finding a Device
+
+If you want to check whether or not a device has been activated, or when it was activated, you can look it up in Trusona using the device's identifier.
+
+```ruby
+  device = Trusona::Device.find(id: 'r1ByVyVKJ7TRgU0RPX0-THMTD_CO3VrCSNqLpJFmhms')
+  if device.active
+    # dance
+  end
+```
+
+## Development
+
+### Patterns
+
+The Trusona gem is built with a few principles in mind:
+
+1. Provide a simple, idomatic, rails-like public interface.
+1. Reduce the scope of the internals exposed to the end-user of the gem.
+
+#### Workers
+
+Behind the public facing API are a variety of Workers that complete simple, single-focused tasks. For example, when creating a Trusonafication, the responsibility of creation is offloaded to the `Trusona::Workers::TrusonaficationCreator`. This pattern is used for nearly all aspects of the SDK internals.
+
+#### Services
+
+Communicating with the Trusona API is done via a set of `Trusona::Services` which are responsible for making HMAC'd requests to the Trusona API and verifying the HMAC'd responses from the Trusona API.
+
+#### Resources
+
+Resources are designed to be simple representations of entities which are represented by the Trusona API.
+
+#### Mappers
+
+Mappers help translate JSON representations of Trusona API entities to Resource objects.
+
+### Rubocop
+
+`Rubocop` is used to ensure adherence to an known style guide. It can be run
+from the command line. Rubocop standards are currently _not_ enforced during
+continuous integration builds.
+
+`bundle exec rubocop lib`
+
+### Testing
+
+`bundle exec rake`
+
+#### Integration Tests
+
+Included in the `integrations` directory are a set of ever growing integration tests which rely on the Trusona config variables in your environment (try `.env`.)
+
+`bundle exec rspec integrations/`
+
+#### Code Coverage
+
+Code coverage is calculated used `SimpleCov` and can be found in the `coverage`
+directory after running the tests
+
+### Deployment
+
+To deploy a new version of the gem to Artifactory, use `bump` to bump the
+version by either `major`, `minor` or `patch` and then push the tags to
+github. Travis CI will build and deploy any tagged commits.
+
+1. Ensure a clean working directory
+1. `bundle exec bump patch --tag`
+1. `git push origin --tags`