workosv2 2.15.0

data/sorbet/tapioca/config.yml

@@ -0,0 +1,13 @@
+gem:
+  # Add your `gem` command parameters here:
+  #
+  # exclude:
+  # - gem_name
+  # doc: true
+  # workers: 5
+dsl:
+  # Add your `dsl` command parameters here:
+  #
+  # exclude:
+  # - SomeGeneratorName
+  # workers: 5

data/sorbet/tapioca/require.rb

@@ -0,0 +1,4 @@
+# typed: true
+# frozen_string_literal: true
+
+# Add your extra requires here (`bin/tapioca require` can be used to boostrap this list)

data/spec/lib/workos/audit_logs_spec.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOSV2::AuditLogs do
+  it_behaves_like 'client'
+
+  before do
+    WorkOSV2.configure do |config|
+      config.key = 'example_api_key'
+    end
+  end
+
+  describe '.create_event' do
+    context 'with valid event payload' do
+      let(:valid_event) do
+        {
+          action: 'user.signed_in',
+          occurred_at: '2022-08-22T15:04:19.704Z',
+          actor: {
+            id: 'user_123',
+            type: 'user',
+            name: 'User',
+            metadata: {
+              foo: 'bar',
+            },
+          },
+          targets: [{
+            id: 'team_123',
+            type: 'team',
+            name: 'Team',
+            metadata: {
+              foo: 'bar',
+            },
+          }],
+          context: {
+            location: '1.1.1.1',
+            user_agent: 'Mozilla',
+          },
+        }
+      end
+
+      context 'with idempotency key' do
+        it 'creates an event' do
+          VCR.use_cassette 'audit_logs/create_event_custom_idempotency_key', match_requests_on: %i[path body] do
+            response = described_class.create_event(
+              organization: 'org_123',
+              event: valid_event,
+              idempotency_key: 'idempotency_key',
+            )
+
+            expect(response).to eq T::Private::Types::Void::VOID
+          end
+        end
+      end
+
+      context 'without idempotency key' do
+        it 'creates an event' do
+          VCR.use_cassette 'audit_logs/create_event', match_requests_on: %i[path body] do
+            response = described_class.create_event(
+              organization: 'org_123',
+              event: valid_event,
+            )
+
+            expect(response).to eq T::Private::Types::Void::VOID
+          end
+        end
+      end
+
+      context 'with invalid event' do
+        it 'returns error' do
+          VCR.use_cassette 'audit_logs/create_event_invalid', match_requests_on: %i[path body] do
+            described_class.create_event(
+              organization: 'org_123',
+              event: valid_event,
+            )
+          rescue WorkOSV2::InvalidRequestError => e
+            expect(
+              e.message,
+            ).to eq 'Status 400, Invalid Audit Log event - request ID: 1cf9b8e7-5910-4a6d-a333-46bcf841422e'
+            expect(e.code).to eq 'invalid_audit_log'
+            expect(e.errors.count).to eq 1
+          end
+        end
+      end
+    end
+  end
+
+  describe '.create_export' do
+    context 'without filters applied' do
+      it 'creates an event' do
+        VCR.use_cassette 'audit_logs/create_export', match_requests_on: %i[path body] do
+          audit_log_export = described_class.create_export(
+            organization: 'org_123',
+            range_start: '2022-06-22T15:04:19.704Z',
+            range_end: '2022-08-22T15:04:19.704Z',
+          )
+
+          expect(audit_log_export).to have_attributes(
+            object: 'audit_log_export',
+            id: 'audit_log_export_123',
+            state: 'pending',
+            url: nil,
+            created_at: '2022-08-22T15:04:19.704Z',
+            updated_at: '2022-08-22T15:04:19.704Z',
+          )
+        end
+      end
+    end
+
+    context 'with filters applied' do
+      it 'creates an export' do
+        VCR.use_cassette 'audit_logs/create_export_with_filters', match_requests_on: %i[path body] do
+          audit_log_export = described_class.create_export(
+            organization: 'org_123',
+            range_start: '2022-06-22T15:04:19.704Z',
+            range_end: '2022-08-22T15:04:19.704Z',
+            actions: ['user.signed_in'],
+            actors: ['Jon Smith'],
+            actor_names: ['Jon Smith'],
+            actor_ids: ['user_123'],
+            targets: %w[user team],
+          )
+
+          expect(audit_log_export.object).to eq 'audit_log_export'
+          expect(audit_log_export.id).to eq 'audit_log_export_123'
+          expect(audit_log_export.state).to eq 'pending'
+          expect(audit_log_export.url).to eq nil
+          expect(audit_log_export.created_at).to eq '2022-08-22T15:04:19.704Z'
+          expect(audit_log_export.updated_at).to eq '2022-08-22T15:04:19.704Z'
+        end
+      end
+    end
+  end
+
+  describe '.get_export' do
+    it 'returns an export' do
+      VCR.use_cassette 'audit_logs/get_export', match_requests_on: %i[path] do
+        audit_log_export = described_class.get_export(
+          id: 'audit_log_export_123',
+        )
+
+        expect(audit_log_export.object).to eq 'audit_log_export'
+        expect(audit_log_export.id).to eq 'audit_log_export_123'
+        expect(audit_log_export.state).to eq 'ready'
+        expect(audit_log_export.url).to eq 'https://audit-logs.com/download.csv'
+        expect(audit_log_export.created_at).to eq '2022-08-22T15:04:19.704Z'
+        expect(audit_log_export.updated_at).to eq '2022-08-22T15:04:19.704Z'
+      end
+    end
+  end
+end

data/spec/lib/workos/audit_trail_spec.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOSV2::AuditTrail do
+  it_behaves_like 'client'
+
+  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_trail/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_trail/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_trail/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(
+                  WorkOSV2::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_trail/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_trail/create_event_invalid') do
+          expect do
+            described_class.create_event(event: invalid_event)
+          end.to raise_error(
+            WorkOSV2::InvalidRequestError,
+            /Status 422, Validation failed \(action_type: action_type must be a string\)/,
+          )
+        end
+      end
+    end
+  end
+
+  describe '.get_events' do
+    context 'with no options' do
+      it 'returns events' do
+        VCR.use_cassette('audit_trail/get_events') do
+          events = described_class.get_events
+
+          expect(events.size).to eq(2)
+        end
+      end
+    end
+  end
+end

data/spec/lib/workos/configuration_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+# typed: false
+
+describe WorkOSV2 do
+  describe '.configure' do
+    context 'with key and no timeout' do
+      before do
+        WorkOSV2.configure do |config|
+          config.key = 'example_api_key'
+        end
+      end
+
+      it 'sets the key and default timeout configuration' do
+        expect(WorkOSV2.config.key).to eq('example_api_key')
+        expect(WorkOSV2.config.timeout).to eq(60)
+      end
+    end
+
+    context 'with key and timeout' do
+      before do
+        WorkOSV2.configure do |config|
+          config.key = 'example_api_key'
+          config.timeout = 120
+        end
+      end
+
+      it 'sets the key and timeout configuration' do
+        expect(WorkOSV2.config.key).to eq('example_api_key')
+        expect(WorkOSV2.config.timeout).to eq(120)
+      end
+    end
+  end
+end
+
+describe WorkOSV2::Configuration do
+  describe '.key!' do
+    context 'with key set' do
+      before do
+        WorkOSV2.config.key = 'example_api_key'
+      end
+
+      it 'returns the key' do
+        expect(WorkOSV2.config.key!).to eq('example_api_key')
+      end
+    end
+
+    context 'with key not set' do
+      before do
+        WorkOSV2.config.key = nil
+      end
+
+      it 'throws an error' do
+        expect do
+          WorkOSV2.config.key!
+        end.to raise_error(
+          '`WorkOSV2.config.key` not set',
+        )
+      end
+    end
+  end
+end