workos 0.0.2 → 0.1.0

data/sorbet/rbi/sorbet-typed/lib/rainbow/all/rainbow.rbi

@@ -5,7 +5,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/edit/master/lib/rainbow/all/rainbow.rbi
 #
-# typed: false
+# typed: strong
 
 module Rainbow
   sig { returns(T::Boolean) }

data/sorbet/rbi/todo.rbi

@@ -3,5 +3,10 @@
 
 # typed: strong
 module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::MethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
+module T::Private::Methods::SingletonMethodHooks; end
 module T::Private::Methods::SingletonMethodHooks; end
 module T::Private::Methods::SingletonMethodHooks; end

data/spec/lib/workos/audit_log_spec.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOS::AuditLog do
+  before(:all) do
+    WorkOS.key = 'key'
+  end
+
+  after(:all) do
+    WorkOS.key = nil
+  end
+
+  describe '.create_event' do
+    context 'with valid event payload' do
+      let(:valid_event) do
+        {
+          group: 'Terrace House',
+          location: '1.1.1.1',
+          action: 'house.created',
+          action_type: 'C',
+          actor_name: 'Daiki Miyagi',
+          actor_id: 'user_12345',
+          target_name: 'Ryota Yamasato',
+          target_id: 'user_67890',
+          occurred_at: '2020-01-10T15:30:00-05:00',
+          metadata: {
+            a: 'b',
+          },
+        }
+      end
+
+      context 'with idempotency key' do
+        context 'when idempotency key is used once' do
+          it 'creates an event' do
+            VCR.use_cassette('audit_log/create_event_custom_idempotency_key') do
+              response = described_class.create_event(
+                event: valid_event,
+                idempotency_key: 'key',
+              )
+
+              expect(response.code).to eq '201'
+              json = JSON.parse(response.body)
+              expect(json['success']).to be true
+            end
+          end
+        end
+
+        context 'when idempotency key is used more than once' do
+          context 'with duplicate event payloads' do
+            it 'creates an event' do
+              VCR.use_cassette('audit_log/create_events_duplicate_idempotency_key_and_payload') do
+                response1 = described_class.create_event(
+                  event: valid_event,
+                  idempotency_key: 'foo',
+                )
+                response2 = described_class.create_event(
+                  event: valid_event,
+                  idempotency_key: 'foo',
+                )
+
+                expect(response1.code).to eq '201'
+                json1 = JSON.parse(response1.body)
+                expect(json1['success']).to be true
+
+                expect(response2.code).to eq '201'
+                json2 = JSON.parse(response1.body)
+                expect(json2['success']).to be true
+              end
+            end
+          end
+
+          context 'with different event payloads' do
+            it 'raises an error' do
+              VCR.use_cassette('audit_log/create_events_duplicate_idempotency_key_different_payload') do
+                described_class.create_event(
+                  event: valid_event,
+                  idempotency_key: 'bar',
+                )
+
+                payload = valid_event.clone
+                payload[:actor_name] = 'Tetsuya Sugaya'
+
+                expect do
+                  described_class.create_event(
+                    event: payload,
+                    idempotency_key: 'bar',
+                  )
+                end.to raise_error(
+                  WorkOS::InvalidRequestError,
+                  /Status 400, Another idempotency key \(bar\) with different request parameters was found. Please use a different idempotency key./,
+                )
+              end
+            end
+          end
+        end
+      end
+
+      context 'with no idempotency key' do
+        it 'creates an event' do
+          VCR.use_cassette('audit_log/create_event') do
+            response = described_class.create_event(event: valid_event)
+
+            expect(response.code).to eq '201'
+            json = JSON.parse(response.body)
+            expect(json['success']).to be true
+          end
+        end
+      end
+    end
+
+    context 'with invalid event payload' do
+      let(:invalid_event) do
+        {
+          group: 'Terrace House',
+          location: '1.1.1.1',
+          action: 'house.created',
+          actor_name: 'Daiki Miyagi',
+          actor_id: 'user_12345',
+          target_name: 'Ryota Yamasato',
+          target_id: 'user_67890',
+          occurred_at: '2020-01-10T15:30:00-05:00',
+          metadata: {
+            a: 'b',
+          },
+        }
+      end
+
+      it 'raises an error' do
+        VCR.use_cassette('audit_log/create_event_invalid') do
+          expect do
+            described_class.create_event(event: invalid_event)
+          end.to raise_error(
+            WorkOS::InvalidRequestError,
+            /Status 422, Validation failed \(action_type: action_type must be a string\)/,
+          )
+        end
+      end
+    end
+  end
+end

data/spec/lib/workos/base_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# typed: false
+
+module WorkOS
+  module Test
+    class << self
+      include Base
+      include Client
+
+      def request
+        execute_request(request: post_request(path: '/events', body: {}))
+      end
+    end
+  end
+end
+
+describe WorkOS::Base do
+  describe '.execute_request' do
+    context 'when unauthenticated' do
+      it 'raises an error' do
+        VCR.use_cassette('base/execute_request_unauthenticated') do
+          expect { WorkOS::Test.request }.to raise_error(
+            WorkOS::AuthenticationError,
+            /Status 401, Unauthorized/,
+          )
+        end
+      end
+    end
+  end
+end

data/spec/lib/workos/sso_spec.rb

@@ -1,41 +1,117 @@
-# typed: false
 # frozen_string_literal: true
+# typed: false
 
 require 'securerandom'
 
 describe WorkOS::SSO do
   describe '.authorization_url' do
-    let(:args) do
-      {
-        domain: 'foo.com',
-        project_id: 'workos-proj-123',
-        redirect_uri: 'foo.com/auth/callback',
-        state: {
-          next_page: '/dashboard/edit',
-        },
-      }
-    end
+    context 'with a domain' do
+      let(:args) do
+        {
+          domain: 'foo.com',
+          project_id: 'workos-proj-123',
+          redirect_uri: 'foo.com/auth/callback',
+          state: {
+            next_page: '/dashboard/edit',
+          },
+        }
+      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 a valid URL' do
-      authorization_url = described_class.authorization_url(**args)
+      it 'returns the expected query string' do
+        authorization_url = described_class.authorization_url(**args)
 
-      expect(URI.parse(authorization_url)).to be_a URI
+        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
 
-    it 'returns the expected hostname' do
-      authorization_url = described_class.authorization_url(**args)
+    context 'with a provider' do
+      let(:args) do
+        {
+          provider: 'GoogleOAuth',
+          project_id: 'workos-proj-123',
+          redirect_uri: 'foo.com/auth/callback',
+          state: {
+            next_page: '/dashboard/edit',
+          },
+        }
+      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).host).to eq(WorkOS::API_HOSTNAME)
+        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&provider=GoogleOAuth',
+        )
+      end
     end
 
-    it 'returns the expected query string' do
-      authorization_url = described_class.authorization_url(**args)
+    context 'with neither domain or provider' do
+      let(:args) do
+        {
+          project_id: 'workos-proj-123',
+          redirect_uri: 'foo.com/auth/callback',
+          state: {
+            next_page: '/dashboard/edit',
+          },
+        }
+      end
+      it 'raises an error' do
+        expect do
+          described_class.authorization_url(**args)
+        end.to raise_error(
+          ArgumentError,
+          'Either domain or provider is required.',
+        )
+      end
+    end
 
-      expect(URI.parse(authorization_url).query).to eq(
-        'domain=foo.com&client_id=workos-proj-123&redirect_uri=' \
-        'foo.com%2Fauth%2Fcallback&response_type=code&' \
-        'state=%7B%3Anext_page%3D%3E%22%2Fdashboard%2Fedit%22%7D',
-      )
+    context 'with an invalid provider' do
+      let(:args) do
+        {
+          provider: 'Okta',
+          project_id: 'workos-proj-123',
+          redirect_uri: 'foo.com/auth/callback',
+          state: {
+            next_page: '/dashboard/edit',
+          },
+        }
+      end
+      it 'raises an error' do
+        expect do
+          described_class.authorization_url(**args)
+        end.to raise_error(
+          ArgumentError,
+          'Okta is not a valid value. `provider` must be in ["GoogleOAuth"]',
+        )
+      end
     end
   end
 
@@ -48,7 +124,6 @@ describe WorkOS::SSO do
       {
         code: SecureRandom.hex(10),
         project_id: 'workos-proj-123',
-        redirect_uri: 'foo.com/auth/callback',
       }
     end
 
@@ -58,19 +133,30 @@ describe WorkOS::SSO do
         client_secret: WorkOS.key,
         code: args[:code],
         grant_type: 'authorization_code',
-        redirect_uri: args[:redirect_uri],
       }
     end
+    let(:user_agent) { 'user-agent-string' }
+    let(:headers) { { 'User-Agent' => user_agent } }
+    before do
+      allow(described_class).to receive(:user_agent).and_return(user_agent)
+    end
 
     context 'with a successful response' do
       let(:body) { File.read("#{SPEC_ROOT}/support/profile.txt") }
 
       before do
         stub_request(:post, 'https://api.workos.com/sso/token').
-          with(query: query).
+          with(query: query, headers: headers).
           to_return(status: 200, body: body)
       end
 
+      it 'includes the SDK Version header' do
+        described_class.profile(**args)
+
+        expect(a_request(:post, 'https://api.workos.com/sso/token').
+          with(query: query, headers: headers)).to have_been_made
+      end
+
       it 'returns a WorkOS::Profile' do
         profile = described_class.profile(**args)
 
@@ -81,17 +167,21 @@ describe WorkOS::SSO do
     context 'with an unprocessable request' do
       before do
         stub_request(:post, 'https://api.workos.com/sso/token').
-          with(query: query).
+          with(query: query, headers: headers).
           to_return(
+            headers: { 'X-Request-ID' => 'request-id' },
             status: 422,
             body: { "message": 'some error message' }.to_json,
           )
       end
 
-      it 'raises an exception' do
+      it 'raises an exception with request ID' do
         expect do
           described_class.profile(**args)
-        end.to raise_error(WorkOS::RequestError, 'some error message')
+        end.to raise_error(
+          WorkOS::APIError,
+          'some error message - request ID: request-id',
+        )
       end
     end
 
@@ -99,18 +189,23 @@ describe WorkOS::SSO do
       before do
         stub_request(:post, 'https://api.workos.com/sso/token').
           with(query: query).
-          to_return(status: 201, body: {
-            message: "The code '01DVX3C5Z367SFHR8QNDMK7V24'" \
-              ' has expired or is invalid.',
-          }.to_json,)
+          to_return(
+            status: 201,
+            headers: { 'X-Request-ID' => 'request-id' },
+            body: {
+              message: "The code '01DVX3C5Z367SFHR8QNDMK7V24'" \
+                ' has expired or is invalid.',
+            }.to_json,
+          )
       end
 
       it 'raises an exception' do
         expect do
           described_class.profile(**args)
         end.to raise_error(
-          WorkOS::RequestError,
-          "The code '01DVX3C5Z367SFHR8QNDMK7V24' has expired or is invalid.",
+          WorkOS::APIError,
+          "The code '01DVX3C5Z367SFHR8QNDMK7V24'" \
+          ' has expired or is invalid. - request ID: request-id',
         )
       end
     end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: false
+# typed: true
 
 require 'simplecov'
 SimpleCov.start
@@ -16,9 +16,16 @@ require 'rubygems'
 require 'rspec'
 require 'webmock/rspec'
 require 'workos'
+require 'vcr'
 
 SPEC_ROOT = File.dirname __FILE__
 
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/support/fixtures/vcr_cassettes'
+  config.filter_sensitive_data('<API_KEY>') { WorkOS.key }
+  config.hook_into :webmock
+end
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
@@ -29,4 +36,17 @@ RSpec.configure do |config|
   end
 
   config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  WebMock::API.prepend(Module.new do
+    extend self
+
+    # Disable VCR when a WebMock stub is created
+    # for clearer spec failure messaging
+    def stub_request(*args)
+      VCR.turn_off!
+      super
+    end
+  end)
+
+  config.before(:each) { VCR.turn_on! }
 end