idnow 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82db134ab8710048f63870b2f4c5735b4a4b2c2808481efedd2bd0816e63d3bb
-  data.tar.gz: a021696004917135fe482aa575ef2fd18c8d27d8e3e46cd7737511012a733354
+  metadata.gz: 3caa1be49888278cacbd44efe6daaccaca538b747312243f55c4b529f4b060da
+  data.tar.gz: 9fdd7352d6dc258acbc7c36e1697eee0865791146390c530bc75476933da6aec
 SHA512:
-  metadata.gz: e0be012fca98d2b9385292d99b50a33dc61889e7e9251ca3ce0c2f56c9b95f92b00a3960d8df66456e188129a5bf44701d9891856fe02466c9648002686cbfaa
-  data.tar.gz: cc023ff9bf7703e4b987ef6b24b5af7745ef231f4ca1ef57d8dc57d5e15f20a07afaff5b5cc628b699e11443b195cfd632ef3e455a40c7aa399cf4f66717e8de
+  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/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.5
+  NewCops: enable
 
 # This configuration was generated by
 # `rubocop --auto-gen-config`
@@ -27,13 +28,6 @@ Metrics/BlockLength:
 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

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.3.3
+  - 2.5.3
 
 script:
   - make test

data/Dockerfile

@@ -1,12 +1,8 @@
-FROM ruby:2.3-alpine
+FROM ruby:2.5
 
 RUN mkdir /gem
 WORKDIR /gem
 
-RUN apk update
-RUN apk add git build-base
-RUN gem install bundler
-
 COPY Gemfile idnow-client.gemspec /gem/
 RUN bundle install
 

data/Makefile

@@ -5,3 +5,9 @@ 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
 
@@ -152,7 +152,22 @@ Idnow.client.download_default_document(document_identifier)
 
 ## Development & testing
 
-RSpec is used for 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.
+
 
 ### Coverage report
 
@@ -167,6 +182,6 @@ COV=true make test
 To run the tests through docker, you can use the included `Dockerfile`:
 
 ```sh
-docker build . -t idnow-client
+make build
 docker run -it idnow-client:latest make test
 ```

data/idnow-client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'idnow'
-  spec.version       = '2.2.0'
+  spec.version       = '2.3.0'
   spec.authors       = ['Joan Martinez, Tobias Bielohlawek']
   spec.email         = ['joan.martinez@solarisbank.de']
 
@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'net-sftp', '~>2.1'
 
-  spec.required_ruby_version = '~> 2.3'
+  spec.required_ruby_version = '>= 2.5', '< 3.1'
 
-  spec.add_development_dependency 'factory_bot', '~> 4.5'
-  spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'rubocop', '~> 0.54.0'
-  spec.add_development_dependency 'shoulda-matchers', '~>3.1'
-  spec.add_development_dependency 'simplecov', '~> 0.10'
-  spec.add_development_dependency 'webmock', '~> 1.22'
+  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

@@ -50,6 +50,7 @@ module Idnow
 
   def env=(env)
     raise ArgumentError, 'Please provide a valid enviroment, :test or :live' unless ENVIRONMENTS.keys.include?(env)
+
     @client = nil
     @env = env
   end

data/lib/idnow/API/automated_testing.rb

@@ -8,13 +8,13 @@ module Idnow
       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

@@ -8,7 +8,7 @@ module Idnow
 
         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
@@ -16,14 +16,15 @@ module Idnow
 
         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)
+      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

data/lib/idnow/API/download_documents.rb

@@ -8,7 +8,7 @@ module Idnow
 
         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

@@ -6,7 +6,7 @@ module Idnow
       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

@@ -11,10 +11,11 @@ module Idnow
         unless status.nil? || IDENTIFICATION_STATUSES.include?(status)
           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
@@ -25,7 +26,7 @@ module Idnow
 
         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

@@ -17,8 +17,9 @@ module Idnow
 
       def upload_document(file_data, request_path)
         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

@@ -26,6 +26,7 @@ module Idnow
       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

data/lib/idnow/configuration.rb

@@ -10,9 +10,7 @@ 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
@@ -20,8 +18,5 @@ module Idnow
         PRODUCTION = 'https://gateway.idnow.de'
       end
     end
-    attr_accessor :host
-
-    attr_accessor :api_version
   end
 end

data/lib/idnow/helpers.rb

@@ -5,7 +5,7 @@ module Idnow
     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/models/identification_data.rb

@@ -9,22 +9,24 @@ module Idnow
       FEMALE = 'FEMALE'
     end
 
+    # 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|
+      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)

data/lib/idnow/models/login_data.rb

@@ -8,7 +8,7 @@ module Idnow
       @api_key = api_key
     end
 
-    def to_json
+    def to_json(*_args)
       { apiKey: @api_key }.to_json
     end
   end

data/lib/idnow/modules/jsonable.rb

@@ -14,7 +14,7 @@ module Idnow
       end
     end
 
-    def to_json
+    def to_json(*_args)
       keys_without_underscores(to_h).to_json
     end
 
@@ -22,6 +22,7 @@ module Idnow
 
     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

data/lib/idnow/raw_response.rb

@@ -13,7 +13,7 @@ module Idnow
     def errors
       if valid_json?(@raw)
         json_data = JSON.parse(@raw)
-        json_data['errors'] if json_data.class == Hash
+        json_data['errors'] if json_data.instance_of?(Hash)
       end
     end
 

data/lib/idnow/sftp_client.rb

@@ -16,6 +16,7 @@ module Idnow
       options = @options.merge(password: @password)
       Net::SFTP.start(@host, @username, options) do |sftp|
         raise Idnow::Exception, "Invalid path. No identification file found under #{file_name}" unless file_exists(sftp, file_name)
+
         begin
           data = sftp.download!(file_name)
         rescue Net::SFTP::Exception => e

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idnow
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Joan Martinez, Tobias Bielohlawek
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-sftp
@@ -28,86 +28,86 @@ dependencies:
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: '0'
 description: Library to consume the IDnow API in Ruby, http://www.idnow.eu/developers
 email:
 - joan.martinez@solarisbank.de
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -125,7 +126,6 @@ files:
 - LICENSE.txt
 - Makefile
 - README.md
-- circle.yml
 - docs/IDnow_API.pdf
 - examples/idnow_automated_testing.rb
 - examples/idnow_download_identification.rb
@@ -172,9 +172,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+  - - "<"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/circle.yml

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