workos 5.11.1 → 5.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2792dbbd0e3dac4d2a9eac0920a135b0db63c723a85fbbec049327ab2cffd547
-  data.tar.gz: 356cb856f6e2df599daf2affc94eb74d4ee885ab71d77e6002ab176718dbc0ee
+  metadata.gz: 6852c01440a63d103cd39a4c0aee2eeb5d1215d79a3e8eb2a3053b5aa3f3376e
+  data.tar.gz: 71c5c53d1f8fc5219903cfcfc23cbeb657da1db2c64980fa9d8914bd6ae92b1d
 SHA512:
-  metadata.gz: d4a1406d88ac981d0d0653027cf2afe17b64d7c577d6cfe0d4ccc9ffb0a6c6be29c0f3ed140a03bb8ce5a8876990e41bea60a892f5675dc6578ce1526a4504f6
-  data.tar.gz: 55abb8c32270ce7b4b5e4e7142f9f6c390e9cca88c3f3eb1242840193f4155da9bf4f018d85e5b34f51ebd3cc85f0cac176c8cd00abffd077133962100083566
+  metadata.gz: eb001da89bc0cf2866dcfd4d4c5207ddc7c960538ab413c45fcd5d5f80e4c97e205cc0e3fb51bdaaf8af984e9e30ad5c317c30e453c8e6579c1914350dfe3f2c
+  data.tar.gz: 5fe92a1ad40c3bced46b0597430b02ea36b20c82f109614df332695aa7d9f613a025e0f30d3afcaab978c5b3de6882a3a67886e55343de513fb508950664a5d3

data/.github/workflows/ci.yml

@@ -17,8 +17,6 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '2.7'
-          - '3.0'
           - '3.1'
           - '3.2'
     steps:

data/.rubocop.yml

@@ -1,6 +1,5 @@
-# Disabling due to conflict with Ruby 2.7/3.1
-Layout/BlockAlignment:
-  Enabled: false
+inherit_from: .rubocop_todo.yml
+
 Layout/DotPosition:
   EnforcedStyle: trailing
 Layout/EmptyLineAfterMagicComment:
@@ -8,11 +7,11 @@ Layout/EmptyLineAfterMagicComment:
 Layout/EmptyLines:
   Enabled: false
 Layout/LineLength:
-  IgnoredPatterns:
+  AllowedPatterns:
     - 'VCR\.use_cassette'
     - '(\A|\s)/.*?/'
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context', 'before', 'it']
+  AllowedMethods: ['describe', 'context', 'before', 'it']
 Metrics/MethodLength:
   Max: 30
 Metrics/ModuleLength:
@@ -28,4 +27,4 @@ Style/TrailingCommaInArguments:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: 'consistent_comma'
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1

data/.rubocop_todo.yml

@@ -0,0 +1,94 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-01-22 21:38:20 UTC using RuboCop version 1.71.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'spec/lib/workos/session_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Layout/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'lib/workos/mfa.rb'
+    - 'lib/workos/user_management.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/SpaceAroundMethodCallOperator:
+  Exclude:
+    - 'spec/lib/workos/directory_sync_spec.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Lint/DuplicateRequire:
+  Exclude:
+    - 'lib/workos/session.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedParentClasses.
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/workos/directory_group.rb'
+    - 'lib/workos/directory_user.rb'
+    - 'lib/workos/errors.rb'
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 624
+
+# Offense count: 8
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: separated, grouped
+Style/AccessorGrouping:
+  Exclude:
+    - 'lib/workos/errors.rb'
+
+# Offense count: 34
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces
+Style/HashAsLastArrayItem:
+  Exclude:
+    - 'spec/lib/workos/directory_sync_spec.rb'
+    - 'spec/lib/workos/event_spec.rb'
+    - 'spec/lib/workos/organizations_spec.rb'
+    - 'spec/lib/workos/sso_spec.rb'
+    - 'spec/lib/workos/user_management_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/KeywordParametersOrder:
+  Exclude:
+    - 'lib/workos/organizations.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: SafeForConstants.
+Style/RedundantFetchBlock:
+  Exclude:
+    - 'spec/lib/workos/cache_spec.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleReturnValues.
+Style/RedundantReturn:
+  Exclude:
+    - 'lib/workos/directory_user.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/SlicingWithRange:
+  Exclude:
+    - 'lib/workos/deprecated_hash_wrapper.rb'
+    - 'lib/workos/session.rb'

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.1.4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    workos (5.11.1)
+    workos (5.12.0)
       encryptor (~> 3.0)
       jwt (~> 2.8)
 
@@ -19,16 +19,18 @@ GEM
     diff-lcs (1.5.1)
     encryptor (3.0.0)
     hashdiff (1.1.0)
+    json (2.9.1)
     jwt (2.10.1)
       base64
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    language_server-protocol (3.17.0.3)
+    parallel (1.26.3)
+    parser (3.3.7.0)
       ast (~> 2.4.1)
       racc
     public_suffix (5.0.4)
-    racc (1.7.3)
+    racc (1.8.1)
     rainbow (3.1.1)
-    regexp_parser (2.9.0)
+    regexp_parser (2.10.0)
     rexml (3.2.6)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -43,19 +45,22 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.4)
-    rubocop (0.93.1)
+    rubocop (1.71.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
-      rexml
-      rubocop-ast (>= 0.6.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.36.2, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.37.0)
+      parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
-    unicode-display_width (1.8.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
     vcr (5.0.0)
     webmock (3.23.0)
       addressable (>= 2.8.0)
@@ -68,7 +73,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (>= 2.0.1)
   rspec (~> 3.9.0)
-  rubocop (~> 0.77)
+  rubocop (~> 1.71)
   vcr (~> 5.0.0)
   webmock
   workos!

data/lib/workos/organization.rb

@@ -7,7 +7,15 @@ module WorkOS
   class Organization
     include HashProvider
 
-    attr_accessor :id, :domains, :name, :allow_profiles_outside_organization, :created_at, :updated_at
+    attr_accessor(
+      :id,
+      :domains,
+      :stripe_customer_id,
+      :name,
+      :allow_profiles_outside_organization,
+      :created_at,
+      :updated_at,
+    )
 
     def initialize(json)
       hash = JSON.parse(json, symbolize_names: true)
@@ -16,6 +24,7 @@ module WorkOS
       @name = hash[:name]
       @allow_profiles_outside_organization = hash[:allow_profiles_outside_organization]
       @domains = hash[:domains]
+      @stripe_customer_id = hash[:stripe_customer_id]
       @created_at = hash[:created_at]
       @updated_at = hash[:updated_at]
     end
@@ -26,6 +35,7 @@ module WorkOS
         name: name,
         allow_profiles_outside_organization: allow_profiles_outside_organization,
         domains: domains,
+        stripe_customer_id: stripe_customer_id,
         created_at: created_at,
         updated_at: updated_at,
       }

data/lib/workos/organizations.rb

@@ -71,7 +71,7 @@ module WorkOS
 
       # Create an organization
       #
-      # @param [Array<Hash>] domain_data List of domain hashes describing an orgnaization domain.
+      # @param [Array<Hash>] domain_data List of domain hashes describing an organization domain.
       # @option domain_data [String] domain The domain that belongs to the organization.
       # @option domain_data [String] state The state of the domain. "verified" or "pending"
       # @param [String] name A unique, descriptive name for the organization
@@ -118,9 +118,10 @@ module WorkOS
       # Update an organization
       #
       # @param [String] organization Organization unique identifier
-      # @param [Array<Hash>] domain_data List of domain hashes describing an orgnaization domain.
+      # @param [Array<Hash>] domain_data List of domain hashes describing an organization domain.
       # @option domain_data [String] domain The domain that belongs to the organization.
       # @option domain_data [String] state The state of the domain. "verified" or "pending"
+      # @param [String] stripe_customer_id The Stripe customer ID associated with this organization.
       # @param [String] name A unique, descriptive name for the organization
       # @param [Boolean, nil] allow_profiles_outside_organization Whether Connections
       #   within the Organization allow profiles that are outside of the Organization's configured User Email Domains.
@@ -129,6 +130,7 @@ module WorkOS
       #   Deprecated: Use domain_data instead.
       def update_organization(
         organization:,
+        stripe_customer_id: nil,
         domain_data: nil,
         domains: nil,
         name: nil,
@@ -136,6 +138,7 @@ module WorkOS
       )
         body = { name: name }
         body[:domain_data] = domain_data if domain_data
+        body[:stripe_customer_id] = stripe_customer_id if stripe_customer_id
 
         if domains
           warn_deprecation '`domains` is deprecated. Use `domain_data` instead.'

data/lib/workos/session.rb

@@ -11,7 +11,6 @@ require 'uri'
 module WorkOS
   # The Session class provides helper methods for working with WorkOS sessions
   # This class is not meant to be instantiated in a user space, and is instantiated internally but exposed.
-  # rubocop:disable Metrics/ClassLength
   class Session
     attr_accessor :jwks, :jwks_algorithms, :user_management, :cookie_password, :session_data, :client_id
 
@@ -180,5 +179,4 @@ module WorkOS
     end
     # rubocop:enable Naming/PredicateName
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/workos/version.rb

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

data/spec/lib/workos/organizations_spec.rb

@@ -295,6 +295,21 @@ describe WorkOS::Organizations do
         end
       end
     end
+    context 'with a stripe_customer_id' do
+      it 'updates the organization' do
+        VCR.use_cassette 'organization/update_with_stripe_customer_id' do
+          organization = described_class.update_organization(
+            organization: 'org_01JJ5H14CAA2SQ5G9HNN6TBZ05',
+            name: 'Test Organization',
+            stripe_customer_id: 'cus_123',
+          )
+
+          expect(organization.id).to eq('org_01JJ5H14CAA2SQ5G9HNN6TBZ05')
+          expect(organization.name).to eq('Test Organization')
+          expect(organization.stripe_customer_id).to eq('cus_123')
+        end
+      end
+    end
   end
 
   describe '.delete_organization' do

data/spec/support/fixtures/vcr_cassettes/organization/update_with_stripe_customer_id.yml

@@ -0,0 +1,78 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://api.workos.com/organizations/org_01JJ5H14CAA2SQ5G9HNN6TBZ05
+    body:
+      encoding: UTF-8
+      string: '{"name":"Test Organization","stripe_customer_id":"cus_123"}'
+    headers:
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - WorkOS; ruby/3.1.4; arm64-darwin24; v5.11.1
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 22 Jan 2025 16:50:26 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 90610b03f84db9f1-SEA
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"1cc-uqKwJf4L85rLspCK9lJ1ceRlbSA"
+      Strict-Transport-Security:
+      - max-age=15552000; includeSubDomains
+      Vary:
+      - Origin, Accept-Encoding
+      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'
+      Expect-Ct:
+      - max-age=0
+      Referrer-Policy:
+      - no-referrer
+      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:
+      - 7b62039f-40f4-4c2c-9ef9-7b1f63615481
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - _cfuvid=TPT.bwe9giSuDXv9bDFC8leHolKCFKy2kdsa0G89jGI-1737564626875-0.0.1.1-604800000;
+        path=/; domain=.workos.com; HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"object":"organization","id":"org_01JJ5H14CAA2SQ5G9HNN6TBZ05","name":"Test
+        Organization","allow_profiles_outside_organization":false,"created_at":"2025-01-21T22:51:46.441Z","updated_at":"2025-01-22T16:50:26.789Z","domains":[{"verification_strategy":"manual","state":"verified","object":"organization_domain","id":"org_domain_01JJ5H14CKRGAE9HVA1Y9YABSX","organization_id":"org_01JJ5H14CAA2SQ5G9HNN6TBZ05","domain":"example.me"}],"stripe_customer_id":"cus_123"}'
+    http_version:
+  recorded_at: Wed, 22 Jan 2025 16:50:26 GMT
+recorded_with: VCR 5.0.0

data/workos.gemspec

@@ -26,9 +26,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '>= 2.0.1'
   spec.add_development_dependency 'rspec', '~> 3.9.0'
-  spec.add_development_dependency 'rubocop', '~> 0.77'
+  spec.add_development_dependency 'rubocop', '~> 1.71'
   spec.add_development_dependency 'vcr', '~> 5.0.0'
   spec.add_development_dependency 'webmock'
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workos
 version: !ruby/object:Gem::Version
-  version: 5.11.1
+  version: 5.12.0
 platform: ruby
 authors:
 - WorkOS
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: encryptor
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: '1.71'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.77'
+        version: '1.71'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
@@ -272,6 +273,7 @@ files:
 - spec/support/fixtures/vcr_cassettes/organization/list.yml
 - spec/support/fixtures/vcr_cassettes/organization/list_organization_roles.yml
 - spec/support/fixtures/vcr_cassettes/organization/update.yml
+- spec/support/fixtures/vcr_cassettes/organization/update_with_stripe_customer_id.yml
 - spec/support/fixtures/vcr_cassettes/organization/update_without_name.yml
 - spec/support/fixtures/vcr_cassettes/passwordless/create_session.yml
 - spec/support/fixtures/vcr_cassettes/passwordless/create_session_invalid.yml
@@ -384,7 +386,7 @@ licenses:
 - MIT
 metadata:
   documentation_uri: https://docs.workos.com/sdk/ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -392,7 +394,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -400,7 +402,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.19
-signing_key: 
+signing_key:
 specification_version: 4
 summary: API client for WorkOS
 test_files:
@@ -492,6 +494,7 @@ test_files:
 - spec/support/fixtures/vcr_cassettes/organization/list.yml
 - spec/support/fixtures/vcr_cassettes/organization/list_organization_roles.yml
 - spec/support/fixtures/vcr_cassettes/organization/update.yml
+- spec/support/fixtures/vcr_cassettes/organization/update_with_stripe_customer_id.yml
 - spec/support/fixtures/vcr_cassettes/organization/update_without_name.yml
 - spec/support/fixtures/vcr_cassettes/passwordless/create_session.yml
 - spec/support/fixtures/vcr_cassettes/passwordless/create_session_invalid.yml