workos 4.2.1 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f18e38578e2afcc1a18b6141954b28c4c58a7ea9ae46baa58eed157a452c1a8b
-  data.tar.gz: 5e5036dfbad3f0fd25f1cb2368144692cd40f18d3668ea43be442ffa62f7b3d7
+  metadata.gz: 6e9c735f7fc4cc9a411de3ae0a3587a65eafb86d5abea06deebda9af4557b7d5
+  data.tar.gz: 0527add6ca64c5be1d9c38a4e205af1974c0b6407e2a9eea2358b6cd9a9328df
 SHA512:
-  metadata.gz: 50833c139a6ad2f9dcfffb74a74e38b7add1edfb3b76b63b0b1e7d2cd5673cc837a9abc35ba05998392aea10907acf80c65c9144abde217b1671aa3c65557a23
-  data.tar.gz: c4ad2de56c7fd7b5da14b849295e2e9d4921b33c0ad6080d47387ff09e4a91c973e7a42ba648869a14280bad15eab3640736652d1b9916d333b24c842ef0c136
+  metadata.gz: 0ee30e5ed0c50be86a2ec193f81b1eb8a9c5900fdac6b124b7a642b874e1e88244bba23df08c60673e9ee23c35f6713e17ccfb9d6f26e3413fb2e0f48696245d
+  data.tar.gz: 1f5cbc0d1f2a61945b3fd0a28feb56bc2dff908d14cb78ad737d2ca3af0197391aff26e763b64e9d0b6577c0c987ab122667b2a92ce61eb54f95114d99d73d73

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (4.2.1)
+    workos (4.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -45,6 +45,19 @@ end
 
 For our SDKs WorkOS follows a Semantic Versioning ([SemVer](https://semver.org/)) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.
 
+## Beta Releases
+
+WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these
+and share feedback with us before these features reach general availability (GA). To install a Beta version,
+please follow the [installation steps](#installation) above using the Beta release version.
+
+> Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a
+> specific version. This way you can install the same version each time without breaking changes unless you are
+> intentionally looking for the latest Beta version.
+
+We highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you
+can move to using the stable version.
+
 ## More Information
 
 * [Single Sign-On Guide](https://workos.com/docs/sso/guide)

data/lib/workos/events.rb

@@ -15,7 +15,7 @@ module WorkOS
       #
       # @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.

data/lib/workos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WorkOS
-  VERSION = '4.2.1'
+  VERSION = '4.3.0'
 end

data/spec/lib/workos/event_spec.rb

@@ -83,5 +83,27 @@ describe WorkOS::Events do
         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

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.3.0
 platform: ruby
 authors:
 - WorkOS
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,6 +201,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_after.yml
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_event.yml
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_organization_id.yml
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_range.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_generic_valid.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_sms_valid.yml
@@ -391,6 +392,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_after.yml
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_event.yml
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_no_options.yml
+- spec/support/fixtures/vcr_cassettes/events/list_events_with_organization_id.yml
 - spec/support/fixtures/vcr_cassettes/events/list_events_with_range.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_generic_valid.yml
 - spec/support/fixtures/vcr_cassettes/mfa/challenge_factor_sms_valid.yml