smile-identity-core 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 433c708dc96d30936d66a28a8722bb0947390d154c0d2ace346ce8381b237fe6
-  data.tar.gz: 84f5459883048c3ee08eb9ee38d6e890d910e4d3a133b39d35eb932603140d70
+  metadata.gz: 242bd9cb947cb4734124d9c281ddf07911b0d8c7a2fe6fdd908546934c1a0dca
+  data.tar.gz: a411c7cf697a15cc5a5c4c618a50795f8c24d1057126e599e82ceb98795cbecd
 SHA512:
-  metadata.gz: badf204f3108464b9e9eaef9884b38f446a7bb26a7f6b72e39e90b6a7a64c474bcc14f22f637cbdeecb6533c487a340ccdfe6d18558b90c10857c8cdbe90c112
-  data.tar.gz: dc5e0266ec8007cd88b41d35164cbb3fa71fc299207779817678f8a75663ecd455ea536a6ee13a0d94cfdfc67ca93f3eaae2feed223dd4059bedcf025d8abb92
+  metadata.gz: aeed377d63e6655d1c4659a0b26a49c633f8ec03e8c1204fdf2553cb1618135ffa09b9ae55923bd291c2674257ec9ba85fb41f2769297ef7703bcce78b5a14a3
+  data.tar.gz: ff670ae6913b44a02b394c264aa5aa9a01215162da762827978774f92f10de736b424be6739145939eca26d1173fd90acd55acc67b714ab75496a23e01628a15

data/CHANGELOG.md

@@ -13,3 +13,14 @@ Some package configurations were added.
 ### Added
 Removed two parameters: optional_callback and return_job_status in the submit_job function in favour of an options hash.
 Introduced return_history and image_links
+
+## [0.2.1] - 2019-09-05
+### Updated
+Updates to the readme
+Update some error messages
+Use the signature class in the Web API class
+Accept more formats as inputs
+Fix the loss of optional_callback
+Ensure that we allow nil inputs or empty hashes for options and id_info
+Confirm the signature when querying the job status
+Add a Utilities class with get_job_status that we use internally to expose a public get_job_status method on WebApi

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (0.2.0)
+    smile-identity-core (0.2.1)
       rubyzip (~> 1.2, >= 1.2.3)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -1,24 +1,34 @@
 # SmileIdentityCore
 
-The official Smile Identity gem exposes two classes namely, the Web API and AuthSmile class.
+The official Smile Identity gem exposes two classes namely, the Web API and Signature class.
 
-The Web API allows you as the Partner to validate a user’s identity against the relevant Identity Authorities/Third Party databases that Smile Identity has access to using ID information provided by your customer/user (including photo for compare).
+The **Web API Class** allows you as the Partner to validate a user’s identity against the relevant Identity Authorities/Third Party databases that Smile Identity has access to using ID information provided by your customer/user (including photo for compare). It has the following public methods:
+- submit_job
+- get_job_status
 
-The Signature class allows you as the Partner to generate a sec key to interact with our servers.
+The **Signature Class** allows you as the Partner to generate a sec key to interact with our servers. It has the following public methods:
+- generate_sec_key
+- confirm_sec_key
+
+<!-- The **Utilities Class** allows you as the Partner to have access to our general Utility functions to gain access to your data. It has the following public methods:
+- get_job_status -->
 
 ## Documentation
 
 This gem requires specific input parameters, for more detail on these parameters please refer to our [documentation for Web API](https://docs-smileid.herokuapp.com/docs#web-api-introduction).
 
-Please note that you will have to be a Smile Identity Partner to be able to query our services.
-## Usage
+Please note that you will have to be a Smile Identity Partner to be able to query our services. You can sign up on the [Portal](https://test-smileid.herokuapp.com/signup?products[]=1-IDVALIDATION&products[]=2-AUTHENTICATION).
+
+## Installation
+
+View the package on [Rubygems](https://rubygems.org/gems/smile-identity-core).
 
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'smile-identity-core'
 ```
-and
+and require the package:
 
 ```ruby
 require 'smile-identity-core'
@@ -30,30 +40,20 @@ Or install it to your system as:
   $ gem install smile-identity-core
 ```
 
-#### Calculating your Signature
-
-```
-$ connection = SmileIdentityCore::AuthSmile.new(partner_id, api_key)
+You now may use the classes as follows:
 
-$ sec_key = connection.generate_sec_key(timestamp)
-where timestamp is optional
+#### Web Api Class
 
+##### submit_job method
 ```
+$ connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
 
-The response will be a hash:
-
-```
-{
-  :sec_key=> "<the generated sec key>",
- :timestamp=> 1563283420
-}
+$ response = connection.submit_job(partner_params, images, id_info, options)
 ```
 
-#### Web api
+Please note that if you do not need to pass through id_info or options, you may omit calling those class and send through nil in submit_job, as follows:
 ```
-$ connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
-
-$ response = connection.submit_job(partner_params, images, optional_callback, return_job_status)
+String response = connection.submit_job(partner_params, images, nil, nil);
 ```
 
 The response will be nil if you chose to set return_job_status to false, however if you have set return_job_status to true then you will receive a response like below:
@@ -100,13 +100,81 @@ You can also view your response asynchronously at the callback that you have set
 }
 ```
 
+##### get_job_status method
+Sometimes, you may want to get a particular job status at a later time. You may use the get_job_status function to do this:
+
+You will already have your Web Api class initialised as follows:
+```ruby
+  connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
+```
+
+Thereafter, simply call get_job_status with the correct parameters:
+```ruby
+  response = connection.get_job_status(partner_params, options)
+
+  where options is {return_history: true | false, return_image_links: true | false}
+```
+
+Please note that if you do not need to pass through options if you will not be using them, you may omit pass through an empty hash or nil instead:
+```ruby
+response = connection.get_job_status(partner_params, nil);
+```
+
+#### Signature Class
+
+##### generate_sec_key method
+
+```
+$ connection = SmileIdentityCore::Signature.new(partner_id, api_key)
+
+$ sec_key = connection.generate_sec_key(timestamp)
+where timestamp is optional
+
+```
+
+The response will be a hash:
+
+```
+{
+  :sec_key=> "<the generated sec key>",
+ :timestamp=> 1563283420
+}
+```
+
+##### confirm_sec_key method
+
+You can also confirm the signature that you receive when you interacting with our servers, simply use the confirm_sec_key method which returns a boolean:
+
+```ruby
+$ connection = SmileIdentityCore::Signature.new(partner_id, api_key)
+$ sec_key = connection.confirm_sec_key(sec_key, timestamp)
+```
+
+<!-- #### Utilities Class
+
+You may want to receive more information about a job. This is built into Web Api if you choose to set return_job_status as true in the options hash. However, you also have the option to build the functionality yourself by using the Utilities class. Please note that if you are querying a job immediately after submitting it, you will need to poll it for the duration of the job.
+
+```java
+
+
+utilities_connection = SmileIdentityCore::Utilities.new('partner_id', 'api_key' , sid_server)
+
+utilities_connection.get_job_status('user_id', 'job_id', options)
+where options is {return_history: true | false, return_image_links: true | false}
+``` -->
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests. 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 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 release a new version:
+- Update the version number in `version.rb`
+- Run `gem build smile-identity-core.gemspec`
+- Thereafter `gem push smile-identity-core-version.gem`.
 
-Please note that you should tag the release when doing a push to rubygems.
+Make sure to git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/smile-identity-core/signature.rb

@@ -7,16 +7,34 @@ module SmileIdentityCore
     end
 
     def generate_sec_key(timestamp=Time.now.to_i)
-      @timestamp = timestamp
+      begin
+        @timestamp = timestamp
 
-      hash_signature = Digest::SHA256.hexdigest([@partner_id, @timestamp].join(":"))
-      public_key = OpenSSL::PKey::RSA.new(Base64.strict_decode64(@api_key))
-      @sec_key = [Base64.strict_encode64(public_key.public_encrypt(hash_signature)), hash_signature].join('|')
+        hash_signature = Digest::SHA256.hexdigest([@partner_id, @timestamp].join(":"))
+        public_key = OpenSSL::PKey::RSA.new(Base64.strict_decode64(@api_key))
+        @sec_key = [Base64.strict_encode64(public_key.public_encrypt(hash_signature)), hash_signature].join('|')
 
-      return {
-        sec_key: @sec_key,
-        timestamp: @timestamp
-      }
-  end
+        return {
+          sec_key: @sec_key,
+          timestamp: @timestamp
+        }
+      rescue => e
+        raise e
+      end
+    end
+
+    def confirm_sec_key(timestamp, sec_key)
+      begin
+        hash_signature = Digest::SHA256.hexdigest([@partner_id, timestamp].join(":"))
+        encrypted = sec_key.split('|')[0]
+
+        public_key = OpenSSL::PKey::RSA.new(Base64.strict_decode64(@api_key))
+        decrypted = public_key.public_decrypt(Base64.strict_decode64(encrypted))
+
+        return decrypted == hash_signature
+      rescue => e
+        raise e
+      end
+    end
   end
 end

data/lib/smile-identity-core/utilities.rb

@@ -0,0 +1,83 @@
+module SmileIdentityCore
+  class Utilities
+
+    def initialize(partner_id, api_key, sid_server)
+      @partner_id = partner_id.to_s
+      @api_key = api_key
+
+      if !(sid_server =~ URI::regexp)
+        sid_server_mapping = {
+          0 => 'https://3eydmgh10d.execute-api.us-west-2.amazonaws.com/test',
+          1 => 'https://la7am6gdm8.execute-api.us-west-2.amazonaws.com/prod'
+        }
+        @url = sid_server_mapping[sid_server.to_i]
+      else
+        @url = sid_server
+      end
+
+      @signature_connection = SmileIdentityCore::Signature.new(@partner_id, @api_key)
+
+    end
+
+    def get_job_status(user_id, job_id, options = {})
+
+      if(options.nil? || options.empty?)
+        options = {
+          return_history: false,
+          return_job_status: false
+        }
+      end
+
+      @timestamp = Time.now.to_i
+      return query_job_status(user_id, job_id, symbolize_keys(options))
+    end
+
+    private
+
+    def symbolize_keys params
+      (params.is_a?(Hash)) ? Hash[params.map{ |k, v| [k.to_sym, v] }] : params
+    end
+
+    def query_job_status(user_id, job_id, options)
+      url = "#{@url}/job_status"
+
+      request = Typhoeus::Request.new(
+        url,
+        headers: {'Content-Type': 'application/json', 'Accept': 'application/json'},
+        method: :post,
+        body: configure_job_query(user_id, job_id, options)
+      )
+
+      request.on_complete do |response|
+        begin
+          body = JSON.parse(response.body)
+
+          valid = @signature_connection.confirm_sec_key(body['timestamp'], body['signature'])
+
+          if(!valid)
+            raise "Unable to confirm validity of the job_status response"
+          end
+
+          return body
+        rescue => e
+          raise e
+        end
+      end
+
+      request.run
+    end
+
+    def configure_job_query(user_id, job_id, options)
+      return {
+        sec_key: @signature_connection.generate_sec_key(@timestamp)[:sec_key],
+        timestamp: @timestamp,
+        user_id: user_id,
+        job_id: job_id,
+        partner_id: @partner_id,
+        image_links: options[:return_image_links] || false,
+        history:  options[:return_history] || false
+      }.to_json
+    end
+
+  end
+end

data/lib/smile-identity-core/version.rb

@@ -1,3 +1,3 @@
 module SmileIdentityCore
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/smile-identity-core/web_api.rb

@@ -15,6 +15,7 @@ module SmileIdentityCore
       @callback_url = default_callback
       @api_key = api_key
 
+      @sid_server = sid_server
       if !(sid_server =~ URI::regexp)
         sid_server_mapping = {
           0 => 'https://3eydmgh10d.execute-api.us-west-2.amazonaws.com/test',
@@ -24,22 +25,21 @@ module SmileIdentityCore
       else
         @url = sid_server
       end
-
     end
 
     def submit_job(partner_params, images, id_info, options)
-      self.partner_params = partner_params
+      self.partner_params = symbolize_keys partner_params
       self.images = images
       @timestamp = Time.now.to_i
 
-      self.id_info = id_info
-      self.options = options
+      self.id_info = symbolize_keys id_info
+      self.options = symbolize_keys options
 
-      if options[:optional_callback] && options[:optional_callback].length > 0
-        @callback_url = options[:optional_callback]
+      if @options[:optional_callback] && @options[:optional_callback].length > 0
+        @callback_url = @options[:optional_callback]
       end
 
-      if partner_params[:job_type].to_i == 1
+      if @partner_params[:job_type].to_i == 1
         validate_enroll_with_id
       end
 
@@ -48,13 +48,24 @@ module SmileIdentityCore
       return setup_requests
     end
 
+    def get_job_status(partner_params, options)
+      partner_params = symbolize_keys partner_params
+      @timestamp = Time.now.to_i
+
+      user_id = partner_params[:user_id]
+      job_id = partner_params[:job_id]
+
+      utilities = SmileIdentityCore::Utilities.new(@partner_id, @api_key, @sid_server)
+      return utilities.get_job_status(user_id, job_id, options);
+    end
+
     def partner_params=(partner_params)
       if partner_params == nil
         raise ArgumentError.new('Please ensure that you send through partner params')
       end
 
       if !partner_params.is_a?(Hash)
-        raise ArgumentError.new('Partner params needs to be an object')
+        raise ArgumentError.new('Partner params needs to be a hash')
       end
 
       [:user_id, :job_id, :job_type].each do |key|
@@ -80,11 +91,28 @@ module SmileIdentityCore
         raise ArgumentError.new('You need to send through at least one selfie image')
       end
 
-      @images = images
+      @images = images.map { |image| symbolize_keys image }
     end
 
     def id_info=(id_info)
-      if id_info[:entered] == 'true'
+
+      updated_id_info = id_info
+
+      if updated_id_info.nil?
+        updated_id_info = {}
+      end
+
+      # if it doesnt exist, set it false
+      if(!updated_id_info.key?(:entered) || id_info[:entered].empty?)
+        updated_id_info[:entered] = "false"
+      end
+
+      # if it's a boolean
+      if(!!updated_id_info[:entered] == updated_id_info[:entered])
+        updated_id_info[:entered] = id_info[:entered].to_s
+      end
+
+      if updated_id_info[:entered] && updated_id_info[:entered] == 'true'
         [:first_name, :last_name, :country, :id_type, :id_number].each do |key|
           unless id_info[key] && !id_info[key].nil? && !id_info[key].empty?
             raise ArgumentError.new("Please make sure that #{key.to_s} is included in the id_info")
@@ -92,14 +120,25 @@ module SmileIdentityCore
         end
       end
 
-      @id_info = id_info
+      if updated_id_info[:country] && updated_id_info[:country].upcase == 'NG' && ['PASSPORT', 'VOTER_ID', 'DRIVERS_LICENSE', 'NATIONAL_ID', 'TIN', 'CAC'].include?(updated_id_info[:id_type].upcase) && (!updated_id_info[:dob] || updated_id_info[:dob].empty? || updated_id_info[:dob].nil?)
+        raise ArgumentError.new("The ID type #{updated_id_info[:id_type]} for #{updated_id_info[:country]} requires a valid dob paramater.")
+      end
+
+      @id_info = updated_id_info
     end
 
     def options=(options)
-      updated_options = {}
+      updated_options = options
+
+      if updated_options.nil?
+        updated_options = {}
+      end
+
       [:optional_callback, :return_job_status, :return_image_links, :return_history].map do |key|
         if key != :optional_callback
-          updated_options[key] = check_boolean(key, options[key])
+          updated_options[key] = check_boolean(key, options)
+        else
+          updated_options[key] = check_string(key, options)
         end
       end
 
@@ -108,6 +147,10 @@ module SmileIdentityCore
 
     private
 
+    def symbolize_keys params
+      (params.is_a?(Hash)) ? Hash[params.map{ |k, v| [k.to_sym, v] }] : params
+    end
+
     def validate_return_data
       if (!@callback_url || @callback_url.empty?) && !@options[:return_job_status]
         raise ArgumentError.new("Please choose to either get your response via the callback or job status query")
@@ -120,26 +163,33 @@ module SmileIdentityCore
       end
     end
 
-    def check_boolean(key, bool)
-      if (!bool)
-        bool = false;
+    def check_boolean(key, obj)
+      if (!obj || !obj[key])
+        return false
       end
 
-      if !!bool != bool
+      if !!obj[key] != obj[key]
         raise ArgumentError.new("#{key} needs to be a boolean")
       end
 
-      return bool
+      return obj[key]
+    end
+
+    def check_string(key, obj)
+      if (!obj || !obj[key])
+        return ''
+      else
+        return obj[key]
+      end
     end
 
     def determine_sec_key
-      hash_signature = Digest::SHA256.hexdigest([@partner_id.to_i, @timestamp].join(":"))
-      public_key = OpenSSL::PKey::RSA.new(Base64.decode64(@api_key))
-      @sec_key = [Base64.encode64(public_key.public_encrypt(hash_signature)), hash_signature].join('|')
+      @sec_key = SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_sec_key(@timestamp)[:sec_key]
     end
 
     def configure_prep_upload_json
-      body =  {
+
+      body = {
         file_name: 'selfie.zip',
         timestamp: @timestamp,
         sec_key: determine_sec_key,
@@ -182,7 +232,6 @@ module SmileIdentityCore
         end
       end
       request.run
-
     end
 
     def configure_info_json(server_information)
@@ -276,6 +325,7 @@ module SmileIdentityCore
       request.on_complete do |response|
         if response.success?
           if @options[:return_job_status]
+            @utilies_connection = SmileIdentityCore::Utilities.new(@partner_id, @api_key, @sid_server)
             return query_job_status
           else
             return
@@ -295,51 +345,17 @@ module SmileIdentityCore
     end
 
     def query_job_status(counter=0)
-      job_complete = false
       counter < 4 ? (sleep 2) : (sleep 6)
       counter += 1
 
-      body = {
-        sec_key: @sec_key,
-        timestamp: @timestamp,
-        user_id: @partner_params[:user_id],
-        job_id: @partner_params[:job_id],
-        partner_id: @partner_id,
-        image_links: @options[:return_image_links],
-        history: @options[:return_history]
-      }.to_json
-
-      url = "#{@url}/job_status"
+      response = @utilies_connection.get_job_status(@partner_params[:user_id], @partner_params[:job_id], @options)
 
-      request = Typhoeus::Request.new(
-        url,
-        headers: {'Content-Type': 'application/json', 'Accept': 'application/json'},
-        method: :post,
-        body: body
-      )
-
-      request.on_complete do |response|
-
-        if response.code == 0
-          return query_job_status(counter)
-        else
-          begin
-            status_body = JSON.load(response.body)
-            job_complete = status_body['job_complete'].to_s
-          rescue => e
-            puts e.message
-            puts e.backtrace
-          end
-
-          if job_complete == 'true' || counter == 20
-            return JSON.parse(response.body)
-          else
-            return query_job_status(counter)
-          end
-        end
+      if response && (response['job_complete'] == true || counter == 20)
+        return response
+      else
+        return query_job_status(counter)
       end
 
-      request.run
     end
   end
 end

data/lib/smile-identity-core.rb

@@ -1,6 +1,7 @@
 require "smile-identity-core/version"
 require "smile-identity-core/web_api.rb"
 require "smile-identity-core/signature.rb"
+require "smile-identity-core/utilities.rb"
 
 module SmileIdentityCore
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smile-identity-core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ridhwana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-14 00:00:00.000000000 Z
+date: 2019-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,9 +125,9 @@ files:
 - bin/setup
 - lib/smile-identity-core.rb
 - lib/smile-identity-core/signature.rb
+- lib/smile-identity-core/utilities.rb
 - lib/smile-identity-core/version.rb
 - lib/smile-identity-core/web_api.rb
-- smile-identity-core-0.1.0.gem
 - smile-identity-core.gemspec
 - travis.yml
 homepage: https://www.smileidentity.com/