From 13f0dcfa1986764884b425551406d0786d861260 Mon Sep 17 00:00:00 2001
From: alisherry <sheheryar.s.ali@gmail.com>
Date: Fri, 26 Apr 2024 16:00:05 -0400
Subject: [PATCH] Add additional spec for organization_id support in `events`
 (#289)

* Add spec for organization

* typo

* rubocop
---
 lib/workos/events.rb                          |  2 +-
 spec/lib/workos/event_spec.rb                 | 22 +++++
 .../list_events_with_organization_id.yml      | 80 +++++++++++++++++++
 3 files changed, 103 insertions(+), 1 deletion(-)
 create mode 100644 spec/support/fixtures/vcr_cassettes/events/list_events_with_organization_id.yml

diff --git a/lib/workos/events.rb b/lib/workos/events.rb
index 25e28d96..6c46ae0a 100644
--- a/lib/workos/events.rb
+++ b/lib/workos/events.rb
@@ -15,7 +15,7 @@ class << self
       #
       # @param [Hash] options An options hash
       # @option options [String] event The type of event
-      #  retrieved.
+      # @option options [String] organization_id Limit scope of events to an organization
       # @option options [String] limit Maximum number of records to return.
       # @option options [String] after Pagination cursor to receive records
       #  after a provided Event ID.
diff --git a/spec/lib/workos/event_spec.rb b/spec/lib/workos/event_spec.rb
index 8fc96503..d67d29ac 100644
--- a/spec/lib/workos/event_spec.rb
+++ b/spec/lib/workos/event_spec.rb
@@ -83,5 +83,27 @@
         end
       end
     end
+
+    context 'with the organization_id option' do
+      it 'forms the proper request to the API' do
+        request_args = [
+          '/events?organization_id=org_1234',
+          '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 'events/list_events_with_organization_id' do
+          events = described_class.list_events(
+            organization_id: 'org_1234',
+          )
+
+          expect(events.data.size).to eq(1)
+        end
+      end
+    end
   end
 end
diff --git a/spec/support/fixtures/vcr_cassettes/events/list_events_with_organization_id.yml b/spec/support/fixtures/vcr_cassettes/events/list_events_with_organization_id.yml
new file mode 100644
index 00000000..1c9906fc
--- /dev/null
+++ b/spec/support/fixtures/vcr_cassettes/events/list_events_with_organization_id.yml
@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.workos.com/events?organization_id=org_1234
+    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.2; arm64-darwin21; v2.3.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 14 Jul 2022 16:46:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Content-Length:
+      - '616'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Content-Security-Policy:
+      - 'default-src ''self'';base-uri ''self'';block-all-mixed-content;font-src ''self''
+        https: data:;frame-ancestors ''self'';img-src ''self'' data:;object-src ''none'';script-src
+        ''self'';script-src-attr ''none'';style-src ''self'' https: ''unsafe-inline'';upgrade-insecure-requests'
+      Etag:
+      - W/"680-NPvBik348v8xg6EE7iZMYwD5UXw"
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      Via:
+      - 1.1 spaces-router (b642bf20b975)
+      X-Content-Type-Options:
+      - nosniff
+      X-Dns-Prefetch-Control:
+      - 'off'
+      X-Download-Options:
+      - noopen
+      X-Frame-Options:
+      - SAMEORIGIN
+      X-Permitted-Cross-Domain-Policies:
+      - none
+      X-Request-Id:
+      - 51a82273-b413-cead-b968-c07ba4d6fd08
+      X-Xss-Protection:
+      - '0'
+      Cf-Cache-Status:
+      - DYNAMIC
+      Report-To:
+      - '{"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=OS7ELJ3A8tkzMafvaIThD%2B5JlYmul1puZlAXTxEKYBLlq%2B6DCtqDqAi4dtr4yRP3khNmg6MwPiuLqtdOXRmPOtag9Ti%2FGK8ra%2BJOlpwkFjD965CNBfzao4EJtExDkbS3"}],"group":"cf-nel","max_age":604800}'
+      Nel:
+      - '{"success_fraction":0,"report_to":"cf-nel","max_age":604800}'
+      Server:
+      - cloudflare
+      Cf-Ray:
+      - 72abbbf2b93e8ca5-EWR
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"list","data":[{"object":"event","id":"event_01FK3HFFGMC2WF32RR8SKWC8KA","event":"dsync.user.created","created_at":"2021-10-28T13:29:54.451Z","data":{"email":"foo@foocorp.com"}}], "list_metadata":{"after":null}}'
+    http_version:
+  recorded_at: Thu, 14 Jul 2022 16:46:23 GMT
+recorded_with: VCR 5.0.0