Refactor tests

Remove mocked API calls from tests

Author: hwhmeikle

.github/workflows/authsignal.png

@@ -15,7 +15,9 @@ jobs:
       matrix:
         ruby:
           - 3.0.3
-
+    env:
+      AUTHSIGNAL_API_URL: ${{ secrets.AUTHSIGNAL_API_URL }}
+      AUTHSIGNAL_API_SECRET_KEY: ${{ secrets.AUTHSIGNAL_API_SECRET_KEY }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

.github/workflows/main.yml

@@ -16,6 +16,8 @@ jobs:
         if: contains(github.ref, 'refs/tags/')
         uses: cadwallion/publish-rubygems-action@master
         env:
+          AUTHSIGNAL_API_URL: ${{ secrets.AUTHSIGNAL_API_URL }}
+          AUTHSIGNAL_API_SECRET_KEY: ${{ secrets.AUTHSIGNAL_API_SECRET_KEY }}
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
           RELEASE_COMMAND: bundle exec rake -f RakefileRelease

.github/workflows/release-package.yml

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.env

.gitignore

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

Gemfile

@@ -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,6 +57,7 @@ PLATFORMS
 
 DEPENDENCIES
   authsignal-ruby!
+  dotenv
   rake (~> 13.0)
   rspec (~> 3.2)
   webmock (~> 3.14)

Gemfile.lock

@@ -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 `api_url` for your tenant's region.
+## Documentation
 
-| Region      | API URL                             |
-| ----------- | ----------------------------------- |
-| US (Oregon) | https://signal.authsignal.com/v1    |
-| AU (Sydney) | https://au.signal.authsignal.com/v1 |
-| EU (Dublin) | https://eu.signal.authsignal.com/v1 |
+Refer to our [SDK documentation](https://docs.authsignal.com/sdks/server/overview) for information on how to use this SDK.
 
-For example, to set the API URL to use our AU region:
-
-```
-require 'authsignal'
-
-Authsignal.setup do |config|
-    config.api_secret_key = ENV["AUTHSIGNAL_SECRET_KEY"]
-    config.api_url = "https://au.signal.authsignal.com/v1"
-
-    # If you would like the Authsignal client to retry requests due to network issues
-    config.retry = true # default value: false
-
-    # 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/quickstarts/ruby-on-rails).
 
 ### Response & Error handling
 
@@ -84,42 +25,35 @@ 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_code: 400,
-#    error_code: '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.
 
 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: AuthsignalError: 400 - /body/oobChannel must be equal to one of the allowed values. status_code: 401, error_code: invalid_request, error_description: /body/oobChannel must be equal to one of the allowed values.
-```
-
-## 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).
+<Authsignal::ApiError: AuthsignalError: 400 - body.verificationMethod must be equal to one of the allowed values - allowedValues: AUTHENTICATOR_APP,EMAIL_MAGIC_LINK,EMAIL_OTP,SMS.
+```