workos 2.16.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cbb0a53c0c7c21c1d8cb22a6d3d2679421da8fbeb237009bcd31c1f679c1586
-  data.tar.gz: 914321349e893fb0d9e7c955c6bff5c92851f5946d2f2bc278de6cad01295ae2
+  metadata.gz: ef5e91f45a32fca11bf7338b94c35c1c9cbc74d7193a065e2f7b4f995b40a108
+  data.tar.gz: 168c7c0b96de3b066845ece0fdb7c92ae37f7ba3ac8729cdc0226f22bf12442b
 SHA512:
-  metadata.gz: 777ab4dd91a7ce30ce709dd4578018abf4cde6b1c3d213588b1d1cc0d0b5c0c503ecd79e9c8fa30ff6d8d597fcb92ca027527b46e96d93fdbbb060b916830f90
-  data.tar.gz: 63ee003031a51bfa309e0095d2e4a6abb7caee9c6b3202efda809b7b6922a782fe04214af94a5647863bf059eca7f9228d91cdebc86e1800e3ae1caf9aeedbff
+  metadata.gz: 57574ab78fd8bdd0cd5e77612290c58c252b80ac7e086b7c7d60046e9688d4bf19e4ede830f4ac91f53f4400e3b25c3001322d8e83656866fece316a41c6a9ac
+  data.tar.gz: 7595a48e1a25602247bb684bb4d95727f8a0fdc39c27a02662f9f677335b310f980596522519e294bedabae88e460e81589c34fdf04a85bdaea544c64400f38b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (2.16.0)
+    workos (2.17.0)
       sorbet-runtime (~> 0.5)
 
 GEM

data/lib/workos/client.rb

@@ -9,7 +9,7 @@ module WorkOS
 
     sig { returns(Net::HTTP) }
     def client
-      Net::HTTP.new(WorkOS::API_HOSTNAME, 443).tap do |http_client|
+      Net::HTTP.new(WorkOS.config.api_hostname, 443).tap do |http_client|
         http_client.use_ssl = true
         http_client.open_timeout = WorkOS.config.timeout
         http_client.read_timeout = WorkOS.config.timeout

data/lib/workos/configuration.rb

@@ -4,7 +4,7 @@
 module WorkOS
   # Configuration class sets config initializer
   class Configuration
-    attr_accessor :timeout, :key
+    attr_accessor :api_hostname, :timeout, :key
 
     def initialize
       @timeout = 60

data/lib/workos/sso.rb

@@ -104,7 +104,7 @@ module WorkOS
           organization: organization,
         }.compact)
 
-        "https://#{WorkOS::API_HOSTNAME}/sso/authorize?#{query}"
+        "https://#{WorkOS.config.api_hostname}/sso/authorize?#{query}"
       end
       # rubocop:enable Metrics/ParameterLists
 

data/lib/workos/types/provider_enum.rb

@@ -7,6 +7,7 @@ module WorkOS
     # fixed set of values for SSO Providers.
     class Provider < T::Enum
       enums do
+        GitHub = new('GitHubOAuth')
         Google = new('GoogleOAuth')
         Microsoft = new('MicrosoftOAuth')
       end

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '2.16.0'
+  VERSION = '2.17.0'
 end

data/lib/workos.rb

@@ -11,10 +11,25 @@ require 'workos/configuration'
 # 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.
+# `WorkOS.configure { |config| config.key = [your api key] }` somewhere
+# in the load path of your application, such as an initializer.
 module WorkOS
-  API_HOSTNAME = ENV['WORKOS_API_HOSTNAME'] || 'api.workos.com'
+  def self.default_config
+    Configuration.new.tap do |config|
+      config.api_hostname = ENV['WORKOS_API_HOSTNAME'] || 'api.workos.com'
+      # Remove WORKOS_KEY at some point in the future. Keeping it here now for
+      # backwards compatibility.
+      config.key = ENV['WORKOS_API_KEY'] || ENV['WORKOS_KEY']
+    end
+  end
+
+  def self.config
+    @config ||= default_config
+  end
+
+  def self.configure
+    yield(config)
+  end
 
   def self.key=(value)
     warn '`WorkOS.key=` is deprecated. Use `WorkOS.configure` instead.'
@@ -28,14 +43,6 @@ module WorkOS
     config.key
   end
 
-  def self.config
-    @config ||= Configuration.new
-  end
-
-  def self.configure
-    yield(config)
-  end
-
   autoload :Types, 'workos/types'
   autoload :Client, 'workos/client'
   autoload :Configuration, 'workos/configuration'
@@ -71,9 +78,4 @@ module WorkOS
   autoload :InvalidRequestError, 'workos/errors'
   autoload :SignatureVerificationError, 'workos/errors'
   autoload :TimeoutError, 'workos/errors'
-
-  # Remove WORKOS_KEY at some point in the future. Keeping it here now for
-  # backwards compatibility.
-  key = ENV['WORKOS_API_KEY'] || ENV['WORKOS_KEY']
-  config.key = key unless key.nil?
 end

data/spec/lib/workos/sso_spec.rb

@@ -26,7 +26,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -60,7 +60,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -94,7 +94,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -128,7 +128,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -163,7 +163,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -198,7 +198,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -232,7 +232,7 @@ describe WorkOS::SSO do
       it 'returns the expected hostname' do
         authorization_url = described_class.authorization_url(**args)
 
-        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+        expect(URI.parse(authorization_url).host).to eq(WorkOS.config.api_hostname)
       end
 
       it 'returns the expected query string' do
@@ -282,7 +282,7 @@ describe WorkOS::SSO do
           described_class.authorization_url(**args)
         end.to raise_error(
           ArgumentError,
-          'Okta is not a valid value. `provider` must be in ["GoogleOAuth", "MicrosoftOAuth"]',
+          'Okta is not a valid value. `provider` must be in ["GitHubOAuth", "GoogleOAuth", "MicrosoftOAuth"]',
         )
       end
     end

data/workos.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   }
 
   spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 2.16.0
+  version: 2.17.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -153,12 +153,7 @@ dependencies:
 description: API client for WorkOS
 email:
 - support@workos.com
-executables:
-- build
-- console
-- docs
-- publish
-- tapioca
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -423,7 +418,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.16
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: API client for WorkOS