smile-identity-core 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b6be5ffaad64aa13c654eca628db1437da28d46a1e3d4b3564b373e4132508
-  data.tar.gz: 1042167bb8981ac85cf0a1dbf466f2b099ca5468b013e62119a322582a879c9c
+  metadata.gz: 9614cb861ac00a8133527a647e8d6c6dcc91b00aca6c7fe643e32ddc986b3f7d
+  data.tar.gz: f1ac7dcb3413c1f08ac16c909e0f466091519dae0412519a1161cd0179143040
 SHA512:
-  metadata.gz: f301a2f41634473bb47393dc5992f30f381a8088250aa2ebfc7739003384c52a37031182fc6e048b78227e990c465659f18fcc0d39bd4efc65ecc48d285325ce
-  data.tar.gz: ba2e07c8c8f68117f7343bf0949277999a3e48ec770a50bfdd51ab0f98690d4219d2f989bbe436a558a9ca9adc3092607ae427911f2fc68e1233e94c33267f47
+  metadata.gz: db1d5e0344e58bb11728af749ef1b37f051add89fdda7797347d0771d091b3221482d90beed6f566d082d4120c9c2d45d63e0dea828202ff9c087d58c498094e
+  data.tar.gz: f524bd93102a7ac6621314a950b5fba0b06a62437f1ad4328e26c092192ffa74ccc9ce5919d1806e126a5d2d9305b9ad204e913da13cf02f1c31079d5775dc70

data/.travis.yml

@@ -1,7 +1,11 @@
 ---
+dist: bionic
 sudo: false
 language: ruby
 cache: bundler
 rvm:
   - 2.5.1
-before_install: gem install bundler -v 2.0.2
+  - 2.6
+  - 2.7
+  - 3.0
+before_install: gem install bundler -v 2.2.6

data/CHANGELOG.md

@@ -39,3 +39,11 @@ Amend the success response when job status is false to be a JSON String containi
 Add the ID API Class
 Add the ability to query ID Api from the Web API class
 Update the documentation
+
+## [1.0.1] - 2019-10-24
+## Updated
+Remove first_name and last_name validations from id information in Web Api
+Add country, id_number and id_type validations for id information in ID Api
+
+## [1.0.2] - 2020-01-16
+Add {"success":true,"smile_job_id":"job_id"} to the response when we poll job status too

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    smile-identity-core (1.0.0)
+    smile-identity-core (1.2.0)
       rubyzip (~> 1.2, >= 1.2.3)
       typhoeus (~> 1.0, >= 1.0.1)
 
@@ -12,8 +12,8 @@ GEM
     docile (1.1.5)
     ethon (0.12.0)
       ffi (>= 1.3.0)
-    ffi (1.11.1)
-    json (2.2.0)
+    ffi (1.13.1)
+    json (2.5.1)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -34,7 +34,7 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    typhoeus (1.3.1)
+    typhoeus (1.4.0)
       ethon (>= 0.9.0)
 
 PLATFORMS
@@ -48,4 +48,4 @@ DEPENDENCIES
   smile-identity-core!
 
 BUNDLED WITH
-   2.0.2
+   2.2.6

data/README.md

@@ -1,12 +1,13 @@
-# SmileIdentityCore
+# SmileIdentityCore [![Build Status](https://travis-ci.com/smileidentity/smile-identity-core-ruby.svg?branch=master)](https://travis-ci.com/smileidentity/smile-identity-core-ruby)
 
-The official Smile Identity gem exposes three classes namely, the Web API and Signature class.
+The official Smile Identity gem exposes four classes namely; the Web Api class, the ID Api class, the Signature class and the Utilities class.
 
-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:
+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
+- get_web_token
 
-The **ID Class** lets you performs basic KYC Services including verifying an ID number as well as retrieve a user's Personal Information. It has the following public methods:
+The **ID Api Class** lets you performs basic KYC Services including verifying an ID number as well as retrieve a user's Personal Information. It has the following public methods:
 - submit_job
 
 The **Signature Class** allows you as the Partner to generate a sec key to interact with our servers. It has the following public methods:
@@ -20,7 +21,7 @@ The **Utilities Class** allows you as the Partner to have access to our general
 
 This gem requires specific input parameters, for more detail on these parameters please refer to our [documentation for Web API](https://docs.smileidentity.com).
 
-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).
+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://portal.smileidentity.com/signup).
 
 ## Installation
 
@@ -39,7 +40,7 @@ require 'smile-identity-core'
 
 Or install it to your system as:
 
-```
+```sh
   $ gem install smile-identity-core
 ```
 
@@ -48,33 +49,33 @@ You now may use the classes as follows:
 #### Web Api Class
 
 ##### submit_job method
-```
-$ connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
+```ruby
+connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
 
-$ response = connection.submit_job(partner_params, images, id_info, options)
+response = connection.submit_job(partner_params, images, id_info, options)
 ```
 
 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:
 
-```
-$ response = connection.submit_job(partner_params, images, nil, nil);
+```ruby
+response = connection.submit_job(partner_params, images, nil, nil);
 ```
 
 In the case of a Job Type 5 you can simply omit the the images and options keys. Remember that the response is immediate, so there is no need to query the job_status. There is also no enrollment so no images are required. The response for a job type 5 can be found in the response section below.
 
-```
-$ response = connection.submit_job(partner_params, nil, id_info, nil);
+```ruby
+response = connection.submit_job(partner_params, nil, id_info, nil);
 ```
 
 **Response:**
 
 Should you choose to *set return_job_status to false*, the response will be a JSON String containing:
-```
+```ruby
 {success: true, smile_job_id: smile_job_id}
 ```
 
 However, if you have *set return_job_status to true (with image_links and history)* then you will receive JSON Object response like below:
-```
+```json
 {
    "job_success":true,
    "result":{
@@ -150,7 +151,7 @@ However, if you have *set return_job_status to true (with image_links and histor
 ```
 
 You can also *view your response asynchronously at the callback* that you have set, it will look as follows:
-```
+```json
 {
    "job_success":true,
    "result":{
@@ -226,7 +227,7 @@ You can also *view your response asynchronously at the callback* that you have s
 ```
 
 If you have queried a job type 5, your response be a JSON String that will contain the following:
-```
+```json
 {
    "JSONVersion":"1.0.0",
    "SmileJobID":"0000001105",
@@ -279,7 +280,7 @@ response = connection.get_job_status(partner_params, nil);
 
 Your response will return a JSON Object below with image_links and history included:
 
-```
+```json
 {
    "job_success":true,
    "result":{
@@ -354,20 +355,54 @@ Your response will return a JSON Object below with image_links and history inclu
 }
 ```
 
+##### get_web_token method
+ You may want to use our hosted web integration, and create a session. The `get_web_token` method enables this.
+ You have your Web Api class initialised as follows:
+ ```ruby
+ connection = SmileIdentityCore::WebApi.new(partner_id, default_callback, api_key, sid_server)
+
+ ```
+
+ Next, you'll need to create your request params. This should take the following
+ structure:
+
+ ```ruby
+ {
+ 	user_id: 'user-1', # String: required
+ 	job_id: 'job-1', # String: required
+ 	product: 'authentication', # String: required one of 'authentication', 'identity_verification', 'smartselfie', 'ekyc_smartselfie', 'enhanced_kyc', 'document_verification'
+ 	callback_url: "https://smileidentity.com/callback" # String: required, optional if callback url was set during instantiation of the class
+ }
+ ```
+
+ Thereafter, call `get_web_token` with the correct parameters:
+ ```ruby
+   response = connection.get_web_token(request_params)
+ ```
+
+ **Response**
+
+ Your response will return a hash that contains
+ ```ruby
+ {
+ 	token: <token_string>
+ }
+ ```
+
 #### ID Api Class
 
 
 ##### submit_job method
-```
-$ connection = SmileIdentityCore::IDApi.new(partner_id, api_key, sid_server)
+```ruby
+connection = SmileIdentityCore::IDApi.new(partner_id, api_key, sid_server)
 
-$ response = connection.submit_job(partner_params, id_info)
+response = connection.submit_job(partner_params, id_info)
 ```
 
 **Response**
 
 Your response will return a JSON String containing the below:
-```
+```json
 {
    "JSONVersion":"1.0.0",
    "SmileJobID":"0000001105",
@@ -400,17 +435,17 @@ Your response will return a JSON String containing the below:
 
 ##### generate_sec_key method
 
-```
-$ connection = SmileIdentityCore::Signature.new(partner_id, api_key)
+```ruby
+connection = SmileIdentityCore::Signature.new(partner_id, api_key)
 
-$ sec_key = connection.generate_sec_key(timestamp)
+sec_key = connection.generate_sec_key(timestamp)
 where timestamp is optional
 
 ```
 
 The response will be a hash:
 
-```
+```ruby
 {
   :sec_key=> "<the generated sec key>",
  :timestamp=> 1563283420
@@ -422,8 +457,8 @@ The response will be a hash:
 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)
+connection = SmileIdentityCore::Signature.new(partner_id, api_key)
+sec_key = connection.confirm_sec_key(sec_key, timestamp)
 ```
 
 #### Utilities Class
@@ -443,13 +478,23 @@ After checking out the repo, run `bundle install` to install dependencies. Then,
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+You can use `bundle console` and then call the necessary classes with their parameters.
+
+## Testing
+
+Run `bundle exec rspec` to run the tests.
+After running your tests open the coverage/index.html to view the test coverage
+
+## Deployment
+
 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`.
+- Thereafter `gem push smile-identity-core-<version>.gem`.
 
 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
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/smileidentity/smile-identity-core

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

@@ -8,8 +8,8 @@ module SmileIdentityCore
       @sid_server = sid_server
       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'
+          0 => 'https://testapi.smileidentity.com/v1',
+          1 => 'https://api.smileidentity.com/v1',
         }
         @url = sid_server_mapping[sid_server.to_i]
       else
@@ -17,32 +17,30 @@ module SmileIdentityCore
       end
     end
 
-    def submit_job(partner_params, id_info)
+    def submit_job(partner_params, id_info, options = {})
       self.partner_params = symbolize_keys partner_params
-
-      @timestamp = Time.now.to_i
-
       self.id_info = symbolize_keys id_info
+      @use_new_signature = symbolize_keys(options || {}).fetch(:signature, false)
 
       if @partner_params[:job_type].to_i != 5
-        raise ArgumentError.new('Please ensure that you are setting your job_type to 5 to query ID Api')
+        raise ArgumentError, 'Please ensure that you are setting your job_type to 5 to query ID Api'
       end
 
-      return setup_requests
+      setup_requests
     end
 
     def partner_params=(partner_params)
       if partner_params == nil
-        raise ArgumentError.new('Please ensure that you send through partner params')
+        raise ArgumentError, 'Please ensure that you send through partner params'
       end
 
       if !partner_params.is_a?(Hash)
-        raise ArgumentError.new('Partner params needs to be a hash')
+        raise ArgumentError, 'Partner params needs to be a hash'
       end
 
       [:user_id, :job_id, :job_type].each do |key|
         unless partner_params[key] && !partner_params[key].nil? && !(partner_params[key].empty? if partner_params[key].is_a?(String))
-          raise ArgumentError.new("Please make sure that #{key.to_s} is included in the partner params")
+          raise ArgumentError, "Please make sure that #{key} is included in the partner params"
         end
       end
 
@@ -54,10 +52,14 @@ module SmileIdentityCore
       updated_id_info = id_info
 
       if updated_id_info.nil? ||  updated_id_info.keys.length == 0
-        raise ArgumentError.new("Please make sure that id_info not empty or nil")
+        raise ArgumentError, 'Please make sure that id_info not empty or nil'
       end
 
-      # maybe do some validation on consistent required fields like id_type and id_number
+      [:country, :id_type, :id_number].each do |key|
+        unless updated_id_info[key] && !updated_id_info[key].nil? && !updated_id_info[key].empty?
+          raise ArgumentError, "Please make sure that #{key} is included in the id_info"
+        end
+      end
 
       @id_info = updated_id_info
     end
@@ -95,20 +97,28 @@ module SmileIdentityCore
     end
 
     def configure_json
-      body = {
-        timestamp: @timestamp,
-        sec_key: determine_sec_key,
-        partner_id: @partner_id,
-        partner_params: @partner_params
-      }
-
-      body.merge!(@id_info)
-      JSON.generate(body)
+      request_security(use_new_signature: @use_new_signature)
+        .merge(@id_info)
+        .merge(
+          partner_id: @partner_id,
+          partner_params: @partner_params)
+        .to_json
     end
 
-    def determine_sec_key
-      @sec_key = SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_sec_key(@timestamp)[:sec_key]
+    def request_security(use_new_signature: true)
+      if use_new_signature
+        @timestamp = Time.now.to_s
+        {
+          signature: SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(@timestamp)[:signature],
+          timestamp: @timestamp,
+        }
+      else
+        @timestamp = Time.now.to_i
+        {
+          sec_key: SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_sec_key(@timestamp)[:sec_key],
+          timestamp: @timestamp,
+        }
+      end
     end
-
   end
 end

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

@@ -3,7 +3,7 @@ module SmileIdentityCore
 
     def initialize(partner_id, api_key)
       @api_key = api_key
-      @partner_id = partner_id.to_i
+      @partner_id = partner_id
     end
 
     def generate_sec_key(timestamp=Time.now.to_i)
@@ -14,7 +14,7 @@ module SmileIdentityCore
         public_key = OpenSSL::PKey::RSA.new(Base64.decode64(@api_key))
         @sec_key = [Base64.encode64(public_key.public_encrypt(hash_signature)), hash_signature].join('|')
 
-        return {
+        {
           sec_key: @sec_key,
           timestamp: @timestamp
         }
@@ -31,10 +31,26 @@ module SmileIdentityCore
         public_key = OpenSSL::PKey::RSA.new(Base64.decode64(@api_key))
         decrypted = public_key.public_decrypt(Base64.decode64(encrypted))
 
-        return decrypted == hash_signature
+        decrypted == hash_signature
       rescue => e
         raise e
       end
     end
+
+    def generate_signature(timestamp=Time.now.to_s)
+      hmac = OpenSSL::HMAC.new(@api_key, 'sha256')
+      hmac.update(timestamp.to_s)
+      hmac.update(@partner_id)
+      hmac.update("sid_request")
+      signature = Base64.strict_encode64(hmac.digest())
+      {
+        signature: signature,
+        timestamp: timestamp.to_s
+      }
+    end
+
+    def confirm_signature(timestamp, msg_signature)
+      generate_signature(timestamp)[:signature] == msg_signature
+    end
   end
 end

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

@@ -7,8 +7,8 @@ module SmileIdentityCore
 
       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'
+          0 => 'https://testapi.smileidentity.com/v1',
+          1 => 'https://api.smileidentity.com/v1',
         }
         @url = sid_server_mapping[sid_server.to_i]
       else
@@ -20,16 +20,12 @@ module SmileIdentityCore
     end
 
     def get_job_status(user_id, job_id, options = {})
+      options = symbolize_keys(options || {})
+      options[:return_history] ||= false
+      options[:return_image_links] ||= false
 
-      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))
+      security = request_security(use_new_signature: options.fetch(:signature, false))
+      query_job_status(configure_job_query(user_id, job_id, options).merge(security))
     end
 
     private
@@ -38,21 +34,30 @@ module SmileIdentityCore
       (params.is_a?(Hash)) ? Hash[params.map{ |k, v| [k.to_sym, v] }] : params
     end
 
-    def query_job_status(user_id, job_id, options)
+    def query_job_status(request_json_data)
       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)
+        body: request_json_data.to_json
       )
 
       request.on_complete do |response|
         begin
           body = JSON.parse(response.body)
 
-          valid = @signature_connection.confirm_sec_key(body['timestamp'], body['signature'])
+          # NB: we have to trust that the server will return the right kind of
+          # timestamp (integer or string) for the signature, and the right kind
+          # of signature in the "signature" field. The best way to know what
+          # kind of validation to perform is by remembering which kind of
+          # security we started with.
+          if request_json_data.has_key?(:sec_key)
+            valid = @signature_connection.confirm_sec_key(body['timestamp'], body['signature'])
+          else
+            valid = @signature_connection.confirm_signature(body['timestamp'], body['signature'])
+          end
 
           if(!valid)
             raise "Unable to confirm validity of the job_status response"
@@ -67,17 +72,30 @@ module SmileIdentityCore
       request.run
     end
 
+    def request_security(use_new_signature: false)
+      if use_new_signature
+        @timestamp = Time.now.to_s
+        {
+          signature: @signature_connection.generate_signature(@timestamp)[:signature],
+          timestamp: @timestamp,
+        }
+      else
+        @timestamp = Time.now.to_i
+        {
+          sec_key: @signature_connection.generate_sec_key(@timestamp)[:sec_key],
+          timestamp: @timestamp,
+        }
+      end
+    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
+        image_links: options[:return_image_links],
+        history:  options[:return_history]
+      }
     end
-
   end
 end

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

@@ -1,3 +1,8 @@
 module SmileIdentityCore
-  VERSION = "1.0.0"
+  VERSION = "1.2.0"
+
+  def self.version_as_hash
+    major, minor, patch = *VERSION.split('.')
+    { majorVersion: major, minorVersion: minor, buildNumber: patch }
+  end
 end

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

@@ -18,8 +18,8 @@ module SmileIdentityCore
       @sid_server = sid_server
       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'
+          0 => 'https://testapi.smileidentity.com/v1',
+          1 => 'https://api.smileidentity.com/v1',
         }
         @url = sid_server_mapping[sid_server.to_i]
       else
@@ -35,8 +35,6 @@ module SmileIdentityCore
       end
 
       self.images = images
-      @timestamp = Time.now.to_i
-
       self.id_info = symbolize_keys id_info
       self.options = symbolize_keys options
 
@@ -50,7 +48,7 @@ module SmileIdentityCore
 
       validate_return_data
 
-      return setup_requests
+      setup_requests
     end
 
     def get_job_status(partner_params, options)
@@ -61,21 +59,21 @@ module SmileIdentityCore
       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);
+      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')
+        raise ArgumentError, 'Please ensure that you send through partner params'
       end
 
       if !partner_params.is_a?(Hash)
-        raise ArgumentError.new('Partner params needs to be a hash')
+        raise ArgumentError, 'Partner params needs to be a hash'
       end
 
       [:user_id, :job_id, :job_type].each do |key|
         unless partner_params[key] && !partner_params[key].nil? && !(partner_params[key].empty? if partner_params[key].is_a?(String))
-          raise ArgumentError.new("Please make sure that #{key.to_s} is included in the partner params")
+          raise ArgumentError, "Please make sure that #{key} is included in the partner params"
         end
       end
 
@@ -84,19 +82,20 @@ module SmileIdentityCore
 
     def images=(images)
       if images == nil
-        raise ArgumentError.new('Please ensure that you send through image details')
+        raise ArgumentError, 'Please ensure that you send through image details'
       end
 
       if !images.is_a?(Array)
-        raise ArgumentError.new('Image details needs to be an array')
+        raise ArgumentError, 'Image details needs to be an array'
       end
 
       # all job types require atleast a selfie
       if images.length == 0 || images.none? {|h| h[:image_type_id] == 0 || h[:image_type_id] == 2 }
-        raise ArgumentError.new('You need to send through at least one selfie image')
+        raise ArgumentError, 'You need to send through at least one selfie image'
       end
 
       @images = images.map { |image| symbolize_keys image }
+
     end
 
     def id_info=(id_info)
@@ -118,53 +117,73 @@ module SmileIdentityCore
       end
 
       if updated_id_info[:entered] && updated_id_info[:entered] == 'true'
-        [:first_name, :last_name, :country, :id_type, :id_number].each do |key|
+        [: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")
+            raise ArgumentError, "Please make sure that #{key.to_s} is included in the id_info"
           end
         end
       end
 
-      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 = 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)
-        else
-          updated_options[key] = check_string(key, options)
-        end
-      end
+      updated_options[:optional_callback] = check_string(:optional_callback, options)
+      updated_options[:return_job_status] = check_boolean(:return_job_status, options)
+      updated_options[:return_image_links] = check_boolean(:return_image_links, options)
+      updated_options[:return_history] = check_boolean(:return_history, options)
+      @use_new_signature = updated_options.fetch(:signature, false)
 
       @options = updated_options
     end
 
+    def get_web_token(request_params)
+      raise ArgumentError, 'Please ensure that you send through request params' if request_params.nil?
+      raise ArgumentError, 'Request params needs to be an object' unless request_params.is_a?(Hash)
+
+      callback_url = request_params[:callback_url] || @callback_url
+      request_params[:callback_url] = callback_url
+
+      keys = %i[user_id job_id product callback_url]
+      blank_keys = get_blank_keys(keys, request_params)
+      error_message = "#{blank_keys.join(', ')} #{blank_keys.length > 1 ? 'are' : 'is'} required to get a web token"
+      raise ArgumentError, error_message unless blank_keys.empty?
+
+      request_web_token(request_params)
+    end
+
     private
 
+    def request_web_token(request_params)
+      request_params.merge!({ partner_id: @partner_id }).merge!(request_security)
+      url = "#{@url}/token"
+
+      response = Typhoeus.post(
+        url,
+        headers: { 'Content-Type' => 'application/json' },
+        body: request_params.to_json
+      )
+
+      return response.body if response.code == 200
+
+      raise "#{response.code}: #{response.body}"
+    end
+
     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")
+        raise ArgumentError, 'Please choose to either get your response via the callback or job status query'
       end
     end
 
     def validate_enroll_with_id
       if(((@images.none? {|h| h[:image_type_id] == 1 || h[:image_type_id] == 3 }) && @id_info[:entered] != 'true'))
-        raise ArgumentError.new("You are attempting to complete a job type 1 without providing an id card image or id info")
+        raise ArgumentError, 'You are attempting to complete a job type 1 without providing an id card image or id info'
       end
     end
 
@@ -174,37 +193,54 @@ module SmileIdentityCore
       end
 
       if !!obj[key] != obj[key]
-        raise ArgumentError.new("#{key} needs to be a boolean")
+        raise ArgumentError, "#{key} needs to be a boolean"
       end
 
-      return obj[key]
+      obj[key]
     end
 
     def check_string(key, obj)
       if (!obj || !obj[key])
-        return ''
+        ''
       else
-        return obj[key]
+        obj[key]
       end
     end
 
-    def determine_sec_key
-      @sec_key = SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_sec_key(@timestamp)[:sec_key]
+    def blank?(obj, key)
+      return obj[key].empty? if obj[key].respond_to?(:empty?)
+
+      obj[key].nil?
     end
 
-    def configure_prep_upload_json
+    def get_blank_keys(keys, obj)
+      keys.select { |key| blank?(obj, key) }
+    end
 
-      body = {
+    def request_security(use_new_signature: true)
+      if use_new_signature
+        @timestamp = Time.now.to_s
+        {
+          signature: SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(@timestamp)[:signature],
+          timestamp: @timestamp,
+        }
+      else
+        @timestamp = Time.now.to_i
+        {
+          sec_key: SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_sec_key(@timestamp)[:sec_key],
+          timestamp: @timestamp,
+        }
+      end
+    end
+
+    def configure_prep_upload_json
+      request_security(use_new_signature: @use_new_signature).merge(
         file_name: 'selfie.zip',
-        timestamp: @timestamp,
-        sec_key: determine_sec_key,
         smile_client_id: @partner_id,
         partner_params: @partner_params,
         model_parameters: {}, # what is this for
         callback_url: @callback_url
-      }
-
-      JSON.generate(body)
+      ).to_json
     end
 
     def setup_requests
@@ -219,6 +255,12 @@ module SmileIdentityCore
 
       request.on_complete do |response|
         if response.success?
+          # TODO: if/when we sign these responses, verify the signature here and raise if it's off.
+          # if updated_options[:signature]
+          #   SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(@timestamp)
+          # else
+          #   SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_sec_key(@timestamp)
+          # end
 
           prep_upload_response = JSON.parse(response.body)
           info_json = configure_info_json(prep_upload_response)
@@ -227,13 +269,13 @@ module SmileIdentityCore
           return file_upload_response
 
         elsif response.timed_out?
-          raise "#{response.code.to_s}: #{response.body}"
+          raise "#{response.code}: #{response.body}"
         elsif response.code == 0
           # Could not get an http response, something's wrong.
-          raise "#{response.code.to_s}: #{response.body}"
+          raise "#{response.code}: #{response.body}"
         else
           # Received a non-successful http response.
-          raise "#{response.code.to_s}: #{response.body}"
+          raise "#{response.code}: #{response.body}"
         end
       end
       request.run
@@ -242,18 +284,12 @@ module SmileIdentityCore
     def configure_info_json(server_information)
       info = {
         "package_information": {
-          "apiVersion": {
-            "buildNumber": 0,
-            "majorVersion": 2,
-            "minorVersion": 0
-          },
+          "apiVersion": SmileIdentityCore.version_as_hash,
           "language": "ruby"
         },
-        "misc_information": {
-          "sec_key": @sec_key,
+        "misc_information": request_security(use_new_signature: @use_new_signature).merge(
           "retry": "false",
           "partner_params": @partner_params,
-          "timestamp": @timestamp,
           "file_name": "selfie.zip", # figure out what to do here
           "smile_client_id": @partner_id,
           "callback_url": @callback_url,
@@ -269,17 +305,17 @@ module SmileIdentityCore
             "countryCode": "+",
             "countryName": ""
           }
-        },
+        ),
         "id_info": @id_info,
         "images": configure_image_payload,
         "server_information": server_information
       }
-      return info
+      info
     end
 
     def configure_image_payload
       @images.map { |i|
-        if isImageFile?i[:image_type_id]
+        if image_file?(i[:image_type_id])
           {
             image_type_id: i[:image_type_id],
             image: '',
@@ -295,7 +331,7 @@ module SmileIdentityCore
       }
     end
 
-    def isImageFile?type
+    def image_file?(type)
       type.to_i == 0 || type.to_i == 1
     end
 
@@ -332,7 +368,10 @@ module SmileIdentityCore
         if response.success?
           if @options[:return_job_status]
             @utilies_connection = SmileIdentityCore::Utilities.new(@partner_id, @api_key, @sid_server)
-            return query_job_status
+            job_response = query_job_status
+            job_response["success"] = true
+            job_response["smile_job_id"] = smile_job_id
+            return job_response
           else
             return {success: true, smile_job_id: smile_job_id}.to_json
           end
@@ -357,9 +396,9 @@ module SmileIdentityCore
       response = @utilies_connection.get_job_status(@partner_params[:user_id], @partner_params[:job_id], @options)
 
       if response && (response['job_complete'] == true || counter == 20)
-        return response
+        response
       else
-        return query_job_status(counter)
+        query_job_status(counter)
       end
 
     end

data/smile-identity-core.gemspec

@@ -5,8 +5,8 @@ require "smile-identity-core/version"
 Gem::Specification.new do |spec|
   spec.name          = "smile-identity-core"
   spec.version       = SmileIdentityCore::VERSION
-  spec.authors       = ["Ridhwana"]
-  spec.email         = ["ridhwana.khan16@gmail.com"]
+  spec.authors       = ["Smile Identity"]
+  spec.email         = ["support@smileidentity.com"]
 
   spec.summary       = "The Smile Identity Web API allows the user to access most of the features of the Smile Identity system through direct server to server queries."
   spec.description   = "The Official Smile Identity gem"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smile-identity-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Ridhwana
+- Smile Identity
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2021-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,7 +108,7 @@ dependencies:
         version: 1.2.3
 description: The Official Smile Identity gem
 email:
-- ridhwana.khan16@gmail.com
+- support@smileidentity.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -130,7 +130,6 @@ files:
 - lib/smile-identity-core/version.rb
 - lib/smile-identity-core/web_api.rb
 - smile-identity-core.gemspec
-- travis.yml
 homepage: https://www.smileidentity.com/
 licenses:
 - MIT
@@ -154,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: The Smile Identity Web API allows the user to access most of the features

data/travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-rvm:
-  - 2.5.1
-
-script:
-  - bundle exec rake spec
-
-before_install:
-  - gem install bundle