workos 0.2.1 → 0.2.2

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 (24) hide show
  1. checksums.yaml +4 -4
  2. data/CODEOWNERS +1 -1
  3. data/Gemfile.lock +2 -2
  4. data/README.md +3 -3
  5. data/docs/WorkOS.html +3 -3
  6. data/docs/WorkOS/APIError.html +2 -2
  7. data/docs/WorkOS/AuditTrail.html +2 -2
  8. data/docs/WorkOS/AuthenticationError.html +2 -2
  9. data/docs/WorkOS/Base.html +2 -2
  10. data/docs/WorkOS/Client.html +2 -2
  11. data/docs/WorkOS/InvalidRequestError.html +2 -2
  12. data/docs/WorkOS/Profile.html +2 -2
  13. data/docs/WorkOS/SSO.html +2 -2
  14. data/docs/WorkOS/Types.html +2 -2
  15. data/docs/WorkOS/Types/ProfileStruct.html +2 -2
  16. data/docs/WorkOS/Types/Provider.html +2 -2
  17. data/docs/WorkOS/WorkOSError.html +2 -2
  18. data/docs/file.README.html +5 -5
  19. data/docs/index.html +2 -2
  20. data/docs/top-level-namespace.html +2 -2
  21. data/lib/workos.rb +5 -2
  22. data/lib/workos/version.rb +1 -2
  23. data/workos.gemspec +2 -2
  24. metadata +3 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cae0b9677dcbd0009ad596ea9c517d7a1f7ca6c42e7ef4021b338ef3f6d7fe33
4
- data.tar.gz: 9a4f2907b7ceaf9267243d12f1df6c4200a3b50727c4cf2778a60c85b3c045cc
3
+ metadata.gz: 85c5142c818be2437ddf9782fa43d686f43a36cdae410a8c76c585b815614673
4
+ data.tar.gz: 18a225e552fa8482536f3b7b390f57e1b1491e9927f0a09a7b80f44b4910120c
5
5
  SHA512:
6
- metadata.gz: 5f4eda363342a5c35f1e7f5ceb7b8b883639988e5829d738ab428359831c2ba0000b61c142454d48f44f67359e7d29f1c009d9df9ce0955f44183033a5269b7b
7
- data.tar.gz: 577ae3386fce2825cae538464f7390f11c25ab8ca904162d2195e6652fdd04c51a5267692f78fcddee37d831d378a166207dcb37f32cd4651d299781ee008432
6
+ metadata.gz: 1d6624e4e04f3657be82f13feb304f25c2d4cd102ceb7bb25e1755c6abdd3271ef63cbb1ca66a0005182f08efcb68e896743fc8100d2a7ea9deebc466c8d52a9
7
+ data.tar.gz: acf638e6e5479c76bbb0bc258277a07db00f975aa30ea196c17f0f5c2a30b8c95ea33451a976dfc51fff22f00d9820beb1b820bb81d88b93830529055fe51234
data/CODEOWNERS CHANGED
@@ -1 +1 @@
1
- @marktran @sbauch
1
+ @marktran
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- workos (0.2.1)
4
+ workos (0.2.2)
5
5
  sorbet-runtime (~> 0.5)
6
6
 
7
7
  GEM
@@ -56,7 +56,7 @@ GEM
56
56
  simplecov-html (0.10.2)
57
57
  sorbet (0.5.5181)
58
58
  sorbet-static (= 0.5.5181)
59
- sorbet-runtime (0.5.5373)
59
+ sorbet-runtime (0.5.5501)
60
60
  sorbet-static (0.5.5181-universal-darwin-14)
61
61
  unicode-display_width (1.6.0)
62
62
  url (0.3.2)
data/README.md CHANGED
@@ -26,12 +26,12 @@ gem 'workos'
26
26
 
27
27
  To use the SDK you must first provide your API key from the [WorkOS Developer Dashboard](https://dashboard.workos.com/api-keys).
28
28
 
29
- You can do this through the `WORKOS_KEY` environment variable or by calling `WorkOS.key = [your API key]`.
29
+ You can do this through the `WORKOS_API_KEY` environment variable or by calling `WorkOS.key = [your API key]`.
30
30
 
31
- The WorkOS Gem will read the environment variable `WORKOS_KEY`:
31
+ The WorkOS Gem will read the environment variable `WORKOS_API_KEY`:
32
32
 
33
33
  ```sh
34
- $ WORKOS_KEY=[your api key] ruby app.rb
34
+ $ WORKOS_API_KEY=[your api key] ruby app.rb
35
35
  ```
36
36
 
37
37
  Alternatively, you may set the key yourself, such as in an initializer in your application load path:
data/docs/WorkOS.html CHANGED
@@ -88,7 +88,7 @@
88
88
  <h2>Overview</h2><div class="docstring">
89
89
  <div class="discussion">
90
90
 
91
- <p>Use the WorkOS module to authenticate your requests to the WorkOS API. The gem will read your API key automatically from the ENV var `WORKOS_KEY`. Alternatively, you can set the key yourself with `WorkOS.key = [your api key]` somewhere in the load path of your application, such as an initializer.</p>
91
+ <p>Use the WorkOS module to authenticate your requests to the WorkOS API. The gem will read your API key automatically from the ENV var `WORKOS_API_KEY`. Alternatively, you can set the key yourself with `WorkOS.key = [your api key]` somewhere in the load path of your application, such as an initializer.</p>
92
92
 
93
93
 
94
94
  </div>
@@ -314,9 +314,9 @@
314
314
  </div>
315
315
 
316
316
  <div id="footer">
317
- Generated on Thu Mar 19 20:24:36 2020 by
317
+ Generated on Tue Apr 7 22:21:07 2020 by
318
318
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
319
- 0.9.22 (ruby-2.6.5).
319
+ 0.9.22 (ruby-2.7.1).
320
320
  </div>
321
321
 
322
322
  </div>
data/docs/WorkOS/APIError.html CHANGED
@@ -150,9 +150,9 @@
150
150
  </div>
151
151
 
152
152
  <div id="footer">
153
- Generated on Thu Mar 19 20:24:37 2020 by
153
+ Generated on Tue Apr 7 22:21:08 2020 by
154
154
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
155
- 0.9.22 (ruby-2.6.5).
155
+ 0.9.22 (ruby-2.7.1).
156
156
  </div>
157
157
 
158
158
  </div>
data/docs/WorkOS/AuditTrail.html CHANGED
@@ -225,9 +225,9 @@
225
225
  </div>
226
226
 
227
227
  <div id="footer">
228
- Generated on Thu Mar 19 20:24:37 2020 by
228
+ Generated on Tue Apr 7 22:21:08 2020 by
229
229
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
230
- 0.9.22 (ruby-2.6.5).
230
+ 0.9.22 (ruby-2.7.1).
231
231
  </div>
232
232
 
233
233
  </div>
data/docs/WorkOS/AuthenticationError.html CHANGED
@@ -150,9 +150,9 @@
150
150
  </div>
151
151
 
152
152
  <div id="footer">
153
- Generated on Thu Mar 19 20:24:37 2020 by
153
+ Generated on Tue Apr 7 22:21:08 2020 by
154
154
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
155
- 0.9.22 (ruby-2.6.5).
155
+ 0.9.22 (ruby-2.7.1).
156
156
  </div>
157
157
 
158
158
  </div>
data/docs/WorkOS/Base.html CHANGED
@@ -277,9 +277,9 @@
277
277
  </div>
278
278
 
279
279
  <div id="footer">
280
- Generated on Thu Mar 19 20:24:36 2020 by
280
+ Generated on Tue Apr 7 22:21:07 2020 by
281
281
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
282
- 0.9.22 (ruby-2.6.5).
282
+ 0.9.22 (ruby-2.7.1).
283
283
  </div>
284
284
 
285
285
  </div>
data/docs/WorkOS/Client.html CHANGED
@@ -494,9 +494,9 @@
494
494
  </div>
495
495
 
496
496
  <div id="footer">
497
- Generated on Thu Mar 19 20:24:37 2020 by
497
+ Generated on Tue Apr 7 22:21:08 2020 by
498
498
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
499
- 0.9.22 (ruby-2.6.5).
499
+ 0.9.22 (ruby-2.7.1).
500
500
  </div>
501
501
 
502
502
  </div>
data/docs/WorkOS/InvalidRequestError.html CHANGED
@@ -150,9 +150,9 @@
150
150
  </div>
151
151
 
152
152
  <div id="footer">
153
- Generated on Thu Mar 19 20:24:37 2020 by
153
+ Generated on Tue Apr 7 22:21:08 2020 by
154
154
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
155
- 0.9.22 (ruby-2.6.5).
155
+ 0.9.22 (ruby-2.7.1).
156
156
  </div>
157
157
 
158
158
  </div>
data/docs/WorkOS/Profile.html CHANGED
@@ -778,9 +778,9 @@
778
778
  </div>
779
779
 
780
780
  <div id="footer">
781
- Generated on Thu Mar 19 20:24:37 2020 by
781
+ Generated on Tue Apr 7 22:21:08 2020 by
782
782
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
783
- 0.9.22 (ruby-2.6.5).
783
+ 0.9.22 (ruby-2.7.1).
784
784
  </div>
785
785
 
786
786
  </div>
data/docs/WorkOS/SSO.html CHANGED
@@ -681,9 +681,9 @@
681
681
  </div>
682
682
 
683
683
  <div id="footer">
684
- Generated on Thu Mar 19 20:24:36 2020 by
684
+ Generated on Tue Apr 7 22:21:07 2020 by
685
685
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
686
- 0.9.22 (ruby-2.6.5).
686
+ 0.9.22 (ruby-2.7.1).
687
687
  </div>
688
688
 
689
689
  </div>
data/docs/WorkOS/Types.html CHANGED
@@ -118,9 +118,9 @@
118
118
  </div>
119
119
 
120
120
  <div id="footer">
121
- Generated on Thu Mar 19 20:24:36 2020 by
121
+ Generated on Tue Apr 7 22:21:07 2020 by
122
122
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
- 0.9.22 (ruby-2.6.5).
123
+ 0.9.22 (ruby-2.7.1).
124
124
  </div>
125
125
 
126
126
  </div>
data/docs/WorkOS/Types/ProfileStruct.html CHANGED
@@ -125,9 +125,9 @@
125
125
  </div>
126
126
 
127
127
  <div id="footer">
128
- Generated on Thu Mar 19 20:24:37 2020 by
128
+ Generated on Tue Apr 7 22:21:08 2020 by
129
129
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130
- 0.9.22 (ruby-2.6.5).
130
+ 0.9.22 (ruby-2.7.1).
131
131
  </div>
132
132
 
133
133
  </div>
data/docs/WorkOS/Types/Provider.html CHANGED
@@ -125,9 +125,9 @@
125
125
  </div>
126
126
 
127
127
  <div id="footer">
128
- Generated on Thu Mar 19 20:24:37 2020 by
128
+ Generated on Tue Apr 7 22:21:08 2020 by
129
129
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
130
- 0.9.22 (ruby-2.6.5).
130
+ 0.9.22 (ruby-2.7.1).
131
131
  </div>
132
132
 
133
133
  </div>
data/docs/WorkOS/WorkOSError.html CHANGED
@@ -437,9 +437,9 @@
437
437
  </div>
438
438
 
439
439
  <div id="footer">
440
- Generated on Thu Mar 19 20:24:37 2020 by
440
+ Generated on Tue Apr 7 22:21:08 2020 by
441
441
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
442
- 0.9.22 (ruby-2.6.5).
442
+ 0.9.22 (ruby-2.7.1).
443
443
  </div>
444
444
 
445
445
  </div>
data/docs/file.README.html CHANGED
@@ -84,11 +84,11 @@
84
84
 
85
85
  <p>To use the SDK you must first provide your API key from the <a href="https://dashboard.workos.com/api-keys">WorkOS Developer Dashboard</a>.</p>
86
86
 
87
- <p>You can do this through the <code>WORKOS_KEY</code> environment variable or by calling <code>WorkOS.key = [your API key]</code>.</p>
87
+ <p>You can do this through the <code>WORKOS_API_KEY</code> environment variable or by calling <code>WorkOS.key = [your API key]</code>.</p>
88
88
 
89
- <p>The WorkOS Gem will read the environment variable <code>WORKOS_KEY</code>:</p>
89
+ <p>The WorkOS Gem will read the environment variable <code>WORKOS_API_KEY</code>:</p>
90
90
 
91
- <pre class="code ruby"><code class="ruby">$ WORKOS_KEY=[your api key] ruby app.rb
91
+ <pre class="code ruby"><code class="ruby">$ WORKOS_API_KEY=[your api key] ruby app.rb
92
92
  </code></pre>
93
93
 
94
94
  <p>Alternatively, you may set the key yourself, such as in an initializer in your application load path:</p>
@@ -242,9 +242,9 @@
242
242
  </div></div>
243
243
 
244
244
  <div id="footer">
245
- Generated on Thu Mar 19 20:24:36 2020 by
245
+ Generated on Tue Apr 7 22:21:07 2020 by
246
246
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
247
- 0.9.22 (ruby-2.6.5).
247
+ 0.9.22 (ruby-2.7.1).
248
248
  </div>
249
249
 
250
250
  </div>
data/docs/index.html CHANGED
@@ -240,9 +240,9 @@
240
240
  </div>
241
241
 
242
242
  <div id="footer">
243
- Generated on Thu Mar 19 20:24:36 2020 by
243
+ Generated on Tue Apr 7 22:21:07 2020 by
244
244
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
245
- 0.9.22 (ruby-2.6.5).
245
+ 0.9.22 (ruby-2.7.1).
246
246
  </div>
247
247
 
248
248
  </div>
data/docs/top-level-namespace.html CHANGED
@@ -100,9 +100,9 @@
100
100
  </div>
101
101
 
102
102
  <div id="footer">
103
- Generated on Thu Mar 19 20:24:36 2020 by
103
+ Generated on Tue Apr 7 22:21:07 2020 by
104
104
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
105
- 0.9.22 (ruby-2.6.5).
105
+ 0.9.22 (ruby-2.7.1).
106
106
  </div>
107
107
 
108
108
  </div>
data/lib/workos.rb CHANGED
@@ -6,7 +6,7 @@ require 'sorbet-runtime'
6
6
 
7
7
  # Use the WorkOS module to authenticate your
8
8
  # requests to the WorkOS API. The gem will read
9
- # your API key automatically from the ENV var `WORKOS_KEY`.
9
+ # your API key automatically from the ENV var `WORKOS_API_KEY`.
10
10
  # Alternatively, you can set the key yourself with
11
11
  # `WorkOS.key = [your api key]` somewhere in the load path of
12
12
  # your application, such as an initializer.
@@ -37,5 +37,8 @@ module WorkOS
37
37
  autoload :AuthenticationError, 'workos/errors'
38
38
  autoload :InvalidRequestError, 'workos/errors'
39
39
 
40
- WorkOS.key = ENV['WORKOS_KEY'] unless ENV['WORKOS_KEY'].nil?
40
+ # Remove WORKOS_KEY at some point in the future. Keeping it here now for
41
+ # backwards compatibility.
42
+ key = ENV['WORKOS_API_KEY'] || ENV['WORKOS_KEY']
43
+ WorkOS.key = key unless key.nil?
41
44
  end
data/lib/workos/version.rb CHANGED
@@ -1,7 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
  # typed: strong
3
3
 
4
-
5
4
  module WorkOS
6
- VERSION = '0.2.1'
5
+ VERSION = '0.2.2'
7
6
  end
data/workos.gemspec CHANGED
@@ -7,8 +7,8 @@ require 'workos/version'
7
7
  Gem::Specification.new do |spec|
8
8
  spec.name = 'workos'
9
9
  spec.version = WorkOS::VERSION
10
- spec.authors = ['WorkOS', 'Sam Bauch', 'Mark Tran']
11
- spec.email = ['team@workos.com', 'sam@workos.com', 'mark@workos.com']
10
+ spec.authors = ['WorkOS']
11
+ spec.email = ['support@workos.com']
12
12
  spec.description = 'API client for WorkOS'
13
13
  spec.summary = 'API client for WorkOS'
14
14
  spec.homepage = 'https://github.com/workos/workos-ruby'
metadata CHANGED
@@ -1,16 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: workos
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - WorkOS
8
- - Sam Bauch
9
- - Mark Tran
10
8
  autorequire:
11
9
  bindir: bin
12
10
  cert_chain: []
13
- date: 2020-03-20 00:00:00.000000000 Z
11
+ date: 2020-04-08 00:00:00.000000000 Z
14
12
  dependencies:
15
13
  - !ruby/object:Gem::Dependency
16
14
  name: sorbet-runtime
@@ -154,9 +152,7 @@ dependencies:
154
152
  version: '0'
155
153
  description: API client for WorkOS
156
154
  email:
157
- - team@workos.com
158
- - sam@workos.com
159
- - mark@workos.com
155
+ - support@workos.com
160
156
  executables:
161
157
  - build
162
158
  - console