workos 4.1.0 → 4.2.1

data/lib/workos/webhook.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 module WorkOS
   # The Webhook class provides a lightweight wrapper around
@@ -7,18 +6,16 @@ module WorkOS
   # in user space, and is instantiated internally but exposed.
   class Webhook
     include HashProvider
-    extend T::Sig
 
     attr_accessor :id, :event, :data, :created_at
 
-    sig { params(json: String).void }
     def initialize(json)
-      raw = parse_json(json)
+      hash = JSON.parse(json, symbolize_names: true)
 
-      @id = T.let(raw.id, String)
-      @event = T.let(raw.event, String)
-      @data = raw.data
-      @created_at = T.let(raw.created_at, String)
+      @id = hash[:id]
+      @event = hash[:event]
+      @data = hash[:data]
+      @created_at = hash[:created_at]
     end
 
     def to_json(*)
@@ -29,23 +26,5 @@ module WorkOS
         created_at: created_at,
       }
     end
-
-    private
-
-    sig do
-      params(
-        json_string: String,
-      ).returns(WorkOS::Types::WebhookStruct)
-    end
-    def parse_json(json_string)
-      hash = JSON.parse(json_string, symbolize_names: true)
-
-      WorkOS::Types::WebhookStruct.new(
-        id: hash[:id],
-        event: hash[:event],
-        data: hash[:data],
-        created_at: hash[:created_at],
-      )
-    end
   end
 end

data/lib/workos/webhooks.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: true
 
 require 'openssl'
 
@@ -14,8 +13,6 @@ module WorkOS
   #
   module Webhooks
     class << self
-      extend T::Sig
-
       DEFAULT_TOLERANCE = 180
 
       # Initializes an Event object from a JSON payload
@@ -37,14 +34,6 @@ module WorkOS
       #
       # @return [WorkOS::Webhook]
       # rubocop:enable Layout/LineLength
-      sig do
-        params(
-          payload: String,
-          sig_header: String,
-          secret: String,
-          tolerance: Integer,
-        ).returns(WorkOS::Webhook)
-      end
       def construct_event(
         payload:,
         sig_header:,
@@ -74,14 +63,6 @@ module WorkOS
       #
       # @return Boolean
       # rubocop:enable Layout/LineLength
-      sig do
-        params(
-          payload: String,
-          sig_header: String,
-          secret: String,
-          tolerance: Integer,
-        ).returns(T::Boolean)
-      end
       # rubocop:disable Metrics/AbcSize
       def verify_header(
         payload:,
@@ -134,11 +115,6 @@ module WorkOS
       #   => ['1626125972272', '80f7ab7efadc306eb5797c588cee9410da9be4416782b497bf1e1bf4175fb928']
       #
       # @return Array
-      sig do
-        params(
-          sig_header: String,
-        ).returns([String, String])
-      end
       def get_timestamp_and_signature_hash(
         sig_header:
       )
@@ -174,13 +150,6 @@ module WorkOS
       #
       # @return String
       # rubocop:enable Layout/LineLength
-      sig do
-        params(
-          timestamp: String,
-          payload: String,
-          secret: String,
-        ).returns(String)
-      end
       def compute_signature(
         timestamp:,
         payload:,
@@ -193,19 +162,13 @@ module WorkOS
 
       # Constant time string comparison to prevent timing attacks
       # Code borrowed from ActiveSupport
-      sig do
-        params(
-          str_a: String,
-          str_b: String,
-        ).returns(T::Boolean)
-      end
       def secure_compare(
         str_a:,
         str_b:
       )
         return false unless str_a.bytesize == str_b.bytesize
 
-        l = T.unsafe(str_a.unpack("C#{str_a.bytesize}"))
+        l = str_a.unpack("C#{str_a.bytesize}")
 
         res = 0
         str_b.each_byte { |byte| res |= byte ^ l.shift }

data/lib/workos.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
-# typed: true
 
 require 'workos/version'
-require 'sorbet-runtime'
 require 'json'
 require 'workos/hash_provider'
 require 'workos/configuration'

data/spec/lib/workos/audit_logs_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::AuditLogs do
   it_behaves_like 'client'
@@ -48,7 +47,7 @@ describe WorkOS::AuditLogs do
               idempotency_key: 'idempotency_key',
             )
 
-            expect(response).to eq T::Private::Types::Void::VOID
+            expect(response.code).to eq '201'
           end
         end
       end
@@ -61,7 +60,7 @@ describe WorkOS::AuditLogs do
               event: valid_event,
             )
 
-            expect(response).to eq T::Private::Types::Void::VOID
+            expect(response.code).to eq '201'
           end
         end
       end

data/spec/lib/workos/configuration_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS do
   describe '.configure' do

data/spec/lib/workos/directory_sync_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::DirectorySync do
   it_behaves_like 'client'

data/spec/lib/workos/directory_user_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::DirectoryUser do
   # rubocop:disable Layout/LineLength

data/spec/lib/workos/event_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::Events do
   it_behaves_like 'client'

data/spec/lib/workos/mfa_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::MFA do
   it_behaves_like 'client'

data/spec/lib/workos/organizations_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::Organizations do
   it_behaves_like 'client'

data/spec/lib/workos/passwordless_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::Passwordless do
   it_behaves_like 'client'

data/spec/lib/workos/portal_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::Portal do
   it_behaves_like 'client'

data/spec/lib/workos/sso_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 require 'securerandom'
 

data/spec/lib/workos/user_management_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 describe WorkOS::UserManagement do
   it_behaves_like 'client'
@@ -1146,4 +1145,33 @@ describe WorkOS::UserManagement do
       end
     end
   end
+
+  describe '.revoke_session' do
+    context 'with valid payload' do
+      it 'revokes session' do
+        VCR.use_cassette 'user_management/revoke_session/valid' do
+          result = described_class.revoke_session(
+            session_id: 'session_01HRX85ATNADY1GQ053AHRFFN6',
+          )
+
+          expect(result).to be true
+        end
+      end
+    end
+
+    context 'with a non-existant session' do
+      it 'returns an error' do
+        VCR.use_cassette 'user_management/revoke_session/not_found' do
+          expect do
+            described_class.revoke_session(
+              session_id: 'session_01H5JQDV7R7ATEYZDEG0W5PRYS',
+            )
+          end.to raise_error(
+            WorkOS::APIError,
+            /Session not found/,
+          )
+        end
+      end
+    end
+  end
 end

data/spec/lib/workos/webhooks_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 require 'json'
 require 'openssl'

data/spec/spec_helper.rb

@@ -1,13 +1,4 @@
 # frozen_string_literal: true
-# typed: false
-
-require 'simplecov'
-SimpleCov.start
-
-if ENV['CI'] == 'true'
-  require 'codecov'
-  SimpleCov.formatter = SimpleCov::Formatter::Codecov
-end
 
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 $LOAD_PATH << File.join(File.dirname(__FILE__))

data/spec/support/fixtures/vcr_cassettes/user_management/revoke_session/not_found.yml

@@ -0,0 +1,80 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/user_management/sessions/revoke
+    body:
+      encoding: UTF-8
+      string: '{"session_id":"session_01H5JQDV7R7ATEYZDEG0W5PRYS"}'
+    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-darwin22; v4.2.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Date:
+      - Thu, 11 Apr 2024 22:36:42 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 872e74fd9ed6db9e-LAX
+      Cf-Cache-Status:
+      - DYNAMIC
+      Etag:
+      - W/"91-9u3slgvENRDVFp/62vKalhPzVuw"
+      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:
+      - bc0771a4-8d66-4b34-809c-d3d8976af390
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=iJMFbMBT_gDvh2ZbVYwAWHii9wrMPSJJeFQ3sXKSNNw-1712875002-1.0.1.1-d0033NtW0ShwCrgulDZg60Nw0yfEROthaCZQWVIAnWbbmaoa5HDqSkl4DsECxoAaZNdoLWqOxi9YXtZx9FqVSA;
+        path=/; expires=Thu, 11-Apr-24 23:06:42 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=c2a61e4869ba7669d8dd1d11a8e59bba189e21ba-1712875002; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"Session not found: ''session_01H5JQDV7R7ATEYZDEG0W5PRYS''.","code":"entity_not_found","entity_id":"session_01H5JQDV7R7ATEYZDEG0W5PRYS"}'
+    http_version:
+  recorded_at: Thu, 11 Apr 2024 22:36:42 GMT
+recorded_with: VCR 5.0.0

data/spec/support/fixtures/vcr_cassettes/user_management/revoke_session/valid.yml

@@ -0,0 +1,76 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.workos.com/user_management/sessions/revoke
+    body:
+      encoding: UTF-8
+      string: '{"session_id":"session_01HRX85ATNADY1GQ053AHRFFN6"}'
+    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-darwin22; v4.2.0
+      Authorization:
+      - Bearer <API_KEY>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Thu, 11 Apr 2024 22:36:42 GMT
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cf-Ray:
+      - 872e74fc2ee3092d-LAX
+      Cf-Cache-Status:
+      - DYNAMIC
+      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:
+      - 1b04e560-4438-40ba-97d2-05ae571aeedf
+      X-Xss-Protection:
+      - '0'
+      Set-Cookie:
+      - __cf_bm=lXssAzjuk1ajbWnDLtD_SUYIufESNBd9WVxCY8MCxJU-1712875002-1.0.1.1-oBbEhifco.kAMIrc30VrsrzW8tP4OpouniBD3jTd.5UowyS_IWs6ah59yKeFO9X6IqMLjlJt6n5O9lTpN0.2fw;
+        path=/; expires=Thu, 11-Apr-24 23:06:42 GMT; domain=.workos.com; HttpOnly;
+        Secure; SameSite=None
+      - __cfruid=c2a61e4869ba7669d8dd1d11a8e59bba189e21ba-1712875002; path=/; domain=.workos.com;
+        HttpOnly; Secure; SameSite=None
+      Server:
+      - cloudflare
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version:
+  recorded_at: Thu, 11 Apr 2024 22:36:42 GMT
+recorded_with: VCR 5.0.0

data/spec/support/shared_examples/client_spec.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# typed: false
 
 RSpec.shared_examples 'client' do
   subject(:client) { described_class.client }

data/workos.gemspec

@@ -21,16 +21,11 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'sorbet-runtime', '~> 0.5'
-
   spec.add_development_dependency 'bundler', '>= 2.0.1'
-  spec.add_development_dependency 'codecov', '~> 0.2.8'
   spec.add_development_dependency 'rspec', '~> 3.9.0'
   spec.add_development_dependency 'rubocop', '~> 0.77'
-  spec.add_development_dependency 'sorbet', '~> 0.5'
-  spec.add_development_dependency 'tapioca'
   spec.add_development_dependency 'vcr', '~> 5.0.0'
   spec.add_development_dependency 'webmock'
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.7'
 end