workos 0.11.2 → 1.3.0

data/spec/lib/workos/portal_spec.rb

@@ -2,39 +2,6 @@
 # typed: false
 
 describe WorkOS::Portal do
-  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',
-          )
-
-          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
-
-    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',
-            )
-          end.to raise_error(
-            WorkOS::APIError,
-            /An Organization with the domain example.com already exists/,
-          )
-        end
-      end
-    end
-  end
-
   describe '.generate_link' do
     let(:organization) { 'org_01EHQMYV6MBK39QC5PZXHY59C3' }
 
@@ -100,131 +67,4 @@ describe WorkOS::Portal do
       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
-
-  describe '.get_organization' do
-    context 'with a valid id' do
-      it 'gets the organization details' do
-        VCR.use_cassette('organization/get') do
-          organization = described_class.get_organization(
-            id: 'org_01EZDF20TZEJXKPSX2BJRN6TV6',
-          )
-
-          expect(organization.id).to eq('org_01EZDF20TZEJXKPSX2BJRN6TV6')
-          expect(organization.name).to eq('Foo Corp')
-          expect(organization.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('organization/get_invalid') do
-          expect do
-            described_class.get_organization(id: 'invalid')
-          end.to raise_error(
-            WorkOS::APIError,
-            'Status 404, Not Found - request ID: ',
-          )
-        end
-      end
-    end
-  end
-
-  describe '.update_organization' do
-    context 'with valid payload' do
-      it 'creates an organization' do
-        VCR.use_cassette 'organization/update' do
-          organization = described_class.update_organization(
-            organization: 'org_01F29YJ068E52HGEB8ZQGC9MJG',
-            domains: ['example.me'],
-            name: 'Test Organization',
-          )
-
-          expect(organization.id).to eq('org_01F29YJ068E52HGEB8ZQGC9MJG')
-          expect(organization.name).to eq('Test Organization')
-          expect(organization.domains.first[:domain]).to eq('example.me')
-        end
-      end
-    end
-  end
 end

data/spec/lib/workos/sso_spec.rb

@@ -147,52 +147,40 @@ describe WorkOS::SSO do
         )
       end
     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)
+  describe '.get_profile' do
+    it 'returns a profile' do
+      VCR.use_cassette 'sso/profile' do
+        profile = described_class.get_profile(access_token: 'access_token')
 
-        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)
+        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
+  describe '.profile_and_token' do
     let(:args) do
       {
         code: SecureRandom.hex(10),
@@ -225,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',
@@ -252,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
 
@@ -263,16 +252,16 @@ describe WorkOS::SSO do
           to_return(
             headers: { 'X-Request-ID' => 'request-id' },
             status: 422,
-            body: { "message": 'some error message' }.to_json,
+            body: { "error": 'some error', "error_description": 'some error description' }.to_json,
           )
       end
 
       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',
+          'error: some error, error_description: some error description - request ID: request-id',
         )
       end
     end
@@ -282,97 +271,27 @@ describe WorkOS::SSO do
         stub_request(:post, 'https://api.workos.com/sso/token').
           with(body: request_body).
           to_return(
-            status: 201,
+            status: 400,
             headers: { 'X-Request-ID' => 'request-id' },
             body: {
-              message: "The code '01DVX3C5Z367SFHR8QNDMK7V24'" \
-                ' has expired or is invalid.',
+              "error": 'invalid_grant',
+              "error_description": "The code '01DVX3C5Z367SFHR8QNDMK7V24' has expired or is invalid.",
             }.to_json,
           )
       end
 
       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'" \
+          "error: invalid_grant, error_description: The code '01DVX3C5Z367SFHR8QNDMK7V24'" \
           ' has expired or is invalid. - request ID: request-id',
         )
       end
     end
   end
 
-  describe '.create_connection' do
-    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',
-          )
-
-          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')
-          expect(connection.organization_id).to eq('12345')
-          expect(connection.state).to eq('active')
-          expect(connection.status).to eq('linked')
-        end
-      end
-    end
-
-    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: ',
-          )
-        end
-      end
-    end
-  end
-
-  describe '.promote_draft_connection' do
-    let(:token) { 'draft_conn_id' }
-    let(:client_id) { 'proj_0239u590h' }
-
-    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,
-        )
-
-        expect(response).to be(true)
-      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,
-        )
-
-        expect(response).to be(false)
-      end
-    end
-  end
-
   describe '.list_connections' do
     context 'with no options' do
       it 'returns connections and metadata' do

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

@@ -14,7 +14,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - WorkOS; ruby/2.7.1; x86_64-darwin19; v0.10.3
+      - WorkOS; ruby/3.0.1; x86_64-darwin19; v1.2.1
       Authorization:
       - Bearer <API_KEY>
   response:
@@ -53,20 +53,23 @@ http_interactions:
       X-Xss-Protection:
       - '0'
       X-Request-Id:
-      - 1e6d2f37-ca39-4e6c-8d04-4a56fed444ce
+      - 167e0fa2-cee2-4834-a0aa-4f68fd0a3796
       Content-Type:
       - application/json; charset=utf-8
+      Content-Length:
+      - '784'
       Etag:
-      - W/"7dc-9PMr4siidbvsdQqw0uiJT6E94Dc"
+      - W/"310-fBrsCTIA95j4JLo4UR8X2zBThYQ"
       Date:
-      - Thu, 22 Apr 2021 21:33:48 GMT
-      Transfer-Encoding:
-      - chunked
+      - Mon, 07 Jun 2021 17:55:30 GMT
       Via:
       - 1.1 vegur
     body:
-      encoding: ASCII-8BIT
-      string: '{"object":"list","listMetadata":{"before":"before-id","after":null},"data":[{"object":"directory","id":"directory_edp_1","external_key":"lA3gS1kCZMCkk82E","state":"linked","type":"gsuite directory","name":"Foo Corp","bearer_token":null,"client_id":"project_XXX","domain":"foo-corp.com"}, {"object":"directory","id":"directory_edp_2","external_key":"lA3g","state":"linked","type":"okta scim v2.0","name":"Example", "bearer_token":null,"client_id":"project_XXX","domain":"example.com"}, {"object":"directory","id":"directory_edp_3","external_key":"lA3gS1kC","state":"linked","type":"bamboohr","name":"Acme","bearer_token":null,"client_id":"project_XXX","domain":"acme.com"}]}'
+      encoding: UTF-8
+      string: '{"object":"list","listMetadata":{"before":null,"after":null},"data":[{"object":"directory","id":"directory_01F7796W20KW0CXEQQEYENT0ZC","organization_id":"org_01EZDF20TZEJXKPSX2BJRN6TV6","name":"Bamboo
+        Test","external_key":"rPzV4pdpbaUiKsc6","type":"bamboohr","state":"unlinked","domain":"foo-corp.com"},{"object":"directory","id":"directory_01F5ZY7XVQZ3DRYEZTH1EPA8BS","organization_id":"org_01EZDF20TZEJXKPSX2BJRN6TV6","name":"Foo
+        Corp","external_key":"qV4eyK99QGUaYYa0","type":"okta scim v2.0","state":"linked","domain":"foo-corp.com"},{"object":"directory","id":"directory_01F5XHH1QHX6C2F0Z6WG9YPGCJ","organization_id":"org_01F29YJ068E52HGEB8ZQGC9MJG","name":"Example
+        Azure SCIM","external_key":"YDKJvbWHKKg66cSk","type":"azure scim v2.0","state":"linked","domain":"example.com"}]}'
     http_version:
-  recorded_at: Thu, 22 Apr 2021 21:33:49 GMT
+  recorded_at: Mon, 07 Jun 2021 17:55:30 GMT
 recorded_with: VCR 5.0.0

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

@@ -14,7 +14,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - WorkOS; ruby/2.7.1; x86_64-darwin19; v0.10.3
+      - WorkOS; ruby/3.0.1; x86_64-darwin19; v1.2.1
       Authorization:
       - Bearer <API_KEY>
   response:
@@ -53,7 +53,7 @@ http_interactions:
       X-Xss-Protection:
       - '0'
       X-Request-Id:
-      - ee432766-24b5-4d6d-baa9-05b7d56ac582
+      - d5e27591-7a56-468c-bffe-3a035f3bf26c
       Content-Type:
       - application/json; charset=utf-8
       Content-Length:
@@ -61,12 +61,15 @@ http_interactions:
       Etag:
       - W/"47-5KOnfOsRy36pnaPjBxvaf6LRiGc"
       Date:
-      - Thu, 22 Apr 2021 21:33:48 GMT
+      - Mon, 07 Jun 2021 17:55:30 GMT
       Via:
       - 1.1 vegur
     body:
       encoding: UTF-8
-      string: '{"object":"list","listMetadata":{"before":"before-id","after":null},"data":[{"object":"directory","id":"directory_edp_1","external_key":"lA3gS1kCZMCkk82E","state":"linked","type":"gsuite directory","name":"Foo Corp","bearer_token":null,"client_id":"project_XXX","domain":"foo-corp.com"}, {"object":"directory","id":"directory_edp_2","external_key":"lA3g","state":"linked","type":"okta scim v2.0","name":"Example", "bearer_token":null,"client_id":"project_XXX","domain":"example.com"}, {"object":"directory","id":"directory_edp_3","external_key":"lA3gS1kC","state":"linked","type":"bamboohr","name":"Acme","bearer_token":null,"client_id":"project_XXX","domain":"acme.com"}]}'
+      string: '{"object":"list","listMetadata":{"before":null,"after":null},"data":[{"object":"directory","id":"directory_01F7796W20KW0CXEQQEYENT0ZC","organization_id":"org_01EZDF20TZEJXKPSX2BJRN6TV6","name":"Bamboo
+        Test","external_key":"rPzV4pdpbaUiKsc6","type":"bamboohr","state":"unlinked","domain":"foo-corp.com"},{"object":"directory","id":"directory_01F5ZY7XVQZ3DRYEZTH1EPA8BS","organization_id":"org_01EZDF20TZEJXKPSX2BJRN6TV6","name":"Foo
+        Corp","external_key":"qV4eyK99QGUaYYa0","type":"okta scim v2.0","state":"linked","domain":"foo-corp.com"},{"object":"directory","id":"directory_01F5XHH1QHX6C2F0Z6WG9YPGCJ","organization_id":"org_01F29YJ068E52HGEB8ZQGC9MJG","name":"Example
+        Azure SCIM","external_key":"YDKJvbWHKKg66cSk","type":"azure scim v2.0","state":"linked","domain":"example.com"}]}'
     http_version:
-  recorded_at: Thu, 22 Apr 2021 21:33:48 GMT
+  recorded_at: Mon, 07 Jun 2021 17:55:30 GMT
 recorded_with: VCR 5.0.0