workos 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84def52db9a12c4c5563af30a992f43e68441e7139624b787c588f39827d4843
-  data.tar.gz: 1d378bfefbdeae33688496031448bac6eea97a96e1179e91496c8f8ba69c87ca
+  metadata.gz: 10533ea551520a47120ae8d73f4ff1399fd095eb893bd998ba200019262fc67a
+  data.tar.gz: 1b3bdac8336b2ee2c24a09334aecd399a897e983c6693d73dbed5f196ec3eb18
 SHA512:
-  metadata.gz: 37117a2ea0851f35e83bbe4f17cf04dfb4ab2c7769e7f797ddd3e3d910849e0ae58e07647a72c7a21b4cf7f31f60a17fe60f78da149a422c9c211db284bc19f2
-  data.tar.gz: 5747ba824f3aceda49c56ae5154264d153f59befd01f89465df6bb6f1e29b14edd04c9cc2f66f73442e4e31fa2766bed76ce705c4c1b4609c4b6da1bbc8f701b
+  metadata.gz: 0e36af027698d1887819dd51f93921eed30b47af78deabc99e34864374d5f6ff3569920cf1fdd15c26b488bdb9d7d22105e5ee89dfd40b8f0f2146e789c4b884
+  data.tar.gz: fb776485526b8ace124319050a709fe044fd2a2cdbdaeb261b8b92fcfb7cafdc0f31b3f913d96839671d9fee9ed5151370868b4ccd02827523fb44d478f5b4d4

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockLength:
 Metrics/MethodLength:
   Max: 15
 Metrics/ModuleLength:
-  Max: 150
+  Max: 200
 Metrics/ParameterLists:
   Max: 6
 Style/TrailingCommaInArguments:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.10.2)
+    workos (0.10.3)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -54,7 +54,7 @@ GEM
     simplecov-html (0.12.2)
     sorbet (0.5.5560)
       sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.6317)
+    sorbet-runtime (0.5.6366)
     sorbet-static (0.5.5560-universal-darwin-14)
     unicode-display_width (1.6.0)
     vcr (5.0.0)

data/lib/workos/sso.rb

@@ -26,6 +26,8 @@ module WorkOS
       #  required
       # @param [String] provider A provider name for an Identity Provider
       #  configured on your WorkOS dashboard. Only 'Google' is supported.
+      # @param [String] connection The ID for a Connection configured on
+      #  WorkOS.
       # @param [String] client_id The WorkOS client ID for the environment
       #  where you've configured your SSO connection.
       # @param [String] project_id The WorkOS project ID for the project.
@@ -58,15 +60,18 @@ module WorkOS
           client_id: T.nilable(String),
           domain: T.nilable(String),
           provider: T.nilable(String),
+          connection: T.nilable(String),
           state: T.nilable(String),
         ).returns(String)
       end
+      # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
       def authorization_url(
         redirect_uri:,
         project_id: nil,
         client_id: nil,
         domain: nil,
         provider: nil,
+        connection: nil,
         state: ''
       )
         if project_id
@@ -75,7 +80,11 @@ module WorkOS
           client_id = project_id
         end
 
-        validate_domain_and_provider(provider: provider, domain: domain)
+        validate_authorization_url_arguments(
+          provider: provider,
+          domain: domain,
+          connection: connection,
+        )
 
         query = URI.encode_www_form({
           client_id: client_id,
@@ -84,10 +93,12 @@ module WorkOS
           state: state,
           domain: domain,
           provider: provider,
+          connection: connection,
         }.compact)
 
         "https://#{WorkOS::API_HOSTNAME}/sso/authorize?#{query}"
       end
+      # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
 
       # Fetch the profile details for the authenticated SSO user.
       #
@@ -284,11 +295,17 @@ module WorkOS
         params(
           domain: T.nilable(String),
           provider: T.nilable(String),
+          connection: T.nilable(String),
         ).void
       end
-      def validate_domain_and_provider(domain:, provider:)
-        if [domain, provider].all?(&:nil?)
-          raise ArgumentError, 'Either domain or provider is required.'
+      def validate_authorization_url_arguments(
+        domain:,
+        provider:,
+        connection:
+      )
+        if [domain, provider, connection].all?(&:nil?)
+          raise ArgumentError, 'Either connection, domain, or ' \
+            'provider is required.'
         end
 
         return unless provider && !PROVIDERS.include?(provider)

data/lib/workos/version.rb

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

data/spec/lib/workos/audit_trail_spec.rb

@@ -2,14 +2,6 @@
 # typed: false
 
 describe WorkOS::AuditTrail do
-  before(:all) do
-    WorkOS.key = 'key'
-  end
-
-  after(:all) do
-    WorkOS.key = nil
-  end
-
   describe '.create_event' do
     context 'with valid event payload' do
       let(:valid_event) do

data/spec/lib/workos/directory_sync_spec.rb

@@ -2,14 +2,6 @@
 # typed: false
 
 describe WorkOS::DirectorySync do
-  before(:all) do
-    WorkOS.key = 'key'
-  end
-
-  after(:all) do
-    WorkOS.key = nil
-  end
-
   describe '.list_directories' do
     context 'with no options' do
       it 'returns directories' do

data/spec/lib/workos/passwordless_spec.rb

@@ -2,14 +2,6 @@
 # typed: false
 
 describe WorkOS::Passwordless do
-  before(:all) do
-    WorkOS.key = 'key'
-  end
-
-  after(:all) do
-    WorkOS.key = nil
-  end
-
   describe '.create_session' do
     context 'with valid options payload' do
       let(:valid_options) do

data/spec/lib/workos/portal_spec.rb

@@ -2,14 +2,6 @@
 # typed: false
 
 describe WorkOS::Portal do
-  before :all do
-    WorkOS.key = 'test'
-  end
-
-  after :all do
-    WorkOS.key = nil
-  end
-
   describe '.create_organization' do
     context 'with valid payload' do
       it 'creates an organization' do

data/spec/lib/workos/sso_spec.rb

@@ -73,7 +73,41 @@ describe WorkOS::SSO do
       end
     end
 
-    context 'with neither domain or provider' do
+    context 'with a connection' do
+      let(:args) do
+        {
+          connection: 'connection_123',
+          client_id: 'workos-proj-123',
+          redirect_uri: 'foo.com/auth/callback',
+          state: {
+            next_page: '/dashboard/edit',
+          }.to_s,
+        }
+      end
+      it 'returns a valid URL' do
+        authorization_url = described_class.authorization_url(**args)
+
+        expect(URI.parse(authorization_url)).to be_a URI
+      end
+
+      it 'returns the expected hostname' do
+        authorization_url = described_class.authorization_url(**args)
+
+        expect(URI.parse(authorization_url).host).to eq(WorkOS::API_HOSTNAME)
+      end
+
+      it 'returns the expected query string' do
+        authorization_url = described_class.authorization_url(**args)
+
+        expect(URI.parse(authorization_url).query).to eq(
+          'client_id=workos-proj-123&redirect_uri=foo.com%2Fauth%2Fcallback' \
+          '&response_type=code&state=%7B%3Anext_page%3D%3E%22%2Fdashboard%2F' \
+          'edit%22%7D&connection=connection_123',
+        )
+      end
+    end
+
+    context 'with neither connection, domain, or provider' do
       let(:args) do
         {
           client_id: 'workos-proj-123',
@@ -88,7 +122,7 @@ describe WorkOS::SSO do
           described_class.authorization_url(**args)
         end.to raise_error(
           ArgumentError,
-          'Either domain or provider is required.',
+          'Either connection, domain, or provider is required.',
         )
       end
     end
@@ -159,10 +193,6 @@ describe WorkOS::SSO do
   end
 
   describe '.profile' do
-    before do
-      WorkOS.key = 'api-key'
-    end
-
     let(:args) do
       {
         code: SecureRandom.hex(10),
@@ -274,14 +304,6 @@ describe WorkOS::SSO do
   end
 
   describe '.create_connection' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
-
-    after(:all) do
-      WorkOS.key = nil
-    end
-
     context 'with a valid source' do
       it 'creates a connection' do
         VCR.use_cassette('sso/create_connection_with_valid_source') do
@@ -312,14 +334,6 @@ describe WorkOS::SSO do
   end
 
   describe '.promote_draft_connection' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
-
-    after(:all) do
-      WorkOS.key = nil
-    end
-
     let(:token) { 'draft_conn_id' }
     let(:client_id) { 'proj_0239u590h' }
 
@@ -357,14 +371,6 @@ describe WorkOS::SSO do
   end
 
   describe '.list_connections' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
-
-    after(:all) do
-      WorkOS.key = nil
-    end
-
     context 'with no options' do
       it 'returns connections' do
         VCR.use_cassette('sso/list_connections') do
@@ -446,14 +452,6 @@ describe WorkOS::SSO do
   end
 
   describe '.get_connection' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
-
-    after(:all) do
-      WorkOS.key = nil
-    end
-
     context 'with a valid id' do
       it 'gets the connection details' do
         VCR.use_cassette('sso/get_connection_with_valid_id') do
@@ -484,14 +482,6 @@ describe WorkOS::SSO do
   end
 
   describe '.delete_connection' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
-
-    after(:all) do
-      WorkOS.key = nil
-    end
-
     context 'with a valid id' do
       it 'returns true' do
         VCR.use_cassette('sso/delete_connection_with_valid_id') do

data/spec/spec_helper.rb

@@ -48,5 +48,6 @@ RSpec.configure do |config|
     end
   end)
 
+  config.before(:all) { WorkOS.key ||= '' }
   config.before(:each) { VCR.turn_on! }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-03 00:00:00.000000000 Z
+date: 2021-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -305,7 +305,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.13
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: API client for WorkOS