authsignal-ruby 4.1.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c4fa986346960144f15616720f21828275ffabdf16a817e05cadb4ee3c33565
-  data.tar.gz: 0b748a47e76e7af70786179cfde9fa037188da9c6beee9d25194e47f61adf98e
+  metadata.gz: 60927c210d3c9ca7c01e5fc6a3b2cddfbd069693cc221cd585f24154e07fd515
+  data.tar.gz: 9ca1be169ea1f4e24510e42de4a8b6cc79628b7e88a35bc46e279a2a4d254440
 SHA512:
-  metadata.gz: 6dfcbd7a4ef015d250e33eebf556f1c651d440de45df9155791748d77f9668e57a40d0e27fb5091290fe178130c3dd70c09cc8aa85829855e317ab263637c5af
-  data.tar.gz: 9ed3d53d1cd3772b2c6744dfacf1ff1471f09e743e1b9ba102f3d731b0c39e185533bad167ceb6f536c0b77c2be49b79094e46fafca8840542dc5b73fd1eb31d
+  metadata.gz: 2ea4f562bea332f0db4f3b5fbf24a4cf6993bdb17d2879e232219ad7814ab5b59ca2c3a9e52087d295f285bd15f9c890abe8c43162875b6af1af22171049fbc7
+  data.tar.gz: b75556ccafcf243fd4ff33c7d8c25731ae9dfc6bc51637b64a667ab8faa99ae8b2fdf1bb5c7039dff2701e0f338c39c7be64ec09add77273c490353e2eec3f2c

data/CHANGELOG.md

@@ -1,5 +1 @@
-## [Unreleased]
-
-## [0.1.0] - 2022-07-14
-
-- Initial release
+SDK changes are currently documented in the [Releases](https://github.com/authsignal/authsignal-ruby/releases) section.

data/Gemfile

@@ -4,3 +4,7 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in authsignal-ruby.gemspec
 gemspec
+
+group :test do
+  gem 'dotenv'
+end

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    authsignal-ruby (4.1.0)
-      faraday (>= 2)
+    authsignal-ruby (5.0.1)
+      faraday (>= 2.0.1)
       faraday-retry (~> 2.2)
 
 GEM
@@ -15,6 +15,7 @@ GEM
       bigdecimal
       rexml
     diff-lcs (1.5.1)
+    dotenv (3.1.7)
     faraday (2.12.0)
       faraday-net_http (>= 2.0, < 3.4)
       json
@@ -56,9 +57,10 @@ PLATFORMS
 
 DEPENDENCIES
   authsignal-ruby!
+  dotenv
   rake (~> 13.0)
   rspec (~> 3.2)
   webmock (~> 3.14)
 
 BUNDLED WITH
-   2.5.16
+   2.5.14

data/README.md

@@ -1,6 +1,8 @@
-# Authsignal Server Ruby SDK
+<img width="1070" alt="Authsignal" src="https://raw.githubusercontent.com/authsignal/authsignal-node/main/.github/images/authsignal.png">
 
-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).
+# Authsignal Ruby SDK
+
+The Authsignal Ruby library for server-side applications.
 
 ## Installation
 
@@ -10,72 +12,11 @@ Add this line to your application's Gemfile:
 gem "authsignal-ruby"
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install authsignal-ruby
-
-## 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`
-
-```ruby
-Authsignal.setup do |config|
-    config.api_secret_key = ENV["AUTHSIGNAL_SECRET_KEY"]
-end
-```
-
-You can find your `api_secret_key` in the [Authsignal Portal](https://portal.authsignal.com/organisations/tenants/api).
-
-You must specify the correct `baseUrl` for your tenant's region.
-
-| 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 |
-
-For example, to set the base URL to use our AU region:
-
-```
-require 'authsignal'
-
-Authsignal.setup do |config|
-    config.api_secret_key = ENV["AUTHSIGNAL_SECRET_KEY"]
-    config.base_uri = "https://au.signal.authsignal.com/v1"
+## Documentation
 
-    # If you would like the Authsignal client to retry requests due to network issues
-    config.retry = true # default value: false
+Refer to our [SDK documentation](https://docs.authsignal.com/sdks/server/overview) for information on how to use this SDK.
 
-    # If you would like to inspect raw request/response in development
-    config.debug = true # default value: false
-end
-```
-
-## Usage
-
-Authsignal's server side signal API has four main api calls `track`, `get_action`, `get_user`, `enroll_verified_authenticator`.
-
-For more details on these api calls, refer to our [official Ruby SDK docs](https://docs.authsignal.com/sdks/server/ruby#track).
-
-Example:
-
-```ruby
-Authsignal.track user_id: 'AS_001', action: 'withdraw', idempotency_key: 'a_random_hash'
-
-# returns:
-# {
-#    success?: true,
-#    state: 'ALLOW',
-#    idempotency_key: 'a_random_hash',
-#    ... rest of payload ...
-# }
-```
+Or check out our [Ruby on Rails Quickstart Guide](https://docs.authsignal.com/integrations/ruby-on-rails).
 
 ### Response & Error handling
 
@@ -84,18 +25,20 @@ The Authsignal SDK offers two response formats. By default, its methods return t
 Example:
 
 ```ruby
-Authsignal.enroll_verified_authenticator user_id: 'AS_001',
-                                         authenticator: {
-                                           oob_channel: 'INVALID', email: 'joebloke@authsignal.com'
-                                         }
+Authsignal.enroll_verified_authenticator(
+  user_id: 'AS_001',
+  attributes: {
+    verification_method: 'INVALID',
+    email: 'hamish@authsignal.com'
+  }
+)
 
 # returns:
-# {
-#    success?: false,
-#    status: 400,
-#    error: 'invalid_request',
-#    error_description: '/body/oobChannel must be equal to one of the allowed values'
-# }
+{
+  "error": "invalid_request",
+  "errorCode": "invalid_request",
+  "errorDescription": "body.verificationMethod must be equal to one of the allowed values - allowedValues: AUTHENTICATOR_APP,EMAIL_MAGIC_LINK,EMAIL_OTP,SMS"
+}
 ```
 
 All methods have a bang (!) counterpart that raises an Authsignal::ApiError if the request fails.
@@ -103,23 +46,14 @@ All methods have a bang (!) counterpart that raises an Authsignal::ApiError if t
 Example:
 
 ```ruby
-Authsignal.enroll_verified_authenticator! user_id: 'AS_001',
-                                         authenticator: {
-                                           oob_channel: 'INVALID', email: 'joebloke@authsignal.com'
-                                         }
+Authsignal.enroll_verified_authenticator!(
+  user_id: 'AS_001',
+  attributes: {
+    verification_method: 'INVALID',
+    email: 'hamish@authsignal.com'
+  }
+)
 
 # raise:
-# <Authsignal::ApiError: invalid_request status: 400, error: invalid_request, description: /body/oobChannel must be equal to one o...
+<Authsignal::ApiError: AuthsignalError: 400 - body.verificationMethod must be equal to one of the allowed values - allowedValues: AUTHENTICATOR_APP,EMAIL_MAGIC_LINK,EMAIL_OTP,SMS.
 ```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` or `bundle exec rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-Log request/response against test server: `Authsignal.configuration.debug = true`
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/authsignal/api_error.rb

@@ -2,18 +2,30 @@
 
 module Authsignal
   class ApiError < StandardError
-    attr_reader :status, :error, :description
+    attr_reader :status_code, :error_code, :error_description
 
-    def initialize(message = "An unexpected API error occurred", status, error, description)
-      @status      = status || 500
-      @error       = error
-      @description = description
+    def initialize(status_code, error_code, error_description = nil)
+      message = format_message(status_code, error_code, error_description)
 
       super(message)
+
+      @status_code = status_code
+      @error_code = error_code
+      @error_description = error_description
     end
 
     def to_s
-      "#{super} status: #{status}, error: #{error}, description: #{description}"
+      "#{super} status_code: #{status_code}, error_code: #{error_code}, error_description: #{error_description}"
+    end
+
+    private
+
+    def format_message(status_code, error_code, error_description)
+      "AuthsignalError: #{status_code} - #{format_description(error_code, error_description)}"
+    end
+
+    def format_description(error_code, error_description)
+      error_description && error_description.length > 0 ? error_description : error_code
     end
   end
 end

data/lib/authsignal/client.rb

@@ -17,7 +17,7 @@ module Authsignal
             @api_key = require_api_key
 
             @client = Faraday.new do |builder|
-                builder.url_prefix = Authsignal.configuration.base_uri
+                builder.url_prefix = Authsignal.configuration.api_url
                 builder.adapter :net_http
                 builder.request :authorization, :basic, @api_key, nil
 
@@ -36,47 +36,50 @@ module Authsignal
             end
         end
 
-        def track(event)
-            user_id = url_encode(event[:user_id])
-            action = event[:action]
+        def get_user(user_id:)
+            path = "users/#{url_encode(user_id)}"
+            make_request(:get, path)
+        end
 
-            path = "users/#{user_id}/actions/#{action}"
-            body = event.except(:user_id)
+        def update_user(user_id:, attributes:)
+            make_request(:post, "users/#{url_encode(user_id)}", body: attributes)
+        end
 
-            make_request(:post, path, body: body)
+        def delete_user(user_id:)
+            make_request(:delete, "users/#{url_encode(user_id)}")
         end
 
-        def get_user(user_id:, redirect_url: nil)
-            if(redirect_url)
-                path = "users/#{url_encode(user_id)}?redirectUrl=#{redirect_url}"
-            else
-                path = "users/#{url_encode(user_id)}"
-            end
-            make_request(:get, path)
+        def get_authenticators(user_id:)
+            make_request(:get, "users/#{url_encode(user_id)}/authenticators")
         end
 
-        def update_user(user_id:, user:)
-            make_request(:post, "users/#{url_encode(user_id)}", body: user)
+        def enroll_verified_authenticator(user_id:, attributes:)
+            make_request(:post, "users/#{url_encode(user_id)}/authenticators", body: attributes)
         end
 
-        def delete_user(user_id:)
-            make_request(:delete, "users/#{url_encode(user_id)}")
+        def delete_authenticator(user_id:, user_authenticator_id:)
+            make_request(:delete, "users/#{url_encode(user_id)}/authenticators/#{url_encode(user_authenticator_id)}")
+        end
+
+        def track(user_id:, action:, attributes:)
+            path = "users/#{user_id}/actions/#{action}"
+
+            make_request(:post, path, body: attributes)
         end
 
-        def validate_challenge(user_id: nil, token:, action: nil)
+        def validate_challenge(token:, user_id: nil, action: nil)
             path = "validate"
             body = { user_id: user_id, token: token, action: action }
 
             make_request(:post, path, body: body)
         end
 
-        def get_action(user_id, action, idempotency_key)
+        def get_action(user_id:, action:, idempotency_key:)
             make_request(:get, "users/#{url_encode(user_id)}/actions/#{action}/#{url_encode(idempotency_key)}")
         end
 
-        def update_action_state(user_id:, action:, idempotency_key:, state:) 
-            body = { state: state }
-            make_request(:patch, "users/#{url_encode(user_id)}/actions/#{action}/#{url_encode(idempotency_key)}", body: body)
+        def update_action(user_id:, action:, idempotency_key:, attributes:) 
+            make_request(:patch, "users/#{url_encode(user_id)}/actions/#{action}/#{url_encode(idempotency_key)}", body: attributes)
         end
 
         ##
@@ -85,14 +88,6 @@ module Authsignal
             make_request(:post , "users/#{url_encode(user_id)}", body: user_payload)
         end
 
-        def enroll_verified_authenticator(user_id, authenticator)
-            make_request(:post, "users/#{url_encode(user_id)}/authenticators", body: authenticator)
-        end
-
-        def delete_authenticator(user_id:, user_authenticator_id:)
-            make_request(:delete, "users/#{url_encode(user_id)}/authenticators/#{url_encode(user_authenticator_id)}")
-        end
-
         private
 
         def url_encode(s)

data/lib/authsignal/configuration.rb

@@ -13,7 +13,7 @@ module Authsignal
         end
   
         config_option :api_secret_key
-        config_option :base_uri
+        config_option :api_url
         config_option :debug
         config_option :retry
 
@@ -22,7 +22,7 @@ module Authsignal
       
             # set default attribute values
             @defaults = OpenStruct.new({
-                base_uri: 'https://signal.authsignal.com/v1/',
+                api_url: 'https://signal.authsignal.com/v1/',
                 retry: false,
                 debug: false
             })

data/lib/authsignal/version.rb

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

data/lib/authsignal.rb

@@ -25,14 +25,14 @@ module Authsignal
             configuration.defaults
         end
 
-        def get_user(user_id:, redirect_url: nil)
-            response = Client.new.get_user(user_id: user_id, redirect_url: redirect_url)
+        def get_user(user_id:)
+            response = Client.new.get_user(user_id: user_id)
 
             handle_response(response)
         end
 
-        def update_user(user_id:, user:)
-            response = Client.new.update_user(user_id: user_id, user: user)
+        def update_user(user_id:, attributes:)
+            response = Client.new.update_user(user_id: user_id, attributes: attributes)
 
             handle_response(response)
         end
@@ -43,42 +43,44 @@ module Authsignal
             handle_response(response)
         end
 
-        def get_action(user_id:, action:, idempotency_key:)
-            response = Client.new.get_action(user_id, action, idempotency_key)
+        def get_authenticators(user_id:)
+            response = Client.new.get_authenticators(user_id: user_id)
 
             handle_response(response)
         end
 
-        def update_action_state(user_id:, action:, idempotency_key:, state:)
-            # NOTE: Rely on API to respond when given invalid state
-            response = Client.new.update_action_state(user_id: user_id, action: action, idempotency_key: idempotency_key, state: state)
+        def enroll_verified_authenticator(user_id:, attributes:)
+            response = Client.new.enroll_verified_authenticator(user_id: user_id, attributes: attributes)
 
             handle_response(response)
         end
 
-        def enroll_verified_authenticator(user_id:, authenticator:)
-            response = Client.new.enroll_verified_authenticator(user_id, authenticator)
+        def delete_authenticator(user_id:, user_authenticator_id:)
+            response = Client.new.delete_authenticator(user_id: user_id, user_authenticator_id: user_authenticator_id)
 
             handle_response(response)
         end
 
-        def delete_authenticator(user_id:, user_authenticator_id: )
-            response = Client.new.delete_authenticator(user_id: user_id, user_authenticator_id: user_authenticator_id)
+        def track(user_id:, action:, attributes:)
+            response = Client.new.track(user_id: user_id, action: action, attributes: attributes)
+            handle_response(response)
+        end
 
+        def validate_challenge(token:, user_id: nil, action: nil)
+            response = Client.new.validate_challenge(token: token,user_id: user_id, action: action)
+            
             handle_response(response)
         end
 
-        def track(event, options={})
-            raise ArgumentError, "Action Code is required" unless event[:action].to_s.length > 0
-            raise ArgumentError, "User ID value" unless event[:user_id].to_s.length > 0
+        def get_action(user_id:, action:, idempotency_key:)
+            response = Client.new.get_action(user_id: user_id, action: action, idempotency_key: idempotency_key)
 
-            response = Client.new.track(event)
             handle_response(response)
         end
 
-        def validate_challenge(token:, user_id: nil, action: nil)
-            response = Client.new.validate_challenge(user_id: user_id, token: token, action: action)
-            
+        def update_action(user_id:, action:, idempotency_key:, attributes:)
+            response = Client.new.update_action(user_id: user_id, action: action, idempotency_key: idempotency_key, attributes: attributes)
+
             handle_response(response)
         end
 
@@ -93,15 +95,19 @@ module Authsignal
         end
 
         def handle_success_response(response)
-            response.body.merge(success?: true)
+            if response.body.is_a?(Array)
+                { success?: true, data: response.body }
+            else
+                response.body.merge(success?: true)
+            end
         end
 
         def handle_error_response(response)
             case response.body
             when Hash
-                response.body.merge(status: response.status, success?: false)
+                { status_code: response.status, success?: false, error_code: response.body[:error], error_description: response.body[:error_description] }
             else
-                { status: response&.status || 500, success?: false }
+                { status_code: response&.status || 500, success?: false }
             end
         end
     end
@@ -110,11 +116,11 @@ module Authsignal
     (methods - NON_API_METHODS).each do |method|
         define_singleton_method("#{method}!") do |*args, **kwargs|
             send(method, *args, **kwargs).tap do |response|
-                status = response[:status]
-                err = response[:error]
-                desc = response[:error_description]
+                status_code = response[:status_code]
+                error_code = response[:error_code]
+                error_description = response[:error_description]
 
-                raise ApiError.new(err, status, err, desc) unless response[:success?]
+                raise ApiError.new(status_code, error_code, error_description) unless response[:success?]
             end
         end
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: authsignal-ruby
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.1
 platform: ruby
 authors:
 - justinsoong
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-05 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +111,6 @@ licenses:
 metadata:
   homepage_uri: https://www.authsignal.com
   source_code_uri: https://github.com/authsignal/authsignal-ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: The Authsignal ruby server side signal API.
 test_files: []