workos 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 773cbb5edfa2433922650417a8b487513bc197fa72b758fd4423bea67bf87f49
-  data.tar.gz: 72f573248a97132d57117718e811242b6be36ad15025eeec9f311a3477186bf4
+  metadata.gz: ce58ab479d49e4f828ebe675fb3f3b8104a6d82d85f19da6087f9a907dc1e827
+  data.tar.gz: 96d0c77cf047d6e56952414cda3d80d2395b692b4125af95c15a9ba85b00c0c9
 SHA512:
-  metadata.gz: 4fe620f43ec9b30ed8a885c08d157bfc5f0da091d820306fcba3e9dee9ba7b6d69d3f5b5cad8b74882a3080058ede66da47af228c2ccd761715ee4c8a7d82eac
-  data.tar.gz: 442b32e6bdc38579e21937c7da371d4b6f767027c021620f538d468d0e8ac9ca31cd226778c7b5f10f419f3d1c0d21cb402e846738abd871a67c95ac315130d4
+  metadata.gz: 8529507b9187453055b084ec30446123a2572f4045380f17916d640b1c0f052eb64089d620695469b3eb0839c3d88e4f6827a24de1802bd432f2c5f134cb3094
+  data.tar.gz: 505133b5a111f5efdfd1b9c26b773f6359dc21841273df43ae0f7090afec8ee11350830004f2dd285d7b607b3d423e95513c50484cab36ade8be60686be214f1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (0.3.3)
+    workos (0.4.0)
       sorbet-runtime (~> 0.5)
 
 GEM
@@ -56,7 +56,7 @@ GEM
     simplecov-html (0.10.2)
     sorbet (0.5.5560)
       sorbet-static (= 0.5.5560)
-    sorbet-runtime (0.5.5815)
+    sorbet-runtime (0.5.5858)
     sorbet-static (0.5.5560-universal-darwin-14)
     unicode-display_width (1.6.0)
     url (0.3.2)

data/lib/workos/audit_trail.rb

@@ -57,6 +57,54 @@ module WorkOS
 
         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 [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] 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/lib/workos/version.rb

@@ -2,5 +2,5 @@
 # typed: strong
 
 module WorkOS
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/spec/lib/workos/audit_trail_spec.rb

@@ -137,4 +137,16 @@ describe WorkOS::AuditTrail do
       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/support/fixtures/vcr_cassettes/audit_trail/get_events.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+  - request:
+      method: get
+      uri: https://api.workos.com/events
+      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.4.0
+        Authorization:
+          - Bearer <API_KEY>
+    response:
+      status:
+        code: 200
+        message: OK
+      headers:
+        Vary:
+          - Origin, Accept-Encoding
+        Access-Control-Allow-Credentials:
+          - "true"
+        X-Dns-Prefetch-Control:
+          - "off"
+        X-Frame-Options:
+          - SAMEORIGIN
+        Strict-Transport-Security:
+          - max-age=15552000; includeSubDomains
+        X-Download-Options:
+          - noopen
+        X-Content-Type-Options:
+          - nosniff
+        X-Xss-Protection:
+          - 1; mode=block
+        X-Request-Id:
+          - ""
+        Content-Type:
+          - application/json; charset=utf-8
+        Etag:
+          - W/"1784-HtVN7X+AT30Dlt9nZrirP0nnyV8"
+        Date:
+          - Fri, 31 Jul 2020 14:41:12 GMT
+        Connection:
+          - keep-alive
+        Transfer-Encoding:
+          - chunked
+      body:
+        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}}'
+      http_version:
+    recorded_at: Fri, 31 Jul 2020 14:41:12 GMT
+recorded_with: VCR 5.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-14 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -239,6 +239,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/get_events.yml
 - spec/support/fixtures/vcr_cassettes/base/execute_request_unauthenticated.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/get_group.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/get_group_with_invalid_id.yml
@@ -289,6 +290,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_event_invalid.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_and_payload.yml
 - spec/support/fixtures/vcr_cassettes/audit_trail/create_events_duplicate_idempotency_key_different_payload.yml
+- spec/support/fixtures/vcr_cassettes/audit_trail/get_events.yml
 - spec/support/fixtures/vcr_cassettes/base/execute_request_unauthenticated.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/get_group.yml
 - spec/support/fixtures/vcr_cassettes/directory_sync/get_group_with_invalid_id.yml