idnow 1.0.0 → 2.3.0

data/lib/idnow/API/authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Idnow
   module API
     module Authentication

data/lib/idnow/API/automated_testing.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module Idnow
   module API
     module AutomatedTesting
-      HOST = 'https://api.test.idnow.de'.freeze
+      HOST = 'https://api.test.idnow.de'
 
       def testing_start(transaction_number:)
         path = full_path_for("identifications/#{transaction_number}/start")
         request = Idnow::PostJsonRequest.new(path, {})
-        execute(request, 'X-API_KEY' => @api_key, http_client: automated_testing_http_client)
+        execute(request, { 'X-API_KEY' => @api_key }, http_client: automated_testing_http_client)
       end
 
       def testing_request_video_chat(transaction_number:)
         path = full_path_for("identifications/#{transaction_number}/requestVideoChat")
         request = Idnow::PostJsonRequest.new(path, {})
-        execute(request, 'X-API_KEY' => @api_key, http_client: automated_testing_http_client)
+        execute(request, { 'X-API_KEY' => @api_key }, http_client: automated_testing_http_client)
       end
     end
   end

data/lib/idnow/API/document_definitions.rb

@@ -1,28 +1,31 @@
+# frozen_string_literal: true
+
 module Idnow
   module API
     module DocumentDefinitions
       def create_document_definition(document_data)
-        fail Idnow::AuthenticationException if @auth_token.nil?
+        raise Idnow::AuthenticationException if @auth_token.nil?
 
         path = full_path_for('documentdefinitions')
         request = Idnow::PostJsonRequest.new(path, document_data)
-        execute(request, 'X-API-LOGIN-TOKEN' => @auth_token)
+        execute(request, { 'X-API-LOGIN-TOKEN' => @auth_token })
       end
 
       def list_document_definitions
-        fail Idnow::AuthenticationException if @auth_token.nil?
+        raise Idnow::AuthenticationException if @auth_token.nil?
 
         path = full_path_for('documentdefinitions')
         request = Idnow::GetRequest.new(path)
-        response = execute(request, 'X-API-LOGIN-TOKEN' => @auth_token)
+        response = execute(request, { 'X-API-LOGIN-TOKEN' => @auth_token })
         response.data.map do |data|
           Idnow::DocumentDefinition.new(data)
         end
       end
 
-      def list_cached_document_definitions(refresh = false)
-        return @document_definitions = list_document_definitions if refresh
-        @document_definitions ||= list_document_definitions
+      def list_cached_document_definitions(refresh = false) # rubocop:disable Style/OptionalBooleanParameter
+        return @list_cached_document_definitions = list_document_definitions if refresh
+
+        @list_cached_document_definitions ||= list_document_definitions
       end
     end
   end

data/lib/idnow/API/download_documents.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 module Idnow
   module API
     module DownloadDocuments
       def download_default_document(document_definition_identifier)
-        fail Idnow::AuthenticationException if @auth_token.nil?
+        raise Idnow::AuthenticationException if @auth_token.nil?
 
         path = full_path_for("documentdefinitions/#{document_definition_identifier}/data")
         request = Idnow::GetRequest.new(path, '')
-        execute(request, 'X-API-LOGIN-TOKEN' => @auth_token)
+        execute(request, { 'X-API-LOGIN-TOKEN' => @auth_token })
       end
     end
   end

data/lib/idnow/API/request_identifications.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Idnow
   module API
     module RequestIdentifications
       def request_identification(transaction_number:, identification_data:)
         path = full_path_for("identifications/#{transaction_number}/start")
         request = Idnow::PostJsonRequest.new(path, identification_data)
-        response = execute(request, 'X-API-KEY' => @api_key)
+        response = execute(request, { 'X-API-KEY' => @api_key })
         Idnow::IdentificationRequest.new(response.data, transaction_number, @target_host, @company_id)
       end
     end

data/lib/idnow/API/retrieve_identifications.rb

@@ -1,29 +1,32 @@
+# frozen_string_literal: true
+
 module Idnow
   module API
     module RetrieveIdentifications
-      IDENTIFICATION_STATUSES = %w(pending failed).freeze
+      IDENTIFICATION_STATUSES = %w[pending failed].freeze
 
       def list_identifications(status: nil)
-        fail Idnow::AuthenticationException if @auth_token.nil?
+        raise Idnow::AuthenticationException if @auth_token.nil?
 
         unless status.nil? || IDENTIFICATION_STATUSES.include?(status)
-          fail Idnow::InvalidArguments, "Status #{status} not defined, possible options are: #{IDENTIFICATION_STATUSES.join(',')}"
+          raise Idnow::InvalidArguments, "Status #{status} not defined, possible options are: #{IDENTIFICATION_STATUSES.join(',')}"
         end
+
         partial_path = status.nil? ? 'identifications' : "identifications?#{status}=true"
         path = full_path_for(partial_path)
         request = Idnow::GetRequest.new(path)
-        response = execute(request, 'X-API-LOGIN-TOKEN' => @auth_token)
+        response = execute(request, { 'X-API-LOGIN-TOKEN' => @auth_token })
         response.data['identifications'].map do |data|
           Idnow::Identification.new(data)
         end
       end
 
       def get_identification(transaction_number:)
-        fail Idnow::AuthenticationException if @auth_token.nil?
+        raise Idnow::AuthenticationException if @auth_token.nil?
 
         path = full_path_for("identifications/#{transaction_number}")
         request = Idnow::GetRequest.new(path)
-        response = execute(request, 'X-API-LOGIN-TOKEN' => @auth_token)
+        response = execute(request, { 'X-API-LOGIN-TOKEN' => @auth_token })
         Idnow::Identification.new(response.data)
       end
 

data/lib/idnow/API/upload_documents.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Idnow
   module API
     module UploadDocuments
@@ -14,9 +16,10 @@ module Idnow
       private
 
       def upload_document(file_data, request_path)
-        fail Idnow::AuthenticationException if @auth_token.nil?
+        raise Idnow::AuthenticationException if @auth_token.nil?
+
         request = Idnow::PostBinaryRequest.new(request_path, file_data)
-        execute(request, 'X-API-LOGIN-TOKEN' => @auth_token)
+        execute(request, { 'X-API-LOGIN-TOKEN' => @auth_token })
       end
     end
   end

data/lib/idnow/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'idnow/API/authentication'
 require 'idnow/API/automated_testing' # shouldn't be included by default
 require 'idnow/API/request_identifications'
@@ -16,21 +18,24 @@ module Idnow
     include Idnow::API::UploadDocuments
     include Idnow::API::DownloadDocuments
 
-    API_VERSION = 'v1'.freeze
+    API_VERSION = 'v1'
 
     attr_reader :host
 
-    def initialize(env:, company_id:, api_key:)
-      fail 'Please set env to :test or :live' unless Idnow::ENVIRONMENTS.keys.include?(env)
-      fail 'Please set your company_id' if company_id.nil?
-      fail 'Please set your api_key' if api_key.nil?
-      @host        = Idnow::ENVIRONMENTS[env][:host]
-      @target_host = Idnow::ENVIRONMENTS[env][:target_host]
+    def initialize(env:, company_id:, api_key:, timeout: nil, sftp_options: {})
+      raise 'Please set env to :test or :live' unless Idnow::ENVIRONMENTS.keys.include?(env)
+      raise 'Please set your company_id' if company_id.nil?
+      raise 'Please set your api_key' if api_key.nil?
+
+      @host        = Idnow.endpoint(env, :host)
+      @target_host = Idnow.endpoint(env, :target_host)
       @company_id  = company_id
       @api_key     = api_key
 
       @http_client = HttpClient.new(host: @host)
-      @sftp_client = SftpClient.new(host: @host, username: @company_id, password: @api_key)
+
+      sftp_options[:timeout] = timeout if timeout
+      @sftp_client = SftpClient.new(host: @host, username: @company_id, password: @api_key, options: sftp_options)
     end
 
     private
@@ -45,7 +50,7 @@ module Idnow
                  end
 
       response.tap do |r|
-        fail Idnow::ResponseException, r.errors if r.errors?
+        raise Idnow::ResponseException, r.errors if r.errors?
       end
     end
 

data/lib/idnow/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Idnow
   class Configuration
     # TODO: This class is not being used right now, but its aim is to be able for the developers
@@ -8,18 +10,13 @@ module Idnow
     # config.company_id = company_id
     # end
 
-    attr_accessor :api_key
-
-    attr_accessor :company_id
+    attr_accessor :api_key, :company_id, :host, :api_version
 
     module Idnow
       module Host
-        TEST = 'https://gateway.test.idnow.de'.freeze
-        PRODUCTION = 'https://gateway.idnow.de'.freeze
+        TEST = 'https://gateway.test.idnow.de'
+        PRODUCTION = 'https://gateway.idnow.de'
       end
     end
-    attr_accessor :host
-
-    attr_accessor :api_version
   end
 end

data/lib/idnow/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Idnow
   class Exception < StandardError
     def initialize(message)

data/lib/idnow/get_request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 
 module Idnow

data/lib/idnow/helpers.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Idnow
   module Helpers
     PROJECT_ROOT = File.dirname(File.dirname(File.dirname(__FILE__)))
 
     module Factories
-      Dir[File.join(PROJECT_ROOT, 'spec', 'support', 'factories', '*.rb')].each { |file| require(file) }
+      Dir[File.join(PROJECT_ROOT, 'spec', 'support', 'factories', '*.rb')].sort.each { |file| require(file) }
     end
   end
 end

data/lib/idnow/http_client.rb

@@ -1,26 +1,29 @@
+# frozen_string_literal: true
+
 module Idnow
   class HttpClient
-    def initialize(host:)
-      @uri = URI.parse(host)
+    def initialize(host:, read_timout_sec: 30)
+      @uri          = URI.parse(host)
+      @read_timeout = read_timout_sec
     end
 
     def execute(request, headers = {})
       headers.each do |k, v|
         request[k] = v
       end
-      begin
-        client.request(request)
-      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
-             Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
-        raise Idnow::ConnectionException, e
-      end
+
+      client.request(request)
+    rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+           Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+      raise Idnow::ConnectionException, e
     end
 
     private
 
     def client
       Net::HTTP.new(@uri.host, @uri.port).tap do |http|
-        http.use_ssl = true
+        http.read_timeout = @read_timeout
+        http.use_ssl      = @uri.scheme == 'https'
       end
     end
   end

data/lib/idnow/json_response.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Idnow
   class JsonResponse < RawResponse
     attr_reader :data
 
     def initialize(raw_response)
       super
-      raw_response = (raw_response == '') ? '{}' : raw_response
+      raw_response = raw_response == '' ? '{}' : raw_response
       @data = JSON.parse(raw_response)
     end
   end

data/lib/idnow/models/contact_data.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Idnow
   class ContactData
     include Idnow::Jsonable

data/lib/idnow/models/document_definition.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Idnow
   class DocumentDefinition
     include Idnow::Jsonable

data/lib/idnow/models/identification.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'forwardable'
-require 'pry'
+
 module Idnow
   class Identification
     extend Forwardable
     include Idnow::Jsonable
 
     attr_accessor :identification_process, :contact_data, :user_data,
-                  :identification_document, :attachments, :esigning
+                  :identification_document, :attachments, :esigning, :raw_data
 
     def initialize(data)
       @identification_process  = IdentificationProcess.new(data['identificationprocess'])
@@ -15,6 +17,7 @@ module Idnow
       @identification_document = IdentificationDocument.new(data.fetch('identificationdocument', {}))
       @attachments             = data['attachments']
       @esigning                = data['esigning']
+      @raw_data                = data
     end
 
     def esigning?

data/lib/idnow/models/identification_data.rb

@@ -1,25 +1,32 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module Idnow
   class IdentificationData
     module Gender
-      MALE = 'MALE'.freeze
-      FEMALE = 'FEMALE'.freeze
+      MALE = 'MALE'
+      FEMALE = 'FEMALE'
     end
 
-    attr_accessor :birthplace, :birthname, :city, :country, :custom1,
-                  :custom2, :custom3, :custom4, :custom5, :trackingid, :email, :firstname, :gender,
-                  :lastname, :mobilephone, :nationality, :street, :streetnumber, :title, :zipcode
+    # rubocop:disable Naming/MethodName
+    attr_accessor :birthplace, :birthname, :city, :custom1,
+                  :custom2, :custom3, :custom4, :custom5, :trackingid, :email, :firstname,
+                  :lastname, :mobilephone, :nationality, :street, :streetnumber, :title, :zipcode,
+                  :preferredLang
+    # rubocop:enable Naming/MethodName
+
+    attr_reader :country, :gender
 
     def initialize(params = {})
-      params.keys.each do |key|
-        fail ArgumentError, "Attribute #{key} is not supported!" unless respond_to?(key.to_sym)
+      params.each_key do |key|
+        raise ArgumentError, "Attribute #{key} is not supported!" unless respond_to?(key.to_sym)
 
         send("#{key}=", params[key])
       end
     end
 
-    def to_json
+    def to_json(*_args)
       result = {}
       instance_variables.each do |attribute|
         result[attribute.to_s.delete('@')] = instance_variable_get(attribute)
@@ -30,7 +37,7 @@ module Idnow
     ########### Getter / Setter ############
 
     def birthday
-      @birthday.strftime('%Y-%m-%d') if @birthday
+      @birthday&.strftime('%Y-%m-%d')
     end
 
     def birthday=(birthday)
@@ -42,18 +49,18 @@ module Idnow
     end
 
     def country=(country)
-      fail ArgumentError, 'Country must be ISO 3166 two letter country code' unless country.instance_of?(String) && country.size == 2
+      raise ArgumentError, 'Country must be ISO 3166 two letter country code' unless country.instance_of?(String) && country.size == 2
 
       @country = country.upcase
     end
 
     def gender=(gender)
-      if %w(M MALE).include?(gender.to_s.strip.upcase)
+      if %w[M MALE].include?(gender.to_s.strip.upcase)
         @gender = Gender::MALE
-      elsif %w(F FEMALE).include?(gender.to_s.strip.upcase)
+      elsif %w[F FEMALE].include?(gender.to_s.strip.upcase)
         @gender = Gender::FEMALE
       else
-        fail ArgumentError, 'Provide valid value for gender: MALE or FEMALE'
+        raise ArgumentError, 'Provide valid value for gender: MALE or FEMALE'
       end
     end
   end

data/lib/idnow/models/identification_document.rb

@@ -1,15 +1,19 @@
+# frozen_string_literal: true
+
 module Idnow
   class IdentificationDocument
     include Idnow::Jsonable
 
-    attr_accessor :country, :number, :issued_by, :date_issued, :type, :valid_until
+    attr_accessor :country, :number, :issued_by, :type
+    attr_writer :date_issued, :valid_until
+
     def initialize(data)
-      @country             = dig_value('country', data)
-      @number              = dig_value('number', data)
-      @issued_by           = dig_value('issuedby', data)
-      @date_issued         = dig_value('dateissued', data)
-      @type                = dig_value('type', data)
-      @valid_until         = dig_value('validuntil', data)
+      @country     = data.dig('country', 'value')
+      @number      = data.dig('number', 'value')
+      @issued_by   = data.dig('issuedby', 'value')
+      @date_issued = data.dig('dateissued', 'value')
+      @type        = data.dig('type', 'value')
+      @valid_until = data.dig('validuntil', 'value')
     end
 
     def date_issued
@@ -19,16 +23,5 @@ module Idnow
     def valid_until
       Date.parse(@valid_until) if @valid_until
     end
-
-    private
-
-    def dig_value(*keys, data)
-      # TODO: use ruby 2.3 and dig
-      result = data
-      keys.each do |key|
-        result = result.fetch(key, {})
-      end
-      result['value']
-    end
   end
 end