Add specs and general tweaks

Author: Vasile Zaremba

.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--order random

Gemfile

@@ -1,3 +1,9 @@
 source 'https://rubygems.org'
 
+gem 'guard'
+gem 'guard-rspec'
+gem 'pry'
+gem 'pry-byebug'
+gem 'rubocop'
+
 gemspec

Guardfile

@@ -0,0 +1,11 @@
+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

README.md

@@ -6,9 +6,7 @@ This gem contains the Yoti strategy for OmniAuth.
 
 You should have already installed OmniAuth into your app. If not, read the [OmniAuth README](https://github.com/omniauth/omniauth) to get started.
 
-Now sign in into the [Yoti dashboard](https://www.yoti.com/dashboard/login) and create an application. Take note of your Application ID and Yoti client SDK ID because that is what your web application will use to authenticate against the Yoti API. Make sure to set a callback URL and download the pem key.
-
-An Ruby on Rails example app that implements the Yoti OmniAuth strategy can be found in [Yoti Web Labs](https://github.com/lampkicking/yoti-web-labs/tree/master/voting-app)
+Now sign in into the [Yoti dashboard](https://www.yoti.com/dashboard/login) and create an application. Take note of your Application ID and Yoti client SDK ID because that is what your web application will use to authenticate against the Yoti API. Make sure to set a callback URL to `YOUR_SITE/auth/yoti/callback`, and download the pem key.
 
 ## Using This Strategy
 
@@ -20,11 +18,15 @@ gem 'omniauth-yoti'
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install omniauth-yoti
+```shell
+$ gem install omniauth-yoti
+```
 
 ## Configuration
 
@@ -44,17 +46,17 @@ end
 
 `YOTI_APPLICATION_ID` -  found on the *Integrations* settings page, under the Login button section.
 
-`YOTI_CLIENT_SDK_ID` - found on the *Integrations* settings page
+`YOTI_CLIENT_SDK_ID` - found on the *Integrations* settings page.
 
-`YOTI_KEY_FILE_PATH` - the full path to your security key downloaded from the *Keys* settings page (e.g. /Users/developer/access-security.pem)
+`YOTI_KEY_FILE_PATH` - the full path to your security key downloaded from the *Keys* settings page (e.g. /Users/developer/access-security.pem).
 
 If you don't have access to the file system to store the pem file, you can replace `key_file_path` with `key`, that stores a string with the content of the secret key (`key: "-----BEGIN RSA PRIVATE KEY-----\nMIIEp..."`).
 
 The configuration values are documented in the [Yoti gem repository](https://github.com/lampkicking/yoti-sdk-server-ruby#configuration).
 
 ## Authentication
 
-A call to `/auth/yoti/callback` will open the Yoti authentication page, and after a sucessful authentication, you will be redirected to the callback URL from your Yoti dasboard. The auth hash will be available in `request.env['omniauth.auth']`:
+A call to `/auth/yoti/callback` will open the Yoti authentication page, and after a successful authentication, you will be redirected to the callback URL from your Yoti dashboard. The auth hash will be available in `request.env['omniauth.auth']`:
 
 ```ruby
 {

lib/omniauth/strategies/yoti.rb

@@ -6,42 +6,55 @@ module Strategies
     class Yoti
       include OmniAuth::Strategy
 
-      option :config, [:application_id, :client_sdk_id, :key_file_path, :key]
+      option :client_options
 
       def request_phase
-        redirect "https://www.yoti.com/connect/#{options.config.first.application_id}"
+        redirect "https://www.yoti.com/connect/#{options.client_options[:application_id]}"
       end
 
-      uid { @yoti_activity_details.user_id }
-      info { { name: @yoti_activity_details.user_id } }
+      uid { yoti_user_id }
+      info { { name: yoti_user_id } }
 
       def extra
-        @raw_info ||= begin
-          user_profile = @yoti_activity_details.user_profile
-          {
-            photo: user_profile['selfie'],
-            given_names: user_profile['given_names'],
-            family_name: user_profile['family_name'],
-            mobile_number: user_profile['phone_number'],
-            date_of_birth: user_profile['date_of_birth'],
-            address: user_profile['post_code'],
-            gender: user_profile['gender'],
-            nationality: user_profile['nationality']
-          }
+        @raw_info ||= {
+          photo: yoti_user_profile['selfie'],
+          given_names: yoti_user_profile['given_names'],
+          family_name: yoti_user_profile['family_name'],
+          mobile_number: yoti_user_profile['phone_number'],
+          date_of_birth: yoti_user_profile['date_of_birth'],
+          address: yoti_user_profile['post_code'],
+          gender: yoti_user_profile['gender'],
+          nationality: yoti_user_profile['nationality']
+        }
+      end
+
+      private
+
+      def yoti_activity_details
+        @yoti_activity_details ||= begin
+          configure_yoti_client!
+          ::Yoti::Client.get_activity_details(token)
         end
       end
 
-      def callback_phase
+      def yoti_user_profile
+        yoti_activity_details.user_profile
+      end
+
+      def yoti_user_id
+        yoti_activity_details.user_id
+      end
+
+      def configure_yoti_client!
         ::Yoti.configure do |config|
-          config.client_sdk_id = options.config.first['client_sdk_id']
-          config.key_file_path = options.config.first['key_file_path']
-          config.key = options.config.first['key']
+          config.client_sdk_id = options.client_options[:client_sdk_id]
+          config.key_file_path = options.client_options[:key_file_path]
+          config.key = options.client_options[:key]
         end
+      end
 
-        token = Rack::Utils.parse_nested_query(request.query_string)['token']
-        @yoti_activity_details = ::Yoti::Client.get_activity_details(token)
-
-        super
+      def token
+        Rack::Utils.parse_nested_query(request.query_string)['token']
       end
     end
   end

lib/omniauth/yoti/version.rb

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

omniauth-yoti.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock'
 end

rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 15
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false

spec/fixtures/encrypted_yoti_token.txt

@@ -0,0 +1 @@
+c31Db4y6ClxSWy26xDpa9LEX3ZTUuR-rKaAhjQWnmKilR20IshkysR5Y3Hh3R6hanOyxcu7fl5vbjikkGZZb3_iH6NjxmBXuGY_Fr23AhrHvGL9WMg4EtemVvr6VI2f_5H_PDhDpYUvv-YpEM0f_SReoVxGIc8VGfj1gukuhPyNJ9hs55-SDdUjN77JiA6FPcYZxEIaqQE_yT_c3Y4V72Jnq3RHbG0vL6SefSfY_fFsnx_HeddsJc10qJYCwAkdGzVzbJH2DQ2Swp821Gwyj9eNK54S6HvpIg7LclID7BtymG6z7cTNp3fXX7mgKYoQlh_DHmPmaiqyj398w424RBg==