workos 6.1.0 → 7.0.0

data/test/workos/test_webhook_verify.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# @oagen-ignore-file
+require "test_helper"
+require "openssl"
+
+class WebhookVerifyTest < Minitest::Test
+  SECRET = "whsec_test_secret"
+
+  def setup
+    @client = WorkOS::Client.new(api_key: "sk_test_webhook")
+    @webhooks = @client.webhooks
+  end
+
+  def signed(payload, ts: now_ms, secret: SECRET)
+    sig = OpenSSL::HMAC.hexdigest("SHA256", secret, "#{ts}.#{payload}")
+    "t=#{ts}, v1=#{sig}"
+  end
+
+  def now_ms
+    (Time.now.to_f * 1000).to_i
+  end
+
+  def test_verify_methods_exist
+    assert_respond_to @webhooks, :verify_event
+    assert_respond_to @webhooks, :verify_header
+    assert_respond_to @webhooks, :compute_signature
+    assert_respond_to @webhooks, :parse_signature_header
+  end
+
+  def test_verify_event_returns_parsed_payload
+    payload = '{"id":"evt_1","event":"user.created"}'
+    sig_header = signed(payload)
+    event = @webhooks.verify_event(payload: payload, sig_header: sig_header, secret: SECRET)
+    assert_equal "evt_1", event["id"]
+    assert_equal "user.created", event["event"]
+  end
+
+  def test_verify_header_passes_for_valid_signature
+    payload = '{"x":1}'
+    assert @webhooks.verify_header(payload: payload, sig_header: signed(payload), secret: SECRET)
+  end
+
+  def test_verify_header_raises_on_bad_signature
+    payload = '{"x":1}'
+    bad = "t=#{now_ms}, v1=deadbeef"
+    assert_raises(WorkOS::SignatureVerificationError) do
+      @webhooks.verify_header(payload: payload, sig_header: bad, secret: SECRET)
+    end
+  end
+
+  def test_verify_header_raises_on_stale_timestamp
+    payload = '{"x":1}'
+    old_ts = now_ms - (10 * 60 * 1000) # 10 minutes old
+    sig = OpenSSL::HMAC.hexdigest("SHA256", SECRET, "#{old_ts}.#{payload}")
+    header = "t=#{old_ts}, v1=#{sig}"
+    err = assert_raises(WorkOS::SignatureVerificationError) do
+      @webhooks.verify_header(payload: payload, sig_header: header, secret: SECRET, tolerance: 60)
+    end
+    assert_match(/Timestamp outside the tolerance zone/, err.message)
+  end
+
+  def test_verify_header_raises_on_malformed_header
+    assert_raises(WorkOS::SignatureVerificationError) do
+      @webhooks.verify_header(payload: "{}", sig_header: "garbage", secret: SECRET)
+    end
+    assert_raises(WorkOS::SignatureVerificationError) do
+      @webhooks.verify_header(payload: "{}", sig_header: nil, secret: SECRET)
+    end
+  end
+
+  def test_compute_signature_matches_manual_hmac
+    payload = "hello"
+    ts = "1700000000000"
+    expected = OpenSSL::HMAC.hexdigest("SHA256", SECRET, "#{ts}.#{payload}")
+    assert_equal expected, @webhooks.compute_signature(payload: payload, timestamp: ts, secret: SECRET)
+  end
+
+  def test_parse_signature_header
+    ts, sig = @webhooks.parse_signature_header("t=12345, v1=abcdef")
+    assert_equal "12345", ts
+    assert_equal "abcdef", sig
+  end
+end

data/test/workos/test_webhooks.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "test_helper"
+
+class WebhooksTest < Minitest::Test
+  include FixtureHelper
+
+  def setup
+    @client = WorkOS::Client.new(api_key: "sk_test_123")
+  end
+
+  def test_list_webhook_endpoints_returns_expected_result
+    stub_request(:get, %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)})
+      .to_return(body: '{"data": [], "list_metadata": {}}', status: 200)
+    result = @client.webhooks.list_webhook_endpoints
+    assert_kind_of WorkOS::Types::ListStruct, result
+  end
+
+  def test_create_webhook_endpoint_returns_expected_result
+    stub_request(:post, %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)})
+      .to_return(body: "{}", status: 200)
+    result = @client.webhooks.create_webhook_endpoint(endpoint_url: "stub", events: [])
+    refute_nil result
+  end
+
+  def test_update_webhook_endpoint_returns_expected_result
+    stub_request(:patch, %r{\Ahttps://api\.workos\.com/webhook_endpoints/stub(\?|\z)})
+      .to_return(body: "{}", status: 200)
+    result = @client.webhooks.update_webhook_endpoint(id: "stub")
+    refute_nil result
+  end
+
+  def test_delete_webhook_endpoint_returns_expected_result
+    stub_request(:delete, %r{\Ahttps://api\.workos\.com/webhook_endpoints/stub(\?|\z)})
+      .to_return(body: "{}", status: 200)
+    result = @client.webhooks.delete_webhook_endpoint(id: "stub")
+    assert_nil result
+  end
+
+  # Parameterized authentication error tests (one per endpoint).
+  [
+    {name: :list_webhook_endpoints, verb: :get, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)}},
+    {name: :create_webhook_endpoint, verb: :post, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints(\?|\z)}, args: {endpoint_url: "stub", events: []}},
+    {name: :update_webhook_endpoint, verb: :patch, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints/stub(\?|\z)}, args: {id: "stub"}},
+    {name: :delete_webhook_endpoint, verb: :delete, url: %r{\Ahttps://api\.workos\.com/webhook_endpoints/stub(\?|\z)}, args: {id: "stub"}}
+  ].each do |spec|
+    define_method("test_#{spec[:name]}_raises_authentication_error_on_401") do
+      stub_request(spec[:verb], spec[:url])
+        .to_return(body: '{"message": "Unauthorized"}', status: 401)
+      assert_raises(WorkOS::AuthenticationError) do
+        @client.webhooks.send(spec[:name], **(spec[:args] || {}))
+      end
+    end
+  end
+end

data/test/workos/test_widgets.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by oagen. Do not edit.
+
+require "test_helper"
+
+class WidgetsTest < Minitest::Test
+  include FixtureHelper
+
+  def setup
+    @client = WorkOS::Client.new(api_key: "sk_test_123")
+  end
+
+  def test_create_token_returns_expected_result
+    stub_request(:post, %r{\Ahttps://api\.workos\.com/widgets/token(\?|\z)})
+      .to_return(body: "{}", status: 200)
+    result = @client.widgets.create_token(organization_id: "stub")
+    refute_nil result
+  end
+
+  # Parameterized authentication error tests (one per endpoint).
+  [
+    {name: :create_token, verb: :post, url: %r{\Ahttps://api\.workos\.com/widgets/token(\?|\z)}, args: {organization_id: "stub"}}
+  ].each do |spec|
+    define_method("test_#{spec[:name]}_raises_authentication_error_on_401") do
+      stub_request(spec[:verb], spec[:url])
+        .to_return(body: '{"message": "Unauthorized"}', status: 401)
+      assert_raises(WorkOS::AuthenticationError) do
+        @client.widgets.send(spec[:name], **(spec[:args] || {}))
+      end
+    end
+  end
+end

data/workos.gemspec

@@ -1,35 +1,36 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+require "English"
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'workos/version'
+require "workos/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'workos'
+  spec.name = "workos"
   spec.version = WorkOS::VERSION
-  spec.authors = ['WorkOS']
-  spec.email = ['support@workos.com']
-  spec.description = 'API client for WorkOS'
-  spec.summary = 'API client for WorkOS'
-  spec.homepage = 'https://github.com/workos-inc/workos-ruby'
-  spec.license = 'MIT'
+  spec.authors = ["WorkOS"]
+  spec.email = ["support@workos.com"]
+  spec.description = "API client for WorkOS"
+  spec.summary = "API client for WorkOS"
+  spec.homepage = "https://github.com/workos/workos-ruby"
+  spec.license = "MIT"
   spec.metadata = {
-    'documentation_uri' => 'https://docs.workos.com/sdk/ruby',
+    "documentation_uri" => "https://docs.workos.com/sdk/ruby"
   }
 
   spec.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'encryptor', '~> 3.0'
-  spec.add_dependency 'jwt', '~> 3.1'
+  spec.add_dependency "jwt", "~> 3.1"
+  spec.add_dependency "logger", "~> 1.7"
+  spec.add_dependency "zeitwerk", "~> 2.6"
 
-  spec.add_development_dependency 'bundler', '>= 2.0.1'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.9.0'
-  spec.add_development_dependency 'rubocop', '~> 1.71'
-  spec.add_development_dependency 'vcr', '~> 6.0'
-  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency "bundler", ">= 2.0.1"
+  spec.add_development_dependency "minitest", "~> 6.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "standard", "~> 1.49"
+  spec.add_development_dependency "webmock", "~> 3.26"
 
-  spec.required_ruby_version = '>= 3.1'
+  spec.required_ruby_version = ">= 3.3"
 end