authsignal-ruby 3.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2bf6c96e9f79775fa1d3db3deb5ec5258a8c651e1b4fb8c1c3740c3f5ebd5b6
-  data.tar.gz: 90124d4aa0b3111cd4b52424c78b16f208d4179991e8dcfc52f48fc735483bba
+  metadata.gz: 9c4fa986346960144f15616720f21828275ffabdf16a817e05cadb4ee3c33565
+  data.tar.gz: 0b748a47e76e7af70786179cfde9fa037188da9c6beee9d25194e47f61adf98e
 SHA512:
-  metadata.gz: 1cb34330978dc710806be016761805b82c7cc442ab58752baf33ff62bff64a4476c7f62fce114e10f3dae144c100ae4fe05d167cd66435d3d38fdcb3adb63612
-  data.tar.gz: 5dca5b72d6c09fa2bfe78768d451661f6bad5d1188257a6d7523f51f389956c51214af1250c2f318706274b080c9a9ada019ad2f5e246f0daface09e05351096
+  metadata.gz: 6dfcbd7a4ef015d250e33eebf556f1c651d440de45df9155791748d77f9668e57a40d0e27fb5091290fe178130c3dd70c09cc8aa85829855e317ab263637c5af
+  data.tar.gz: 9ed3d53d1cd3772b2c6744dfacf1ff1471f09e743e1b9ba102f3d731b0c39e185533bad167ceb6f536c0b77c2be49b79094e46fafca8840542dc5b73fd1eb31d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    authsignal-ruby (3.0.1)
+    authsignal-ruby (4.1.0)
       faraday (>= 2)
       faraday-retry (~> 2.2)
 
@@ -14,7 +14,7 @@ GEM
     crack (1.0.0)
       bigdecimal
       rexml
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     faraday (2.12.0)
       faraday-net_http (>= 2.0, < 3.4)
       json
@@ -29,21 +29,21 @@ GEM
     net-http (0.4.1)
       uri
     public_suffix (6.0.1)
-    rake (13.0.6)
+    rake (13.2.1)
     rexml (3.3.8)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.2)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     uri (0.13.1)
     webmock (3.24.0)
       addressable (>= 2.8.0)
@@ -51,6 +51,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  arm64-darwin-24
   ruby
 
 DEPENDENCIES
@@ -60,4 +61,4 @@ DEPENDENCIES
   webmock (~> 3.14)
 
 BUNDLED WITH
-   2.3.21
+   2.5.16

data/README.md

@@ -64,6 +64,7 @@ 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'
 
@@ -78,9 +79,10 @@ Authsignal.track user_id: 'AS_001', action: 'withdraw', idempotency_key: 'a_rand
 
 ### Response & Error handling
 
-Authsignal client come with 2 flavors of responses, by default calling the signal APIs will returns payload in hash.
+The Authsignal SDK offers two response formats. By default, its methods return the payload in hash format.
 
 Example:
+
 ```ruby
 Authsignal.enroll_verified_authenticator user_id: 'AS_001',
                                          authenticator: {
@@ -96,10 +98,10 @@ Authsignal.enroll_verified_authenticator user_id: 'AS_001',
 # }
 ```
 
-All signal APIs come with a bang(`!`) counterpart, which will raise `Authsignal::ApiError` when the request is unsuccessful.
-
+All methods have a bang (!) counterpart that raises an Authsignal::ApiError if the request fails.
 
 Example:
+
 ```ruby
 Authsignal.enroll_verified_authenticator! user_id: 'AS_001',
                                          authenticator: {
@@ -109,6 +111,7 @@ Authsignal.enroll_verified_authenticator! user_id: 'AS_001',
 # 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/client.rb

@@ -65,14 +65,20 @@ module Authsignal
 
         def validate_challenge(user_id: nil, token:, action: nil)
             path = "validate"
+            body = { user_id: user_id, token: token, action: action }
 
-            make_request(:post, path, body: { user_id: user_id, token: token, action: action })
+            make_request(:post, path, body: body)
         end
 
         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)
+        end
+
         ##
         # TODO: delete identify?
         def identify(user_id, user_payload)
@@ -83,16 +89,12 @@ module Authsignal
             make_request(:post, "users/#{url_encode(user_id)}/authenticators", body: authenticator)
         end
 
-        def delete_user_authenticator(user_id:, user_authenticator_id:)
+        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 make_request(method, path, body: nil, headers: nil)
-            @client.public_send(method, path, body, headers)
-        end
-
         def url_encode(s)
             ERB::Util.url_encode(s)
         end
@@ -108,5 +110,12 @@ module Authsignal
         def require_api_key
             Authsignal.configuration.api_secret_key || print_api_key_warning
         end
+
+        def make_request(method, path, body: nil, headers: nil)
+            if body.is_a?(Hash)
+                body = body.reject { |_, v| v.nil? }
+            end
+            @client.public_send(method, path, body, headers)
+        end
     end
 end

data/lib/authsignal/version.rb

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

data/lib/authsignal.rb

@@ -49,14 +49,21 @@ module Authsignal
             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)
+
+            handle_response(response)
+        end
+
         def enroll_verified_authenticator(user_id:, authenticator:)
             response = Client.new.enroll_verified_authenticator(user_id, authenticator)
 
             handle_response(response)
         end
 
-        def delete_user_authenticator(user_id:, user_authenticator_id: )
-            response = Client.new.delete_user_authenticator(user_id: user_id, user_authenticator_id: user_authenticator_id)
+        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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authsignal-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - justinsoong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday