5.0.0

Release Notes

Changes have been made so that conventions used in the Ruby SDK align with Authsignal's general SDK conventions.

Breaking Changes

1. update_user

   • Replaced the user parameter with attributes in the update_user function.

2. track

   • Updated function signature:
     • Old:

       def track(event)

     • New:

       def track(:user_id, :action, :attributes)

3. enroll_verified_authenticator

   • Updated to accept named parameters: user_id and attributes.

4. get_user

   • Removed redirectUrl from the function signature.

5. update_action_state

   • Renamed method update_action_state to update_action.
   • Replaced input parameter state with attributes.

6. Parameter Renaming

   • Replaced base_uri with api_url to align with Authsignal conventions.

7. Error Handling Updates

   • Error response changes:
     • status replaced with status_code.
     • error replaced with error_code.

---

Non-Breaking Changes

1. get_authenticators
   • Added a new method: get_authenticators.

4.1.0

✨ New Feature: update_action_state method

We’ve introduced a new method, update_action_state, in the Authsignal SDK. This method allows you to update the state of an action directly through the SDK, making it easier to integrate action state management into your application.

4.0.0

Release Notes

Enhancements

• Omit null values by default in all API requests: Updated the API to automatically exclude null values from requests to ensure consistency with Authsignal's other SDKs.

Breaking Changes

• Rename delete_user_authenticator to delete_authenticator: Renamed the delete_user_authenticator method to delete_authenticator across the codebase to maintain a consistent naming convention for related functions. This change will break existing integrations if they are referencing the old method name. Please update your codebase to use the new method name.

3.0.1

✨ New Features & Improvements

• success? in responses: Added success? to provide clear response status indicators.
• Bang methods to raise errors: Introduced bang versions of methods to immediately raise exceptions when operations fail.
• action option in validate_challenge method: Ensures that the validated action matches the tracked action when the action parameter is provided.
• Remove deprecated action_code from validate_challenge response: Cleaned up outdated response structure to avoid confusion.

3.0.0

✨ New Features & Improvements

• Camelize keys in JSON request bodies to align with API expectations.
• Snakecase keys in JSON response bodies to ensure Ruby-friendly object structures.
• Handles text/plain responses gracefully for more flexible API interactions.
• Basic retry mechanism added to handle transient errors.

🐛 Fixes

• Relative URI prefix fix: Use /v1 for API paths, ensuring proper resolution with relative URIs.

🔧 Chores & Maintenance

• Added debug and retry configuration options for better control and troubleshooting.

2.1.3

• Adds Delete User Authenticator

2.1.2

• Adds Delete User

2.1.1

• Adds Update User method
• Breaking change to align action_code parameter in get_user

v2.0.0

This change simplifies the validate_challenge method by calling Authsignal's API to validate a challenge.

Breaking changes:

validate_challenge now returns is_valid instead of success

Make user_id optional in validate_challenge method

• Make user_id optional in validate_challenge method