workos 0.9.2 → 0.11.0

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
@@ -47,9 +39,9 @@ describe WorkOS::Portal do
     let(:organization) { 'org_01EHQMYV6MBK39QC5PZXHY59C3' }
 
     describe 'with a valid organization' do
-      describe 'with the minimal params' do
+      context 'with the sso intent' do
         it 'returns an Admin Portal link' do
-          VCR.use_cassette 'portal/generate_link' do
+          VCR.use_cassette 'portal/generate_link_sso' do
             portal_link = described_class.generate_link(
               intent: 'sso',
               organization: organization,
@@ -61,6 +53,21 @@ describe WorkOS::Portal do
           end
         end
       end
+
+      describe 'with the dsync intent' do
+        it 'returns an Admin Portal link' do
+          VCR.use_cassette 'portal/generate_link_dsync' do
+            portal_link = described_class.generate_link(
+              intent: 'dsync',
+              organization: organization,
+            )
+
+            expect(portal_link).to eq(
+              'https://id.workos.com/portal/launch?secret=secret',
+            )
+          end
+        end
+      end
     end
 
     describe 'with an invalid organization' do
@@ -88,7 +95,7 @@ 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

data/spec/lib/workos/sso_spec.rb

@@ -9,7 +9,7 @@ describe WorkOS::SSO do
       let(:args) do
         {
           domain: 'foo.com',
-          project_id: 'workos-proj-123',
+          client_id: 'workos-proj-123',
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
@@ -43,7 +43,7 @@ describe WorkOS::SSO do
       let(:args) do
         {
           provider: 'GoogleOAuth',
-          project_id: 'workos-proj-123',
+          client_id: 'workos-proj-123',
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
@@ -73,10 +73,44 @@ describe WorkOS::SSO do
       end
     end
 
-    context 'with neither domain or provider' do
+    context 'with a connection' do
       let(:args) do
         {
-          project_id: 'workos-proj-123',
+          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',
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
@@ -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
@@ -97,7 +131,7 @@ describe WorkOS::SSO do
       let(:args) do
         {
           provider: 'Okta',
-          project_id: 'workos-proj-123',
+          client_id: 'workos-proj-123',
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
@@ -113,23 +147,62 @@ describe WorkOS::SSO do
         )
       end
     end
-  end
 
-  describe '.profile' do
-    before do
-      WorkOS.key = 'api-key'
+    context 'passing the project_id' do
+      let(:args) do
+        {
+          domain: 'foo.com',
+          project_id: 'workos-proj-123',
+          redirect_uri: 'foo.com/auth/callback',
+          state: {
+            next_page: '/dashboard/edit',
+          }.to_s,
+        }
+      end
+      it 'raises a deprecation warning' 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
+
+      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&domain=foo.com',
+        )
+      end
     end
+  end
 
+  describe '.profile' do
     let(:args) do
       {
         code: SecureRandom.hex(10),
-        project_id: 'workos-proj-123',
+        client_id: 'workos-proj-123',
       }
     end
 
     let(:request_body) do
       {
-        client_id: args[:project_id],
+        client_id: args[:client_id],
         client_secret: WorkOS.key,
         code: args[:code],
         grant_type: 'authorization_code',
@@ -231,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
@@ -250,6 +315,8 @@ describe WorkOS::SSO do
           expect(connection.connection_type).to eq('GoogleOAuth')
           expect(connection.name).to eq('Foo Corp')
           expect(connection.domains.first[:domain]).to eq('example.com')
+          expect(connection.organization_id).to eq('12345')
+          expect(connection.status).to eq('linked')
         end
       end
     end
@@ -269,16 +336,8 @@ 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(:project_id) { 'proj_0239u590h' }
+    let(:client_id) { 'proj_0239u590h' }
 
     context 'with a valid request' do
       before do
@@ -312,4 +371,215 @@ describe WorkOS::SSO do
       end
     end
   end
+
+  describe '.list_connections' do
+    context 'with no options' do
+      it 'returns connections and metadata' do
+        expected_metadata = {
+          'after' => nil,
+          'before' => 'before_id',
+        }
+
+        VCR.use_cassette 'sso/list_connections/with_no_options' do
+          connections = described_class.list_connections
+
+          expect(connections.data.size).to eq(3)
+          expect(connections.list_metadata).to eq(expected_metadata)
+        end
+      end
+    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'
+        ]
+
+        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_connection_type' do
+          connections = described_class.list_connections(
+            connection_type: 'OktaSAML',
+          )
+
+          expect(connections.data.size).to eq(3)
+          expect(connections.data.first.connection_type).to eq('OktaSAML')
+        end
+      end
+    end
+
+    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'
+        ]
+
+        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_domain' do
+          connections = described_class.list_connections(
+            domain: 'foo-corp.com',
+          )
+
+          expect(connections.data.size).to eq(1)
+        end
+      end
+    end
+
+    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.data.size).to eq(1)
+          expect(connections.data.first.organization_id).to eq(
+            'org_01EGS4P7QR31EZ4YWD1Z1XA176',
+          )
+        end
+      end
+    end
+
+    context 'with limit option' do
+      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.data.size).to eq(2)
+        end
+      end
+    end
+
+    context 'with before option' do
+      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.data.size).to eq(3)
+        end
+      end
+    end
+
+    context 'with after option' do
+      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.data.size).to eq(3)
+        end
+      end
+    end
+  end
+
+  describe '.get_connection' do
+    context 'with a valid id' do
+      it 'gets the connection details' do
+        VCR.use_cassette('sso/get_connection_with_valid_id') do
+          connection = WorkOS::SSO.get_connection(
+            id: 'conn_01EX00NB050H354WKGC7990AR2',
+          )
+
+          expect(connection.id).to eq('conn_01EX00NB050H354WKGC7990AR2')
+          expect(connection.connection_type).to eq('OktaSAML')
+          expect(connection.name).to eq('Foo Corp')
+          expect(connection.domains.first[:domain]).to eq('foo-corp.com')
+        end
+      end
+    end
+
+    context 'with an invalid id' do
+      it 'raises an error' do
+        VCR.use_cassette('sso/get_connection_with_invalid_id') do
+          expect do
+            WorkOS::SSO.get_connection(id: 'invalid')
+          end.to raise_error(
+            WorkOS::APIError,
+            'Status 404, Not Found - request ID: ',
+          )
+        end
+      end
+    end
+  end
+
+  describe '.delete_connection' do
+    context 'with a valid id' do
+      it 'returns true' do
+        VCR.use_cassette('sso/delete_connection_with_valid_id') do
+          response = WorkOS::SSO.delete_connection(
+            id: 'conn_01EX55FRVN1V2PCA9YWTMZQMMQ',
+          )
+
+          expect(response).to be(true)
+        end
+      end
+    end
+
+    context 'with an invalid id' do
+      it 'returns false' do
+        VCR.use_cassette('sso/delete_connection_with_invalid_id') do
+          expect do
+            WorkOS::SSO.delete_connection(id: 'invalid')
+          end.to raise_error(
+            WorkOS::APIError,
+            'Status 404, Not Found - request ID: ',
+          )
+        end
+      end
+    end
+  end
 end