workos 0.10.0 → 1.1.0

data/spec/lib/workos/portal_spec.rb

@@ -2,56 +2,30 @@
 # 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
-        VCR.use_cassette 'organization/create' do
-          organization = described_class.create_organization(
-            domains: ['example.com'],
-            name: 'Test Organization',
-          )
+  describe '.generate_link' do
+    let(:organization) { 'org_01EHQMYV6MBK39QC5PZXHY59C3' }
 
-          expect(organization.id).to eq('org_01EHT88Z8J8795GZNQ4ZP1J81T')
-          expect(organization.name).to eq('Test Organization')
-          expect(organization.domains.first[:domain]).to eq('example.com')
-        end
-      end
-    end
+    describe 'with a valid organization' do
+      context 'with the sso intent' do
+        it 'returns an Admin Portal link' do
+          VCR.use_cassette 'portal/generate_link_sso' do
+            portal_link = described_class.generate_link(
+              intent: 'sso',
+              organization: organization,
+            )
 
-    context 'with an invalid payload' do
-      it 'returns an error' do
-        VCR.use_cassette 'organization/create_invalid' do
-          expect do
-            described_class.create_organization(
-              domains: ['example.com'],
-              name: 'Test Organization 2',
+            expect(portal_link).to eq(
+              'https://id.workos.com/portal/launch?secret=secret',
             )
-          end.to raise_error(
-            WorkOS::APIError,
-            /An Organization with the domain example.com already exists/,
-          )
+          end
         end
       end
-    end
-  end
 
-  describe '.generate_link' do
-    let(:organization) { 'org_01EHQMYV6MBK39QC5PZXHY59C3' }
-
-    describe 'with a valid organization' do
-      describe 'with the minimal params' do
+      describe 'with the dsync intent' do
         it 'returns an Admin Portal link' do
-          VCR.use_cassette 'portal/generate_link' do
+          VCR.use_cassette 'portal/generate_link_dsync' do
             portal_link = described_class.generate_link(
-              intent: 'sso',
+              intent: 'dsync',
               organization: organization,
             )
 
@@ -88,89 +62,9 @@ describe WorkOS::Portal do
           )
         end.to raise_error(
           ArgumentError,
-          'bogus-intent is not a valid value. `intent` must be in ["sso"]',
+          /bogus-intent is not a valid value/,
         )
       end
     end
   end
-
-  describe '.list_organizations' do
-    context 'with no options' do
-      it 'returns organizations and metadata' do
-        expected_metadata = {
-          'after' => nil,
-          'before' => 'before-id',
-        }
-
-        VCR.use_cassette 'organization/list' do
-          organizations = described_class.list_organizations
-
-          expect(organizations.data.size).to eq(7)
-          expect(organizations.list_metadata).to eq(expected_metadata)
-        end
-      end
-    end
-
-    context 'with the before option' do
-      it 'forms the proper request to the API' do
-        request_args = [
-          '/organizations?before=before-id',
-          'Content-Type' => 'application/json'
-        ]
-
-        expected_request = Net::HTTP::Get.new(*request_args)
-
-        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
-          and_return(expected_request)
-
-        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
-          organizations = described_class.list_organizations(
-            before: 'before-id',
-          )
-
-          expect(organizations.data.size).to eq(7)
-        end
-      end
-    end
-
-    context 'with the after option' do
-      it 'forms the proper request to the API' do
-        request_args = [
-          '/organizations?after=after-id',
-          'Content-Type' => 'application/json'
-        ]
-
-        expected_request = Net::HTTP::Get.new(*request_args)
-
-        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
-          and_return(expected_request)
-
-        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
-          organizations = described_class.list_organizations(after: 'after-id')
-
-          expect(organizations.data.size).to eq(7)
-        end
-      end
-    end
-
-    context 'with the limit option' do
-      it 'forms the proper request to the API' do
-        request_args = [
-          '/organizations?limit=10',
-          'Content-Type' => 'application/json'
-        ]
-
-        expected_request = Net::HTTP::Get.new(*request_args)
-
-        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
-          and_return(expected_request)
-
-        VCR.use_cassette 'organization/list', match_requests_on: [:path] do
-          organizations = described_class.list_organizations(limit: 10)
-
-          expect(organizations.data.size).to eq(7)
-        end
-      end
-    end
-  end
 end

data/spec/lib/workos/sso_spec.rb

@@ -73,9 +73,10 @@ 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: {
@@ -83,20 +84,32 @@ describe WorkOS::SSO do
           }.to_s,
         }
       end
-      it 'raises an error' do
-        expect do
-          described_class.authorization_url(**args)
-        end.to raise_error(
-          ArgumentError,
-          'Either domain or provider is required.',
+      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 an invalid provider' do
+    context 'with neither connection, domain, or provider' do
       let(:args) do
         {
-          provider: 'Okta',
           client_id: 'workos-proj-123',
           redirect_uri: 'foo.com/auth/callback',
           state: {
@@ -109,60 +122,65 @@ 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"]',
+          'Either connection, domain, or provider is required.',
         )
       end
     end
 
-    context 'passing the project_id' do
+    context 'with an invalid provider' do
       let(:args) do
         {
-          domain: 'foo.com',
-          project_id: 'workos-proj-123',
+          provider: 'Okta',
+          client_id: 'workos-proj-123',
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
           }.to_s,
         }
       end
-      it 'raises a deprecation warning' do
+      it 'raises an error' do
         expect do
           described_class.authorization_url(**args)
-        end.to output(
-          "[DEPRECATION] `project_id` is deprecated.
-          Please use `client_id` instead.\n",
-        ).to_stderr
-      end
-
-      it 'returns a valid URL' do
-        authorization_url = described_class.authorization_url(**args)
-
-        expect(URI.parse(authorization_url)).to be_a URI
+        end.to raise_error(
+          ArgumentError,
+          'Okta is not a valid value. `provider` must be in ["GoogleOAuth"]',
+        )
       end
+    end
+  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
+  describe '.get_profile' do
+    it 'returns a profile' do
+      VCR.use_cassette 'sso/profile' do
+        profile = described_class.get_profile(access_token: 'access_token')
 
-      it 'returns the expected query string' do
-        authorization_url = described_class.authorization_url(**args)
+        expectation = {
+          connection_id: 'conn_01E83FVYZHY7DM4S9503JHV0R5',
+          connection_type: 'GoogleOAuth',
+          email: 'bob.loblaw@workos.com',
+          first_name: 'Bob',
+          id: 'prof_01EEJTY9SZ1R350RB7B73SNBKF',
+          idp_id: '116485463307139932699',
+          last_name: 'Loblaw',
+          raw_attributes: {
+            email: 'bob.loblaw@workos.com',
+            family_name: 'Loblaw',
+            given_name: 'Bob',
+            hd: 'workos.com',
+            id: '116485463307139932699',
+            locale: 'en',
+            name: 'Bob Loblaw',
+            picture: 'https://lh3.googleusercontent.com/a-/AOh14GyO2hLlgZvteDQ3Ldi3_-RteZLya0hWH7247Cam=s96-c',
+            verified_email: true,
+          },
+        }
 
-        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&domain=foo.com',
-        )
+        expect(profile.to_json).to eq(expectation)
       end
     end
   end
 
-  describe '.profile' do
-    before do
-      WorkOS.key = 'api-key'
-    end
-
+  describe '.profile_and_token' do
     let(:args) do
       {
         code: SecureRandom.hex(10),
@@ -195,15 +213,15 @@ describe WorkOS::SSO do
       end
 
       it 'includes the SDK Version header' do
-        described_class.profile(**args)
+        described_class.profile_and_token(**args)
 
         expect(a_request(:post, 'https://api.workos.com/sso/token').
           with(headers: headers, body: request_body)).to have_been_made
       end
 
-      it 'returns a WorkOS::Profile' do
-        profile = described_class.profile(**args)
-        expect(profile).to be_a(WorkOS::Profile)
+      it 'returns a WorkOS::ProfileAndToken' do
+        profile_and_token = described_class.profile_and_token(**args)
+        expect(profile_and_token).to be_a(WorkOS::ProfileAndToken)
 
         expectation = {
           connection_id: 'conn_01EMH8WAK20T42N2NBMNBCYHAG',
@@ -222,7 +240,8 @@ describe WorkOS::SSO do
           },
         }
 
-        expect(profile.to_json).to eq(expectation)
+        expect(profile_and_token.access_token).to eq('01DVX6QBS3EG6FHY2ESAA5Q65X')
+        expect(profile_and_token.profile.to_json).to eq(expectation)
       end
     end
 
@@ -239,7 +258,7 @@ describe WorkOS::SSO do
 
       it 'raises an exception with request ID' do
         expect do
-          described_class.profile(**args)
+          described_class.profile_and_token(**args)
         end.to raise_error(
           WorkOS::APIError,
           'some error message - request ID: request-id',
@@ -263,7 +282,7 @@ describe WorkOS::SSO do
 
       it 'raises an exception' do
         expect do
-          described_class.profile(**args)
+          described_class.profile_and_token(**args)
         end.to raise_error(
           WorkOS::APIError,
           "The code '01DVX3C5Z367SFHR8QNDMK7V24'" \
@@ -273,173 +292,161 @@ describe WorkOS::SSO do
     end
   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
-          connection = WorkOS::SSO.create_connection(
-            source: 'draft_conn_01E6PK87QP6NQ29RRX0G100YGV',
-          )
+  describe '.list_connections' do
+    context 'with no options' do
+      it 'returns connections and metadata' do
+        expected_metadata = {
+          'after' => nil,
+          'before' => 'before_id',
+        }
 
-          expect(connection.id).to eq('conn_01E4F9T2YWZFD218DN04KVFDSY')
-          expect(connection.connection_type).to eq('GoogleOAuth')
-          expect(connection.name).to eq('Foo Corp')
-          expect(connection.domains.first[:domain]).to eq('example.com')
-        end
-      end
-    end
+        VCR.use_cassette 'sso/list_connections/with_no_options' do
+          connections = described_class.list_connections
 
-    context 'with an invalid source' do
-      it 'raises an error' do
-        VCR.use_cassette('sso/create_connection_with_invalid_source') do
-          expect do
-            WorkOS::SSO.create_connection(source: 'invalid')
-          end.to raise_error(
-            WorkOS::APIError,
-            'Status 404, Not Found - request ID: ',
-          )
+          expect(connections.data.size).to eq(3)
+          expect(connections.list_metadata).to eq(expected_metadata)
         end
       end
     end
-  end
 
-  describe '.promote_draft_connection' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
+    context 'with connection_type option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/connections?connection_type=OktaSAML',
+          'Content-Type' => 'application/json'
+        ]
 
-    after(:all) do
-      WorkOS.key = nil
-    end
+        expected_request = Net::HTTP::Get.new(*request_args)
 
-    let(:token) { 'draft_conn_id' }
-    let(:client_id) { 'proj_0239u590h' }
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
 
-    context 'with a valid request' do
-      before do
-        stub_request(
-          :post,
-          "https://api.workos.com/draft_connections/#{token}/activate",
-        ).to_return(status: 200)
-      end
-      it 'returns true' do
-        response = described_class.promote_draft_connection(
-          token: token,
-        )
+        VCR.use_cassette 'sso/list_connections/with_connection_type' do
+          connections = described_class.list_connections(
+            connection_type: 'OktaSAML',
+          )
 
-        expect(response).to be(true)
+          expect(connections.data.size).to eq(3)
+          expect(connections.data.first.connection_type).to eq('OktaSAML')
+        end
       end
     end
 
-    context 'with an invalid request' do
-      before do
-        stub_request(
-          :post,
-          "https://api.workos.com/draft_connections/#{token}/activate",
-        ).to_return(status: 403)
-      end
-      it 'returns true' do
-        response = described_class.promote_draft_connection(
-          token: token,
-        )
+    context 'with domain option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/connections?domain=foo-corp.com',
+          'Content-Type' => 'application/json'
+        ]
 
-        expect(response).to be(false)
-      end
-    end
-  end
+        expected_request = Net::HTTP::Get.new(*request_args)
 
-  describe '.list_connections' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
 
-    after(:all) do
-      WorkOS.key = nil
-    end
+        VCR.use_cassette 'sso/list_connections/with_domain' do
+          connections = described_class.list_connections(
+            domain: 'foo-corp.com',
+          )
 
-    context 'with no options' do
-      it 'returns connections' do
-        VCR.use_cassette('sso/list_connections') do
-          connections = WorkOS::SSO.list_connections
-          expect(connections.size).to eq(1)
+          expect(connections.data.size).to eq(1)
         end
       end
     end
 
-    context 'with connection_type option' do
-      it 'returns connections' do
-        VCR.use_cassette('sso/list_connections_with_connection_type_param') do
-          connections = WorkOS::SSO.list_connections(
-            connection_type: 'OktaSAML',
+    context 'with organization_id option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/connections?organization_id=org_01EGS4P7QR31EZ4YWD1Z1XA176',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'sso/list_connections/with_organization_id' do
+          connections = described_class.list_connections(
+            organization_id: 'org_01EGS4P7QR31EZ4YWD1Z1XA176',
           )
-          expect(connections.first['connection_type']).to eq('OktaSAML')
-        end
-      end
-    end
 
-    context 'with domain option' do
-      it 'returns connections' do
-        VCR.use_cassette('sso/list_connections_with_domain_param') do
-          connections = WorkOS::SSO.list_connections(
-            domain: 'foo-corp.com',
+          expect(connections.data.size).to eq(1)
+          expect(connections.data.first.organization_id).to eq(
+            'org_01EGS4P7QR31EZ4YWD1Z1XA176',
           )
-          domains = connections.first['domains']
-          expect(domains.first['domain']).to eq('foo-corp.com')
         end
       end
     end
 
     context 'with limit option' do
-      it 'returns connections' do
-        VCR.use_cassette('sso/list_connections_with_limit_param') do
-          connections = WorkOS::SSO.list_connections(
-            limit: 1,
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/connections?limit=2',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'sso/list_connections/with_limit' do
+          connections = described_class.list_connections(
+            limit: 2,
           )
-          expect(connections.size).to eq(1)
+
+          expect(connections.data.size).to eq(2)
         end
       end
     end
 
     context 'with before option' do
-      it 'returns connections' do
-        VCR.use_cassette('sso/list_connections_with_before_param') do
-          connections = WorkOS::SSO.list_connections(
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/connections?before=conn_01EQKPMQAPV02H270HKVNS4CTA',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'sso/list_connections/with_before' do
+          connections = described_class.list_connections(
             before: 'conn_01EQKPMQAPV02H270HKVNS4CTA',
           )
-          expect(connections.size).to eq(1)
+
+          expect(connections.data.size).to eq(3)
         end
       end
     end
 
     context 'with after option' do
-      it 'returns connections' do
-        VCR.use_cassette('sso/list_connections_with_after_param') do
-          connections = WorkOS::SSO.list_connections(
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/connections?after=conn_01EQKPMQAPV02H270HKVNS4CTA',
+          'Content-Type' => 'application/json'
+        ]
+
+        expected_request = Net::HTTP::Get.new(*request_args)
+
+        expect(Net::HTTP::Get).to receive(:new).with(*request_args).
+          and_return(expected_request)
+
+        VCR.use_cassette 'sso/list_connections/with_after' do
+          connections = described_class.list_connections(
             after: 'conn_01EQKPMQAPV02H270HKVNS4CTA',
           )
-          expect(connections.size).to eq(1)
+
+          expect(connections.data.size).to eq(3)
         end
       end
     end
   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
@@ -470,14 +477,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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: true
+# typed: false
 
 require 'simplecov'
 SimpleCov.start
@@ -48,5 +48,6 @@ RSpec.configure do |config|
     end
   end)
 
+  config.before(:all) { WorkOS.key ||= '' }
   config.before(:each) { VCR.turn_on! }
 end