trulioo 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a255bcac10cd99492b2f008bd7b182435b29376b
+  data.tar.gz: '08c61063bc7a9c77391cf2076602b1ffe737a5b0'
+SHA512:
+  metadata.gz: 4678a9116c8e69966ea9f5560fe265c914492b6d994593b17c7e90378a6342612e058940c35c5eaeaf4c6d9002746f5a1e4ab0fa2892d3493f68d63fe718978e
+  data.tar.gz: dafc67619a0e3544a3be2c0d7998a7d1616740896f62d8b65bb744a04924e257547bafdb24aae8533b283591fbbdd638c17fa00064410ecbc4de9631452721da

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 FundAmerica, LLC
+
+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,157 @@
+# Trulioo
+
+This gem provides access to [Trulioo](https://www.trulioo.com/)'s GlobalGateway
+API. For detailed information regarding the API, check out their [API
+docs](https://api.globaldatacompany.com/docs).
+
+## Getting Started
+
+### Installation
+
+Add `trulioo` to your Gemfile and run `bundle install`:
+
+```ruby
+gem 'trulioo`
+```
+
+Or install it manually:
+
+```console
+$ gem install httparty
+$ gem install trulioo
+```
+
+### Configure
+
+Settings can be configured as so:
+
+```ruby
+require 'trulioo'
+
+Trulioo.configure do |config|
+  config.username = 'username'
+  config.password = 'password'
+end
+```
+
+### Usage
+
+You'll want to try the `say_hello` to make sure the URL is correct and the
+`test_authentication` endpoint to make sure your credentials are correct.
+
+```ruby
+client = Trulioo::Client.new
+client.say_hello              # => "Hello World"
+client.test_authentication    # => "Hello Company_Username"
+```
+
+## API Endpoints
+
+### Connection
+
+Used to test your connection.
+
+#### `say_hello`
+
+This is the only endpoint that does not require authentication. It takes in an
+optional param that will be displayed in the greeting.
+
+```ruby
+client.connection.say_hello            # => "Hello World"
+client.connection.say_hello 'Company'  # => "Hello Company"
+```
+
+#### `test_authentication`
+
+If the provided username and password are correct, this will return the username
+of your account in the greeting.
+
+```ruby
+client.connection.test_authentication  # => "Hello Company_Username"
+```
+
+### Verifications
+
+Accesses version 1 of their Normalized API.
+
+#### `transaction_record`
+
+Retrieves the information of an existing verification. This takes an optional
+param if you would like more information. The options available:
+
+- `:withaddress`: If your account includes address cleansing.
+- `:verbose`: If your account includes address cleansing and watchlist details.
+
+```ruby
+client.verifications.transaction_record(transaction_id)
+client.verifications.transaction_record(transaction_id, :withaddress)
+client.verifications.transaction_record(transaction_id, :verbose)
+```
+
+#### `verify`
+
+Performs a verification. Accepts a hash for the data. You do not need to include
+the key `AcceptTruliooTermsAndConditions` as it is already included.
+
+```ruby
+client.verifications.verify({ CountryCode: 'US', ... })
+```
+
+### Configuration
+
+Information regarding how your account is configured.
+
+#### `consents`
+
+Consents required for the provided country. Accepts a string or symbol.
+
+```ruby
+client.configuration.consents('US')
+```
+
+#### `country_codes`
+
+Returns countries configured for your account.
+
+```ruby
+client.configuration.consents
+```
+
+#### `country_subdivisions`
+
+Gets the provinces states or other subdivisions for a country, mostly matches
+ISO 3166-2.
+
+```ruby
+client.configuration.country_subdivisions('US')
+```
+
+#### `document_types`
+
+Get available document verification types.
+
+```ruby
+client.configuration.document_types('US')
+```
+
+#### `fields`
+
+Generates json schema for the API, which can be used to format your `data`
+object when performing a verification.
+
+```ruby
+client.configuration.fields('US')
+```
+
+## Testing
+
+### Development
+
+Tests are run using MiniTest. To run tests, first copy `test/env.yml.example` to
+`test/env.yml`. Update the variables in the file and then run `rake test` (or
+just `rake`). The `env.yml` file is necessary to test against any endpoints that
+require authentication. The `TestConnection#say_hello` should work fine without
+it.
+
+Each endpoint has its own test suite to make it easier to run tests for that API
+endpoint.

data/lib/trulioo.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'trulioo/settings'
+require 'trulioo/client'
+
+# Trulioo holds the settings and allows them to be set using Trulioo.configure.
+module Trulioo
+  class << self
+    def configure
+      yield(settings)
+    end
+
+    def settings
+      @_settings ||= Settings.new
+    end
+  end
+end

data/lib/trulioo/api.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'trulioo/api/base'
+require 'trulioo/api/configuration'
+require 'trulioo/api/connection'
+require 'trulioo/api/verifications'
+
+module Trulioo
+  # Trulioo::API is where the endpoints will be handled.
+  module API
+  end
+end

data/lib/trulioo/api/base.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Trulioo
+  module API
+    # Trulioo::API::Base has information for the API classes to call the
+    # endpoint correctly.
+    class Base
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      private
+
+      def get(*params)
+        client.connector.get(namespace, *params)
+      end
+
+      def namespace
+        @_namespace ||= self.class.name.split('::').last
+      end
+
+      def post(*params)
+        client.connector.post(namespace, *params)
+      end
+    end
+  end
+end

data/lib/trulioo/api/configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Trulioo
+  module API
+    # Trulioo::Configuration manages the "Configuration" API endpoints. This
+    # will tell you how your account is configured.
+    class Configuration < Trulioo::API::Base
+      def consents(country)
+        configuration_namespace
+        get("consents/#{configuration_name}/#{country}", auth: true)
+      end
+
+      def country_codes
+        configuration_namespace
+        get("countrycodes/#{configuration_name}", auth: true)
+      end
+
+      def country_subdivisions(country)
+        configuration_namespace
+        get("countrysubdivisions/#{country}", auth: true)
+      end
+
+      def document_types(country)
+        configuration_namespace
+        get("documentTypes/#{country}", auth: true)
+      end
+
+      def fields(country)
+        configuration_namespace
+        get("fields/#{configuration_name}/#{country}", auth: true)
+      end
+
+      private
+
+      def configuration_name
+        'Identity Verification'
+      end
+
+      def configuration_namespace
+        @namespace = 'configuration'
+      end
+    end
+  end
+end

data/lib/trulioo/api/connection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trulioo
+  module API
+    # Trulioo::Connection manages the "Connection" API endpoints. These are used
+    # to test your connection to the Trulioo servers.
+    class Connection < Trulioo::API::Base
+      def say_hello(name = 'World')
+        connection_namespace
+        get("sayhello/#{name}")
+      end
+
+      def test_authentication
+        connection_namespace
+        get('testauthentication', auth: true)
+      end
+
+      private
+
+      def connection_namespace
+        @namespace = 'connection'
+      end
+    end
+  end
+end

data/lib/trulioo/api/verifications.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Trulioo
+  module API
+    # Trulioo::Verifications manages the "Verifications" API endpoints. This
+    # accesses the Normalized API.
+    class Verifications < Trulioo::API::Base
+      def transaction_record(transaction_id, option = nil)
+        action = "transactionrecord/#{transaction_id}"
+        action += "/#{option}" if option.try(:to_sym).in?(options)
+        get(action, auth: true)
+      end
+
+      def verify(data)
+        post('verify', auth: true, body: data)
+      end
+
+      private
+
+      def options
+        %i[verbose withaddress]
+      end
+
+      def verifications_namespace
+        @namespace = 'verifications'
+      end
+    end
+  end
+end

data/lib/trulioo/client.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'trulioo/api'
+require 'trulioo/connector'
+
+module Trulioo
+  # Trulioo::Client handles the Connector and the different API endpoints for
+  # easy access.
+  class Client
+    attr_reader :connector, :configuration, :connection, :verifications
+
+    def initialize(settings = Trulioo.settings)
+      @connector = Trulioo::Connector.new(settings)
+      @configuration = Trulioo::API::Configuration.new(self)
+      @connection = Trulioo::API::Connection.new(self)
+      @verifications = Trulioo::API::Verifications.new(self)
+    end
+  end
+end

data/lib/trulioo/connector.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'httparty'
+
+module Trulioo
+  # Trulioo::Connector manages the calls to the API.
+  class Connector
+    attr_reader :settings
+
+    def initialize(settings)
+      @settings = settings
+    end
+
+    %i[get post].each do |verb|
+      define_method(verb) do |namespace, action, options = {}|
+        HTTParty.send(verb, url(namespace, action), params(options))
+      end
+    end
+
+    private
+
+    def auth_params
+      {
+        basic_auth: {
+          username: settings.username,
+          password: settings.password
+        }
+      }
+    end
+
+    def params(options)
+      params = {
+        headers: {
+          'Content-Type' => 'application/json'
+        }
+      }
+      params.merge!(auth_params) if options[:auth]
+      params[:body] = params_body(options[:body]) if options[:body]
+      params
+    end
+
+    def params_body(body)
+      { AcceptTruliooTermsAndConditions: true }.merge(body).to_json
+    end
+
+    def url(namespace, action)
+      URI.encode(
+        "#{settings.base_uri}/#{namespace}/#{settings.api_version}/#{action}"
+      )
+    end
+  end
+end

data/lib/trulioo/settings.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trulioo
+  # Trulioo::Settings holds the variables used to connect to Trulioo's servers.
+  class Settings
+    attr_accessor :api_version, :base_uri, :password, :url, :username
+
+    def initialize
+      @api_version = 'v1'
+      @base_uri = 'https://api.globaldatacompany.com'
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: trulioo
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dave Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: d@fundamerica.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/trulioo.rb
+- lib/trulioo/api.rb
+- lib/trulioo/api/base.rb
+- lib/trulioo/api/configuration.rb
+- lib/trulioo/api/connection.rb
+- lib/trulioo/api/verifications.rb
+- lib/trulioo/client.rb
+- lib/trulioo/connector.rb
+- lib/trulioo/settings.rb
+homepage: https://github.com/fundamerica/trulioo
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for Trulioo's GlobalGateway API
+test_files: []