yoti 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f78d9caae30514cbb608f4156a54d6c8c2f7d82a3df8afbdf6295b8239e983a7
-  data.tar.gz: 59b9aad24b60db06445300441abfdf20203b52de713976d3a6815aca159b6579
+  metadata.gz: e34d2dbc6a002d6ea68375d1e0d0ba861587db16a7502e597aaacac5f97799f4
+  data.tar.gz: 81e54ccb7d6b3270efea24d7e1a632d4719f604eccd7da49f101ff6e565ca99d
 SHA512:
-  metadata.gz: f656f156b49a6b96ed09271fcbb1fa312ef918195c184631481a9dee5e427c1c1866c58d43d97f09f7f38c7072b1bb9adb2de9acafa99d9c9f783845090d2eab
-  data.tar.gz: 601d9374b0320b4c59bf6c5378e50dbba524337ef28b2b6d74ba7eebbef4f30c029f187ce75f52a631343178e9281cd5d28c8b25e1c96c3531d1816bc67c0de8
+  metadata.gz: 4433d2b8ac27da64991fe3f1f0d2271feb3c1ad41f43b50c49d9ec0615a75714042e63ef343fb93f4f8ae98860f93a4534f2128eafe1af7813ceba6d88458620
+  data.tar.gz: 0a2338a401a97000ba2a4999347c3e4471bfa896565653d87ac2b548c11b8eae73c86a1241cad5293ef3e19922e97caa7c67658df603c7704ced9965a806abc7

data/lib/yoti.rb

@@ -51,6 +51,7 @@ require_relative 'yoti/share/attribute_issuance_details'
 
 require_relative 'yoti/doc_scan/client'
 require_relative 'yoti/doc_scan/constants'
+require_relative 'yoti/doc_scan/errors'
 
 require_relative 'yoti/doc_scan/session/create/create_session_result'
 require_relative 'yoti/doc_scan/session/create/requested_check'
@@ -74,6 +75,7 @@ require_relative 'yoti/doc_scan/session/retrieve/authenticity_check_response'
 require_relative 'yoti/doc_scan/session/retrieve/breakdown_response'
 require_relative 'yoti/doc_scan/session/retrieve/details_response'
 require_relative 'yoti/doc_scan/session/retrieve/document_fields_response'
+require_relative 'yoti/doc_scan/session/retrieve/document_id_photo_response'
 require_relative 'yoti/doc_scan/session/retrieve/face_map_response'
 require_relative 'yoti/doc_scan/session/retrieve/face_match_check_response'
 require_relative 'yoti/doc_scan/session/retrieve/frame_response'

data/lib/yoti/data_type/signed_time_stamp.rb

@@ -5,7 +5,7 @@ module Yoti
 
     def initialize(version, time_stamp)
       @version = version
-      @time_stamp = time_stamp
+      @time_stamp = time_stamp.utc
     end
   end
 end

data/lib/yoti/doc_scan/client.rb

@@ -18,15 +18,18 @@ module Yoti
             'session_specification'
           )
 
-          response = create_request
-                     .with_http_method('POST')
-                     .with_endpoint('sessions')
-                     .with_payload(session_specification)
-                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
-                     .build
-                     .execute
-
-          Yoti::DocScan::Session::Create::CreateSessionResult.new(JSON.parse(response.body))
+          request = create_request
+                    .with_http_method('POST')
+                    .with_endpoint('sessions')
+                    .with_payload(session_specification)
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            Yoti::DocScan::Session::Create::CreateSessionResult.new(JSON.parse(request.execute.body))
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
         end
 
         #
@@ -39,14 +42,17 @@ module Yoti
         def get_session(session_id)
           Validation.assert_is_a(String, session_id, 'session_id')
 
-          response = create_request
-                     .with_http_method('GET')
-                     .with_endpoint(session_path(session_id))
-                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
-                     .build
-                     .execute
-
-          Yoti::DocScan::Session::Retrieve::GetSessionResult.new(JSON.parse(response.body))
+          request = create_request
+                    .with_http_method('GET')
+                    .with_endpoint(session_path(session_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            Yoti::DocScan::Session::Retrieve::GetSessionResult.new(JSON.parse(request.execute.body))
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
         end
 
         #
@@ -58,12 +64,17 @@ module Yoti
         def delete_session(session_id)
           Validation.assert_is_a(String, session_id, 'session_id')
 
-          create_request
-            .with_http_method('DELETE')
-            .with_endpoint(session_path(session_id))
-            .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
-            .build
-            .execute
+          request = create_request
+                    .with_http_method('DELETE')
+                    .with_endpoint(session_path(session_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
         end
 
         #
@@ -79,17 +90,22 @@ module Yoti
           Validation.assert_is_a(String, session_id, 'session_id')
           Validation.assert_is_a(String, media_id, 'media_id')
 
-          response = create_request
-                     .with_http_method('GET')
-                     .with_endpoint(media_path(session_id, media_id))
-                     .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
-                     .build
-                     .execute
-
-          Yoti::Media.new(
-            response.body,
-            response.get_fields('content-type')[0]
-          )
+          request = create_request
+                    .with_http_method('GET')
+                    .with_endpoint(media_path(session_id, media_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            response = request.execute
+
+            Yoti::Media.new(
+              response.body,
+              response.get_fields('content-type')[0]
+            )
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
         end
 
         #
@@ -103,12 +119,17 @@ module Yoti
           Validation.assert_is_a(String, session_id, 'session_id')
           Validation.assert_is_a(String, media_id, 'media_id')
 
-          create_request
-            .with_http_method('DELETE')
-            .with_endpoint(media_path(session_id, media_id))
-            .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
-            .build
-            .execute
+          request = create_request
+                    .with_http_method('DELETE')
+                    .with_endpoint(media_path(session_id, media_id))
+                    .with_query_param('sdkId', Yoti.configuration.client_sdk_id)
+                    .build
+
+          begin
+            request.execute
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
         end
 
         #
@@ -117,13 +138,16 @@ module Yoti
         # @return [Yoti::DocScan::Support::SupportedDocumentsResponse]
         #
         def supported_documents
-          response = create_request
-                     .with_http_method('GET')
-                     .with_endpoint('supported-documents')
-                     .build
-                     .execute
-
-          Yoti::DocScan::Support::SupportedDocumentsResponse.new(JSON.parse(response.body))
+          request = create_request
+                    .with_http_method('GET')
+                    .with_endpoint('supported-documents')
+                    .build
+
+          begin
+            Yoti::DocScan::Support::SupportedDocumentsResponse.new(JSON.parse(request.execute.body))
+          rescue Yoti::RequestError => e
+            raise Yoti::DocScan::Error.wrap(e)
+          end
         end
 
         private

data/lib/yoti/doc_scan/constants.rb

@@ -15,6 +15,8 @@ module Yoti
       EXCLUDE = 'BLACKLIST'
       ALWAYS = 'ALWAYS'
       FALLBACK = 'FALLBACK'
+      DESIRED = 'DESIRED'
+      IGNORE = 'IGNORE'
       NEVER = 'NEVER'
       ZOOM = 'ZOOM'
       CAMERA = 'CAMERA'

data/lib/yoti/doc_scan/errors.rb

@@ -0,0 +1,81 @@
+require 'json'
+
+module Yoti
+  module DocScan
+    #
+    # Raises exceptions related to Doc Scan API requests
+    #
+    class Error < RequestError
+      def initialize(msg = nil, response = nil)
+        super(msg, response)
+
+        @default_message = msg
+      end
+
+      def message
+        @message ||= format_message
+      end
+
+      #
+      # Wraps an existing error
+      #
+      # @param [Error] error
+      #
+      # @return [self]
+      #
+      def self.wrap(error)
+        new(error.message, error.response)
+      end
+
+      private
+
+      #
+      # Formats error message from response.
+      #
+      # @return [String]
+      #
+      def format_message
+        return @default_message if @response.nil? || @response['Content-Type'] != 'application/json'
+
+        json = JSON.parse(@response.body)
+        format_response(json) || @default_message
+      end
+
+      #
+      # Format JSON error response.
+      #
+      # @param [Hash] json
+      #
+      # @return [String, nil]
+      #
+      def format_response(json)
+        return nil if json['code'].nil? || json['message'].nil?
+
+        code_message = "#{json['code']} - #{json['message']}"
+
+        unless json['errors'].nil?
+          property_errors = format_property_errors(json['errors'])
+
+          return "#{code_message}: #{property_errors.compact.join(', ')}" if property_errors.count.positive?
+        end
+
+        code_message
+      end
+
+      #
+      # Format property errors.
+      #
+      # @param [Array<Hash>] errors
+      #
+      # @return [Array<String>]
+      #
+      def format_property_errors(errors)
+        errors
+          .map do |e|
+            "#{e['property']} \"#{e['message']}\"" if e['property'] && e['message']
+          end
+          .compact
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/create/requested_text_extraction_task.rb

@@ -33,16 +33,22 @@ module Yoti
           #
           # @param [String] manual_check
           #   Describes the manual fallback behaviour applied to each Task
+          # @param [String, nil] chip_data
+          #   Describes the chip data requirement for each Task
           #
-          def initialize(manual_check)
+          def initialize(manual_check, chip_data)
             Validation.assert_is_a(String, manual_check, 'manual_check')
             @manual_check = manual_check
+
+            Validation.assert_is_a(String, chip_data, 'chip_data', true)
+            @chip_data = chip_data
           end
 
           def as_json(*_args)
             {
-              manual_check: @manual_check
-            }
+              manual_check: @manual_check,
+              chip_data: @chip_data
+            }.compact
           end
         end
 
@@ -80,11 +86,27 @@ module Yoti
             self
           end
 
+          #
+          # @return [self]
+          #
+          def with_chip_data_desired
+            @chip_data = Constants::DESIRED
+            self
+          end
+
+          #
+          # @return [self]
+          #
+          def with_chip_data_ignore
+            @chip_data = Constants::IGNORE
+            self
+          end
+
           #
           # @return [RequestedTextExtractionTask]
           #
           def build
-            config = RequestedTextExtractionTaskConfig.new(@manual_check)
+            config = RequestedTextExtractionTaskConfig.new(@manual_check, @chip_data)
             RequestedTextExtractionTask.new(config)
           end
         end

data/lib/yoti/doc_scan/session/retrieve/document_id_photo_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Yoti
+  module DocScan
+    module Session
+      module Retrieve
+        class DocumentIdPhotoResponse
+          # @return [MediaResponse]
+          attr_reader :media
+
+          #
+          # @param [Hash] document_id_photo
+          #
+          def initialize(document_id_photo)
+            @media = MediaResponse.new(document_id_photo['media']) unless document_id_photo['media'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yoti/doc_scan/session/retrieve/id_document_resource_response.rb

@@ -17,6 +17,9 @@ module Yoti
           # @return [DocumentFieldsResponse]
           attr_reader :document_fields
 
+          # @return [DocumentIdPhotoResponse]
+          attr_reader :document_id_photo
+
           #
           # @param [Hash] resource
           #
@@ -37,6 +40,8 @@ module Yoti
             end
 
             @document_fields = DocumentFieldsResponse.new(resource['document_fields']) unless resource['document_fields'].nil?
+
+            @document_id_photo = DocumentIdPhotoResponse.new(resource['document_id_photo']) unless resource['document_id_photo'].nil?
           end
 
           #

data/lib/yoti/dynamic_share_service/policy/dynamic_policy.rb

@@ -93,36 +93,54 @@ module Yoti
 
       #
       # @param [String] name
-      # @param [Hash] constraints
+      # @param [Array<SourceConstraint>] constraints
+      # @param [Bool] accept_self_asserted
       #
-      def with_wanted_attribute_by_name(name, constraints: nil)
+      def with_wanted_attribute_by_name(name, constraints: nil, accept_self_asserted: nil)
         attribute_builder = WantedAttribute.builder.with_name(name)
         constraints&.each do |constraint|
           attribute_builder.with_constraint constraint
         end
+        attribute_builder.with_accept_self_asserted(accept_self_asserted) unless accept_self_asserted.nil?
         attribute = attribute_builder.build
         with_wanted_attribute attribute
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_family_name(options = {})
         with_wanted_attribute_by_name Attribute::FAMILY_NAME, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_given_names(options = {})
         with_wanted_attribute_by_name Attribute::GIVEN_NAMES, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_full_name(options = {})
         with_wanted_attribute_by_name Attribute::FULL_NAME, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_date_of_birth(options = {})
         with_wanted_attribute_by_name Attribute::DATE_OF_BIRTH, **options
       end
 
       #
       # @param [String] derivation
-      # @param [Hash] constraints
+      # @param [Array<SourceConstraint>] constraints
       #
       def with_age_derived_attribute(derivation, constraints: nil)
         attribute_builder = WantedAttribute.builder
@@ -136,6 +154,8 @@ module Yoti
 
       #
       # @param [Integer] age
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
       #
       def with_age_over(age, options = {})
         with_age_derived_attribute(Attribute::AGE_OVER + age.to_s, **options)
@@ -143,41 +163,83 @@ module Yoti
 
       #
       # @param [Integer] age
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
       #
       def with_age_under(age, options = {})
         with_age_derived_attribute(Attribute::AGE_UNDER + age.to_s, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_gender(options = {})
         with_wanted_attribute_by_name Attribute::GENDER, **options
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_postal_address(options = {})
         with_wanted_attribute_by_name(Attribute::POSTAL_ADDRESS, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_structured_postal_address(options = {})
         with_wanted_attribute_by_name(Attribute::STRUCTURED_POSTAL_ADDRESS, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_nationality(options = {})
         with_wanted_attribute_by_name(Attribute::NATIONALITY, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_phone_number(options = {})
         with_wanted_attribute_by_name(Attribute::PHONE_NUMBER, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_selfie(options = {})
         with_wanted_attribute_by_name(Attribute::SELFIE, **options)
       end
 
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
       def with_email(options = {})
         with_wanted_attribute_by_name(Attribute::EMAIL_ADDRESS, **options)
       end
 
-      def with_document_details
-        with_wanted_attribute_by_name(Attribute::DOCUMENT_DETAILS)
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
+      def with_document_details(options = {})
+        with_wanted_attribute_by_name(Attribute::DOCUMENT_DETAILS, **options)
+      end
+
+      #
+      # @option options [Array<SourceConstraint>] :constraints
+      # @option options [Bool] :accept_self_asserted
+      #
+      def with_document_images(options = {})
+        with_wanted_attribute_by_name(Attribute::DOCUMENT_IMAGES, **options)
       end
     end
   end

data/lib/yoti/errors.rb

@@ -7,16 +7,14 @@ module Yoti
     attr_reader :response
 
     def initialize(message, response = nil)
-      super(append_response_message(message, response))
+      super(message)
       @response = response
     end
 
-    private
+    def message
+      return super if @response.nil? || @response.body.empty?
 
-    def append_response_message(message, response)
-      return message if response.nil? || response.body.empty?
-
-      "#{message}: #{response.body}"
+      "#{super}: #{@response.body}"
     end
   end
 

data/lib/yoti/version.rb

@@ -1,4 +1,4 @@
 module Yoti
   # @return [String] the gem's current version
-  VERSION = '1.7.1'.freeze
+  VERSION = '1.8.0'.freeze
 end

data/yoti.gemspec

@@ -18,7 +18,19 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/getyoti/yoti-ruby-sdk'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|examples|docs)/|^sonar-project.properties$|^.dependabot/config.yml$|^.travis.yml$}) }
+  exclude_patterns = [
+    '^(test|spec|features|examples|docs|.github)/',
+    '^.gitignore$',
+    '^sonar-project.properties$',
+    '^.dependabot/config.yml$',
+    '^.travis.yml$',
+    '^CONTRIBUTING.md$',
+    '^Guardfile$',
+    '^Rakefile$',
+    '^yardstick.yml$',
+    '^rubocop.yml$'
+  ]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/#{exclude_patterns.join('|')}/) }
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.4'
@@ -28,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'dotenv', '~> 2.2'
   spec.add_development_dependency 'generator_spec', '~> 0.9'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'simplecov', '~> 0.17.1'
   spec.add_development_dependency 'webmock', '~> 3.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yoti
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Yoti
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -160,14 +160,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/ISSUE_TEMPLATE.md"
-- ".gitignore"
-- CONTRIBUTING.md
 - Gemfile
-- Guardfile
 - LICENSE.md
 - README.md
-- Rakefile
 - lib/generators/yoti/install/install_generator.rb
 - lib/generators/yoti/install/templates/yoti.rb
 - lib/yoti.rb
@@ -189,6 +184,7 @@ files:
 - lib/yoti/data_type/signed_time_stamp.rb
 - lib/yoti/doc_scan/client.rb
 - lib/yoti/doc_scan/constants.rb
+- lib/yoti/doc_scan/errors.rb
 - lib/yoti/doc_scan/session/create/create_session_result.rb
 - lib/yoti/doc_scan/session/create/document_filter.rb
 - lib/yoti/doc_scan/session/create/document_restrictions_filter.rb
@@ -209,6 +205,7 @@ files:
 - lib/yoti/doc_scan/session/retrieve/check_response.rb
 - lib/yoti/doc_scan/session/retrieve/details_response.rb
 - lib/yoti/doc_scan/session/retrieve/document_fields_response.rb
+- lib/yoti/doc_scan/session/retrieve/document_id_photo_response.rb
 - lib/yoti/doc_scan/session/retrieve/face_map_response.rb
 - lib/yoti/doc_scan/session/retrieve/face_match_check_response.rb
 - lib/yoti/doc_scan/session/retrieve/frame_response.rb
@@ -266,8 +263,6 @@ files:
 - lib/yoti/util/log.rb
 - lib/yoti/util/validation.rb
 - lib/yoti/version.rb
-- rubocop.yml
-- yardstick.yml
 - yoti.gemspec
 homepage: https://github.com/getyoti/yoti-ruby-sdk
 licenses:

data/.github/ISSUE_TEMPLATE.md

@@ -1,17 +0,0 @@
----
-name: Custom issue template
-about: " There's a better way to get help!"
-title: ''
-labels: ''
-assignees: ''
-
----
-
-#
-# Wait ✋
-#
-# There's a better way to get help!
-#
-# Send your questions or issues to sdksupport@yoti.com
-#
-#

data/.gitignore

@@ -1,40 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-.env
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-/yardoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Ignore Yardstick measurement files
-/measurement
-examples/rails/public/*.jpeg
-examples/sinatra/public/*.jpeg

data/CONTRIBUTING.md

@@ -1,98 +0,0 @@
-# Contributing
-
-After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rake spec` to run the tests. To install this gem onto your local machine, run `bundle exec rake install`.
-
-You can use [Guard][] to automatically run the tests every time a file in the `lib` or `spec` folder changes.
-
-Run Guard through Bundler with:
-
-```shell
-bundle exec guard
-```
-
-[Guard]: https://github.com/guard/guard
-
-## Dependencies
-
-Although this gem supports Ruby 2.0.0, in order to use the latest development dependencies you have to use at least Ruby 2.2.2.
-
-## Requirements
-
-### Code coverage
-
-The 100% code coverage requirement must be met before submitting new code.
-This can be checked by opening the generated [SimpleCov][] files:
-
- ```shell
-open coverage/index.html
- ```
-
-### Style guide
-
-The Ruby style guide is configured in the [rubocop.yml](rubocop.yml) file and can be checked by running:
-
-```shell
-bundle exec rake rubocop
-```
-
-### Documentation
-
-The documentation uses the [Yard][] format. Please ensure all new classes and methods are fully documented.
-
-There are a few Rake tasks to handle documentation:
-
-```shell
-bundle exec rake measurement
-```
-
-Verifies the documentation with [Yardstick][] and generates the `measurement/report.txt` file, containing tips on how to improve the documentation coverage.
-
-```shell
-bundle exec rake yard
-```
-
-Generates [YARD][] documentation in the `./yardoc` folder.
-
-### Git
-
-Commit messages should ideally start with one of the following verbs:
-
-* Add
-* Merge
-* Fix
-* Remove
-* Improve
-* Use
-
-[SimpleCov]:   https://github.com/colszowka/simplecov
-[Yard]:        http://yardoc.org/
-[Yardstick]:   https://github.com/dkubb/yardstick
-
-## Publishing a new release
-
-* Create a new release on [GitHub](https://github.com/getyoti/yoti-ruby-sdk/releases)
-* Build the gem and push it to [RubyGems](https://rubygems.org/gems/yoti)
-
-```shell
-rake build
-gem push pkg/yoti-[version].gem
-```
-
-## Submitting a pull request
-
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add specs for your unimplemented feature or bug fix.
-4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake`. If your specs fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 3.
-8. If Rubocop warns you about styling errors, correct them based on the guidelines and run `bundle exec rake rubocop` to make sure all offences are gone.
-9. Add documentation for your feature or bug fix.
-10. Commit and push your changes.
-11. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/

data/Guardfile

@@ -1,11 +0,0 @@
-guard :rspec, cmd: 'bundle exec rspec -c -f doc' do
-  # watch /lib/ files
-  watch(%r{^lib/(.+).rb$}) do |m|
-    "spec/#{m[1]}_spec.rb"
-  end
-
-  # watch /spec/ files
-  watch(%r{^spec/(.+).rb$}) do |m|
-    "spec/#{m[1]}.rb"
-  end
-end

data/Rakefile

@@ -1,50 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'yaml'
-
-################################
-# Tests                        #
-################################
-
-RSpec::Core::RakeTask.new(:test_yoti) do |t|
-  t.pattern = ['spec/yoti']
-end
-
-RSpec::Core::RakeTask.new(:test_generators) do |t|
-  t.pattern = ['spec/generators']
-end
-
-RSpec::Core::RakeTask.new(:spec)
-
-################################
-# Rubocop                      #
-################################
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop) do |t|
-  t.options = ['--config', 'rubocop.yml']
-end
-
-################################
-# Documentation                #
-################################
-
-require 'yard'
-YARD::Rake::YardocTask.new do |t|
-  t.options = ['--output-dir', './yardoc']
-  t.stats_options = ['--list-undoc']
-end
-
-yardstick_options = YAML.load_file('yardstick.yml')
-
-require 'yardstick/rake/measurement'
-Yardstick::Rake::Measurement.new(:measurement, yardstick_options) do |measurement|
-  measurement.output = 'measurement/report.txt'
-end
-
-################################
-# Defaults                     #
-################################
-
-task default: %i[spec rubocop]
-task test: %i[test_yoti test_generators rubocop]

data/rubocop.yml

@@ -1,65 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  DisplayStyleGuide: true
-  TargetRubyVersion: 2.4
-  Exclude:
-    - 'examples/rails/config/**/*'
-    - 'examples/doc_scan/config/**/*'
-    - 'examples/doc_scan/bin/**/*'
-    - 'lib/yoti/protobuf/attrpubapi/*'
-    - 'lib/yoti/protobuf/compubapi/*'
-    - 'lib/yoti/protobuf/sharepubapi/*'
-
-Metrics/AbcSize:
-  Enabled: false
-  Max: 23
-  Exclude:
-    - examples/rails/app/controllers/yoti_controller.rb
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/**/*.rb
-    - yoti.gemspec
-
-Metrics/CyclomaticComplexity:
-  Max: 9
-
-Metrics/ClassLength:
-  Enabled: false
-  Max: 115
-
-Layout/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
-  Enabled: false
-  CountComments: false
-  Max: 19
-  Exclude:
-    - spec/yoti/data_type/multi_value_spec.rb
-
-Style/Documentation:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Style/NumericLiterals:
-  Enabled: false
-
-Style/MutableConstant:
-  Enabled: false
-
-Naming/MethodName:
-  Exclude:
-    - lib/yoti/util/anchor_processor.rb
-
-Naming/PredicateName:
-  Exclude:
-    - lib/yoti/util/age_processor.rb
-
-Metrics/ParameterLists:
-  Exclude:
-    - lib/yoti/doc_scan/session/create/sdk_config.rb
-    - lib/yoti/doc_scan/session/create/session_specification.rb
-    - spec/yoti/doc_scan/client_spec.rb

data/yardstick.yml

@@ -1,9 +0,0 @@
-rules:
-  ApiTag::Presence:
-    enabled: false
-  ApiTag::Inclusion:
-    enabled: false
-  ApiTag::PrivateMethod:
-    enabled: false
-  ExampleTag:
-    enabled: false