workos 2.16.0 → 3.0.0

data/lib/workos/audit_trail.rb

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-# typed: true
-
-require 'net/http'
-require 'uri'
-
-module WorkOS
-  # The Audit Trail module provides convenience methods for working with the
-  # WorkOS Audit Trail platform. You'll need a valid API key.
-  #
-  # @see https://docs.workos.com/audit-trail/overview
-  module AuditTrail
-    class << self
-      extend T::Sig
-      include Client
-
-      # Create an Audit Trail event.
-      #
-      # @param [Hash] event An event hash
-      # @option event [String] group A single organization containing related
-      #  members. This will normally be the customer of a vendor's application.
-      # @option event [String] location Identifier for where the event
-      #  originated. This will be an IP address (IPv4 or IPv6), hostname, or
-      #  device ID.
-      # @option event [String] action Specific activity performed by the actor.
-      # @option event [String] action_type Corresponding CRUD category of the
-      #  event. Can be one of C, R, U, or D.
-      # @option event [String] actor_name Display name of the entity performing
-      #  the action.
-      # @option event [String] actor_id Unique identifier of the entity
-      #  performing the action.
-      # @option event [String] target_name Display name of the object or
-      #  resource that is being acted upon.
-      # @option event [String] target_id Unique identifier of the object or
-      #  resource being acted upon.
-      # @option event [String] occurred_at ISO-8601 datetime at which the event
-      #  happened, with millisecond precision.
-      # @option event [Hash] metadata Arbitrary key-value data containing
-      #  information associated with the event. Note: There is a limit of 50
-      #  keys. Key names can be up to 40 characters long, and values can be up
-      #  to 500 characters long.
-      # @param [String] idempotency_key An idempotency key
-      sig do
-        params(
-          event: Hash,
-          idempotency_key: T.nilable(String),
-        ).returns(::T.untyped)
-      end
-
-      def create_event(event:, idempotency_key: nil)
-        request = post_request(
-          path: '/events',
-          auth: true,
-          idempotency_key: idempotency_key,
-          body: event,
-        )
-
-        execute_request(request: request)
-      end
-
-      # Retrieve Audit Trail events.
-      #
-      # @param [Hash] options An options hash
-      # @option options [String] before Event ID to look before
-      # @option options [String] after Event ID to look after
-      # @option options [Integer] limit Number of Events to return
-      # @option options [String] order The order in which to paginate records
-      # @option options [Array<String>] group List of Groups to filter for
-      # @option options [Array<String>] action List of Actions to filter for
-      # @option options [Array<String>] action_type List of Action Types to
-      #  filter for
-      # @option options [Array<String>] actor_name List of Actor Name to filter
-      #  for
-      # @option options [Array<String>] actor_id List of Actor IDs to filter for
-      # @option options [Array<String>] target_name List of Target Names to
-      #  filter for
-      # @option options [Array<String>] target_id List of Target IDs to filter
-      #  for
-      # @option options [String] occurred_at ISO-8601 datetime of when an event
-      #  occurred
-      # @option options [String] occurred_at_gt ISO-8601 datetime of when an
-      #  event occurred after
-      # @option options [String] occurred_at_gte ISO-8601 datetime of when an
-      #  event occurred at or after
-      # @option options [String] occurred_at_lt ISO-8601 datetime of when an
-      #  event occurred before
-      # @option options [String] occurred_at_lte ISO-8601 datetime of when an
-      #  event occured at or before
-      # @option options [String] search Keyword search
-      #
-      # @return [Array<Hash>]
-      sig do
-        params(
-          options: T::Hash[Symbol, String],
-        ).returns(T::Array[T::Hash[String, T.nilable(String)]])
-      end
-
-      def get_events(options = {})
-        response = execute_request(
-          request: get_request(
-            path: '/events',
-            auth: true,
-            params: options,
-          ),
-        )
-
-        JSON.parse(response.body)['data']
-      end
-    end
-  end
-end

data/spec/lib/workos/audit_trail_spec.rb

@@ -1,146 +0,0 @@
-# frozen_string_literal: true
-# typed: false
-
-describe WorkOS::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(
-                  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_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(
-            WorkOS::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