workos 2.15.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b01746fa31764bb3e0a381ca2e3dd0bef08a39a9e80db8d5079997e2e392d36
-  data.tar.gz: 79ec855c5da2d642a911b7896d353628e837c020a471d70824b39bb510e60d71
+  metadata.gz: ef5e91f45a32fca11bf7338b94c35c1c9cbc74d7193a065e2f7b4f995b40a108
+  data.tar.gz: 168c7c0b96de3b066845ece0fdb7c92ae37f7ba3ac8729cdc0226f22bf12442b
 SHA512:
-  metadata.gz: 6aaee86d818a23e40de43f9f5eececdb109fe1fdbba6c4c7a50916e814976ec7a140628415c40aca4d170eb4fd3105125eb8bc4c68ea8ff695f6bb8f91baeea9
-  data.tar.gz: c805ad7bf051ebaeb1b5ac485f710d951d5890cd9219adbf32daa3edf653d2baa8e0fb740c550d4e0be9433d7fe6fb355d4130148a66ef9e80f7f73d76bebc66
+  metadata.gz: 57574ab78fd8bdd0cd5e77612290c58c252b80ac7e086b7c7d60046e9688d4bf19e4ede830f4ac91f53f4400e3b25c3001322d8e83656866fece316a41c6a9ac
+  data.tar.gz: 7595a48e1a25602247bb684bb4d95727f8a0fdc39c27a02662f9f677335b310f980596522519e294bedabae88e460e81589c34fdf04a85bdaea544c64400f38b

data/Gemfile.lock

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

data/devbox.json

@@ -0,0 +1,18 @@
+{
+  "packages": [
+    "ruby@3.0.2"
+  ],
+  "shell": {
+    "init_hook": [
+      "bundle install"
+    ],
+    "scripts": {
+      "test": [
+        "bundle exec rspec"
+      ], 
+      "lint": [
+        "bundle exec rubocop"
+      ]
+    }
+  }
+}

data/devbox.lock

@@ -0,0 +1,11 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "ruby@3.0.2": {
+      "last_modified": "2021-11-01T15:39:33Z",
+      "plugin_version": "0.0.1",
+      "resolved": "github:NixOS/nixpkgs/7053541084bf5ce2921ef307e5585d39d7ba8b3f#ruby_3_0",
+      "version": "3.0.2"
+    }
+  }
+}

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/events.rb

@@ -44,7 +44,7 @@ module WorkOS
 
         WorkOS::Types::ListStruct.new(
           data: events,
-          list_metadata: parsed_response['listMetadata'],
+          list_metadata: parsed_response['list_metadata'],
         )
       end
     end

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.15.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/spec/support/fixtures/vcr_cassettes/events/list_events_with_after.yml

@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/events/list_events_with_event.yml

@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/events/list_events_with_no_options.yml

@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/events/list_events_with_range.yml

@@ -74,7 +74,7 @@ http_interactions:
       - 72abbbf2b93e8ca5-EWR
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "listMetadata":{"after":null}}'
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
     http_version:
   recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
 recorded_with: VCR 5.0.0

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.15.0
+  version: 2.17.0
 platform: ruby
 authors:
 - WorkOS
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-26 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:
@@ -181,6 +176,8 @@ files:
 - bin/publish
 - bin/tapioca
 - codecov.yml
+- devbox.json
+- devbox.lock
 - docs/WorkOS.html
 - docs/WorkOS/APIError.html
 - docs/WorkOS/AuditLog.html
@@ -421,7 +418,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: API client for WorkOS