omniauth-authentiq 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d152b93e57ba436e49e30fd7f431112caa8d7d00
-  data.tar.gz: 60a303403dbf79a815e8b4c1eb6e1ef956a2da0c
+  metadata.gz: 8560d7ad601092c667fe1c25e4455a0131bb7c38
+  data.tar.gz: 38099791a64a96d54f65c5b9a0e18505a985512c
 SHA512:
-  metadata.gz: 298d17713393ba75ed612351070d7a1dfeae1d525f3bce46e7196ebe7f71aac23113a6166f8a1763d61a39fa880641bc75310e5d7036318f7cfd4d98e76917af
-  data.tar.gz: 1accbd0efe54a26d15f5081cfce63d6cefcb0005a3f70f95529992cd2ded0c28856a1ccbf03d72588efd0a71fa83704e0bea1fc4e4e9d6929a7b940c408908f2
+  metadata.gz: a6c4d1d27f4f163e5ff83b9e43f140a63356f5fcccf8c6e74872b00094759cbb09fc775eeaa92cd4ee5cf0fd7b7ae682cc081e8483bb55503c4a06989c1ff40e
+  data.tar.gz: 87920c93b8f43e0a62df1afa4e3026ad75bec0b2e97e7d590f4f6fb0ab1a53e38d88a303ab0548ab3e0ec12d9ec25a173c27eb5735689548dab828df2351e9e5

data/README.md

@@ -1,6 +1,7 @@
 # OmniAuth Authentiq
 
-Official OmniAuth strategy for authenticating with AuthentiqID. Sign up for [Authentiq](https://www.authentiq.com/register/?utm_source=github&utm_medium=readme&utm_campaign=omniauth) to obtain your application credentials.
+Official [OmniAuth](https://github.com/omniauth/omniauth/wiki) strategy for authenticating with an  Authentiq ID mobile app ([iOS](https://itunes.apple.com/us/app/authentiq-id/id964932341),  [Android](https://play.google.com/store/apps/details?id=com.authentiq.authentiqid)).
+Application credentials can be obtained [at Authentiq](https://www.authentiq.com/register/?utm_source=github&utm_medium=readme&utm_campaign=omniauth).
 
 ## Installation
 
@@ -14,26 +15,29 @@ Then bundle:
 
     $ bundle install
 
-# Basic Usage
+# Basic Usage with Rails
 
 ```ruby
 use OmniAuth::Builder do
-  provider :authentiq, ENV['AUTHENTIQ_KEY'], ENV['AUTHENTIQ_SECRET']
+  provider :authentiq, ENV['AUTHENTIQ_KEY'], ENV['AUTHENTIQ_SECRET'],
+           scope: 'aq:name email~rs aq:push'
 end
 ```
 
-
 # Scopes
 
-Authentiq gives you the capability to request various data from the user. This is done by adding the scope parameters to the basic usage.
+Authentiq adds the capability to request personal information like name, email, phone number, and address from the Authentiq ID app ([iOS](https://itunes.apple.com/us/app/authentiq-id/id964932341),  [Android](https://play.google.com/store/apps/details?id=com.authentiq.authentiqid)).
+During authentication, and only after the user consents, this information will be shared by the Authentiq ID app.
 
-Depending on your implementation, you may need to declare the redirect_uri parameter
+Requesting specific information or "scopes" is done by modifying the `scope` parameter in the basic usage example above.
+Depending on your implementation, you may also need to provide the `redirect_uri` parameter. 
 
+Example:
 ```ruby
 use OmniAuth::Builder do
   provider :authentiq, ENV['AUTHENTIQ_KEY'], ENV['AUTHENTIQ_SECRET'], 
            scope: 'aq:name email~rs aq:push phone address',
-           redirect_uri: 'redirect_uri'
+           redirect_uri: '<REDIRECT_URI>'
 end
 ```
 
@@ -42,13 +46,15 @@ Available scopes are:
 - `email` for Email
 - `phone` for Phone
 - `address` for Address
-- `aq:location` for Location (Coordinates and geolocated address)
+- `aq:location` for Location (geo coordinates)
+- `aq:push` to request permission to sign in via Push Notifications in the Authentiq ID app
 
 Append `~r` to a scope to explicitly require it from the user.
 
-Append `~s` or `~rs` to phone or email scope to explicitly require a signed and/or verified scope from the user.
+Append `~s` to phone or email scope to explicitly require a verified (signed) scope.
+
+The `~s` and `~r` can be combined to `~rs` to indicate that the scope is both required and should be / have been verified.
 
-To enable login via Push Notifications in the Authentiq ID mobile app, add `aq:push` to the list of scopes.
 
 ## Tests
 
@@ -56,5 +62,4 @@ Tests are coming soon.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://gitlab.com/authentiq/omniauth-authentiq.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/AuthentiqID/omniauth-authentiq.

data/lib/omniauth/authentiq/version.rb

@@ -1,5 +1,5 @@
 module OmniAuth
   module Authentiq
-    VERSION = "0.2.1"
+    VERSION = "0.2.2"
   end
 end

data/lib/omniauth/strategies/authentiq.rb

@@ -36,7 +36,7 @@ module OmniAuth
             :email => (@raw_info['email'] unless @raw_info['email'].nil?),
             :phone => (@raw_info['phone_number'] unless @raw_info['phone_number'].nil?),
             :location => (@raw_info['address'] unless @raw_info['address'].nil?),
-            :geolocation => (@raw_info['location'] unless @raw_info['location'].nil?)
+            :geolocation => (@raw_info['aq:location'] unless @raw_info['aq:location'].nil?)
         }.reject { |k, v| v.nil? }
       end
 
@@ -46,7 +46,8 @@ module OmniAuth
             :email_verified => (@raw_info['email_verified'] unless @raw_info['email_verified'].nil?),
             :phone_type => (@raw_info['phone_type'] unless @raw_info['phone_type'].nil?),
             :phone_number_verified => (@raw_info['phone_number_verified'] unless @raw_info['phone_number_verified'].nil?),
-            :locale => (@raw_info['locale'] unless @raw_info['locale'].nil?)
+            :locale => (@raw_info['locale'] unless @raw_info['locale'].nil?),
+            :zoneinfo => (@raw_info['zoneinfo'] unless @raw_info['zoneinfo'].nil?)
         }.reject { |k, v| v.nil? }
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-authentiq
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Alexandros Keramidas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-13 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2