authsignal-ruby 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d563b12a80a89c807b644c531b09401fc38844d479581ca14f6fb58507cdc601
-  data.tar.gz: 436573b2924b8862b0332ce6fc07353a2cfe66fa4be8c801106f6b55e2546f49
+  metadata.gz: f77d1646d619436a3c5e25b76be690252c3f4bf2dcb7588ea09cae4c11283017
+  data.tar.gz: 67ad78b10cb51e07b2f2726a4a8ad74ba094eacd37b0acd6436a4e89f9b7d306
 SHA512:
-  metadata.gz: d5790f1d540710c6341185342d7e26e165d08d2db070abb83696a3701ec3c8db95a0c7ae89b275176c59af86c5f54f99139f1e1155d98fdb92c8179c8d128e95
-  data.tar.gz: 650b7ceea94f65580a14c53cd1091e672034ebc1352e17e9ff198e03e7745fe901b0eefbdc2bd9e0d636befc63bba2da63e2f3df89aa38c6d479e55b1d97f56d
+  metadata.gz: a02302caa711e51e25877b73e2b83c074ebd868e9f43eec42d0b29046f0f62a99ec07a930e73eb4204cffab72992831395e36b8f6d6a6a01e010536e2c550286
+  data.tar.gz: 5791b35e320bc81ca7f7137f736f847f7b2eae79073afe9eed0c91376e557dd63c2e0d952bf42d2d15dd04eac3c6827e003283e63e0f95f3cb681d4d3714ee3e

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    authsignal-ruby (0.1.2)
-      httparty (~> 0.20.0)
+    authsignal-ruby (0.1.5)
+      httparty (~> 0.21.0)
 
 GEM
   remote: https://rubygems.org/
@@ -13,12 +13,10 @@ GEM
       rexml
     diff-lcs (1.5.0)
     hashdiff (1.0.1)
-    httparty (0.20.0)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.4.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2022.0105)
+    mini_mime (1.1.5)
     multi_xml (0.6.0)
     public_suffix (4.0.7)
     rake (13.0.6)
@@ -51,4 +49,4 @@ DEPENDENCIES
   webmock (~> 3.14.0)
 
 BUNDLED WITH
-   2.2.32
+   2.3.21

data/README.md

@@ -1,6 +1,6 @@
 # Authsignal Server Ruby SDK
 
-[Authsignal](https://www.authsignal.com/?utm_source=github&utm_medium=ruby_sdk) provides passwordless step up authentication (Multi-factor Authentication - MFA) that can be placed anywhere within your application. Authsignal also provides a no-code fraud risk rules engine to manage when step up challenges are triggered.
+Check out our [official Ruby SDK documentation](https://docs.authsignal.com/sdks/server/ruby), and [Ruby on Rails Quickstart Guide](https://docs.authsignal.com/quickstarts/ruby-on-rails).
 
 ## Installation
 
@@ -18,7 +18,8 @@ Or install it yourself as:
 
     $ gem install authsignal-ruby
 
-## Configuration
+## Initialization
+
 Initialize the Authsignal Ruby SDK, ensuring you do not hard code the Authsignal Secret Key, always keep this safe.
 
 In Ruby on Rails, you would typically place this code block in a file like `config/initializers/authsignal.rb`
@@ -29,100 +30,32 @@ Authsignal.setup do |config|
 end
 ```
 
-## Usage
-
-Authsignal's server side signal API has four main calls `track_action`, `get_action`, `get_user`, `identify`
+You can find your `api_secret_key` in the [Authsignal Portal](https://portal.authsignal.com/organisations/tenants/api).
 
-These examples assume that the SDK is being called from a Ruby on Rails app, adapt depending on your server framework.
+You must specify the correct `baseUrl` for your tenant's region.
 
-### Track Action
-The track action call is the main api call to send actions to authsignal, the default decision is to `ALLOW` actions, this allows you to call track action as a means to keep an audit trail of your user activity.
+| Region      | Base URL                            |
+| ----------- | ----------------------------------- |
+| US (Oregon) | https://signal.authsignal.com/v1    |
+| AU (Sydney) | https://au.signal.authsignal.com/v1 |
+| EU (Dublin) | https://eu.signal.authsignal.com/v1 |
 
-Add to the rules in the admin portal or the change default decision to influence the flows for your end users. If a user is not enrolled with authenticators, the default decision is to `ALLOW`.
+For example, to set the base URL to use our AU region:
 
-```ruby
-# OPTIONAL: The Authsignal cookie available when using the authsignal browser Javascript SDK
-# you could you use own device/session/fingerprinting identifiers.
-authsignal_cookie = request.cookies["__as_aid"]
-
-# OPTIONAL: The idempotencyKey is a unique identifier per track action
-# this could be for a unique object associated to your application
-# like a shopping cart check out id
-# If ommitted, Authsignal will generate the idempotencyKey and return in the response
-idempotency_key = SecureRandom.uuid
-
-# OPTIONAL: If you're using a redirect flow, set the redirect URL, this is the url authsignal will redirect to after a Challenge is completed.
-redirect_url = "https://www.yourapp.com/back_to_your_app"
-
-response = Authsignal.track_action({
-        action_code: "signIn",
-        idempotency_key: idempotency_key,
-        redirect_url: redirect_url,
-        user_id: current_user.id,
-        email: current_user.email,
-        device_id: authsignal_cookie,
-        user_agent: request.user_agent,
-        ip_address: request.ip,
-        custom: {
-            it_could_be_a_bool: true,
-            it_could_be_a_string: "test",
-            it_could_be_a_number: 400.00
-        }
-    }
-)
 ```
-*Response*
-```ruby
-response = Authsignal.track_action({..})
-case response[:state]
-when "ALLOW"
-    # Carry on with your operation/business logic
-when "BLOCK"
-    # Stop your operations
-when "CHALLENGE_REQUIRED"
-    # Step up authentication required, redirect or pass the challengeUrl to the front end
-    response[:challenge_url]
-end
-```
-
-### Get Action
-Call get action after a challenge is completed by the user, after a redirect or a succesful browser challenge pop-up flow, and if the state of the action is `CHALLENGE_SUCCEEDED` you can proceed with completing the business logic.
+require 'authsignal'
 
-```ruby
-response = Authsignal.get_action(
-    user_id: current_user.id,
-    action_code: "testAction",
-    idempotency_key: "15cac140-f639-48c5-92db-835ec8d3d144")
-
-if(response[:state] === "CHALLENGE_SUCCEEDED")
-    # The user has successfully completed the challenge, and you should proceed with
-    # the business logic
+Authsignal.setup do |config|
+    config.api_secret_key = ENV["AUTHSIGNAL_SECRET_KEY"]
+    config.base_uri = "https://au.signal.authsignal.com/v1"
 end
 ```
 
-### Get User
-Get user retrieves the current enrolment state of the user, use this call to redirect users to the enrolment or management flows so that the user can do self service management of their authenticator factors. User the `url` in the response to either redirect or initiate the pop up client side flow.
-
-```ruby
-response = Authsignal.get_user(user_id: current_user.id, redirect_url: "http://www.yourapp.com/path-back")
-
-is_enrolled = response[:is_enrolled]
-url = response[:url]
-```
-
-### Identify
-Get identify to link and update additional user indetifiers (like email) to the primary record.
-
-```ruby
-Authsignal.identify(user_id: current_user.id, user: { email: "newemail@email.com" })
-```
+## Usage
 
-### Enrol Authenticator
-If your application already has a valid authenticator like a validated phone number for your customer, you can enrol the authenticator on behalf of the user using this function
+Authsignal's server side signal API has four main api calls `track_action`, `get_action`, `get_user`, `enrol_authenticator`.
 
-```ruby
-Authsignal.enrol_authenticator(user_id: current_user.id, authenticator:{ oob_channel: "SMS", phone_number: "+64270000000" })
-```
+For more details on these api calls, refer to our [official Ruby SDK docs](https://docs.authsignal.com/sdks/server/ruby#track_action).
 
 ## Development
 

data/Rakefile

@@ -5,4 +5,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: :spec

data/RakefileRelease

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require_relative 'lib/authsignal/version'
+
+task default: :build_and_push_gem
+
+RSpec::Core::RakeTask.new(:build_and_push_gem) do |task|
+  version = Authsignal::VERSION
+  puts "Building gem..."
+  sh "gem build authsignal-ruby.gemspec"
+  puts "Pushing authsignal-ruby-#{version} gem..."
+  sh "gem push authsignal-ruby-#{version}.gem"
+  puts "Gem authsignal-ruby-#{version} has been pushed."
+end

data/lib/authsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Authsignal
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/authsignal.rb

@@ -69,6 +69,37 @@ module Authsignal
             false
         end
 
+        def validate_challenge(request)
+            token = request[:token]
+
+            begin
+                decoded_token = JWT.decode(token, Authsignal.configuration.api_secret_key)[0]
+            rescue JWT::DecodeError
+                puts 'Token verification failed'
+            end
+          
+            user_id = decoded_token["other"]["userId"]
+            action_code = decoded_token["other"]["actionCode"]
+            idempotency_key = decoded_token["other"]["idempotencyKey"]
+          
+            if request[:userId] && request[:userId] != user_id
+              return { user_id: user_id, success: false, state: nil }
+            end
+
+            if action_code && idempotency_key
+              action_result = get_action(user_id: user_id, action_code: action_code, idempotency_key: idempotency_key)
+          
+              if action_result
+                state = action_result[:state]
+                success = state == "CHALLENGE_SUCCEEDED"
+          
+                return { user_id: user_id, success: success, state: state, action: action_code }
+              end
+            end
+          
+            { user_id: user_id, success: false, state: nil }
+          end
+
         private
         def underscore(string)
             string.gsub(/::/, '/').

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authsignal-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - justinsoong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2023-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.21.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,6 +81,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- RakefileRelease
 - bin/console
 - bin/setup
 - lib/authsignal.rb
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: The Authsignal ruby server side signal API.