smile-identity-core 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c6c2b9d1846e6939c1a1f8407b24d08f40eb54492f302ff682f0070afbd837a
-  data.tar.gz: 46d3ef6830ee732870ea1657faeb3d1feb8f020b05dd715b615d313541e90bfe
+  metadata.gz: 9614cb861ac00a8133527a647e8d6c6dcc91b00aca6c7fe643e32ddc986b3f7d
+  data.tar.gz: f1ac7dcb3413c1f08ac16c909e0f466091519dae0412519a1161cd0179143040
 SHA512:
-  metadata.gz: 6548acb1e3cb5efa6cd2d73b048449e99ef74c8e3dde60fa06373c6535353f97bc46eb950446ed825c5938b95559db85d58870ce8909f258bcd7066bedae0085
-  data.tar.gz: 4a0b84d72c3ce4b69c051c944d2cc95d4c02bb58244fd2b47bc532d7f6a67ab5e7bb5d7cccb89c8e4a7fc0f217c3548a457ae1a6783ed6bdd2e9b3b18ed80d7d
+  metadata.gz: db1d5e0344e58bb11728af749ef1b37f051add89fdda7797347d0771d091b3221482d90beed6f566d082d4120c9c2d45d63e0dea828202ff9c087d58c498094e
+  data.tar.gz: f524bd93102a7ac6621314a950b5fba0b06a62437f1ad4328e26c092192ffa74ccc9ce5919d1806e126a5d2d9305b9ad204e913da13cf02f1c31079d5775dc70

data/.travis.yml

@@ -1,4 +1,5 @@
 ---
+dist: bionic
 sudo: false
 language: ruby
 cache: bundler

data/Gemfile.lock

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

data/README.md

@@ -5,6 +5,7 @@ The official Smile Identity gem exposes four classes namely; the Web Api 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:
 - submit_job
 - get_job_status
+- get_web_token
 
 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
@@ -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

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

@@ -23,24 +23,24 @@ module SmileIdentityCore
       @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
 
@@ -52,12 +52,12 @@ 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
 
       [: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.new("Please make sure that #{key.to_s} is included in the id_info")
+          raise ArgumentError, "Please make sure that #{key} is included in the id_info"
         end
       end
 

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

@@ -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,7 +31,7 @@ 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
@@ -43,7 +43,7 @@ module SmileIdentityCore
       hmac.update(@partner_id)
       hmac.update("sid_request")
       signature = Base64.strict_encode64(hmac.digest())
-      return {
+      {
         signature: signature,
         timestamp: timestamp.to_s
       }

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

@@ -1,5 +1,5 @@
 module SmileIdentityCore
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 
   def self.version_as_hash
     major, minor, patch = *VERSION.split('.')

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

@@ -48,7 +48,7 @@ module SmileIdentityCore
 
       validate_return_data
 
-      return setup_requests
+      setup_requests
     end
 
     def get_job_status(partner_params, options)
@@ -59,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
 
@@ -82,16 +82,16 @@ 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 }
@@ -119,7 +119,7 @@ module SmileIdentityCore
       if updated_id_info[:entered] && updated_id_info[:entered] == 'true'
         [: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
@@ -139,21 +139,51 @@ module SmileIdentityCore
       @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
 
@@ -163,21 +193,30 @@ 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
-    # zeKn:WFL7t2X/+4
 
     def check_string(key, obj)
       if (!obj || !obj[key])
-        return ''
+        ''
       else
-        return obj[key]
+        obj[key]
       end
     end
 
+    def blank?(obj, key)
+      return obj[key].empty? if obj[key].respond_to?(:empty?)
+
+      obj[key].nil?
+    end
+
+    def get_blank_keys(keys, obj)
+      keys.select { |key| blank?(obj, key) }
+    end
+
     def request_security(use_new_signature: true)
       if use_new_signature
         @timestamp = Time.now.to_s
@@ -230,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
@@ -271,7 +310,7 @@ module SmileIdentityCore
         "images": configure_image_payload,
         "server_information": server_information
       }
-      return info
+      info
     end
 
     def configure_image_payload
@@ -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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
-- Ridhwana
-autorequire:
+- Smile Identity
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-29 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: []
@@ -138,7 +138,7 @@ metadata:
   source_code_uri: https://github.com/smileidentity/smile-identity-core-ruby
   documentation_uri: https://docs.smileidentity.com
   changelog_uri: https://github.com/smileidentity/smile-identity-core/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -153,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+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
   of the Smile Identity system through direct server to server queries.