idnow 1.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 68e89c9d1b1a11908376b9492588a24195deb333
-  data.tar.gz: 024274414183613e12b8dc8c2400085f5be24fc3
+SHA256:
+  metadata.gz: 3caa1be49888278cacbd44efe6daaccaca538b747312243f55c4b529f4b060da
+  data.tar.gz: 9fdd7352d6dc258acbc7c36e1697eee0865791146390c530bc75476933da6aec
 SHA512:
-  metadata.gz: f8337596ceff9678d48c84599e5f2425e8ae6d708f5d41b0bf50ff0fa7652087656d4bdcf9e0c1c64146c54b2a1e2d323e3663f92d61dff7f4b8dc71cfb6e340
-  data.tar.gz: d138e5b6fe4600e56af9bc8667b6b19735e8b881149109ccddedc671b67d19695f2c2d7622a18c8b90d6227a38be9cc7cf5512b8c919611a3ad9856a7344ba43
+  metadata.gz: f3a64af1fd998df4db251c4ddf6d7b728e759024d4f9174fb3817c30c598234bcd0589f118d36fdf062ff86fad813dda5c1b825d0ae0f582cd3cb1acef7a5fb9
+  data.tar.gz: 9e355e9c36dbdab33c17b8715f9a36b11c3e985bc6370eada59ed034eb198d0d88f230003a668698bafc1567a6e648007f6f5b5e84f49ca06c0b0f621beb16b1

data/.github/workflows/gem-push.yml

@@ -0,0 +1,67 @@
+name: Ruby Gem
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.5
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.5.x
+
+    - name: Build gem
+      run: |
+        gem build *.gemspec
+    - name: Upload gem
+      uses: actions/upload-artifact@v2
+      with:
+        name: idnow-client.gem
+        path: "*.gem"
+
+  publish:
+    name: Publish RubyGems
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/download-artifact@v2
+      with:
+        name: idnow-client.gem
+    - name: Set up Ruby 2.5
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.5.x
+    - name: Publish to RubyGems
+      run: gem push *.gem
+      env:
+        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+
+  publish_gpr:
+    name: Publish GPR
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/download-artifact@v2
+      with:
+        name: idnow-client.gem
+    - name: Set up Ruby 2.5
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.5.x
+    - name: Publish to GPR
+      run: |
+        mv *.gem idnow-client-2.3.0.gem
+        gem push --host https://rubygems.pkg.github.com/${OWNER} idnow-client-2.3.0.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{github.repository_owner}}
+
+

data/.gitignore

@@ -10,3 +10,4 @@
 /spec/reports/
 /tmp/
 tags
+.*.sw?

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
 # This configuration was generated by
 # `rubocop --auto-gen-config`
@@ -19,14 +20,12 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 31
 
-Metrics/AbcSize:
-  Enabled: false
+Metrics/BlockLength:
+  Max: 190
+  Exclude:
+    - 'spec/**/*.rb'
 
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: braces, no_braces, context_dependent
-Style/BracesAroundHashParameters:
+Metrics/AbcSize:
   Enabled: false
 
 # Offense count: 7
@@ -35,9 +34,3 @@ Style/Documentation:
 
 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

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
-  - 2.0.0
-before_install: gem install bundler -v 1.10.6
+  - 2.5.3
+
+script:
+  - make test

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.5
+
+RUN mkdir /gem
+WORKDIR /gem
+
+COPY Gemfile idnow-client.gemspec /gem/
+RUN bundle install
+
+COPY . /gem/

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in idnow.gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Dominic Breuker
+Copyright (c) 2016 solarisBank AG
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Makefile

@@ -1,2 +1,13 @@
-test:
+test: rspec
+
+rspec:
 	bundle exec rspec
+
+rubocop:
+	bundle exec rubocop
+
+build:
+	docker build -t idnow-client .
+
+dev: build
+	docker run --rm -it -v $$PWD:/gem idnow-client bash

data/README.md

@@ -1,6 +1,6 @@
 # Idnow Client
-Library to consume the [IDnow API](http://www.idnow.eu/developers)  in Ruby.
 
+Library to consume the [IDnow API](http://www.idnow.eu/developers) in Ruby. [![Build Status](https://travis-ci.com/Solarisbank/idnow-client.svg?branch=master)](https://travis-ci.com/Solarisbank/idnow-client)
 
 ## Installation
 
@@ -18,7 +18,6 @@ Or install it yourself as:
 
     $ gem install idnow
 
-
 ## Configuration
 
 The Idnow client takes three settings:
@@ -32,6 +31,7 @@ The Idnow client takes three settings:
 
 *  **company_id**
 *  **api_key**
+*  **custom_environments** (optional)
 
 You have the option of using a global singleton client:
 
@@ -39,6 +39,18 @@ You have the option of using a global singleton client:
 Idnow.env = :test
 Idnow.company_id = "mycompany"
 Idnow.api_key = "1234api_key"
+
+# optional
+Idnow.custom_environments = {
+  test: {
+    host:        'https://gateway.test.idnow.example.com',
+    target_host: 'https://go.test.idnow.example.com'
+  },
+  live: {
+    host:        'https://gateway.idnow.example.com',
+    target_host: 'https://go.idnow.example.com'
+  }
+}
 ```
 
 Or many clients can be initialized with:
@@ -48,11 +60,15 @@ 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
+Please read the official IDnow documentation for details. Some examples can also be found in 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.
+# 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',
@@ -86,22 +102,24 @@ 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.
+# 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.
+# 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
+#### Esigning
+
 ```ruby
 # Create document definition
 document_identifier = "doc_id"
@@ -132,11 +150,38 @@ Idnow.client.upload_default_document(document_identifier, file_data)
 Idnow.client.download_default_document(document_identifier)
 ```
 
+## Development & testing
+
+RSpec is used for testing. For easier development, the project is dockerized allowing development inisde the container.  Make use of following make targets:
+
+Create development container:
+
+```
+make build
+```
+
+Open development console
+
+```
+make dev
+```
+
+Inside the console, `rspec` or `bundle` can be executed.
 
-## Development
 
-RSpec is used for testing.
+### Coverage report
+
 To enable code coverage check, set COV environment variable:
 
-```COV=true bundle exec rspec```
+```sh
+COV=true make test
+```
+
+### Testing with docker
 
+To run the tests through docker, you can use the included `Dockerfile`:
+
+```sh
+make build
+docker run -it idnow-client:latest make test
+```

data/examples/idnow_automated_testing.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'idnow'
 
-fail 'please call with a transaction number' unless ARGV[0]
+raise 'please call with a transaction number' unless ARGV[0]
 
 company_id = ENV.fetch('IDNOW_COMPANY_ID')
 api_key = ENV.fetch('IDNOW_API_KEY')

data/examples/idnow_download_identification.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'idnow'
 
-fail 'please call with a transaction number' unless ARGV[0]
+raise 'please call with a transaction number' unless ARGV[0]
 
 company_id = ENV.fetch('IDNOW_COMPANY_ID')
 api_key = ENV.fetch('IDNOW_API_KEY')

data/examples/idnow_get_identification.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'idnow'
 
-fail 'please call with a transaction number' unless ARGV[0]
+raise 'please call with a transaction number' unless ARGV[0]
 
 company_id = ENV.fetch('IDNOW_COMPANY_ID')
 api_key = ENV.fetch('IDNOW_API_KEY')

data/examples/idnow_upload_download_default_document.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'idnow'
 
-fail 'please call with a document identifier (must be unique)' unless ARGV[0]
+raise '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')

data/idnow-client.gemspec

@@ -1,15 +1,15 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 Gem::Specification.new do |spec|
   spec.name          = 'idnow'
-  spec.version       = '1.0.0'
+  spec.version       = '2.3.0'
   spec.authors       = ['Joan Martinez, Tobias Bielohlawek']
-  spec.email         = ['joan.martinez.ripoll@gmail.com']
+  spec.email         = ['joan.martinez@solarisbank.de']
 
   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)
+  raise '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'
@@ -21,10 +21,12 @@ Gem::Specification.new do |spec|
 
   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'
+  spec.required_ruby_version = '>= 2.5', '< 3.1'
+
+  spec.add_development_dependency 'factory_bot'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
 end

data/lib/idnow.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'idnow/modules/jsonable'
 require 'idnow/client'
 
@@ -23,14 +25,16 @@ 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
+  # Used to request an identification through the idnow API
+  module Host
+    TEST_SERVER = 'https://gateway.test.idnow.de'
+    LIVE_SERVER = 'https://gateway.idnow.de'
   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
+  # Used for redirecting the user to the identification process
+  module TargetHost
+    TEST_SERVER = 'https://go.test.idnow.de'
+    LIVE_SERVER = 'https://go.idnow.de'
   end
 
   ENVIRONMENTS = {
@@ -45,7 +49,8 @@ module Idnow
   }.freeze
 
   def env=(env)
-    fail ArgumentError, 'Please provide a valid enviroment, :test or :live' unless ENVIRONMENTS.keys.include?(env)
+    raise ArgumentError, 'Please provide a valid enviroment, :test or :live' unless ENVIRONMENTS.keys.include?(env)
+
     @client = nil
     @env = env
   end
@@ -60,9 +65,23 @@ module Idnow
     @api_key = api_key
   end
 
+  def sftp_options=(sftp_options)
+    @client = nil
+    @sftp_options = sftp_options
+  end
+
+  def custom_environments=(custom_environments)
+    @client = nil
+    @custom_environments = custom_environments
+  end
+
+  def endpoint(env, host)
+    (@custom_environments || {}).dig(env, host) || Idnow::ENVIRONMENTS[env][host]
+  end
+
   def client
-    @client ||= Idnow::Client.new(env: @env, company_id: @company_id, api_key: @api_key)
+    @client ||= Idnow::Client.new(env: @env, company_id: @company_id, api_key: @api_key, sftp_options: @sftp_options || {})
   end
 
-  module_function :env=, :company_id=, :api_key=, :client
+  module_function :env=, :company_id=, :api_key=, :sftp_options=, :custom_environments=, :endpoint, :client
 end