smile-identity-core 1.2.0 → 2.0.0

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

@@ -1,50 +1,47 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'tempfile'
 require 'base64'
 require 'openssl'
 require 'uri'
-
 require 'typhoeus'
 require 'zip'
 
 module SmileIdentityCore
+  # Allows Identity verifications of ids with images
   class WebApi
-
     def initialize(partner_id, default_callback, api_key, sid_server)
       @partner_id = partner_id.to_s
       @callback_url = default_callback
       @api_key = api_key
-
       @sid_server = sid_server
-      if !(sid_server =~ URI::regexp)
-        sid_server_mapping = {
-          0 => 'https://testapi.smileidentity.com/v1',
-          1 => 'https://api.smileidentity.com/v1',
-        }
-        @url = sid_server_mapping[sid_server.to_i]
-      else
-        @url = sid_server
-      end
+      @url = if sid_server !~ URI::DEFAULT_PARSER.make_regexp
+               SmileIdentityCore::ENV::SID_SERVER_MAPPING[sid_server.to_s]
+             else
+               sid_server
+             end
     end
 
     def submit_job(partner_params, images, id_info, options)
-
       self.partner_params = symbolize_keys partner_params
-      if @partner_params[:job_type].to_i == 5
+      if @partner_params[:job_type].to_i == JobType::ENHANCED_KYC
         return SmileIdentityCore::IDApi.new(@partner_id, @api_key, @sid_server).submit_job(partner_params, id_info)
       end
 
+      if @partner_params[:job_type].to_i == JobType::BUSINESS_VERIFICATION
+        return SmileIdentityCore::BusinessVerification.new(@partner_id, @api_key, @sid_server).submit_job(
+          partner_params, id_info
+        )
+      end
+
       self.images = images
       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]
-      end
+      @callback_url = @options[:optional_callback] if @options[:optional_callback]&.length&.positive?
 
-      if @partner_params[:job_type].to_i == 1
-        validate_enroll_with_id
-      end
+      validate_enroll_with_id if @partner_params[:job_type].to_i == 1
 
       validate_return_data
 
@@ -59,21 +56,18 @@ module SmileIdentityCore
       job_id = partner_params[:job_id]
 
       utilities = SmileIdentityCore::Utilities.new(@partner_id, @api_key, @sid_server)
-      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, 'Please ensure that you send through partner params'
-      end
+      raise ArgumentError, 'Please ensure that you send through partner params' if partner_params.nil?
 
-      if !partner_params.is_a?(Hash)
-        raise ArgumentError, 'Partner params needs to be a hash'
-      end
+      raise ArgumentError, 'Partner params needs to be a hash' unless partner_params.is_a?(Hash)
 
-      [: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, "Please make sure that #{key} is included in the partner params"
+      %i[user_id job_id job_type].each do |key|
+        if partner_params[key].to_s.empty?
+          raise ArgumentError,
+                "Please make sure that #{key} is included in the partner params"
         end
       end
 
@@ -81,46 +75,30 @@ module SmileIdentityCore
     end
 
     def images=(images)
-      if images == nil
-        raise ArgumentError, 'Please ensure that you send through image details'
-      end
+      raise ArgumentError, 'Please ensure that you send through image details' if images.nil?
 
-      if !images.is_a?(Array)
-        raise ArgumentError, 'Image details needs to be an array'
-      end
+      raise ArgumentError, 'Image details needs to be an array' unless images.is_a?(Array)
 
       # all job types require atleast a selfie
-      if images.length == 0 || images.none? {|h| h[:image_type_id] == 0 || h[:image_type_id] == 2 }
+      if images.length.zero? || images.none? { |h| (h[:image_type_id]).zero? || h[:image_type_id] == 2 }
         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)
-
-      updated_id_info = id_info
-
-      if updated_id_info.nil?
-        updated_id_info = {}
-      end
+      updated_id_info = id_info.nil? ? {} : id_info
 
       # if it doesnt exist, set it false
-      if(!updated_id_info.key?(:entered) || id_info[:entered].empty?)
-        updated_id_info[:entered] = "false"
-      end
+      updated_id_info[:entered] = 'false' if !updated_id_info.key?(:entered) || id_info[:entered].empty?
 
       # if it's a boolean
-      if(!!updated_id_info[:entered] == updated_id_info[:entered])
-        updated_id_info[:entered] = id_info[:entered].to_s
-      end
+      updated_id_info[:entered] = id_info[:entered].to_s if !updated_id_info[:entered].nil? == updated_id_info[:entered]
 
       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, "Please make sure that #{key.to_s} is included in the id_info"
-          end
+        %i[country id_type id_number].each do |key|
+          raise ArgumentError, "Please make sure that #{key} is included in the id_info" if id_info[key].to_s.empty?
         end
       end
 
@@ -134,7 +112,6 @@ module SmileIdentityCore
       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
@@ -157,7 +134,13 @@ module SmileIdentityCore
     private
 
     def request_web_token(request_params)
-      request_params.merge!({ partner_id: @partner_id }).merge!(request_security)
+      request_params
+        .merge(SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(Time.now.to_s))
+        .merge!(
+          { partner_id: @partner_id,
+            source_sdk: SmileIdentityCore::SOURCE_SDK,
+            source_sdk_version: SmileIdentityCore::VERSION }
+        )
       url = "#{@url}/token"
 
       response = Typhoeus.post(
@@ -171,8 +154,8 @@ module SmileIdentityCore
       raise "#{response.code}: #{response.body}"
     end
 
-    def symbolize_keys params
-      (params.is_a?(Hash)) ? Hash[params.map{ |k, v| [k.to_sym, v] }] : params
+    def symbolize_keys(params)
+      params.is_a?(Hash) ? params.transform_keys(&:to_sym) : params
     end
 
     def validate_return_data
@@ -182,25 +165,21 @@ module SmileIdentityCore
     end
 
     def validate_enroll_with_id
-      if(((@images.none? {|h| h[:image_type_id] == 1 || h[:image_type_id] == 3 }) && @id_info[:entered] != 'true'))
+      if (@images.none? { |h| h[:image_type_id] == 1 || h[:image_type_id] == 3 }) && @id_info[:entered] != 'true'
         raise ArgumentError, 'You are attempting to complete a job type 1 without providing an id card image or id info'
       end
     end
 
     def check_boolean(key, obj)
-      if (!obj || !obj[key])
-        return false
-      end
+      return false if !obj || !obj[key]
 
-      if !!obj[key] != obj[key]
-        raise ArgumentError, "#{key} needs to be a boolean"
-      end
+      raise ArgumentError, "#{key} needs to be a boolean" if !obj[key].nil? != obj[key]
 
       obj[key]
     end
 
     def check_string(key, obj)
-      if (!obj || !obj[key])
+      if !obj || !obj[key]
         ''
       else
         obj[key]
@@ -217,104 +196,84 @@ module SmileIdentityCore
       keys.select { |key| blank?(obj, key) }
     end
 
-    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(
+      SmileIdentityCore::Signature.new(@partner_id, @api_key).generate_signature(Time.now.to_s).merge(
         file_name: 'selfie.zip',
         smile_client_id: @partner_id,
         partner_params: @partner_params,
         model_parameters: {}, # what is this for
-        callback_url: @callback_url
+        callback_url: @callback_url,
+        source_sdk: SmileIdentityCore::SOURCE_SDK,
+        source_sdk_version: SmileIdentityCore::VERSION
       ).to_json
     end
 
     def setup_requests
-
       url = "#{@url}/upload"
       request = Typhoeus::Request.new(
         url,
         method: 'POST',
-        headers: {'Content-Type'=> "application/json"},
+        headers: { 'Content-Type' => 'application/json' },
         body: configure_prep_upload_json
       )
 
       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)
 
-          file_upload_response = upload_file(prep_upload_response['upload_url'], info_json, prep_upload_response['smile_job_id'])
+          file_upload_response = upload_file(prep_upload_response['upload_url'], info_json,
+                                             prep_upload_response['smile_job_id'])
           return file_upload_response
-
-        elsif response.timed_out?
-          raise "#{response.code}: #{response.body}"
-        elsif response.code == 0
-          # Could not get an http response, something's wrong.
-          raise "#{response.code}: #{response.body}"
-        else
-          # Received a non-successful http response.
-          raise "#{response.code}: #{response.body}"
         end
+
+        raise "#{response.code}: #{response.body}"
       end
       request.run
     end
 
     def configure_info_json(server_information)
-      info = {
+      {
         "package_information": {
-          "apiVersion": SmileIdentityCore.version_as_hash,
-          "language": "ruby"
+          "apiVersion": {
+            "buildNumber": 0,
+            "majorVersion": 2,
+            "minorVersion": 0
+          },
+          "language": 'ruby'
         },
-        "misc_information": request_security(use_new_signature: @use_new_signature).merge(
-          "retry": "false",
-          "partner_params": @partner_params,
-          "file_name": "selfie.zip", # figure out what to do here
-          "smile_client_id": @partner_id,
-          "callback_url": @callback_url,
-          "userData": { # TO ASK what goes here
-            "isVerifiedProcess": false,
-            "name": "",
-            "fbUserID": "",
-            "firstName": "Bill",
-            "lastName": "",
-            "gender": "",
-            "email": "",
-            "phone": "",
-            "countryCode": "+",
-            "countryName": ""
-          }
-        ),
+        "misc_information": SmileIdentityCore::Signature.new(@partner_id, @api_key)
+                                                        .generate_signature(Time.now.to_s)
+                                                        .merge(
+                                                          "retry": 'false',
+                                                          "partner_params": @partner_params,
+                                                          "file_name": 'selfie.zip', # figure out what to do here
+                                                          "smile_client_id": @partner_id,
+                                                          "callback_url": @callback_url,
+                                                          "userData": { # TO ASK what goes here
+                                                            "isVerifiedProcess": false,
+                                                            "name": '',
+                                                            "fbUserID": '',
+                                                            "firstName": 'Bill',
+                                                            "lastName": '',
+                                                            "gender": '',
+                                                            "email": '',
+                                                            "phone": '',
+                                                            "countryCode": '+',
+                                                            "countryName": ''
+                                                          }
+                                                        ),
         "id_info": @id_info,
         "images": configure_image_payload,
         "server_information": server_information
       }
-      info
     end
 
     def configure_image_payload
-      @images.map { |i|
+      @images.map do |i|
         if image_file?(i[:image_type_id])
           {
             image_type_id: i[:image_type_id],
@@ -328,11 +287,11 @@ module SmileIdentityCore
             file_name: ''
           }
         end
-      }
+      end
     end
 
     def image_file?(type)
-      type.to_i == 0 || type.to_i == 1
+      type.to_i.zero? || type.to_i == 1
     end
 
     def zip_up_file(info_json)
@@ -341,9 +300,9 @@ module SmileIdentityCore
         zos.put_next_entry('info.json')
         zos.puts JSON.pretty_generate(info_json)
 
-        if @images.length > 0
+        if @images.length.positive?
           @images.each do |img|
-            if img[:image_type_id] == 0 || img[:image_type_id] == 1
+            if (img[:image_type_id]).zero? || img[:image_type_id] == 1
               zos.put_next_entry(File.basename(img[:image]))
               zos.print IO.read(img[:image])
             end
@@ -353,43 +312,31 @@ module SmileIdentityCore
     end
 
     def upload_file(url, info_json, smile_job_id)
-
       file = zip_up_file(info_json)
       file.rewind
 
       request = Typhoeus::Request.new(
         url,
         method: 'PUT',
-        headers: {'Content-Type'=> "application/zip"},
-        body: file.read,
+        headers: { 'Content-Type' => 'application/zip' },
+        body: file.read
       )
 
       request.on_complete do |response|
-        if response.success?
-          if @options[:return_job_status]
-            @utilies_connection = SmileIdentityCore::Utilities.new(@partner_id, @api_key, @sid_server)
-            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
-        elsif response.timed_out?
-          raise " #{response.code.to_s}: #{response.body}"
-        elsif response.code == 0
-          # Could not get an http response, something's wrong.
-          raise " #{response.code.to_s}: #{response.body}"
-        else
-          # Received a non-successful http response.
-          raise " #{response.code.to_s}: #{response.body}"
-        end
+        raise " #{response.code}: #{response.body}" unless response.success?
+
+        return { success: true, smile_job_id: smile_job_id }.to_json unless @options[:return_job_status]
+
+        @utilies_connection = SmileIdentityCore::Utilities.new(@partner_id, @api_key, @sid_server)
+        job_response = query_job_status
+        job_response['success'] = true
+        job_response['smile_job_id'] = smile_job_id
+        return job_response
       end
       request.run
-
     end
 
-    def query_job_status(counter=0)
+    def query_job_status(counter = 0)
       counter < 4 ? (sleep 2) : (sleep 6)
       counter += 1
 
@@ -400,7 +347,6 @@ module SmileIdentityCore
       else
         query_job_status(counter)
       end
-
     end
   end
 end

data/lib/smile-identity-core.rb

@@ -1,8 +1,14 @@
-require "smile-identity-core/version"
-require "smile-identity-core/web_api.rb"
-require "smile-identity-core/id_api.rb"
-require "smile-identity-core/signature.rb"
-require "smile-identity-core/utilities.rb"
+# frozen_string_literal: true
+
+require 'smile-identity-core/version'
+require 'smile-identity-core/web_api'
+require 'smile-identity-core/id_api'
+require 'smile-identity-core/signature'
+require 'smile-identity-core/utilities'
+require 'smile-identity-core/business_verification'
+require 'smile-identity-core/constants/env'
+require 'smile-identity-core/constants/image_type'
+require 'smile-identity-core/constants/job_type'
 
 module SmileIdentityCore
   class Error < StandardError; end

data/smile-identity-core.gemspec

@@ -1,39 +1,44 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "smile-identity-core/version"
+require 'smile-identity-core/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "smile-identity-core"
+  spec.name          = 'smile-identity-core'
   spec.version       = SmileIdentityCore::VERSION
-  spec.authors       = ["Smile Identity"]
-  spec.email         = ["support@smileidentity.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"
-  spec.homepage      = "https://www.smileidentity.com/"
-  spec.required_ruby_version = '>= 2.0'
+  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'
+  spec.homepage      = 'https://www.smileidentity.com/'
+  spec.required_ruby_version = '>= 2.5'
   spec.license = 'MIT'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/smileidentity/smile-identity-core-ruby"
-  spec.metadata["documentation_uri"] = "https://docs.smileidentity.com"
-  spec.metadata["changelog_uri"] = "https://github.com/smileidentity/smile-identity-core/blob/master/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/smileidentity/smile-identity-core-ruby'
+  spec.metadata['documentation_uri'] = 'https://docs.smileidentity.com'
+  spec.metadata['changelog_uri'] = 'https://github.com/smileidentity/smile-identity-core-ruby/blob/master/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.37.1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.14.1'
   spec.add_development_dependency 'simplecov', '~> 0.12.0'
 
-  spec.add_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   spec.add_dependency 'rubyzip', '~> 1.2', '>= 1.2.3'
-
+  spec.add_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
 end