authsignal-ruby 5.0.0 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1 -5
  3. data/Gemfile +4 -0
  4. data/Gemfile.lock +5 -3
  5. data/README.md +27 -93
  6. data/lib/authsignal/version.rb +1 -1
  7. metadata +5 -8
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 75bf7679eabfb897458c92a7b284ff2cdd1ea7eb833275e14c1c01c47de3ea89
4
- data.tar.gz: 4a94529da1d514caa69e4498f68d19006a3fd09be8d094be463aa33b9bc5e4d9
3
+ metadata.gz: 60927c210d3c9ca7c01e5fc6a3b2cddfbd069693cc221cd585f24154e07fd515
4
+ data.tar.gz: 9ca1be169ea1f4e24510e42de4a8b6cc79628b7e88a35bc46e279a2a4d254440
5
5
  SHA512:
6
- metadata.gz: c12dd82892ca7c69bf2ec0e981a1ff5276e5f0fca37e6ae173ef385af63649a322b8cdc96d3e39b7d13eea7494bba97c15c234251838e092f816aed7ecaefd20
7
- data.tar.gz: e263f4d2eaa242a23e3aafce95ea7b1db01011d33c51b45b9c655b5e184b39ddf51a4e29d2a8b5b0e6684bd2f2e8b87e110d3848819fc89dc09076bf8e4e2147
6
+ metadata.gz: 2ea4f562bea332f0db4f3b5fbf24a4cf6993bdb17d2879e232219ad7814ab5b59ca2c3a9e52087d295f285bd15f9c890abe8c43162875b6af1af22171049fbc7
7
+ data.tar.gz: b75556ccafcf243fd4ff33c7d8c25731ae9dfc6bc51637b64a667ab8faa99ae8b2fdf1bb5c7039dff2701e0f338c39c7be64ec09add77273c490353e2eec3f2c
data/CHANGELOG.md CHANGED
@@ -1,5 +1 @@
1
- ## [Unreleased]
2
-
3
- ## [0.1.0] - 2022-07-14
4
-
5
- - Initial release
1
+ SDK changes are currently documented in the [Releases](https://github.com/authsignal/authsignal-ruby/releases) section.
data/Gemfile CHANGED
@@ -4,3 +4,7 @@ source "https://rubygems.org"
4
4
 
5
5
  # Specify your gem's dependencies in authsignal-ruby.gemspec
6
6
  gemspec
7
+
8
+ group :test do
9
+ gem 'dotenv'
10
+ end
data/Gemfile.lock CHANGED
@@ -1,8 +1,8 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- authsignal-ruby (5.0.0)
5
- faraday (>= 2)
4
+ authsignal-ruby (5.0.1)
5
+ faraday (>= 2.0.1)
6
6
  faraday-retry (~> 2.2)
7
7
 
8
8
  GEM
@@ -15,6 +15,7 @@ GEM
15
15
  bigdecimal
16
16
  rexml
17
17
  diff-lcs (1.5.1)
18
+ dotenv (3.1.7)
18
19
  faraday (2.12.0)
19
20
  faraday-net_http (>= 2.0, < 3.4)
20
21
  json
@@ -56,9 +57,10 @@ PLATFORMS
56
57
 
57
58
  DEPENDENCIES
58
59
  authsignal-ruby!
60
+ dotenv
59
61
  rake (~> 13.0)
60
62
  rspec (~> 3.2)
61
63
  webmock (~> 3.14)
62
64
 
63
65
  BUNDLED WITH
64
- 2.5.16
66
+ 2.5.14
data/README.md CHANGED
@@ -1,6 +1,8 @@
1
- # Authsignal Server Ruby SDK
1
+ <img width="1070" alt="Authsignal" src="https://raw.githubusercontent.com/authsignal/authsignal-node/main/.github/images/authsignal.png">
2
2
 
3
- 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).
3
+ # Authsignal Ruby SDK
4
+
5
+ The Authsignal Ruby library for server-side applications.
4
6
 
5
7
  ## Installation
6
8
 
@@ -10,72 +12,11 @@ Add this line to your application's Gemfile:
10
12
  gem "authsignal-ruby"
11
13
  ```
12
14
 
13
- And then execute:
14
-
15
- $ bundle install
16
-
17
- Or install it yourself as:
18
-
19
- $ gem install authsignal-ruby
20
-
21
- ## Initialization
22
-
23
- Initialize the Authsignal Ruby SDK, ensuring you do not hard code the Authsignal Secret Key, always keep this safe.
24
-
25
- In Ruby on Rails, you would typically place this code block in a file like `config/initializers/authsignal.rb`
26
-
27
- ```ruby
28
- Authsignal.setup do |config|
29
- config.api_secret_key = ENV["AUTHSIGNAL_SECRET_KEY"]
30
- end
31
- ```
32
-
33
- You can find your `api_secret_key` in the [Authsignal Portal](https://portal.authsignal.com/organisations/tenants/api).
34
-
35
- You must specify the correct `api_url` for your tenant's region.
36
-
37
- | Region | API URL |
38
- | ----------- | ----------------------------------- |
39
- | US (Oregon) | https://signal.authsignal.com/v1 |
40
- | AU (Sydney) | https://au.signal.authsignal.com/v1 |
41
- | EU (Dublin) | https://eu.signal.authsignal.com/v1 |
42
-
43
- For example, to set the API URL to use our AU region:
44
-
45
- ```
46
- require 'authsignal'
47
-
48
- Authsignal.setup do |config|
49
- config.api_secret_key = ENV["AUTHSIGNAL_SECRET_KEY"]
50
- config.api_url = "https://au.signal.authsignal.com/v1"
15
+ ## Documentation
51
16
 
52
- # If you would like the Authsignal client to retry requests due to network issues
53
- config.retry = true # default value: false
17
+ Refer to our [SDK documentation](https://docs.authsignal.com/sdks/server/overview) for information on how to use this SDK.
54
18
 
55
- # If you would like to inspect raw request/response in development
56
- config.debug = true # default value: false
57
- end
58
- ```
59
-
60
- ## Usage
61
-
62
- Authsignal's server side signal API has four main api calls `track`, `get_action`, `get_user`, `enroll_verified_authenticator`.
63
-
64
- For more details on these api calls, refer to our [official Ruby SDK docs](https://docs.authsignal.com/sdks/server/ruby#track).
65
-
66
- Example:
67
-
68
- ```ruby
69
- Authsignal.track user_id: 'AS_001', action: 'withdraw', idempotency_key: 'a_random_hash'
70
-
71
- # returns:
72
- # {
73
- # success?: true,
74
- # state: 'ALLOW',
75
- # idempotency_key: 'a_random_hash',
76
- # ... rest of payload ...
77
- # }
78
- ```
19
+ Or check out our [Ruby on Rails Quickstart Guide](https://docs.authsignal.com/integrations/ruby-on-rails).
79
20
 
80
21
  ### Response & Error handling
81
22
 
@@ -84,18 +25,20 @@ The Authsignal SDK offers two response formats. By default, its methods return t
84
25
  Example:
85
26
 
86
27
  ```ruby
87
- Authsignal.enroll_verified_authenticator user_id: 'AS_001',
88
- authenticator: {
89
- oob_channel: 'INVALID', email: 'joebloke@authsignal.com'
90
- }
28
+ Authsignal.enroll_verified_authenticator(
29
+ user_id: 'AS_001',
30
+ attributes: {
31
+ verification_method: 'INVALID',
32
+ email: 'hamish@authsignal.com'
33
+ }
34
+ )
91
35
 
92
36
  # returns:
93
- # {
94
- # success?: false,
95
- # status_code: 400,
96
- # error_code: 'invalid_request',
97
- # error_description: '/body/oobChannel must be equal to one of the allowed values'
98
- # }
37
+ {
38
+ "error": "invalid_request",
39
+ "errorCode": "invalid_request",
40
+ "errorDescription": "body.verificationMethod must be equal to one of the allowed values - allowedValues: AUTHENTICATOR_APP,EMAIL_MAGIC_LINK,EMAIL_OTP,SMS"
41
+ }
99
42
  ```
100
43
 
101
44
  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
103
46
  Example:
104
47
 
105
48
  ```ruby
106
- Authsignal.enroll_verified_authenticator! user_id: 'AS_001',
107
- authenticator: {
108
- oob_channel: 'INVALID', email: 'joebloke@authsignal.com'
109
- }
49
+ Authsignal.enroll_verified_authenticator!(
50
+ user_id: 'AS_001',
51
+ attributes: {
52
+ verification_method: 'INVALID',
53
+ email: 'hamish@authsignal.com'
54
+ }
55
+ )
110
56
 
111
57
  # raise:
112
- # <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.
58
+ <Authsignal::ApiError: AuthsignalError: 400 - body.verificationMethod must be equal to one of the allowed values - allowedValues: AUTHENTICATOR_APP,EMAIL_MAGIC_LINK,EMAIL_OTP,SMS.
113
59
  ```
114
-
115
- ## Development
116
-
117
- 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.
118
-
119
- 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).
120
-
121
- Log request/response against test server: `Authsignal.configuration.debug = true`
122
-
123
- ## License
124
-
125
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/lib/authsignal/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Authsignal
4
- VERSION = "5.0.0"
4
+ VERSION = "5.0.1"
5
5
  end
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: authsignal-ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.0.0
4
+ version: 5.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - justinsoong
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2024-11-27 00:00:00.000000000 Z
10
+ date: 2025-03-25 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: faraday
@@ -16,14 +15,14 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: '2'
18
+ version: 2.0.1
20
19
  type: :runtime
21
20
  prerelease: false
22
21
  version_requirements: !ruby/object:Gem::Requirement
23
22
  requirements:
24
23
  - - ">="
25
24
  - !ruby/object:Gem::Version
26
- version: '2'
25
+ version: 2.0.1
27
26
  - !ruby/object:Gem::Dependency
28
27
  name: faraday-retry
29
28
  requirement: !ruby/object:Gem::Requirement
@@ -112,7 +111,6 @@ licenses:
112
111
  metadata:
113
112
  homepage_uri: https://www.authsignal.com
114
113
  source_code_uri: https://github.com/authsignal/authsignal-ruby
115
- post_install_message:
116
114
  rdoc_options: []
117
115
  require_paths:
118
116
  - lib
@@ -127,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
127
125
  - !ruby/object:Gem::Version
128
126
  version: '0'
129
127
  requirements: []
130
- rubygems_version: 3.5.22
131
- signing_key:
128
+ rubygems_version: 3.6.2
132
129
  specification_version: 4
133
130
  summary: The Authsignal ruby server side signal API.
134
131
  test_files: []