workos 0.9.2 → 0.10.0

data/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '0.9.2'
+  VERSION = '0.10.0'
 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',
@@ -76,7 +76,7 @@ describe WorkOS::SSO do
     context 'with neither domain or provider' do
       let(:args) do
         {
-          project_id: 'workos-proj-123',
+          client_id: 'workos-proj-123',
           redirect_uri: 'foo.com/auth/callback',
           state: {
             next_page: '/dashboard/edit',
@@ -97,7 +97,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,6 +113,49 @@ describe WorkOS::SSO do
         )
       end
     end
+
+    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
@@ -123,13 +166,13 @@ describe WorkOS::SSO 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',
@@ -278,7 +321,7 @@ describe WorkOS::SSO do
     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 +355,152 @@ describe WorkOS::SSO do
       end
     end
   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
+          connections = WorkOS::SSO.list_connections
+          expect(connections.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',
+          )
+          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',
+          )
+          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,
+          )
+          expect(connections.size).to eq(1)
+        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(
+            before: 'conn_01EQKPMQAPV02H270HKVNS4CTA',
+          )
+          expect(connections.size).to eq(1)
+        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(
+            after: 'conn_01EQKPMQAPV02H270HKVNS4CTA',
+          )
+          expect(connections.size).to eq(1)
+        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
+          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
+    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
+          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

data/spec/support/fixtures/vcr_cassettes/audit_trail/get_events.yml

@@ -54,8 +54,8 @@ http_interactions:
         encoding: ASCII-8BIT
         string:
           '{"data":[{"object":"event","id":"evt_01EEJM9Q9SMC3W2SZDKA5VJ8XQ","group":"workos.com","location":"::1","latitude":null,"longitude":null,"type":"r","actor_name":"foo@example.com","actor_id":"user_01EEG9P7A1DA9VY9CX7GT47RPF","target_name":"api_key_query","target_id":"key_01EEG9MPHAYX46BBZKGK3BGQXJ","metadata":{"description":"User
-          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.384Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","project_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}},{"object":"event","id":"evt_01EEJM9Q7GMR1VGT6VXN2N2JJQ","group":"workos.com","location":"::1","latitude":null,"longitude":null,"type":"r","actor_name":"foo@example.com","actor_id":"user_01EEG9P7A1DA9VY9CX7GT47RPF","target_name":"api_key_query","target_id":"key_01EEG9MPGM8KFT9VBQHJMV8YZB","metadata":{"description":"User
-          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.360Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","project_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}}],"listMetadata":{"before":"evt_01EEJKZDAR6G4JHFQT4R3KSZDQ","after":null}}'
+          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.384Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","client_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}},{"object":"event","id":"evt_01EEJM9Q7GMR1VGT6VXN2N2JJQ","group":"workos.com","location":"::1","latitude":null,"longitude":null,"type":"r","actor_name":"foo@example.com","actor_id":"user_01EEG9P7A1DA9VY9CX7GT47RPF","target_name":"api_key_query","target_id":"key_01EEG9MPGM8KFT9VBQHJMV8YZB","metadata":{"description":"User
+          viewed API key.","x_request_id":""},"occurred_at":"2020-07-31T14:27:00.360Z","action":{"object":"event_action","id":"evt_action_01EEGQXWAHB065P5JD0QDAAGDC","name":"user.viewed_api_key","client_id":"project_01DZB0E7HQMA6G85PQNHQJMZD0"}}],"listMetadata":{"before":"evt_01EEJKZDAR6G4JHFQT4R3KSZDQ","after":null}}'
       http_version:
     recorded_at: Fri, 31 Jul 2020 14:41:12 GMT
 recorded_with: VCR 5.0.0

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

@@ -56,7 +56,7 @@ http_interactions:
       - 1.1 vegur
     body:
       encoding: ASCII-8BIT
-      string: '{"object":"list","listMetadata":{"before":"directory_edp_01E44H95QPBGZ6A4D89VYZ0WX1","after":null},"data":[{"object":"directory","id":"directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW","external_key":"lA3gS1kCZMCkk82E","state":"linked","type":"gsuite directory","name":"Foo Corp","bearer_token":null,"project_id":"project_01DFYCG8RCB1DB6DKFTGXF4Q9F","domain":"foo-corp.com"}]}'
+      string: '{"object":"list","listMetadata":{"before":"directory_edp_01E44H95QPBGZ6A4D89VYZ0WX1","after":null},"data":[{"object":"directory","id":"directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW","external_key":"lA3gS1kCZMCkk82E","state":"linked","type":"gsuite directory","name":"Foo Corp","bearer_token":null,"client_id":"project_01DFYCG8RCB1DB6DKFTGXF4Q9F","domain":"foo-corp.com"}]}'
     http_version:
   recorded_at: Thu, 30 Apr 2020 03:11:45 GMT
 recorded_with: VCR 5.0.0

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

@@ -57,7 +57,7 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"object":"list","listMetadata":{"before":null,"after":null},"data":[{"object":"directory","id":"directory_edp_01E64QQVQTCB0DECJ9CFNXEWDW","external_key":"lA3gS1kCZMCkk82E","state":"linked","type":"gsuite
-        directory","name":"Foo Corp","bearer_token":null,"project_id":"project_01DFYCG8RCB1DB6DKFTGXF4Q9F","domain":"foo-corp.com"}]}'
+        directory","name":"Foo Corp","bearer_token":null,"client_id":"project_01DFYCG8RCB1DB6DKFTGXF4Q9F","domain":"foo-corp.com"}]}'
     http_version:
   recorded_at: Thu, 30 Apr 2020 03:42:20 GMT
 recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/sso/delete_connection_with_invalid_id.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api.workos.com/connections/invalid
+    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-darwin19; v0.10.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    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:
+      - 
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '23'
+      Etag:
+      - W/"17-SuRA/yvUWUo8rK6x7dKURLeBo+0"
+      Date:
+      - Thu, 04 Feb 2021 17:20:08 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not Found"}'
+    http_version:
+  recorded_at: Thu, 04 Feb 2021 17:20:08 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/sso/delete_connection_with_valid_id.yml

@@ -0,0 +1,70 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://api.workos.com/connections/conn_01EX55FRVN1V2PCA9YWTMZQMMQ
+    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-darwin19; v0.10.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - Cowboy
+      Content-Length:
+      - '0'
+      Connection:
+      - keep-alive
+      Vary:
+      - Origin
+      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:
+      -
+      Etag:
+      - W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"
+      Date:
+      - Thu, 04 Feb 2021 17:20:08 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Thu, 04 Feb 2021 17:20:08 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/sso/get_connection_with_invalid_id.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/connections/invalid
+    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-darwin19; v0.10.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    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:
+      - 
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '23'
+      Etag:
+      - W/"17-SuRA/yvUWUo8rK6x7dKURLeBo+0"
+      Date:
+      - Fri, 29 Jan 2021 15:36:23 GMT
+      Via:
+      - 1.1 vegur
+    body:
+      encoding: UTF-8
+      string: '{"message":"Not Found"}'
+    http_version:
+  recorded_at: Fri, 29 Jan 2021 15:36:23 GMT
+recorded_with: VCR 5.0.0