omniauth-yoti 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0764709e7bb83835d612ac5279ca733cdf6fbcec'
-  data.tar.gz: 692ce05e5faae22f3370df7901de1934d6673d61
+  metadata.gz: 4dbb17c7f98c58491e886790858ba3b6a097d242
+  data.tar.gz: 36ae694b78aa792dd3b29ca58de17fe3430a34b5
 SHA512:
-  metadata.gz: 044f4078c68d7e328904718253e7b24097d83c15ee54cbf17b94cef127eb9f8f43543a85fd8bd480cdd6c090d647abe35a5be224092da9447fd303832d760efa
-  data.tar.gz: cdd2f2dc69c8b7ed12d46206c2d8e492cc2219832301766cdd06466cd0be40f5d6c1c144743e43595e6da9829515b9fbb627b5fca8c0c939a7812b5cb0cd9a37
+  metadata.gz: 78e98484084f29a6075c74b3a7780f06b3e2082ff527a2dc808311be33953e608b0b6ef29f7b63a769f9c69b8e3e3fee14f3bf8c3f4abba4702cf501ade6e772
+  data.tar.gz: 105219e7d3863a979747a4fc353b132d6372c13d111ad43df1c1b9f3f82cef371f4c50670eacbc334482703a8c64c7ff3761b2f6490cfb8564923a4b45160444

data/CHANGELOG.md

@@ -1,17 +1,23 @@
-# Change Log
+# Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 1.1.3 - 2017-11-01
+## [1.2.0] - 2018-03-09
+### Added
+- `age_verified` returns a boolean value of the age validation
+
+### Changed
+- Moved the profile attributes in the response Hash  from `extra` to `info`. Please check [README.md](README.md#upgrading-from-version-11) for details.
 
+## [1.1.3] - 2017-11-01
 ### Added
 - `base64_selfie_uri` value
 
-## 1.1.2 - 2017-10-18
+## [1.1.2] - 2017-10-18
 
-## 1.1.1 - 2017-09-13
+## [1.1.1] - 2017-09-13
 ### Changed
 - Switched from proprietary to MIT license
 
@@ -21,8 +27,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - `simplecov` `~> 0.15`
 - `webmock` `~> 3.0`
 
-## 1.1.0 - 2017-04-11
-Updates dependencies to the latest versions and aligns extra fields naming conventions with the Yoti attributes.
+## [1.1.0] - 2017-04-11
+Updated dependencies to the latest versions and aligns extra fields naming conventions with the Yoti attributes.
 
 ### Added
 - `email_address` field
@@ -40,10 +46,10 @@ Updates dependencies to the latest versions and aligns extra fields naming conve
 - `simplecov` `~> 0.14`
 - `webmock` `~> 2.3`
 
-## 1.0.1 - 2016-11-28
+## [1.0.1] - 2016-11-28
 ### Added
 - Yoti proprietary license
 
-## 1.0.0 - 2016-11-25
+## [1.0.0] - 2016-11-25
 ### Added
 - This is an initial public release.

data/README.md

@@ -19,13 +19,13 @@ gem 'omniauth-yoti'
 And then execute:
 
 ```shell
-$ bundle
+bundle
 ```
 
 Or install it yourself as:
 
 ```shell
-$ gem install omniauth-yoti
+gem install omniauth-yoti
 ```
 
 ## Configuration
@@ -63,21 +63,42 @@ A call to `/auth/yoti/callback` will open the Yoti authentication page, and afte
   "provider" => "yoti",
   "uid" => "mHvpV4...",
   "info" => {
-              "name" => "mHvpV4Mm+yMb...",
-              "base64_selfie_uri" => "data:image/jpeg;base64,/9j/2wCEAAMCAg..."
-            },
+    "name" => "John Doe",
+    "selfie" => "jpeg image data file",
+    "full_name" => "John Doe",
+    "given_names" => "John",
+    "family_name" => "Doe",
+    "phone_number" => "07474747474",
+    "email_address" => "email@example.com",
+    "date_of_birth" => "1989-11-09",
+    "postal_address" => "Fountain House\n130 Fenchurch St\nLONDON\nEC3M 5DJ",
+    "gender" => "MALE",
+    "nationality" => "GBR"
+    "base64_selfie_uri" => "data:image/jpeg;base64,/9j/2wCEAAMCAg..."
+    "age_verified" => true
+  },
   "credentials" => {},
   "extra" => {
-               "selfie" => "jpeg image file",
-               "given_names" => "Given Name",
-               "family_name" => "Family Name",
-               "phone_number" => "07474747474",
-               "email_address" => "email@example.com",
-               "date_of_birth" => nil,
-               "postal_address" => nil,
-               "gender" => 'MALE',
-               "nationality" => nil
-             }
+    { "raw_info" =>
+      {
+        "selfie" => "jpeg image data file",
+        "full_name" => "John Doe",
+        "given_names" => "Given Name",
+        "family_name" => "Family Name",
+        "phone_number" => "07474747474",
+        "email_address" => "email@example.com",
+        "date_of_birth" => "1989-11-09",
+        "postal_address" => "Fountain House\n130 Fenchurch St\nLONDON\nEC3M 5DJ",
+        "gender" => "MALE",
+        "nationality" => "GBR",
+        "age_over:18" => true
+      }
+    }
 }
-
 ```
+
+## Upgrading from version 1.1
+
+Most of the profile attributes that were being stored in the `extra` fields got moved to `info`.
+
+e.g. `request.env['omniauth.auth']['extra']['given_names']` will become `request.env['omniauth.auth']['info']['given_names']`

data/lib/omniauth/strategies/yoti.rb

@@ -13,14 +13,12 @@ module OmniAuth
       end
 
       uid { yoti_user_id }
-      info {{
-        name: yoti_user_id,
-        base64_selfie_uri: base64_selfie_uri
-      }}
 
-      def extra
-        @raw_info ||= {
+      info do
+        {
+          name: yoti_user_profile['full_name'],
           selfie: yoti_user_profile['selfie'],
+          full_name: yoti_user_profile['full_name'],
           given_names: yoti_user_profile['given_names'],
           family_name: yoti_user_profile['family_name'],
           phone_number: yoti_user_profile['phone_number'],
@@ -28,10 +26,22 @@ module OmniAuth
           date_of_birth: yoti_user_profile['date_of_birth'],
           postal_address: yoti_user_profile['postal_address'],
           gender: yoti_user_profile['gender'],
-          nationality: yoti_user_profile['nationality']
+          nationality: yoti_user_profile['nationality'],
+          base64_selfie_uri: base64_selfie_uri,
+          age_verified: age_verified
         }
       end
 
+      extra do
+        {
+          raw_info: raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= yoti_user_profile
+      end
+
       private
 
       def yoti_activity_details
@@ -53,6 +63,10 @@ module OmniAuth
         yoti_activity_details.base64_selfie_uri
       end
 
+      def age_verified
+        yoti_activity_details.age_verified
+      end
+
       def configure_yoti_client!
         ::Yoti.configure do |config|
           config.client_sdk_id = options.client_options[:client_sdk_id]

data/lib/omniauth/yoti/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Yoti
-    VERSION = '1.1.3'.freeze
+    VERSION = '1.2.0'.freeze
   end
 end

data/omniauth-yoti.gemspec

@@ -1,6 +1,4 @@
-# coding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'omniauth/yoti/version'
 
@@ -22,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.1.9'
 
   spec.add_dependency 'omniauth', '~> 1.6'
-  spec.add_dependency 'yoti', '~> 1.1.0'
+  spec.add_dependency 'yoti', '~> 1.2.1'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 12.1'

data/rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.1.9
 
 Metrics/AbcSize:
   Max: 20
@@ -13,6 +13,9 @@ Metrics/MethodLength:
   CountComments: false
   Max: 15
 
+Metrics/BlockLength:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -22,5 +25,5 @@ Style/FrozenStringLiteralComment:
 Style/NumericLiterals:
   Enabled: false
 
-Style/FileName:
+Naming:
   Enabled: false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-yoti
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Sebastian Zaremba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement