yoti 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 687ddf7f2ce726749774b2cbbd5bbe97419d9df5
-  data.tar.gz: 8f8cdefad48fd070ac6c0dbe7fc5994f4a8878fb
+  metadata.gz: db62b520742b6807cac9c0813675327f9dec1bf9
+  data.tar.gz: fb2006107a34a2b9eed606ddc63ed61062ec8d96
 SHA512:
-  metadata.gz: 603439330c7f7298590d4d3b1f1a8b7bdd6ec6756876729ac5fb9e02522bfe141cbfc12e7dc7afda4ffb5283771036e63127ddb8a9c89ef5324c2394df08ab32
-  data.tar.gz: 2cd356bf349ae241461f949f3214fe698a84aebfbc871fd7bcb76d0e75c2381bdff7a83ec358c548b1e00dea794fb4bc700bc28f14fb02d162f3850011d5379c
+  metadata.gz: af3eebba165eaf25a7ab88a6a07a32de685a2f8ed522a3808519287955100127ef08dbc840856c849c1e25bbf3443a6aad64aa008edc4b29b21230dab5c1ecc2
+  data.tar.gz: ba85c6be0f0978ebcb0209835fd0a4564cf9458b54f88173242705df7a3278b3c4c99bb37b858fb306edc49b998af9c89e809535d98c24cab0eabb8ab6306309

data/.gitignore

@@ -35,3 +35,5 @@ Gemfile.lock
 
 # Ignore Yardstick measurement files
 /measurement
+examples/rails/public/*.jpeg
+examples/sinatra/public/*.jpeg

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.2.0 - 2018-02-28
+### Added
+- AML (Anti Money Laundering) check service
+
 ## 1.1.0 - 2017-10-24
 ### Changed
 - `user_profile['selfie']` will return image data instead of an image URI

data/CONTRIBUTING.md

@@ -4,11 +4,10 @@ After checking out the repo, run `bundle install` to install dependencies. Then,
 
 You can use [Guard][] to automatically run the tests every time a file in the `lib` or `spec` folder changes.
 
-
 Run Guard through Bundler with:
 
 ```shell
-$ bundle exec guard
+bundle exec guard
 ```
 
 [Guard]: https://github.com/guard/guard
@@ -22,12 +21,13 @@ If you wish to compile `.proto` definitions to Ruby, you will need to install [G
 ### OSX
 
 ```shell
-$ brew install protobuf
+brew install protobuf
 ```
 
 ### Ubuntu
+
 ```shell
-$ sudo apt-get install -y protobuf
+sudo apt-get install -y protobuf
 ```
 
 This gem relies heavily on the [Ruby Protobuf][] gem. For more information on how Google Protobuf works, please see the [Wiki pages][].
@@ -35,9 +35,9 @@ This gem relies heavily on the [Ruby Protobuf][] gem. For more information on ho
 Compiling the common and attribute `.proto` definitions can be done with the following commands:
 
 ```shell
-$ cd lib/yoti/protobuf/v1
-$ protoc -I definitions/attribute-public-api/attrpubapi_v1 --ruby_out ./attribute_public_api definitions/attribute-public-api/attrpubapi_v1/*.proto
-$ protoc -I definitions/common-public-api/compubapi_v1/ --ruby_out ./common_public_api definitions/common-public-api/compubapi_v1/*.proto
+cd lib/yoti/protobuf/v1
+protoc -I definitions/attribute-public-api/attrpubapi_v1 --ruby_out ./attribute_public_api definitions/attribute-public-api/attrpubapi_v1/*.proto
+protoc -I definitions/common-public-api/compubapi_v1/ --ruby_out ./common_public_api definitions/common-public-api/compubapi_v1/*.proto
 ```
 
 These commands will overwrite the current protobuf Ruby modules, which have been modified. If the protobuf files have to be updated, a good idea would be to change them manually, or generate the files in a new location, and compare the content.
@@ -53,30 +53,33 @@ The 100% code coverage requirement must be met before submitting new code.
 This can be checked by opening the generated [SimpleCov][] files:
 
  ```shell
- $ open coverage/index.html
+open coverage/index.html
  ```
 
 ### Style guide
+
 The Ruby style guide is configured in the [rubocop.yml](rubocop.yml) file and can be checked by running:
 
 ```shell
-$ bundle exec rake rubocop
+bundle exec rake rubocop
 ```
 
 ### Documentation
+
 The documentation uses the [Yard][] format. Please ensure all new classes and methods are fully documented.
 
 There are a few Rake tasks to handle documentation:
 
 ```shell
-$ bundle exec rake measurement
+bundle exec rake measurement
 ```
 
 Verifies the documentation with [Yardstick][] and generates the `measurement/report.txt` file, containing tips on how to improve the documentation coverage.
 
 ```shell
-$ bundle exec rake yard
+bundle exec rake yard
 ```
+
 Generates [YARD][] documentation in the doc folder.
 
 ### Git
@@ -106,6 +109,7 @@ gem push pkg/yoti-[version].gem
 ```
 
 ## Submitting a pull request
+
 1. [Fork the repository.][fork]
 2. [Create a topic branch.][branch]
 3. Add specs for your unimplemented feature or bug fix.

data/README.md

@@ -4,42 +4,15 @@ Welcome to the Yoti Ruby SDK. This repository contains the tools you need to qui
 
 ## Table of Contents
 
-1) [An Architectural view](#an-architectural-view) -
-High level overview of integration
-
-2) [References](#references)-
-Guides before you start
-
-3) [Requirements](#requirements)-
-Everything you need to get started
-
-4) [Installing the SDK](#installing-the-sdk)-
-How to install our SDK
-
-5) [SDK Project import](#sdk-project-import)-
-How to install the SDK to your project
-
-6) [Configuration](#configuration)-
-entry point explanation
-
-7) [Profile Retrieval](#profile-retrieval)-
-How to retrieve a Yoti profile using the token
-
-8) [Handling users](#handling-users)-
-How to manage users
-
-9) [API Coverage](#api-coverage)-
-Attributes defined
-
-10) [Running the examples](running-the-examples)-
-Attributes defined
-
-11) [Support](#support)-
-Please feel free to reach out
-
-12) [Change Log](#change-log)
-
-13) [License](#license)
+1. [An Architectural view](#an-architectural-view) - High level overview of integration
+1. [Requirements](#requirements) - Everything you need to get started
+1. [Installing the SDK](#installing-the-sdk) - How to install our SDK
+1. [Configuration](#configuration) - Configuring the SDK
+1. [Profile Retrieval](#profile-retrieval) - How to retrieve a Yoti profile using the token
+1. [AML Integration](#aml-integration) - How to integrate with Yoti's AML (Anti Money Laundering) service
+1. [Running the Examples](#running-the-examples) - How to run the example projects provided
+1. [API Coverage](#api-coverage) - Attributes defined
+1. [Support](#support) - Please feel free to reach out
 
 ## An Architectural view
 
@@ -51,7 +24,6 @@ Yoti SDK carries out for you steps 6, 7, 8 and the profile decryption in step 9.
 
 ![alt text](login_flow.png "Login flow")
 
-
 Yoti also allows you to enable user details verification from your mobile app by means of the Android (TBA) and iOS (TBA) SDKs. In that scenario, your Yoti-enabled mobile app is playing both the role of the browser and the Yoti app. Your back-end doesn't need to handle these cases in a significantly different way, but you might decide to handle the `User-Agent` header in order to provide different responses for desktop and mobile clients.
 
 ## References
@@ -92,21 +64,21 @@ gem 'yoti'
 And then execute:
 
 ```shell
-$ bundle install
+bundle install
 ```
 
 Or simply run the following command from your terminal:
 
 ```shell
-$ [sudo] gem install yoti
+[sudo] gem install yoti
 ```
 
-## SDK Project import
+## SDK Project Import
 
 The gem provides a generator for the initialization file:
 
 ```shell
-$ rails generate yoti:install
+rails generate yoti:install
 ```
 
 The generated initialisation file can be found in `config/initializers/yoti.rb`.
@@ -121,6 +93,7 @@ Yoti.configure do |config|
   config.key_file_path = ENV['YOTI_KEY_FILE_PATH']
 end
 ```
+
 Make sure the following environment variables can be accessed by your app:
 
 `YOTI_CLIENT_SDK_ID` - found on the Key settings page on your application dashboard
@@ -129,12 +102,12 @@ Make sure the following environment variables can be accessed by your app:
 
 The following options are available:
 
-Config               | Required | Default              | Note
----------------------|----------|----------------------|-----
-`client_sdk_id`      | Yes      |                      | SDK identifier generated by when you publish your app
-`key_file_path`      | Yes      |                      | Path to the pem file generated when you create your app
-`api_url`            | No       | https://api.yoti.com | Path to Yoti URL used for debugging purposes
-`api_port`           | No       | 443                  | Path to Yoti port used for debugging purposes
+Config               | Required | Default                | Note
+---------------------|----------|------------------------|-----
+`client_sdk_id`      | Yes      |                        | SDK identifier generated by when you publish your app
+`key_file_path`      | Yes      |                        | Path to the pem file generated when you create your app
+`api_url`            | No       | `https://api.yoti.com` | Path to Yoti URL used for debugging purposes
+`api_port`           | No       | 443                    | Path to Yoti port used for debugging purposes
 
 Keeping your settings and access keys outside your repository is highly recommended. You can use gems like [dotenv][] to manage environment variables more easily.
 
@@ -155,11 +128,7 @@ Yoti.configure do |config|
 end
 ```
 
-Where `YOTI_KEY` is an environment variable with the following format:
-
-```
-YOTI_KEY="-----BEGIN RSA PRIVATE KEY-----\nMIIEp..."
-```
+Where `YOTI_KEY` is an environment variable with the following format: `YOTI_KEY="-----BEGIN RSA PRIVATE KEY-----\nMIIEp..."`
 
 An easier way of setting this on Heroku would be to use the [Heroku Command Line][]
 
@@ -169,9 +138,7 @@ heroku config:add YOTI_KEY ="$(cat your-access-security.pem)"
 
 [Heroku Command Line]: https://devcenter.heroku.com/articles/heroku-command-line
 
-
-
-## Profile retrieval
+## Profile Retrieval
 
 When your application receives a token via the exposed endpoint (it will be assigned to a query string parameter named `token`), you can easily retrieve the user profile:
 
@@ -189,11 +156,14 @@ else
 end
 ```
 
-The `user_profile ` object provides a set of attributes corresponding to user attributes. Whether the attributes are present or not depends on the settings you have applied to your app on Yoti Dashboard.
+The `user_profile` object provides a set of attributes corresponding to user attributes. Whether the attributes are present or not depends on the settings you have applied to your app on Yoti Dashboard.
 
-### Handling users
+### Handling Users
 
-When you retrieve the user profile, you receive a user ID generated by Yoti exclusively for your application. This means that if the same individual logs into another app, Yoti will assign them a different id. You can use such id to verify whether the retrieved profile identifies a new or an existing user. Here is an example of how this works:
+When you retrieve the user profile, you receive a user ID generated by Yoti exclusively for your application.
+This means that if the same individual logs into another app, Yoti will assign her/him a different ID.
+You can use this ID to verify whether (for your application) the retrieved profile identifies a new or an existing user.
+Here is an example of how this works:
 
 ```ruby
 if yoti_activity_details.outcome == 'SUCCESS'
@@ -209,9 +179,54 @@ else
 end
 ```
 
-Where `your_user_search_function` is a piece of logic in your app that is supposed to find a user, given a user_id. Regardless of wether the user is a new or an existing one, Yoti will always provide their profile, so you don't necessarily need to store it.
+Where `your_user_search_function` is a piece of logic in your app that is supposed to find a user, given a user_id. Regardless of whether the user is a new or an existing one, Yoti will always provide their profile, so you don't necessarily need to store it.
+
+## AML Integration
+
+Yoti provides an AML (Anti Money Laundering) check service to allow a deeper KYC process to prevent fraud. This is a chargeable service, so please contact [sdksupport@yoti.com](mailto:sdksupport@yoti.com) for more information.
+
+Yoti will provide a boolean result on the following checks:
+
+* PEP list - Verify against Politically Exposed Persons list
+* Fraud list - Verify against  US Social Security Administration Fraud (SSN Fraud) list
+* Watch list - Verify against watch lists from the Office of Foreign Assets Control
+
+To use this functionality you must ensure your application is assigned to your Organisation in the Yoti Dashboard - please see here for further information.
 
-## Running the examples
+For the AML check you will need to provide the following:
+
+* Data provided by Yoti (please ensure you have selected the Given name(s) and Family name attributes from the Data tab in the Yoti Dashboard)
+  * Given name(s)
+  * Family name
+* Data that must be collected from the user:
+  * Country of residence (must be an ISO 3166 3-letter code)
+  * Social Security Number (US citizens only)
+  * Postcode/Zip code (US citizens only)
+
+### Consent
+
+Performing an AML check on a person *requires* their consent.
+**You must ensure you have user consent *before* using this service.**
+
+### Code Example
+
+Given a YotiClient initialised with your SDK ID and KeyPair (see [Client Initialisation](#client-initialisation)) performing an AML check is a straightforward case of providing basic profile data.
+
+```ruby
+require 'yoti'
+
+Yoti.configure do |config|
+  config.client_sdk_id = ENV['YOTI_CLIENT_SDK_ID']
+  config.key_file_path = ENV['YOTI_KEY_FILE_PATH']
+end
+
+aml_address = Yoti::AmlAddress.new('GBR')
+aml_profile = Yoti::AmlProfile.new('Edward Richard George', 'Heath', aml_address)
+
+puts Yoti::Client.aml_check(aml_profile)
+```
+
+## Running the Examples
 
 The examples can be found in the [examples folder](examples).
 For them to work you will need a working callback URL that your browser can redirect to. The callback URL for both examples will be: `http://your-local-url.domain/profile`.
@@ -230,43 +245,42 @@ Visiting the `http://your-local-url.domain` should show a Yoti Connect button
 
 * rename the [.env.default](examples/sinatra/.env.default) file to `.env` and fill in the required configuration values
 * install the dependencies with `bundle install`
-* start the server `dotenv ./app.rb`
+* start the server `ruby ./app.rb`
 
 Visiting the `http://your-local-url.domain` should show a Yoti Connect button
 
-## API coverage
+### AML Check
+
+* rename the [.env.default](examples/aml_check/.env.default) file to `.env` and fill in the required configuration values
+* install the dependencies with `bundle install`
+* run the script with `ruby ./app.rb`
+
+## API Coverage
 
 * Activity Details
-    * [X] User ID `user_id`
-    * [X] Profile
-        * [X] Selfie `selfie`
-        * [X] Given Names `given_names`
-        * [X] Family Name `family_name`
-        * [X] Mobile Number `phone_number`
-        * [X] Email address `email_address`
-        * [X] Date of Birth `date_of_birth`
-        * [X] Address `postal_address`
-        * [X] Gender `gender`
-        * [X] Nationality `nationality`
-    * [X] Base64 Selfie URI `base64_selfie_uri`
+  * [X] User ID `user_id`
+  * [X] Profile
+    * [X] Selfie `selfie`
+    * [X] Full Name `full_name`
+    * [X] Given Names `given_names`
+    * [X] Family Name `family_name`
+    * [X] Mobile Number `phone_number`
+    * [X] Email Address `email_address`
+    * [X] Age / Date of Birth `date_of_birth`
+    * [X] Age / Verify Condition `age_[over|under]:[1-999]`
+    * [X] Address `postal_address`
+    * [X] Gender `gender`
+    * [X] Nationality `nationality`
+  * [X] Base64 Selfie URI `base64_selfie_uri`
 
 ## Support
 
 For any questions or support please email [sdksupport@yoti.com](mailto:sdksupport@yoti.com).
-Please provide the following the get you up and working as quick as possible:
-
-- Computer Type
-- OS Version
-- Version of Ruby being used
-- Screenshot
-
-
-## Changelog
-
-See recent changes in the [release notes][release notes] or the [changelog](CHANGELOG.md).
-
-[release notes]: https://github.com/getyoti/yoti-ruby-sdk/releases
+Please provide the following to get you up and working as quickly as possible:
 
-## License
+* Computer type
+* OS version
+* Version of Ruby being used
+* Screenshot
 
-The gem is available under the following [terms](LICENSE.txt).
+Once we have answered your question we may contact you again to discuss Yoti products and services. If you’d prefer us not to do this, please let us know when you e-mail.

data/lib/yoti.rb

@@ -2,7 +2,15 @@ require_relative 'yoti/version'
 require_relative 'yoti/configuration'
 require_relative 'yoti/errors'
 require_relative 'yoti/ssl'
-require_relative 'yoti/request'
+
+require_relative 'yoti/http/payloads/aml_address'
+require_relative 'yoti/http/payloads/aml_profile'
+require_relative 'yoti/http/aml_check_request'
+
+require_relative 'yoti/http/signed_request'
+require_relative 'yoti/http/profile_request'
+require_relative 'yoti/http/request'
+
 require_relative 'yoti/activity_details'
 require_relative 'yoti/client'
 require_relative 'yoti/protobuf/v1/protobuf'

data/lib/yoti/client.rb

@@ -6,7 +6,7 @@ module Yoti
     # @param encrypted_connect_token [String] token provided as a base 64 string
     # @return [Object] an ActivityDetails instance encapsulating the user profile
     def self.get_activity_details(encrypted_connect_token)
-      receipt = Yoti::Request.new(encrypted_connect_token).receipt
+      receipt = Yoti::ProfileRequest.new(encrypted_connect_token).receipt
       encrypted_data = Protobuf.current_user(receipt)
 
       return ActivityDetails.new(receipt) if encrypted_data.nil?
@@ -16,5 +16,9 @@ module Yoti
       decrypted_profile = Protobuf.attribute_list(decrypted_data)
       ActivityDetails.new(receipt, decrypted_profile)
     end
+
+    def self.aml_check(aml_profile)
+      Yoti::AmlCheckRequest.new(aml_profile).response
+    end
   end
 end

data/lib/yoti/configuration.rb

@@ -1,7 +1,7 @@
 module Yoti
   class Configuration
     attr_accessor :client_sdk_id, :key_file_path, :key, :sdk_identifier,
-                  :api_url, :api_port, :api_version, :api_endpoint
+                  :api_url, :api_port, :api_version
 
     # Set config variables by using a configuration block
     def initialize

data/lib/yoti/errors.rb

@@ -10,4 +10,7 @@ module Yoti
 
   # Raises exceptions realted to an incorrect gem configuration value
   class ConfigurationError < StandardError; end
+
+  # Raises exceptions related to AML actions
+  class AmlError < StandardError; end
 end

data/lib/yoti/http/aml_check_request.rb

@@ -0,0 +1,25 @@
+module Yoti
+  # Manage the API's AML check requests
+  class AmlCheckRequest
+    def initialize(aml_profile)
+      @aml_profile = aml_profile
+      @payload = aml_profile.payload
+      @request = request
+    end
+
+    # @return [String] a JSON representation of the AML check response
+    def response
+      JSON.parse(@request.body)
+    end
+
+    private
+
+    def request
+      yoti_request = Yoti::Request.new
+      yoti_request.http_method = 'POST'
+      yoti_request.endpoint = 'aml-check'
+      yoti_request.payload = @payload
+      yoti_request
+    end
+  end
+end

data/lib/yoti/http/payloads/aml_address.rb

@@ -0,0 +1,17 @@
+module Yoti
+  # Manages the AML check Address object
+  class AmlAddress
+    # @return [String] the country of residence in a ISO 3166 3-letter code format
+    attr_accessor :country
+
+    # @return [String] the postcode required for USA, optional otherwise
+    attr_accessor :post_code
+
+    def initialize(country, post_code = nil)
+      raise AmlError, 'AmlAddress requires a country.' if country.to_s.empty?
+
+      @country = country
+      @post_code = post_code
+    end
+  end
+end

data/lib/yoti/http/payloads/aml_profile.rb

@@ -0,0 +1,41 @@
+module Yoti
+  # Manages the AML check Profile object
+  class AmlProfile
+    def initialize(given_names, family_name, aml_address, ssn = nil)
+      @given_names = given_names
+      @family_name = family_name
+      @ssn = ssn
+      @address = aml_address
+
+      raise AmlError, 'The AML request requires given names, family name and an ISO 3166 3-letter code.' if profile_invalid
+      raise AmlError, 'Request for USA require a valid SSN and postcode.' if usa_invalid
+    end
+
+    # @return [Object] the AML check request body
+    def payload
+      {
+        given_names: @given_names,
+        family_name: @family_name,
+        ssn: @ssn,
+        address: {
+          country: @address.country,
+          post_code: @address.post_code
+        }
+      }
+    end
+
+    private
+
+    def profile_invalid
+      @given_names.to_s.empty? || @family_name.to_s.empty? || address_invalid
+    end
+
+    def address_invalid
+      !@address.is_a?(AmlAddress) || @address.country.to_s.length != 3
+    end
+
+    def usa_invalid
+      @address.country == 'USA' && (@ssn.to_s.empty? || @address.post_code.to_s.empty?)
+    end
+  end
+end

data/lib/yoti/http/profile_request.rb

@@ -0,0 +1,24 @@
+module Yoti
+  # Manage the API's profile requests
+  class ProfileRequest
+    def initialize(encrypted_connect_token)
+      @encrypted_connect_token = encrypted_connect_token
+      @request = request
+    end
+
+    # @return [String] a JSON representation of the profile response receipt
+    def receipt
+      JSON.parse(@request.body)['receipt']
+    end
+
+    private
+
+    def request
+      yoti_request = Yoti::Request.new
+      yoti_request.encrypted_connect_token = @encrypted_connect_token
+      yoti_request.http_method = 'GET'
+      yoti_request.endpoint = 'profile'
+      yoti_request
+    end
+  end
+end

data/lib/yoti/http/request.rb

@@ -0,0 +1,81 @@
+module Yoti
+  # Manage the API's HTTPS requests
+  class Request
+    # @return [String] the URL token received from Yoti Connect
+    attr_accessor :encrypted_connect_token
+
+    # @return [String] the HTTP method used for the request
+    # The allowed methods are: GET, DELETE, POST, PUT, PATCH
+    attr_accessor :http_method
+
+    # @return [String] the API endpoint for the request
+    attr_accessor :endpoint
+
+    # @return [Hash] the body sent with the request
+    attr_accessor :payload
+
+    # Makes a HTTP request after signing the headers
+    # @return [Hash] the body from the HTTP request
+    def body
+      raise RequestError, 'The request requires a HTTP method.' unless @http_method
+      raise RequestError, 'The payload needs to be a hash.' unless @payload.to_s.empty? || @payload.is_a?(Hash)
+
+      res = Net::HTTP.start(uri.hostname, Yoti.configuration.api_port, use_ssl: https_uri?) do |http|
+        signed_request = SignedRequest.new(unsigned_request, path, @payload).sign
+        http.request(signed_request)
+      end
+
+      raise RequestError, "Unsuccessful Yoti API call: #{res.message}" unless res.code == '200'
+      res.body
+    end
+
+    private
+
+    def unsigned_request
+      case @http_method
+      when 'GET'
+        http_req = Net::HTTP::Get.new(uri)
+      when 'DELETE'
+        http_req = Net::HTTP::Delete.new(uri)
+      when 'POST'
+        http_req = Net::HTTP::Post.new(uri)
+        http_req.body = @payload.to_json unless @payload.to_s.empty?
+      when 'PUT'
+        http_req = Net::HTTP::Put.new(uri)
+        http_req.body = @payload.to_json unless @payload.to_s.empty?
+      when 'PATCH'
+        http_req = Net::HTTP::Patch.new(uri)
+        http_req.body = @payload.to_json unless @payload.to_s.empty?
+      else
+        raise RequestError, "Request method not allowed: #{@http_method}"
+      end
+
+      http_req
+    end
+
+    def uri
+      @uri ||= URI(Yoti.configuration.api_endpoint + path)
+    end
+
+    def path
+      @path ||= begin
+        nonce = SecureRandom.uuid
+        timestamp = Time.now.to_i
+
+        "/#{@endpoint}/#{token}"\
+        "?nonce=#{nonce}"\
+        "&timestamp=#{timestamp}"\
+        "&appId=#{Yoti.configuration.client_sdk_id}"
+      end
+    end
+
+    def token
+      return '' unless @encrypted_connect_token
+      Yoti::SSL.decrypt_token(@encrypted_connect_token)
+    end
+
+    def https_uri?
+      uri.scheme == 'https'
+    end
+  end
+end

data/lib/yoti/http/signed_request.rb

@@ -0,0 +1,39 @@
+require 'base64'
+
+module Yoti
+  # Converts a basic Net::HTTP request into a Yoti Signed Request
+  class SignedRequest
+    def initialize(unsigned_request, path, payload = {})
+      @http_req = unsigned_request
+      @path = path
+      @payload = payload
+      @auth_key = Yoti::SSL.auth_key_from_pem
+    end
+
+    def sign
+      @http_req['X-Yoti-Auth-Key'] = @auth_key
+      @http_req['X-Yoti-Auth-Digest'] = message_signature
+      @http_req['X-Yoti-SDK'] = Yoti.configuration.sdk_identifier
+      @http_req['Content-Type'] = 'application/json'
+      @http_req['Accept'] = 'application/json'
+      @http_req
+    end
+
+    private
+
+    def message_signature
+      @message_signature ||= Yoti::SSL.get_secure_signature("#{http_method}&#{@path}#{payload_string}")
+    end
+
+    def http_method
+      @http_req.method
+    end
+
+    # Create the base64 encoded request body
+    def payload_string
+      return '' unless @payload
+
+      '&' + Base64.strict_encode64(@payload.to_json)
+    end
+  end
+end

data/lib/yoti/ssl.rb

@@ -26,7 +26,7 @@ module Yoti
 
         begin
           private_key.private_decrypt(Base64.urlsafe_decode64(encrypted_connect_token))
-        rescue => error
+        rescue StandardError => error
           raise SslError, "Could not decrypt token. #{error}"
         end
       end
@@ -63,7 +63,7 @@ module Yoti
 
       def private_key
         @private_key ||= OpenSSL::PKey::RSA.new(pem)
-      rescue => error
+      rescue StandardError => error
         raise SslError, "The secure key is invalid. #{error}"
       end
     end

data/lib/yoti/version.rb

@@ -1,4 +1,4 @@
 module Yoti
   # @return [String] the gem's current version
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/rubocop.yml

@@ -1,12 +1,12 @@
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.1
   Exclude:
     - 'examples/rails/config/**/*'
 
 Metrics/AbcSize:
-  Max: 15
+  Max: 23
   Exclude:
     - examples/rails/app/controllers/yoti_controller.rb
 
@@ -14,14 +14,15 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/**/*.rb
 
+Metrics/CyclomaticComplexity:
+  Max: 9
+
 Metrics/LineLength:
   Enabled: false
 
 Metrics/MethodLength:
   CountComments: false
-  Max: 15
-  Exclude:
-    - examples/rails/app/controllers/yoti_controller.rb
+  Max: 19
 
 Style/Documentation:
   Enabled: false

data/yoti.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'yoti/version'
@@ -11,11 +9,11 @@ Gem::Specification.new do |spec|
   spec.email         = ['tech@yoti.com']
 
   spec.summary       = 'Yoti Ruby SDK for back-end integration.'
-  spec.description = <<-EOF
+  spec.description = <<-DESC
     This gem contains the tools you need to quickly integrate your Ruby back-end
     with Yoti, so that your users can share their identity details with your
     application in a secure and trusted way.
-  EOF
+  DESC
 
   spec.homepage      = 'https://github.com/getyoti/yoti-ruby-sdk'
   spec.license       = 'MIT'
@@ -33,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'simplecov', '~> 0.13'
-  spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'webmock', '~> 3.3'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yardstick', '~> 0.9'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Sebastian Zaremba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-24 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protobuf
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,12 @@ files:
 - lib/yoti/client.rb
 - lib/yoti/configuration.rb
 - lib/yoti/errors.rb
+- lib/yoti/http/aml_check_request.rb
+- lib/yoti/http/payloads/aml_address.rb
+- lib/yoti/http/payloads/aml_profile.rb
+- lib/yoti/http/profile_request.rb
+- lib/yoti/http/request.rb
+- lib/yoti/http/signed_request.rb
 - lib/yoti/protobuf/v1/attribute_public_api/attribute.pb.rb
 - lib/yoti/protobuf/v1/attribute_public_api/list.pb.rb
 - lib/yoti/protobuf/v1/attribute_public_api/signing.pb.rb
@@ -184,7 +190,6 @@ files:
 - lib/yoti/protobuf/v1/definitions/attribute-public-api/attrpubapi_v1/signing.proto
 - lib/yoti/protobuf/v1/definitions/common-public-api/compubapi_v1/encrypted_data.proto
 - lib/yoti/protobuf/v1/protobuf.rb
-- lib/yoti/request.rb
 - lib/yoti/ssl.rb
 - lib/yoti/version.rb
 - login_flow.png

data/lib/yoti/request.rb

@@ -1,59 +0,0 @@
-module Yoti
-  # Manage the API's HTTPS requests
-  class Request
-    def initialize(encrypted_connect_token)
-      @encrypted_connect_token = encrypted_connect_token
-      @auth_key = Yoti::SSL.auth_key_from_pem
-    end
-
-    # @return [Hash] the receipt key from the request hash response
-    def receipt
-      request['receipt']
-    end
-
-    private
-
-    def request
-      res = Net::HTTP.start(uri.hostname, Yoti.configuration.api_port, use_ssl: https_uri?) do |http|
-        http.request(req)
-      end
-
-      raise RequestError, "Unsuccessful Yoti API call: #{res.message}" unless res.code == '200'
-      JSON.parse(res.body)
-    end
-
-    def req
-      http_req = Net::HTTP::Get.new(uri)
-      http_req['X-Yoti-Auth-Key'] = @auth_key
-      http_req['X-Yoti-Auth-Digest'] = message_signature
-      http_req['X-Yoti-SDK'] = @sdk_identifier
-      http_req['Content-Type'] = 'application/json'
-      http_req['Accept'] = 'application/json'
-      http_req
-    end
-
-    def message_signature
-      @message_signature ||= Yoti::SSL.get_secure_signature("GET&#{path}")
-    end
-
-    def uri
-      @uri ||= URI(Yoti.configuration.api_endpoint + path)
-    end
-
-    def path
-      @path ||= begin
-        nonce = SecureRandom.uuid
-        timestamp = Time.now.to_i
-        "/profile/#{token}?nonce=#{nonce}&timestamp=#{timestamp}&appId=#{Yoti.configuration.client_sdk_id}"
-      end
-    end
-
-    def token
-      @token ||= Yoti::SSL.decrypt_token(@encrypted_connect_token)
-    end
-
-    def https_uri?
-      uri.scheme == 'https'
-    end
-  end
-end