idnow 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68e89c9d1b1a11908376b9492588a24195deb333
+  data.tar.gz: 024274414183613e12b8dc8c2400085f5be24fc3
+SHA512:
+  metadata.gz: f8337596ceff9678d48c84599e5f2425e8ae6d708f5d41b0bf50ff0fa7652087656d4bdcf9e0c1c64146c54b2a1e2d323e3663f92d61dff7f4b8dc71cfb6e340
+  data.tar.gz: d138e5b6fe4600e56af9bc8667b6b19735e8b881149109ccddedc671b67d19695f2c2d7622a18c8b90d6227a38be9cc7cf5512b8c919611a3ad9856a7344ba43

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/vendor/
+/bin/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,43 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.2
+
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-01-27 19:56:34 +0100 using RuboCop version 0.36.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 8
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 140
+
+Metrics/MethodLength:
+  Max: 31
+
+Metrics/AbcSize:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# Offense count: 7
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
+Style/FileName:
+  Exclude:
+    - 'lib/solaris/oauth2-error_monkey-patch.rb'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in idnow.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dominic Breuker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,2 @@
+test:
+	bundle exec rspec

data/README.md

@@ -0,0 +1,142 @@
+# Idnow Client
+Library to consume the [IDnow API](http://www.idnow.eu/developers)  in Ruby.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'idnow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install idnow
+
+
+## Configuration
+
+The Idnow client takes three settings:
+
+*  **env**
+
+  - can be set to `:live` or `:test`. Following the IDnow API documentation, each of these environments will correspondingly set the host to:
+
+      -  Live server `gateway.idnow.de`
+      -  Test server `gateway.test.idnow.de`
+
+*  **company_id**
+*  **api_key**
+
+You have the option of using a global singleton client:
+
+```ruby
+Idnow.env = :test
+Idnow.company_id = "mycompany"
+Idnow.api_key = "1234api_key"
+```
+
+Or many clients can be initialized with:
+
+```ruby
+client = Idnow::Client.new(env: @env, company_id: @company_id, api_key: @api_key)
+```
+
+## API Summary
+Please read the official IDnow documentation for details. Some examples can also be found at the examples folder.
+
+####Identifications
+```ruby
+# Identification data, all fields are optional. If you want to use a testing robot instead of a real agent for the identification, write the robot name at the first_name, last_name or any custom field.
+data = Idnow::IdentificationData.new({
+   birthday: '1984-07-20',
+   birthplace: 'Buxtehude',
+   birthname: 'Meier',
+   city: 'Berlin',
+   country: 'DE',
+   custom1: 'first custom parameter',
+   custom2: 'second custom parameter',
+   custom3: 'third custom parameter',
+   custom4: 'fourth custom parameter',
+   custom5: 'fifth custom parameter',
+   trackingid: 'track123',
+   email: 'petra.meier@example.com',
+   firstname: 'X-AUTOTEST-HAPPYPATH',
+   gender: 'FEMALE',
+   lastname: 'Meier',
+   nationality: 'DE',
+   street: 'Sesamstraße',
+   streetnumber: '34c',
+   title: 'Prof. Dr. Dr. hc',
+   zipcode: '10439'
+})
+
+# Request Identification
+transaction_number = "A_TRANSACTION_NUMBER"
+Idnow.client.request_identification(transaction_number: transaction_number, identification_data: data)
+
+# Start testing robot - Only needed for automated robot testing
+Idnow.client.testing_start(transaction_number: transaction_number)
+
+# Testing video chat - Only needed for automated robot testing
+Idnow.client.testing_request_video_chat(transaction_number: transaction_number)
+
+# List successful identifications.  When using automated robots, keep in mind that it might take a while until the identification is completed.
+Idnow.client.login
+Idnow.client.list_identifications
+
+# List identifications by status pending or failed
+Idnow.client.list_identifications(status: 'pending')
+
+# Get identification. When using automated robots, keep in mind that it might take a while until the identification is completed.
+Idnow.client.get_identification(transaction_number: transaction_number)
+
+# Download identification files
+Idnow.client.download_identification(transaction_number: transaction_number)
+
+```
+
+####Esigning
+```ruby
+# Create document definition
+document_identifier = "doc_id"
+document_data = {
+  "optional": true,
+  "name": 'SomeDoc',
+  "identifier": document_identifier,
+  "mimeType": 'txt',
+  "sortOrder": 1
+}
+
+Idnow.client.create_document_definition(document_data)
+
+# List document definitions
+Idnow.client.login
+Idnow.client.list_document_definitions
+# Or for cached results
+Idnow.client.list_cached_document_definitions
+
+# Upload document for a given identification
+file_data = File.open('path/to/some/file.pdf', 'r')
+Idnow.client.upload_identification_document(transaction_number, document_identifier, file_data)
+
+# Upload default document
+Idnow.client.upload_default_document(document_identifier, file_data)
+
+# Download default document
+Idnow.client.download_default_document(document_identifier)
+```
+
+
+## Development
+
+RSpec is used for testing.
+To enable code coverage check, set COV environment variable:
+
+```COV=true bundle exec rspec```
+

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  ruby:
+    version: 2.2.3
+
+test:
+  override:
+    - make test

data/examples/idnow_automated_testing.rb

@@ -0,0 +1,35 @@
+require 'idnow'
+
+fail 'please call with a transaction number' unless ARGV[0]
+
+company_id = ENV.fetch('IDNOW_COMPANY_ID')
+api_key = ENV.fetch('IDNOW_API_KEY')
+
+transaction_number = ARGV[0]
+
+Idnow.env = :test
+Idnow.company_id = company_id
+Idnow.api_key = api_key
+
+data = Idnow::IdentificationData.new({
+                                       firstname: 'X-AUTOTEST-HAPPYPATH'
+                                     })
+puts "\n\n"
+
+puts "--- Request identification for #{transaction_number} ---"
+identification = Idnow.client.request_identification(transaction_number: transaction_number, identification_data: data)
+puts identification.inspect
+
+puts "\n\n"
+
+puts '--- Start testing robot ---'
+testing_start = Idnow.client.testing_start(transaction_number: transaction_number)
+puts testing_start.inspect
+
+puts "\n\n"
+
+puts '--- Testing video chat---'
+Idnow.client.testing_request_video_chat(transaction_number: transaction_number)
+
+puts 'It might take a while until the identification is marked as successfull,' \
+     ' wait a little bit and then run idnow_get_identification.rb script'

data/examples/idnow_download_identification.rb

@@ -0,0 +1,16 @@
+require 'idnow'
+
+fail 'please call with a transaction number' unless ARGV[0]
+
+company_id = ENV.fetch('IDNOW_COMPANY_ID')
+api_key = ENV.fetch('IDNOW_API_KEY')
+
+transaction_number = ARGV[0]
+
+Idnow.env = :test
+Idnow.company_id = company_id
+Idnow.api_key = api_key
+
+Idnow.client.login
+puts 'Downloading ...'
+Idnow.client.download_identification(transaction_number: transaction_number)

data/examples/idnow_get_identification.rb

@@ -0,0 +1,16 @@
+require 'idnow'
+
+fail 'please call with a transaction number' unless ARGV[0]
+
+company_id = ENV.fetch('IDNOW_COMPANY_ID')
+api_key = ENV.fetch('IDNOW_API_KEY')
+
+transaction_number = ARGV[0]
+
+Idnow.env = :test
+Idnow.company_id = company_id
+Idnow.api_key = api_key
+
+Idnow.client.login
+identification = Idnow.client.get_identification(transaction_number: transaction_number)
+puts identification.inspect

data/examples/idnow_upload_download_default_document.rb

@@ -0,0 +1,33 @@
+require 'idnow'
+
+fail 'please call with a document identifier (must be unique)' unless ARGV[0]
+
+company_id = ENV.fetch('IDNOW_COMPANY_ID')
+api_key = ENV.fetch('IDNOW_API_KEY')
+
+document_identifier = ARGV[0]
+
+Idnow.env = :test
+Idnow.company_id = company_id
+Idnow.api_key = api_key
+
+Idnow.client.login
+
+# Please uncomment the lines below to also create a document definition
+# document_data = {
+#   "optional": true,
+#   "name": 'SomeDoc',
+#   "identifier": document_identifier.to_s,
+#   "mimeType": 'txt',
+#   "sortOrder": 1
+# }
+
+# puts 'Creating document definition...'
+# Idnow.client.create_document_definition(document_data)
+
+puts 'Uploading default document...'
+file = File.open('spec/support/test_files/example.txt', 'r')
+Idnow.client.upload_default_document(document_identifier, file)
+
+puts 'Downloading default document...'
+Idnow.client.download_default_document(document_identifier)

data/idnow-client.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'idnow'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Joan Martinez, Tobias Bielohlawek']
+  spec.email         = ['joan.martinez.ripoll@gmail.com']
+
+  spec.summary       = 'Ruby client for the IDnow API'
+  spec.description   = 'Library to consume the IDnow API in Ruby, http://www.idnow.eu/developers'
+
+  fail 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
+
+  spec.homepage      = 'https://github.com/solarisBank/idnow-client'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'net-sftp', '~>2.1'
+
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'rubocop', '~> 0.36.0'
+  spec.add_development_dependency 'factory_girl', '~> 4.5'
+  spec.add_development_dependency 'shoulda-matchers', '~>3.1'
+end

data/lib/idnow.rb

@@ -0,0 +1,68 @@
+require 'idnow/modules/jsonable'
+require 'idnow/client'
+
+require 'idnow/http_client'
+require 'idnow/sftp_client'
+require 'idnow/post_json_request'
+require 'idnow/post_binary_request'
+require 'idnow/get_request'
+require 'idnow/raw_response'
+require 'idnow/json_response'
+require 'idnow/exception'
+
+require 'idnow/models/login'
+require 'idnow/models/identification_request'
+require 'idnow/models/identification'
+require 'idnow/models/identification_process'
+
+require 'idnow/models/user_data'
+require 'idnow/models/contact_data'
+require 'idnow/models/identification_data'
+require 'idnow/models/identification_document'
+require 'idnow/models/login_data'
+require 'idnow/models/document_definition'
+
+module Idnow
+  module Host # Used to request an identification through the idnow API
+    TEST_SERVER = 'https://gateway.test.idnow.de'.freeze
+    LIVE_SERVER = 'https://gateway.idnow.de'.freeze
+  end
+
+  module TargetHost # Used for redirecting the user to the identification process
+    TEST_SERVER = 'https://go.test.idnow.de'.freeze
+    LIVE_SERVER = 'https://go.idnow.de'.freeze
+  end
+
+  ENVIRONMENTS = {
+    test: {
+      host: Host::TEST_SERVER,
+      target_host: TargetHost::TEST_SERVER
+    },
+    live: {
+      host: Host::LIVE_SERVER,
+      target_host: TargetHost::LIVE_SERVER
+    }
+  }.freeze
+
+  def env=(env)
+    fail ArgumentError, 'Please provide a valid enviroment, :test or :live' unless ENVIRONMENTS.keys.include?(env)
+    @client = nil
+    @env = env
+  end
+
+  def company_id=(company_id)
+    @client = nil
+    @company_id = company_id
+  end
+
+  def api_key=(api_key)
+    @client = nil
+    @api_key = api_key
+  end
+
+  def client
+    @client ||= Idnow::Client.new(env: @env, company_id: @company_id, api_key: @api_key)
+  end
+
+  module_function :env=, :company_id=, :api_key=, :client
+end