idnow 1.0.0

data/lib/idnow/API/authentication.rb

@@ -0,0 +1,13 @@
+module Idnow
+  module API
+    module Authentication
+      def login
+        path = full_path_for('login')
+        login_data = Idnow::LoginData.new(@api_key)
+        request = Idnow::PostJsonRequest.new(path, login_data)
+        response = execute(request)
+        @auth_token = Idnow::Login.new(response.data).auth_token
+      end
+    end
+  end
+end

data/lib/idnow/API/automated_testing.rb

@@ -0,0 +1,19 @@
+module Idnow
+  module API
+    module AutomatedTesting
+      HOST = 'https://api.test.idnow.de'.freeze
+
+      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)
+      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)
+      end
+    end
+  end
+end

data/lib/idnow/API/document_definitions.rb

@@ -0,0 +1,29 @@
+module Idnow
+  module API
+    module DocumentDefinitions
+      def create_document_definition(document_data)
+        fail 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)
+      end
+
+      def list_document_definitions
+        fail 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.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
+      end
+    end
+  end
+end

data/lib/idnow/API/download_documents.rb

@@ -0,0 +1,13 @@
+module Idnow
+  module API
+    module DownloadDocuments
+      def download_default_document(document_definition_identifier)
+        fail 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)
+      end
+    end
+  end
+end

data/lib/idnow/API/request_identifications.rb

@@ -0,0 +1,12 @@
+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)
+        Idnow::IdentificationRequest.new(response.data, transaction_number, @target_host, @company_id)
+      end
+    end
+  end
+end

data/lib/idnow/API/retrieve_identifications.rb

@@ -0,0 +1,36 @@
+module Idnow
+  module API
+    module RetrieveIdentifications
+      IDENTIFICATION_STATUSES = %w(pending failed).freeze
+
+      def list_identifications(status: nil)
+        fail 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(',')}"
+        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.data['identifications'].map do |data|
+          Idnow::Identification.new(data)
+        end
+      end
+
+      def get_identification(transaction_number:)
+        fail 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)
+        Idnow::Identification.new(response.data)
+      end
+
+      def download_identification(transaction_number:)
+        path = "#{transaction_number}.zip"
+        @sftp_client.download(path)
+      end
+    end
+  end
+end

data/lib/idnow/API/upload_documents.rb

@@ -0,0 +1,23 @@
+module Idnow
+  module API
+    module UploadDocuments
+      def upload_identification_document(transaction_number, document_definition_identifier, file_data)
+        request_path = full_path_for("identifications/#{transaction_number}/documents/#{document_definition_identifier}/data")
+        upload_document(file_data, request_path)
+      end
+
+      def upload_default_document(document_definition_identifier, file_data)
+        request_path = full_path_for("documentdefinitions/#{document_definition_identifier}/data")
+        upload_document(file_data, request_path)
+      end
+
+      private
+
+      def upload_document(file_data, request_path)
+        fail Idnow::AuthenticationException if @auth_token.nil?
+        request = Idnow::PostBinaryRequest.new(request_path, file_data)
+        execute(request, 'X-API-LOGIN-TOKEN' => @auth_token)
+      end
+    end
+  end
+end

data/lib/idnow/client.rb

@@ -0,0 +1,60 @@
+require 'idnow/API/authentication'
+require 'idnow/API/automated_testing' # shouldn't be included by default
+require 'idnow/API/request_identifications'
+require 'idnow/API/retrieve_identifications'
+require 'idnow/API/document_definitions'
+require 'idnow/API/upload_documents'
+require 'idnow/API/download_documents'
+
+module Idnow
+  class Client
+    include Idnow::API::Authentication
+    include Idnow::API::RetrieveIdentifications
+    include Idnow::API::RequestIdentifications
+    include Idnow::API::AutomatedTesting
+    include Idnow::API::DocumentDefinitions
+    include Idnow::API::UploadDocuments
+    include Idnow::API::DownloadDocuments
+
+    API_VERSION = 'v1'.freeze
+
+    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]
+      @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)
+    end
+
+    private
+
+    def execute(request, headers = {}, http_client: @http_client)
+      http_response = http_client.execute(request, headers)
+
+      response = if request.content_type == 'application/json'
+                   Idnow::JsonResponse.new(http_response.body)
+                 else
+                   Idnow::RawResponse.new(http_response.body)
+                 end
+
+      response.tap do |r|
+        fail Idnow::ResponseException, r.errors if r.errors?
+      end
+    end
+
+    def full_path_for(partial_path)
+      File.join('/api', API_VERSION, @company_id, partial_path)
+    end
+
+    def automated_testing_http_client
+      @automated_testing_http_client ||= HttpClient.new(host: Idnow::API::AutomatedTesting::HOST)
+    end
+  end
+end

data/lib/idnow/configuration.rb

@@ -0,0 +1,25 @@
+module Idnow
+  class Configuration
+    # TODO: This class is not being used right now, but its aim is to be able for the developers
+    # using the gem to set its configuration with something like
+    # Idnow.config do |config|
+    # config.url = Idnow::TEST_SERVER
+    # config.env = :test
+    # config.company_id = company_id
+    # end
+
+    attr_accessor :api_key
+
+    attr_accessor :company_id
+
+    module Idnow
+      module Host
+        TEST = 'https://gateway.test.idnow.de'.freeze
+        PRODUCTION = 'https://gateway.idnow.de'.freeze
+      end
+    end
+    attr_accessor :host
+
+    attr_accessor :api_version
+  end
+end

data/lib/idnow/exception.rb

@@ -0,0 +1,25 @@
+module Idnow
+  class Exception < StandardError
+    def initialize(message)
+      super("Request to IDnow failed: #{message}")
+    end
+  end
+
+  class ConnectionException < Idnow::Exception
+    def initialize(exception)
+      super("#{exception.class}, #{exception.message}")
+    end
+  end
+
+  class ResponseException < Idnow::Exception
+  end
+
+  class AuthenticationException < Idnow::Exception
+    def initialize
+      super('Not authenticaton token found, please log in first')
+    end
+  end
+
+  class InvalidArguments < Idnow::Exception
+  end
+end

data/lib/idnow/get_request.rb

@@ -0,0 +1,10 @@
+require 'net/http'
+
+module Idnow
+  class GetRequest < Net::HTTP::Get
+    def initialize(path, content_type = 'application/json')
+      super(path)
+      self['Content-Type'] = content_type
+    end
+  end
+end

data/lib/idnow/helpers.rb

@@ -0,0 +1,9 @@
+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) }
+    end
+  end
+end

data/lib/idnow/http_client.rb

@@ -0,0 +1,27 @@
+module Idnow
+  class HttpClient
+    def initialize(host:)
+      @uri = URI.parse(host)
+    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
+    end
+
+    private
+
+    def client
+      Net::HTTP.new(@uri.host, @uri.port).tap do |http|
+        http.use_ssl = true
+      end
+    end
+  end
+end

data/lib/idnow/json_response.rb

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

data/lib/idnow/models/contact_data.rb

@@ -0,0 +1,12 @@
+module Idnow
+  class ContactData
+    include Idnow::Jsonable
+
+    attr_accessor :mobilephone, :email
+
+    def initialize(data)
+      @mobilephone = data['mobilephone']
+      @email = data['email']
+    end
+  end
+end

data/lib/idnow/models/document_definition.rb

@@ -0,0 +1,15 @@
+module Idnow
+  class DocumentDefinition
+    include Idnow::Jsonable
+
+    attr_accessor :optional, :name, :identifier, :mime_type, :sort_order
+
+    def initialize(data)
+      @optional = data['optional']
+      @name = data['name']
+      @identifier = data['identifier']
+      @mime_type = data['mimeType']
+      @sort_order = data['sortOrder']
+    end
+  end
+end

data/lib/idnow/models/identification.rb

@@ -0,0 +1,25 @@
+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
+
+    def initialize(data)
+      @identification_process  = IdentificationProcess.new(data['identificationprocess'])
+      @contact_data            = ContactData.new(data['contactdata'])
+      @user_data               = UserData.new(data['userdata'])
+      @identification_document = IdentificationDocument.new(data.fetch('identificationdocument', {}))
+      @attachments             = data['attachments']
+      @esigning                = data['esigning']
+    end
+
+    def esigning?
+      !@esigning.nil?
+    end
+    def_delegators :identification_process, :successful?, :result, :reason, :id, :transaction_number, :review_pending?
+  end
+end

data/lib/idnow/models/identification_data.rb

@@ -0,0 +1,60 @@
+require 'json'
+
+module Idnow
+  class IdentificationData
+    module Gender
+      MALE = 'MALE'.freeze
+      FEMALE = 'FEMALE'.freeze
+    end
+
+    attr_accessor :birthplace, :birthname, :city, :country, :custom1,
+                  :custom2, :custom3, :custom4, :custom5, :trackingid, :email, :firstname, :gender,
+                  :lastname, :mobilephone, :nationality, :street, :streetnumber, :title, :zipcode
+
+    def initialize(params = {})
+      params.keys.each do |key|
+        fail ArgumentError, "Attribute #{key} is not supported!" unless respond_to?(key.to_sym)
+
+        send("#{key}=", params[key])
+      end
+    end
+
+    def to_json
+      result = {}
+      instance_variables.each do |attribute|
+        result[attribute.to_s.delete('@')] = instance_variable_get(attribute)
+      end
+      result.to_json
+    end
+
+    ########### Getter / Setter ############
+
+    def birthday
+      @birthday.strftime('%Y-%m-%d') if @birthday
+    end
+
+    def birthday=(birthday)
+      @birthday = if birthday.instance_of?(Date) || birthday.instance_of?(DateTime)
+                    birthday
+                  else
+                    Date.parse(birthday)
+                  end
+    end
+
+    def country=(country)
+      fail 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)
+        @gender = Gender::MALE
+      elsif %w(F FEMALE).include?(gender.to_s.strip.upcase)
+        @gender = Gender::FEMALE
+      else
+        fail ArgumentError, 'Provide valid value for gender: MALE or FEMALE'
+      end
+    end
+  end
+end