clerk-sdk-ruby 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 667111230c44f37d6b581dc3bd9aeac82febef5738e36e1976646622e8085938
-  data.tar.gz: 4a02834f63803a6c2264eb9329ad5e7c922d95d80b37047e63e8ad8412888275
+  metadata.gz: 2c5d13e407e2b3827d2d451604f62d018e90ecb79fb28b12864318358bc7bcdf
+  data.tar.gz: c0c69cab555345231c04bec2dfb48316f4f4c66a04f8a5270588ba9a8e98230f
 SHA512:
-  metadata.gz: fa8da41cc220134d1625b59af067f452d6117c2b8b4d7b14ce1682c383a2aef689abfbef6143723b9075eb74e776422fbfa98cfb8ab8a6c86e4a9387d5e6a28d
-  data.tar.gz: 0ab40ea5599abfdeccead036121b4ff761d9a08dd0ad14c932a3feb50ad0d2eb6e1f502dd45255e96df2b18c79ed63cc977c4a4c965c56dc71620c3519e4956a
+  metadata.gz: 3f3b78b75a176ee0667fc492e85bb3672ce258c8fa869cc2196943ed85014e47526abc677d8771d034bcd505ee4edb4999a790f3e16206e0417b2cdaa29cbf96
+  data.tar.gz: 5b7f5366e6ed26d47c4e9856622c0424d46e6dbaf07f218e94f908e587755700b876069e677ecd4c75dc49ced41d18f113d4c2fdd9653dadde99922c8ea3da1f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.1.0 - 2025-04-10
+
+- feat: Add support for org. claims of v2 session tokens [https://github.com/clerk/clerk-sdk-ruby/pull/89]
+
 ## 4.0.0.beta4 - 2025-01-06
 
 [BREAKING] This release introduces our new `clerk-http-client` gem, which is a generated directly from the Clerk API OpenAPI specs. This will help to ensure that the SDK is always in sync with the Clerk API.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clerk-sdk-ruby (4.0.0)
+    clerk-sdk-ruby (4.1.0)
       clerk-http-client (~> 2.0)
       concurrent-ruby (~> 1.1)
       faraday (>= 1.4.1, < 3.0)

data/README.md

@@ -58,18 +58,18 @@ Here's a quick example:
 ```ruby
 clerk = Clerk::SDK.new(api_key: "your_api_key")
 # List all users
-clerk.users.all
+clerk.users.get_user_list
 # Get your first user
-user = clerk.users.all(limit: 1).first
+user = clerk.users.get_user_list(limit: 1).first
 # Extract their primary email address ID
 email_id = user["primary_email_address_id"]
-# Send them a welcome email
-clerk.emails.create(
-    email_address_id: email_id,
-    from_email_name: "welcome",
-    subject: "Welcome to MyApp",
-    body: "Welcome to MyApp, #{user["first_name"]}",
-)
+
+# Create an organization
+p Clerk::SDK.organizations.create_organization({
+  create_organization_request: ClerkHttpClient::CreateOrganizationRequest.new({
+    name: 'example'
+  })
+})
 ```
 
 ## Configuration
@@ -167,9 +167,14 @@ end
 This gives your controller and views access to the following methods and more:
 
 - `clerk.sdk.*`
-- `clerk.session`
-- `clerk.user`
 - `clerk.user?`
+- `clerk.user`: NOTE: This makes an additional request and attempts to cache it.
+- `clerk.user_id`
+- `clerk.organization?`
+- `clerk.organization` NOTE: This makes an additional request and attempts to cache it.
+- `clerk.organization_id`
+- `clerk.organization_role`
+- `clerk.organization_permissions`
 
 ### Skipping the Railtie
 

data/apps/sinatra/config.ru

@@ -1,2 +1,8 @@
 require_relative './app'
+
+Clerk.configure do |config|
+  config.debug = true
+  config.logger = Logger.new($stdout)
+end
+
 run App

data/lib/clerk/configuration.rb

@@ -6,6 +6,7 @@ module Clerk
   class Configuration
     attr_reader :cache_store
     attr_reader :debug
+    attr_reader :logger
     attr_reader :excluded_routes
     attr_reader :publishable_key
     attr_reader :secret_key
@@ -74,5 +75,10 @@ module Clerk
       ClerkHttpClient::Configuration.default.access_token = sk
       @secret_key = sk
     end
+
+    def logger=(logger)
+      ClerkHttpClient::Configuration.default.logger = logger
+      @logger = logger
+    end
   end
 end

data/lib/clerk/sdk.rb

@@ -5,14 +5,14 @@ require "jwt"
 
 module Clerk
   class SDK < ClerkHttpClient::SDK
-    # TODO: Move to constants?
     DEFAULT_HEADERS = {
       "User-Agent": "Clerk/#{Clerk::VERSION}; Faraday/#{Faraday::VERSION}; Ruby/#{RUBY_VERSION}",
-      "X-Clerk-SDK": "ruby/#{Clerk::VERSION}" # TODO: Add framework identifier
+      "X-Clerk-SDK": "ruby/#{Clerk::VERSION}",
+      "Clerk-API-Version": "2025-04-10",
     }
 
     # How often (in seconds) should JWKs be refreshed
-    JWKS_CACHE_LIFETIME = 3600 # 1 hour / TODO: Move to constants?
+    JWKS_CACHE_LIFETIME = 3600 # 1 hour
 
     @@jwks_cache = JWKSCache.new(JWKS_CACHE_LIFETIME)
 
@@ -41,7 +41,44 @@ module Clerk
         {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, exp_leeway: timeout, jwks: jwk_loader).first
+      claims = JWT.decode(token, nil, true, algorithms: algorithms, exp_leeway: timeout, jwks: jwk_loader).first
+
+      # orgs
+      if claims["v"].nil? || claims["v"] == 1
+        claims["v"] = 1
+      elsif claims["v"] == 2 && claims["o"]
+        claims["org_id"]          = claims["o"].fetch("id", nil)
+        claims["org_slug"]        = claims["o"].fetch("slg", nil)
+        claims["org_role"]        = "org:#{claims["o"].fetch("rol", nil)}"
+
+        org_permissions = compute_org_permissions_from_v2_token(claims)
+        claims["org_permissions"] = org_permissions if org_permissions.any?
+        claims.delete("o")
+        claims.delete("fea")
+      end
+
+      claims
+    end
+
+    private
+
+    def compute_org_permissions_from_v2_token(claims)
+      features    = claims["fea"].split(",")
+      permissions = claims["o"]["per"].split(",")
+      mappings    = claims["o"]["fpm"].split(",")
+      org_permissions = []
+
+      mappings.each_with_index do |mapping, i|
+        scope, feature = features[i].split(":")
+
+        next if !scope.include?("o") # not an orgs-related permission
+
+        mapping.to_i.to_s(2).reverse.each_char.each_with_index do |bit, i|
+          org_permissions << "org:#{feature}:#{permissions[i]}" if bit == "1"
+        end
+      end
+
+      org_permissions
     end
   end
 end

data/lib/clerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clerk
-  VERSION = "4.0.0"
+  VERSION = "4.1.0"
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Clerk
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-28 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -306,6 +307,7 @@ metadata:
   homepage_uri: https://github.com/clerkinc/clerk-sdk-ruby
   source_code_uri: https://github.com/clerkinc/clerk-sdk-ruby
   changelog_uri: https://github.com/clerkinc/clerk-sdk-ruby/blob/main/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -320,7 +322,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Clerk SDK for Ruby.
 test_files: []