idnow 1.0.0

data/lib/idnow/models/identification_document.rb

@@ -0,0 +1,34 @@
+module Idnow
+  class IdentificationDocument
+    include Idnow::Jsonable
+
+    attr_accessor :country, :number, :issued_by, :date_issued, :type, :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)
+    end
+
+    def date_issued
+      Date.parse(@date_issued) if @date_issued
+    end
+
+    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

data/lib/idnow/models/identification_process.rb

@@ -0,0 +1,29 @@
+module Idnow
+  class IdentificationProcess
+    include Idnow::Jsonable
+
+    SUCCESSFUL_RESPONSES = %w(SUCCESS SUCCESS_DATA_CHANGED).freeze
+    attr_accessor :result, :reason, :company_id, :filename, :agentname, :identification_time, :id, :href, :type, :transaction_number
+
+    def initialize(data)
+      @result              = data['result']
+      @reason              = data['reason']
+      @company_id          = data['companyid']
+      @filename            = data['filename']
+      @agentname           = data['agentname']
+      @identification_time = data['identificationtime']
+      @id                  = data['id']
+      @href                = data['href']
+      @type                = data['type']
+      @transaction_number  = data['transactionnumber']
+    end
+
+    def successful?
+      SUCCESSFUL_RESPONSES.include?(result)
+    end
+
+    def review_pending?
+      result == 'REVIEW_PENDING'
+    end
+  end
+end

data/lib/idnow/models/identification_request.rb

@@ -0,0 +1,16 @@
+module Idnow
+  class IdentificationRequest
+    attr_accessor :id, :transaction_number
+
+    def initialize(data, transaction_number, target_host, company_id)
+      @id = data['id']
+      @transaction_number = transaction_number
+      @target_host = target_host
+      @company_id = company_id
+    end
+
+    def redirect_url
+      "#{@target_host}/#{@company_id}/identifications/#{@transaction_number}"
+    end
+  end
+end

data/lib/idnow/models/login.rb

@@ -0,0 +1,9 @@
+module Idnow
+  class Login
+    attr_accessor :auth_token
+
+    def initialize(data)
+      @auth_token = data['authToken']
+    end
+  end
+end

data/lib/idnow/models/login_data.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module Idnow
+  class LoginData
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def to_json
+      { apiKey: @api_key }.to_json
+    end
+  end
+end

data/lib/idnow/models/user_data.rb

@@ -0,0 +1,39 @@
+module Idnow
+  class UserData
+    include Idnow::Jsonable
+
+    attr_accessor :birthday, :birthname, :birthplace, :city, :country, :firstname, :gender, :lastname, :nationality, :street, :streetnumber,
+                  :title, :zipcode
+
+    def initialize(data)
+      @birthday     = dig_value('birthday', data)
+      @birthname    = dig_value('birthname', data)
+      @birthplace   = dig_value('birthplace', data)
+      @city         = dig_value('address', 'city', data)
+      @country      = dig_value('address', 'country', data)
+      @firstname    = dig_value('firstname', data)
+      @gender       = dig_value('gender', data)
+      @lastname     = dig_value('lastname', data)
+      @nationality  = dig_value('nationality', data)
+      @street       = dig_value('address', 'street', data)
+      @streetnumber = dig_value('address', 'streetnumber', data)
+      @title        = dig_value('title', data)
+      @zipcode      = dig_value('address', 'zipcode', data)
+    end
+
+    def address
+      "#{street} #{streetnumber}, #{zipcode} #{city}, #{country}"
+    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

data/lib/idnow/modules/jsonable.rb

@@ -0,0 +1,28 @@
+module Idnow
+  module Jsonable
+    def to_h
+      instance_variables.each_with_object({}) do |var, result_hash|
+        key = var.to_s.delete('@')
+        value = if instance_variable_get(var).respond_to?(:to_h)
+                  instance_variable_get(var).to_h
+                else
+                  instance_variable_get(var).to_s
+                end
+        result_hash[key] = value
+      end
+    end
+
+    def to_json
+      keys_without_underscores(to_h).to_json
+    end
+
+    private
+
+    def keys_without_underscores(obj)
+      return obj unless obj.is_a?(Hash)
+      obj.each_with_object({}) do |(k, v), result|
+        result[k.to_s.delete('_')] = keys_without_underscores(v)
+      end
+    end
+  end
+end

data/lib/idnow/post_binary_request.rb

@@ -0,0 +1,11 @@
+require 'net/http'
+
+module Idnow
+  class PostBinaryRequest < Net::HTTP::Post
+    def initialize(path, data)
+      super(path)
+      self['Content-Type'] = 'application/octet-stream'
+      self.body = data
+    end
+  end
+end

data/lib/idnow/post_json_request.rb

@@ -0,0 +1,12 @@
+# require 'json'
+require 'net/http'
+
+module Idnow
+  class PostJsonRequest < Net::HTTP::Post
+    def initialize(path, data)
+      super(path)
+      self['Content-Type'] = 'application/json'
+      self.body = data.to_json
+    end
+  end
+end

data/lib/idnow/raw_response.rb

@@ -0,0 +1,31 @@
+module Idnow
+  class RawResponse
+    attr_reader :raw
+
+    def initialize(raw_response)
+      @raw = raw_response.nil? ? raw_response.to_s : raw_response
+    end
+
+    # IDNow API always returns JSON-formatted errors,
+    # even if a successful response is raw text
+    def errors
+      if valid_json?(@raw)
+        json_data = JSON.parse(@raw)
+        json_data['errors'] if json_data.class == Hash
+      end
+    end
+
+    def errors?
+      !errors.nil?
+    end
+
+    private
+
+    def valid_json?(json)
+      JSON.parse(json)
+      return true
+    rescue JSON::ParserError
+      return false
+    end
+  end
+end

data/lib/idnow/sftp_client.rb

@@ -0,0 +1,24 @@
+require 'net/sftp'
+
+module Idnow
+  class SftpClient
+    def initialize(host:, username:, password:)
+      @host = URI.parse(host).host
+      @username = username
+      @password = password
+    end
+
+    def download(file_name)
+      data = nil
+      Net::SFTP.start(@host, @username, password: @password) do |sftp|
+        fail Idnow::Exception, "Invalid path. No identification file found under #{file_name}" if sftp.dir['.', file_name].empty?
+        begin
+          data = sftp.download!(file_name)
+        rescue Net::SFTP::Exception => e
+          raise Idnow::ConnectionException, e
+        end
+      end
+      data
+    end
+  end
+end

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: idnow
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joan Martinez, Tobias Bielohlawek
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Library to consume the IDnow API in Ruby, http://www.idnow.eu/developers
+email:
+- joan.martinez.ripoll@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- circle.yml
+- docs/IDnow_API.pdf
+- examples/idnow_automated_testing.rb
+- examples/idnow_download_identification.rb
+- examples/idnow_get_identification.rb
+- examples/idnow_upload_download_default_document.rb
+- idnow-client.gemspec
+- lib/idnow.rb
+- lib/idnow/API/authentication.rb
+- lib/idnow/API/automated_testing.rb
+- lib/idnow/API/document_definitions.rb
+- lib/idnow/API/download_documents.rb
+- lib/idnow/API/request_identifications.rb
+- lib/idnow/API/retrieve_identifications.rb
+- lib/idnow/API/upload_documents.rb
+- lib/idnow/client.rb
+- lib/idnow/configuration.rb
+- lib/idnow/exception.rb
+- lib/idnow/get_request.rb
+- lib/idnow/helpers.rb
+- lib/idnow/http_client.rb
+- lib/idnow/json_response.rb
+- lib/idnow/models/contact_data.rb
+- lib/idnow/models/document_definition.rb
+- lib/idnow/models/identification.rb
+- lib/idnow/models/identification_data.rb
+- lib/idnow/models/identification_document.rb
+- lib/idnow/models/identification_process.rb
+- lib/idnow/models/identification_request.rb
+- lib/idnow/models/login.rb
+- lib/idnow/models/login_data.rb
+- lib/idnow/models/user_data.rb
+- lib/idnow/modules/jsonable.rb
+- lib/idnow/post_binary_request.rb
+- lib/idnow/post_json_request.rb
+- lib/idnow/raw_response.rb
+- lib/idnow/sftp_client.rb
+homepage: https://github.com/solarisBank/idnow-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby client for the IDnow API
+test_files: []