authsignal-ruby 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0204e93c2f7fa2b3bf20379b5837243a62960ce0b35c39d69e41f6c98b02125
-  data.tar.gz: 4624f0d600ac6377b4d2ef3945121e7a8dc628852786ca8ecccb2b6c7b589d07
+  metadata.gz: e2bf6c96e9f79775fa1d3db3deb5ec5258a8c651e1b4fb8c1c3740c3f5ebd5b6
+  data.tar.gz: 90124d4aa0b3111cd4b52424c78b16f208d4179991e8dcfc52f48fc735483bba
 SHA512:
-  metadata.gz: 6c9592f43a421e9bd5032b3d81aa44a10e30e03553e293667b5ac1ca7b196d4cad3a12e544e41f70392a54649ed584a8ef4a1a9259363e5de4a4104e50f20601
-  data.tar.gz: 1409c27d455564263fb596e1ac920f5867540711ea07a8bd2b85a47a07c0843dded453c3648557e81ac8d6586539bb531d551c2d09c19178b728c6720d005944
+  metadata.gz: 1cb34330978dc710806be016761805b82c7cc442ab58752baf33ff62bff64a4476c7f62fce114e10f3dae144c100ae4fe05d167cd66435d3d38fdcb3adb63612
+  data.tar.gz: 5dca5b72d6c09fa2bfe78768d451661f6bad5d1188257a6d7523f51f389956c51214af1250c2f318706274b080c9a9ada019ad2f5e246f0daface09e05351096

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    authsignal-ruby (3.0.0)
+    authsignal-ruby (3.0.1)
       faraday (>= 2)
       faraday-retry (~> 2.2)
 

data/README.md

@@ -63,6 +63,52 @@ Authsignal's server side signal API has four main api calls `track`, `get_action
 
 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 ...
+# }
+```
+
+### Response & Error handling
+
+Authsignal client come with 2 flavors of responses, by default calling the signal APIs will returns payload in hash.
+
+Example:
+```ruby
+Authsignal.enroll_verified_authenticator user_id: 'AS_001',
+                                         authenticator: {
+                                           oob_channel: 'INVALID', email: 'joebloke@authsignal.com'
+                                         }
+
+# returns:
+# {
+#    success?: false,
+#    status: 400,
+#    error: 'invalid_request',
+#    error_description: '/body/oobChannel must be equal to one of the allowed values'
+# }
+```
+
+All signal APIs come with a bang(`!`) counterpart, which will raise `Authsignal::ApiError` when the request is unsuccessful.
+
+
+Example:
+```ruby
+Authsignal.enroll_verified_authenticator! user_id: 'AS_001',
+                                         authenticator: {
+                                           oob_channel: 'INVALID', email: 'joebloke@authsignal.com'
+                                         }
+
+# raise:
+# <Authsignal::ApiError: invalid_request status: 400, error: invalid_request, description: /body/oobChannel must be equal to one o...
+```
 ## 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.

data/lib/authsignal/api_error.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Authsignal
+  class ApiError < StandardError
+    attr_reader :status, :error, :description
+
+    def initialize(message = "An unexpected API error occurred", status, error, description)
+      @status      = status || 500
+      @error       = error
+      @description = description
+
+      super(message)
+    end
+
+    def to_s
+      "#{super} status: #{status}, error: #{error}, description: #{description}"
+    end
+  end
+end

data/lib/authsignal/client.rb

@@ -63,10 +63,10 @@ module Authsignal
             make_request(:delete, "users/#{url_encode(user_id)}")
         end
 
-        def validate_challenge(user_id: nil, token:)
+        def validate_challenge(user_id: nil, token:, action: nil)
             path = "validate"
 
-            make_request(:post, path, body: { user_id: user_id, token: token })
+            make_request(:post, path, body: { user_id: user_id, token: token, action: action })
         end
 
         def get_action(user_id, action, idempotency_key)

data/lib/authsignal/middleware/json_response.rb

@@ -9,6 +9,7 @@ module Authsignal
         # Otherwise, we can safe guard with: env.response_headers['content-type'] =~ /application\/json/
         parsed_body = JSON.parse(env.body)
         if parsed_body.is_a?(Hash)
+          parsed_body.delete("actionCode") # Remove deprecated actionCode from response
           env.body = transform_to_snake_case(parsed_body)
         end
       rescue JSON::ParserError

data/lib/authsignal/version.rb

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

data/lib/authsignal.rb

@@ -3,10 +3,13 @@ require "faraday/retry"
 require "authsignal/version"
 require "authsignal/client"
 require "authsignal/configuration"
+require "authsignal/api_error"
 require "authsignal/middleware/json_response"
 require "authsignal/middleware/json_request"
 
 module Authsignal
+    NON_API_METHODS = [:setup, :configuration, :default_configuration]
+
     class << self
         attr_writer :configuration
 
@@ -66,8 +69,8 @@ module Authsignal
             handle_response(response)
         end
 
-        def validate_challenge(token:, user_id: nil)
-            response = Client.new.validate_challenge(user_id: user_id, token: token)
+        def validate_challenge(token:, user_id: nil, action: nil)
+            response = Client.new.validate_challenge(user_id: user_id, token: token, action: action)
             
             handle_response(response)
         end
@@ -76,18 +79,35 @@ module Authsignal
 
         def handle_response(response)
             if response.success?
-                response.body
+                handle_success_response(response)
             else
                 handle_error_response(response)
             end
         end
 
+        def handle_success_response(response)
+            response.body.merge(success?: true)
+        end
+
         def handle_error_response(response)
             case response.body
             when Hash
-                response.body.merge({ status: response.status })
+                response.body.merge(status: response.status, success?: false)
             else
-                { status: response.status }
+                { status: response&.status || 500, success?: false }
+            end
+        end
+    end
+
+    methods = Authsignal.singleton_class.public_instance_methods(false)
+    (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]
+
+                raise ApiError.new(err, status, err, desc) unless response[:success?]
             end
         end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authsignal-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - justinsoong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -100,6 +100,7 @@ files:
 - bin/console
 - bin/setup
 - lib/authsignal.rb
+- lib/authsignal/api_error.rb
 - lib/authsignal/client.rb
 - lib/authsignal/configuration.rb
 - lib/authsignal/middleware/json_request.rb