workos 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae0b9677dcbd0009ad596ea9c517d7a1f7ca6c42e7ef4021b338ef3f6d7fe33
-  data.tar.gz: 9a4f2907b7ceaf9267243d12f1df6c4200a3b50727c4cf2778a60c85b3c045cc
+  metadata.gz: 85c5142c818be2437ddf9782fa43d686f43a36cdae410a8c76c585b815614673
+  data.tar.gz: 18a225e552fa8482536f3b7b390f57e1b1491e9927f0a09a7b80f44b4910120c
 SHA512:
-  metadata.gz: 5f4eda363342a5c35f1e7f5ceb7b8b883639988e5829d738ab428359831c2ba0000b61c142454d48f44f67359e7d29f1c009d9df9ce0955f44183033a5269b7b
-  data.tar.gz: 577ae3386fce2825cae538464f7390f11c25ab8ca904162d2195e6652fdd04c51a5267692f78fcddee37d831d378a166207dcb37f32cd4651d299781ee008432
+  metadata.gz: 1d6624e4e04f3657be82f13feb304f25c2d4cd102ceb7bb25e1755c6abdd3271ef63cbb1ca66a0005182f08efcb68e896743fc8100d2a7ea9deebc466c8d52a9
+  data.tar.gz: acf638e6e5479c76bbb0bc258277a07db00f975aa30ea196c17f0f5c2a30b8c95ea33451a976dfc51fff22f00d9820beb1b820bb81d88b93830529055fe51234

data/CODEOWNERS

@@ -1 +1 @@
-@marktran @sbauch
+@marktran

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.2.1)
+    workos (0.2.2)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -56,7 +56,7 @@ GEM
     simplecov-html (0.10.2)
     sorbet (0.5.5181)
       sorbet-static (= 0.5.5181)
-    sorbet-runtime (0.5.5373)
+    sorbet-runtime (0.5.5501)
     sorbet-static (0.5.5181-universal-darwin-14)
     unicode-display_width (1.6.0)
     url (0.3.2)

data/README.md

@@ -26,12 +26,12 @@ gem 'workos'
 
 To use the SDK you must first provide your API key from the [WorkOS Developer Dashboard](https://dashboard.workos.com/api-keys).
 
-You can do this through the `WORKOS_KEY` environment variable or by calling `WorkOS.key = [your API key]`.
+You can do this through the `WORKOS_API_KEY` environment variable or by calling `WorkOS.key = [your API key]`.
 
-The WorkOS Gem will read the environment variable `WORKOS_KEY`:
+The WorkOS Gem will read the environment variable `WORKOS_API_KEY`:
 
 ```sh
-$ WORKOS_KEY=[your api key] ruby app.rb
+$ WORKOS_API_KEY=[your api key] ruby app.rb
 ```
 
 Alternatively, you may set the key yourself, such as in an initializer in your application load path:

data/docs/WorkOS.html

@@ -88,7 +88,7 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<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>
+<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>
 
 
   </div>
@@ -314,9 +314,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:36 2020 by
+  Generated on Tue Apr  7 22:21:07 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/APIError.html

@@ -150,9 +150,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/AuditTrail.html

@@ -225,9 +225,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/AuthenticationError.html

@@ -150,9 +150,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/Base.html

@@ -277,9 +277,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:36 2020 by
+  Generated on Tue Apr  7 22:21:07 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/Client.html

@@ -494,9 +494,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/InvalidRequestError.html

@@ -150,9 +150,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/Profile.html

@@ -778,9 +778,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/SSO.html

@@ -681,9 +681,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:36 2020 by
+  Generated on Tue Apr  7 22:21:07 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/Types.html

@@ -118,9 +118,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:36 2020 by
+  Generated on Tue Apr  7 22:21:07 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/Types/ProfileStruct.html

@@ -125,9 +125,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/Types/Provider.html

@@ -125,9 +125,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/WorkOS/WorkOSError.html

@@ -437,9 +437,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:37 2020 by
+  Generated on Tue Apr  7 22:21:08 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/file.README.html

@@ -84,11 +84,11 @@
 
 <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>
 
-<p>You can do this through the <code>WORKOS_KEY</code> environment variable or by calling <code>WorkOS.key = [your API key]</code>.</p>
+<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>
 
-<p>The WorkOS Gem will read the environment variable <code>WORKOS_KEY</code>:</p>
+<p>The WorkOS Gem will read the environment variable <code>WORKOS_API_KEY</code>:</p>
 
-<pre class="code ruby"><code class="ruby">$ WORKOS_KEY=[your api key] ruby app.rb
+<pre class="code ruby"><code class="ruby">$ WORKOS_API_KEY=[your api key] ruby app.rb
 </code></pre>
 
 <p>Alternatively, you may set the key yourself, such as in an initializer in your application load path:</p>
@@ -242,9 +242,9 @@
 </div></div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:36 2020 by
+  Generated on Tue Apr  7 22:21:07 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/index.html

@@ -240,9 +240,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:36 2020 by
+  Generated on Tue Apr  7 22:21:07 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/docs/top-level-namespace.html

@@ -100,9 +100,9 @@
 </div>
 
       <div id="footer">
-  Generated on Thu Mar 19 20:24:36 2020 by
+  Generated on Tue Apr  7 22:21:07 2020 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.22 (ruby-2.6.5).
+  0.9.22 (ruby-2.7.1).
 </div>
 
     </div>

data/lib/workos.rb

@@ -6,7 +6,7 @@ require 'sorbet-runtime'
 
 # 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`.
+# 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.
@@ -37,5 +37,8 @@ module WorkOS
   autoload :AuthenticationError, 'workos/errors'
   autoload :InvalidRequestError, 'workos/errors'
 
-  WorkOS.key = ENV['WORKOS_KEY'] unless ENV['WORKOS_KEY'].nil?
+  # Remove WORKOS_KEY at some point in the future. Keeping it here now for
+  # backwards compatibility.
+  key = ENV['WORKOS_API_KEY'] || ENV['WORKOS_KEY']
+  WorkOS.key = key unless key.nil?
 end

data/lib/workos/version.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 # typed: strong
 
-
 module WorkOS
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/workos.gemspec

@@ -7,8 +7,8 @@ require 'workos/version'
 Gem::Specification.new do |spec|
   spec.name          = 'workos'
   spec.version       = WorkOS::VERSION
-  spec.authors       = ['WorkOS', 'Sam Bauch', 'Mark Tran']
-  spec.email         = ['team@workos.com', 'sam@workos.com', 'mark@workos.com']
+  spec.authors       = ['WorkOS']
+  spec.email         = ['support@workos.com']
   spec.description   = 'API client for WorkOS'
   spec.summary       = 'API client for WorkOS'
   spec.homepage      = 'https://github.com/workos/workos-ruby'

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - WorkOS
-- Sam Bauch
-- Mark Tran
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-20 00:00:00.000000000 Z
+date: 2020-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -154,9 +152,7 @@ dependencies:
         version: '0'
 description: API client for WorkOS
 email:
-- team@workos.com
-- sam@workos.com
-- mark@workos.com
+- support@workos.com
 executables:
 - build
 - console