jumio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e941bbd99f1d6738f065a67195a26a25faf3867077eae3aab3275ba6467d848
+  data.tar.gz: 6414ccc1c70dc65bc3517986f81542741734970d17e512255ca78abf0c9d9cf7
+SHA512:
+  metadata.gz: 39e670a843f8e9ff27ba4c1f214636d51879197ab4ab53680da88baadcc75386be112fda91fcbfad9142613f61bb0021c5ba3c936454023ebd9ab21f6a5086b1
+  data.tar.gz: 8a43184251933f11bf751086cbe4b928ef37d529707d737313085c6f1eaf9d319aeb3d81644ffea7da139d9248d8f08f34ed02b41022bd3d6a4258599f4f499d

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

@@ -0,0 +1,33 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/specs.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Specs
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake spec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+vendor
+.env
+
+# rspec failure tracking
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alessandro@juul.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in jumio.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 JUUL Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Jumio
+
+[![Specs](https://github.com/JuulLabs-OSS/jumio/actions/workflows/specs.yml/badge.svg)](https://github.com/JuulLabs-OSS/jumio/actions/workflows/specs.yml)
+
+This is a client to communicate with the [Jumio Netverify Web API](https://github.com/Jumio/implementation-guides/tree/master/netverify) to perform age verification.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jumio'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jumio
+
+## Usage
+
+First, you need to configure them gem:
+
+```ruby
+Jumio.configure do |config|
+  config.api.secret = 'your_api_secret'
+  config.api.token = 'your_api_token'
+
+  config.merchant.app_name = 'your app name'
+  config.merchant.company_name = 'your company name'
+  config.merchant.version = Jumio::VERSION
+end
+```
+
+### Initiate a Verification
+
+```ruby
+Jumio.initiate_verification.call(
+  customerInternalReference: 'your_customer_internal_reference',
+  userReference: 'your_user_reference'
+)
+```
+
+### Get Scan Status
+
+```ruby
+Jumio.get_scan_status.call('your_scan_reference')
+```
+
+### Get Scan Details
+
+```ruby
+Jumio.get_scan_details.call('your_scan_reference')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To execute tests, run `bundle exec rake spec`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/JuulLabs-OSS/jumio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Test project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JuulLabs-OSS/jumio/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jumio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jumio.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jumio/version"
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.name          = "jumio"
+  spec.version       = Jumio::VERSION
+  spec.authors       = ['Juul Labs, Inc.']
+  spec.email         = ['opensource@juul.com']
+
+  spec.summary       = "Wrapper for Jumio Netverify Web API"
+  spec.homepage      = "https://github.com/JuulLabs-OSS/jumio"
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'dry-auto_inject'
+  spec.add_dependency 'dry-configurable'
+  spec.add_dependency 'dry-container'
+  spec.add_dependency 'dry-monads'
+  spec.add_dependency "dry-schema", "~> 1.6.0"
+  spec.add_dependency 'dry-struct', '~> 1.4.0'
+
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+  # Until cc-test-reporter works with 0.18.0
+  # https://github.com/codeclimate/test-reporter/issues/418
+  spec.add_development_dependency "simplecov", "~> 0.17.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "dotenv"
+end

data/lib/jumio/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Jumio
+  # configures an http client based on passed in credentials, or
+  # uses the Jumio.api configuration. The instance will expose the
+  # methods below that return lambdas. This is to maintain pairity
+  # with the existing module interface
+  class Client
+    attr_reader :client
+
+    # @param token [String, nil]
+    # @param secret [String, nil]
+    # @param base_url [String, nil]
+    def initialize(token: nil, secret: nil, base_url: nil)
+      @client = Container.resolve('http_client').new(
+        token: token,
+        secret: secret,
+        base_url: base_url
+      )
+    end
+
+    def get_scan_details
+      ->(scan_reference) {
+        Container.resolve('get_scan_details').
+          call(scan_reference, client)
+      }
+    end
+
+    def get_scan_status
+      ->(scan_reference) {
+        Container.resolve('get_scan_status').
+          call(scan_reference, client)
+      }
+    end
+
+    def initiate_verification
+      ->(verification_params) {
+        Container.resolve('initiate_verification').
+          call(verification_params, client)
+      }
+    end
+  end
+end

data/lib/jumio/config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'dry-configurable'
+
+module Jumio
+  extend Dry::Configurable
+
+  setting :api, reader: true do
+    setting :base_url, 'https://netverify.com/api/'
+    setting :secret
+    setting :token
+  end
+
+  setting :merchant, reader: true do
+    setting :app_name, 'YourApp'
+    setting :company_name, 'YourCompany'
+    setting :version, '1.0'
+  end
+end

data/lib/jumio/container.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'dry-auto_inject'
+
+module Jumio
+  # Publicly accessible parts of Jumio gem
+  class Container
+    extend Dry::Container::Mixin
+
+    register(:http_client) { Object.const_get('Jumio::HttpClient') }
+
+    register(:get_scan_details) { Object.const_get('Jumio::Operations::GetScanDetails').new }
+    register(:get_scan_status) { Object.const_get('Jumio::Operations::GetScanStatus').new }
+    register(:initiate_verification) { Object.const_get('Jumio::Operations::InitiateVerification').new }
+
+    namespace(:repositories) do
+      register(:scan) { Object.const_get('Jumio::Repositories::Scan').new }
+      register(:verification) { Object.const_get('Jumio::Repositories::Verification').new }
+    end
+  end
+
+  JDC_CONTAINER = Dry::AutoInject(Container)
+end

data/lib/jumio/entities/address.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'api_entity'
+
+module Jumio
+  module Entities
+    # A generic address payload.
+    # Jumio is very vague about what could come back, so this entity is currently
+    # very permissive to accomodate all possible formats.
+    #
+    # https://github.com/Jumio/implementation-guides/blob/master/netverify/netverify-retrieval-api.md#us-address-format
+    class Address < ApiEntity
+      attribute :city,            Types::Strict::String.meta(omittable: true)
+      attribute :country,         Types::Strict::String.meta(omittable: true)
+      attribute :line1,           Types::Strict::String.meta(omittable: true)
+      attribute :line2,           Types::Strict::String.meta(omittable: true)
+      attribute :line3,           Types::Strict::String.meta(omittable: true)
+      attribute :line4,           Types::Strict::String.meta(omittable: true)
+      attribute :line5,           Types::Strict::String.meta(omittable: true)
+      attribute :stateCode,       Types::Strict::String.meta(omittable: true)
+      attribute :streetDirection, Types::Strict::String.meta(omittable: true)
+      attribute :streetName,      Types::Strict::String.meta(omittable: true)
+      attribute :streetNumber,    Types::Strict::String.meta(omittable: true)
+      attribute :streetSuffix,    Types::Strict::String.meta(omittable: true)
+      attribute :unitDesignator,  Types::Strict::String.meta(omittable: true)
+      attribute :unitDetails,     Types::Strict::String.meta(omittable: true)
+      attribute :unitNumber,      Types::Strict::String.meta(omittable: true)
+      attribute :zip,             Types::Strict::String.meta(omittable: true)
+      attribute :zipExtension,    Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/jumio/entities/api_entity.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+require_relative 'types'
+
+module Jumio
+  module Entities
+    # Base netverify api entity
+    class ApiEntity < Dry::Struct
+      # Allows us to easily consume api payloads
+      transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/jumio/entities/document.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'jumio/entities/requestable_record'
+
+module Jumio
+  module Entities
+    # Photo ID like Driver's license or Passport
+    #
+    # https://github.com/Jumio/implementation-guides/blob/master/netverify/netverify-retrieval-api.md#response-9
+    class Document < RequestableRecord
+      attribute :address,        Address.meta(omittable: true)
+      attribute :dob,            Types::JSON::Date.meta(omittable: true)
+      attribute :expiry,         Types::Strict::String.meta(omittable: true)
+      attribute :idSubtype,      Types::Strict::String.meta(omittable: true)
+      attribute :issuingCountry, Types::Strict::String.meta(omittable: true)
+      attribute :issuingDate,    Types::Strict::String.meta(omittable: true)
+      attribute :firstName,      Types::Strict::String.meta(omittable: true)
+      attribute :lastName,       Types::Strict::String.meta(omittable: true)
+      attribute :number,         Types::Strict::String.meta(omittable: true)
+      attribute :optionalData1,  Types::Strict::String.meta(omittable: true)
+      attribute :optionalData2,  Types::Strict::String.meta(omittable: true)
+      attribute :personalNumber, Types::Strict::String.meta(omittable: true)
+      attribute :status,         Types::Strict::String
+      attribute :type,           Types::Strict::String.meta(omittable: true)
+      attribute :usState,        Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/jumio/entities/identity_verification.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'api_entity'
+
+module Jumio
+  module Entities
+    # Comparison between customer photo and identification
+    class IdentityVerification < ApiEntity
+      attribute :handwrittenNoteMatches, Types::Strict::String.meta(omittable: true)
+      attribute :reason,                 Types::Strict::String.meta(omittable: true)
+      attribute :similarity,             Types::Strict::String.meta(omittable: true)
+      attribute :validity,               Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/jumio/entities/reject_reason.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/array/wrap'
+
+require_relative 'api_entity'
+require_relative 'reject_reason_details'
+
+module Jumio
+  module Entities
+    # Explanation for identity validation failure
+    class RejectReason < ApiEntity
+      attribute :rejectReasonCode,        Types::Strict::String.meta(omittable: true)
+      attribute :rejectReasonDescription, Types::Strict::String.meta(omittable: true)
+
+      # Since the API used to fetch scan details may return a hash or an array
+      # we choose to wrap this attribute so that it is _always_ an array.
+      attribute :rejectReasonDetails,     Types::Array(RejectReasonDetails).
+        constructor { |val| Array.new(::Array.wrap(val)) }.
+        meta(omittable: true)
+    end
+  end
+end

data/lib/jumio/entities/reject_reason_details.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'api_entity'
+
+module Jumio
+  module Entities
+    # Explanation for identity validation failure
+    class RejectReasonDetails < ApiEntity
+      attribute :detailsCode,        Types::Strict::String.meta(omittable: true)
+      attribute :detailsDescription, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/jumio/entities/requestable_record.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'api_entity'
+require_relative 'types'
+
+module Jumio
+  module Entities
+    # Base entity for any item that can be directly requested from a netverify api.
+    # Root payloads always contain a timestamp and scan reference.
+    # These attributes are not present when part of a nested response.
+    class RequestableRecord < ApiEntity
+      attribute :timestamp,     Types::Strict::String.meta(omittable: true)
+      attribute :scanReference, Types::Strict::String.meta(omittable: true)
+    end
+  end
+end

data/lib/jumio/entities/scan.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'document'
+require_relative 'requestable_record'
+require_relative 'transaction'
+require_relative 'verification'
+
+module Jumio
+  module Entities
+    # A scan details api response
+    #
+    # https://github.com/Jumio/implementation-guides/blob/master/netverify/netverify-retrieval-api.md#retrieving-scan-details
+    #
+    # This entity will contain only a transaction (with some status information)
+    # until Jumio has completed their verification process.
+    class Scan < RequestableRecord
+      attribute :document,      Document.meta(omittable: true)
+      attribute :transaction,   Transaction
+      attribute :verification,  Verification.meta(omittable: true)
+
+      # Added for parity with the ScanStatus response entity
+      def status
+        transaction.status
+      end
+    end
+  end
+end

data/lib/jumio/entities/scan_status.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'requestable_record'
+
+module Jumio
+  module Entities
+    class ScanStatus < RequestableRecord
+      # A separate entity to hold the "scan status request"
+      #
+      # https://github.com/Jumio/implementation-guides/blob/master/netverify/netverify-retrieval-api.md#retrieving-scan-status
+      #
+      # Since this endpoint returns _only_ a status value and the "scan details"
+      # does not return this same status at all, we have a separate entity for
+      # each, so as to not have one shared entity with all attributes optional.
+      #
+      # Although the Jumio docs describe this as "required", we have seen scans
+      # come back without one.
+      attribute :status, Types::Strict::String.meta(omittable: true) # Possible states: PENDING, DONE, FAILED
+    end
+  end
+end

data/lib/jumio/entities/transaction.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'requestable_record'
+
+module Jumio
+  module Entities
+    # Inforation relating the upload up documents to be processed.
+    #
+    # https://github.com/Jumio/implementation-guides/blob/master/netverify/netverify-retrieval-api.md#retrieving-transaction-data-only
+    class Transaction < RequestableRecord
+      attribute :clientIp,                  Types::Strict::String.meta(omittable: true)
+      attribute :customerId,                Types::Strict::String.meta(omittable: true)
+      attribute :date,                      Types::Strict::String
+      attribute :merchantReportingCriteria, Types::Strict::String.meta(omittable: true)
+      attribute :merchantScanReference,     Types::Strict::String.meta(omittable: true)
+      attribute :source,                    Types::Strict::String
+      attribute :status,                    Types::Strict::String
+      attribute :updatedAt,                 Types::JSON::DateTime.meta(omittable: true)
+    end
+  end
+end