workos 0.10.0 → 0.11.1

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

@@ -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
@@ -293,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
@@ -312,14 +336,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,89 +373,160 @@ describe WorkOS::SSO do
   end
 
   describe '.list_connections' do
-    before(:all) do
-      WorkOS.key = 'key'
-    end
+    context 'with no options' do
+      it 'returns connections and metadata' do
+        expected_metadata = {
+          'after' => nil,
+          'before' => 'before_id',
+        }
 
-    after(:all) do
-      WorkOS.key = nil
-    end
+        VCR.use_cassette 'sso/list_connections/with_no_options' do
+          connections = described_class.list_connections
 
-    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(3)
+          expect(connections.list_metadata).to eq(expected_metadata)
         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(
+      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.first['connection_type']).to eq('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 'returns connections' do
-        VCR.use_cassette('sso/list_connections_with_domain_param') do
-          connections = WorkOS::SSO.list_connections(
+      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',
           )
-          domains = connections.first['domains']
-          expect(domains.first['domain']).to eq('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 '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 +557,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

data/spec/support/fixtures/vcr_cassettes/directory_sync/delete_directory.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api.workos.com/directories/directory_01F2T098SKN5PCTVSJ7CWP70N5
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/2.7.1; x86_64-darwin20; v0.10.3
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Server:
+      - Cowboy
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin, Accept-Encoding
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      X-Dns-Prefetch-Control:
+      - 'off'
+      Expect-Ct:
+      - max-age=0
+      X-Frame-Options:
+      - SAMEORIGIN
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      X-Download-Options:
+      - noopen
+      X-Content-Type-Options:
+      - nosniff
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      Referrer-Policy:
+      - no-referrer
+      X-Xss-Protection:
+      - '0'
+      X-Request-Id:
+      - 834c3434-80dd-4e5e-bda7-95cd1412ad29
+      Content-Type:
+      - text/plain; charset=utf-8
+      Content-Length:
+      - '8'
+      Etag:
+      - W/"8-YaBXLEiT7zQxEyDYTILfiL6oPhE"
+      Date:
+      - Wed, 21 Apr 2021 22:26:51 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: Accepted
+    http_version:
+  recorded_at: Wed, 21 Apr 2021 22:26:51 GMT
+recorded_with: VCR 5.0.0