clerk-sdk-ruby 2.7.0 → 2.9.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a63fa1a8677b50586e50404f49bc11c2b281fa99c2dd56e22f932f14a10c28ad
-  data.tar.gz: 797d3896292214650cd3caf2065d84fe36a6667ab24e2989ccedcde3c0b97b30
+  metadata.gz: 3bb75c4354d383821c456ef0e4a3da02d2dbb2404a89dddc6dab99190251c918
+  data.tar.gz: aea4736f0e1c16d94c2f081c32218280d84015282054cbd9a42b7518ab5590d0
 SHA512:
-  metadata.gz: 6194a064d7505ff5d9940e27a37842006401158c60f673f1f3b5425a5da4a52d05b7d77aa984495a9006e77fe376c2a7abedce1086c5c76f5e9430d13bd65a46
-  data.tar.gz: ab494cc80de603e5c9bd15b751219bdbef0ababcd611f9c190f9e1167d4b6abc6328556fcc6dc26521cc449529c028007102d1c15dfe72287056db11eb3ff05e
+  metadata.gz: 0b9b95ab6ba5d002b1a78eff6ad5af4a4c930ea4ae6ef553eab5a7965854a64624340b17ac1ac84348516920fc1b3aba880b459f2e2eb0e112d98018fefce043
+  data.tar.gz: 0caf5c13e253ef08e89b998f68630d7e67574286effa2aa4e8a6490b550dfba0a6f8444e9171fb0b24e3d428d3b1d34c616840926bb0b29260088e7935834bf9

data/.gitignore

@@ -9,3 +9,5 @@
 
 .byebug_history
 *.gem
+
+.idea

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## unreleased
 
+## 2.9.0.beta1 - 2022-12-23
+
+- fix: Make JWKS cache work across different SDK instances [https://github.com/clerkinc/clerk-sdk-ruby/pull/27]
+
+## 2.8.0 - 2022-11-29
+
+- feat: Add support for the users.verify_totp endpoint
+
+## 2.7.0 - 2022-11-02
+
+- feat: Add `#clerk_organization` and `#clerk_organization_id` helpers to fetch the current user's active organization [https://github.com/clerkinc/clerk-sdk-ruby/pull/22]
+- feat: Implement Organization Metadata update endpoint [https://github.com/clerkinc/clerk-sdk-ruby/pull/21]
+
 ## 2.6.0 - 2022-11-01
 
 - feat: Implement Organization endpoints [https://github.com/clerkinc/clerk-sdk-ruby/pull/20]

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    clerk-sdk-ruby (2.6.0)
+    clerk-sdk-ruby (2.8.0)
+      concurrent-ruby (~> 1.1)
       faraday (~> 1.4.1)
-      jwt (~> 2.2)
+      jwt (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     byebug (11.1.3)
+    concurrent-ruby (1.1.10)
     faraday (1.4.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -23,13 +25,14 @@ GEM
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     jwt (2.5.0)
-    minitest (5.14.2)
+    minitest (5.16.3)
     multipart-post (2.2.3)
-    rake (13.0.3)
+    rake (13.0.6)
     ruby2_keywords (0.0.5)
-    timecop (0.9.4)
+    timecop (0.9.6)
 
 PLATFORMS
+  universal-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -40,4 +43,4 @@ DEPENDENCIES
   timecop (~> 0.9.4)
 
 BUNDLED WITH
-   2.2.32
+   2.3.25

data/clerk-sdk-ruby.gemspec

@@ -28,7 +28,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", "~> 1.4.1"
-  spec.add_dependency "jwt", '~> 2.2'
+  spec.add_dependency "jwt", '~> 2.5'
+  spec.add_dependency "concurrent-ruby", "~> 1.1"
 
   spec.add_development_dependency "byebug", "~> 11.1"
   spec.add_development_dependency "timecop", "~> 0.9.4"

data/lib/clerk/jwks_cache.rb

@@ -0,0 +1,32 @@
+class JWKSCache
+  def initialize(lifetime)
+    @lifetime = lifetime
+    @jwks = nil
+    @last_update = nil
+    @lock = Concurrent::ReadWriteLock.new
+  end
+
+  def fetch(sdk, force_refresh: false, kid_not_found: false)
+    should_refresh = @lock.with_read_lock do
+      @jwks.nil? || @last_update.nil? || force_refresh ||
+        (Time.now.to_i-@last_update > @lifetime) ||
+        (kid_not_found && Time.now.to_i-@last_update > 300)
+    end
+
+    if should_refresh
+      @lock.with_write_lock do
+        @last_update = Time.now.to_i
+
+        @jwks = begin
+          sdk.jwks.all["keys"]
+        rescue Clerk::Errors::Base
+          nil
+        end
+      end
+    end
+
+    @lock.with_read_lock do
+      @jwks
+    end
+  end
+end

data/lib/clerk/rack_middleware_v2.rb

@@ -194,7 +194,8 @@ module Clerk
     end
 
     def development_or_staging?
-      Clerk.configuration.api_key.start_with?("test_")
+      Clerk.configuration.api_key.start_with?("test_") ||
+        Clerk.configuration.api_key.start_with?("sk_test_")
     end
 
     def production?
@@ -202,7 +203,7 @@ module Clerk
     end
 
     def cross_origin_request?(req)
-      # origin contains scheme+host and optionally port (ommitted if 80 or 443)
+      # origin contains scheme+host and optionally port (omitted if 80 or 443)
       # ref. https://www.rfc-editor.org/rfc/rfc6454#section-6.1
       origin = req.env["HTTP_ORIGIN"]
       return false if origin.nil?

data/lib/clerk/resources/email_addresses.rb

@@ -0,0 +1,17 @@
+require "forwardable"
+require_relative "plural_resource"
+
+module Clerk
+  module Resources
+    class EmailAddresses
+      extend Forwardable
+
+      def initialize(client)
+        @client = client
+        @resource = PluralResource.new(client, "email_addresses")
+      end
+
+      def_delegators :@resource, :find, :create, :update, :delete
+    end
+  end
+end

data/lib/clerk/resources/phone_numbers.rb

@@ -0,0 +1,17 @@
+require "forwardable"
+require_relative "plural_resource"
+
+module Clerk
+  module Resources
+    class PhoneNumbers
+      extend Forwardable
+
+      def initialize(client)
+        @client = client
+        @resource = PluralResource.new(client, "phone_numbers")
+      end
+
+      def_delegators :@resource, :find, :create, :update, :delete
+    end
+  end
+end

data/lib/clerk/resources/users.rb

@@ -21,6 +21,10 @@ module Clerk
         @client.request(:post, "#{@resource.resource_path(user_id)}/verify_password", body: { password: password })
       end
 
+      def verify_totp(user_id, totp_or_backup_code)
+        @client.request(:post, "#{@resource.resource_path(user_id)}/verify_totp", body: { code: totp_or_backup_code })
+      end
+
       def disable_mfa(user_id)
         @client.request(:delete, "#{@resource.resource_path(user_id)}/mfa")
       end

data/lib/clerk/resources.rb

@@ -1,8 +1,10 @@
 require_relative "resources/allowlist_identifiers"
 require_relative "resources/allowlist"
 require_relative "resources/clients"
+require_relative "resources/email_addresses"
 require_relative "resources/emails"
 require_relative "resources/organizations"
+require_relative "resources/phone_numbers"
 require_relative "resources/sessions"
 require_relative "resources/sms_messages"
 require_relative "resources/users"

data/lib/clerk/sdk.rb

@@ -5,18 +5,22 @@ require "logger"
 require "net/http"
 require "json"
 require "jwt"
+require "concurrent-ruby"
 
 require_relative "resources/allowlist_identifiers"
 require_relative "resources/allowlist"
 require_relative "resources/clients"
+require_relative "resources/email_addresses"
 require_relative "resources/emails"
 require_relative "resources/organizations"
+require_relative "resources/phone_numbers"
 require_relative "resources/sessions"
 require_relative "resources/sms_messages"
 require_relative "resources/users"
 require_relative "resources/users"
 require_relative "resources/jwks"
 require_relative "errors"
+require_relative "jwks_cache"
 
 module Clerk
   class SDK
@@ -28,10 +32,14 @@ module Clerk
     # How often (in seconds) should JWKs be refreshed
     JWKS_CACHE_LIFETIME = 3600 # 1 hour
 
+    @@jwks_cache = JWKSCache.new(JWKS_CACHE_LIFETIME)
+
+    def self.jwks_cache
+      @@jwks_cache
+    end
+
     def initialize(api_key: nil, base_url: nil, logger: nil, ssl_verify: true,
                    connection: nil)
-      @jwks_fetched_at = nil
-
       if connection # Inject a Faraday::Connection for testing or full control over Faraday
         @conn = connection
         return
@@ -111,6 +119,10 @@ module Clerk
       Resources::Clients.new(self)
     end
 
+    def email_addresses
+      Resources::EmailAddresses.new(self)
+    end
+
     def emails
       Resources::Emails.new(self)
     end
@@ -119,6 +131,10 @@ module Clerk
       Resources::Organizations.new(self)
     end
 
+    def phone_numbers
+      Resources::PhoneNumbers.new(self)
+    end
+
     def sessions
       Resources::Sessions.new(self)
     end
@@ -160,17 +176,9 @@ module Clerk
     # `timeout` argument.
     def verify_token(token, force_refresh_jwks: false, algorithms: ['RS256'], timeout: 5)
       jwk_loader = ->(options) do
-        @cached_jwks = nil if options[:invalidate] || force_refresh_jwks
-        @cached_jwks = nil if @jwks_fetched_at && Time.now.to_i - @jwks_fetched_at > JWKS_CACHE_LIFETIME
-
-        @cached_jwks ||= begin
-          keys = jwks.all["keys"]
-          @jwks_fetched_at = Time.now.to_i
-
-          # JWT.decode requires that the 'keys' key in the Hash is a symbol (as
-          # opposed to a string which our SDK returns by default)
-          { keys: keys }
-        end
+        # JWT.decode requires that the 'keys' key in the Hash is a symbol (as
+        # opposed to a string which our SDK returns by default)
+        { keys: SDK.jwks_cache.fetch(self, kid_not_found: (options[:invalidate] || options[:kid_not_found]), force_refresh: force_refresh_jwks) }
       end
 
       JWT.decode(token, nil, true, algorithms: algorithms, jwks: jwk_loader).first

data/lib/clerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clerk
-  VERSION = "2.7.0"
+  VERSION = "2.9.0.beta1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.9.0.beta1
 platform: ruby
 authors:
 - Clerk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-02 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +103,7 @@ files:
 - lib/clerk.rb
 - lib/clerk/authenticatable.rb
 - lib/clerk/errors.rb
+- lib/clerk/jwks_cache.rb
 - lib/clerk/proxy.rb
 - lib/clerk/rack_middleware.rb
 - lib/clerk/rack_middleware_v2.rb
@@ -97,9 +112,11 @@ files:
 - lib/clerk/resources/allowlist.rb
 - lib/clerk/resources/allowlist_identifiers.rb
 - lib/clerk/resources/clients.rb
+- lib/clerk/resources/email_addresses.rb
 - lib/clerk/resources/emails.rb
 - lib/clerk/resources/jwks.rb
 - lib/clerk/resources/organizations.rb
+- lib/clerk/resources/phone_numbers.rb
 - lib/clerk/resources/plural_resource.rb
 - lib/clerk/resources/sessions.rb
 - lib/clerk/resources/singular_resource.rb
@@ -126,9 +143,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.2.5
 signing_key: