clerk-sdk-ruby 2.11.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34c7beec3b3a8d96bb7d508099daf4778d4718e9a4d3b6d84bcf31544f7ff1fb
-  data.tar.gz: 773eae9d2547ad936e7543dae38b9453a07bf44b23f4bfe593b03df2048ea515
+  metadata.gz: c386b9f44d3be850ca0ba0f3bdf5ed2322398fcbd3be2caab4861b5a771f9776
+  data.tar.gz: b82ba95db218bab18647077601ba8ffb44b1d194e6c8c6bda27140fa7d7b979c
 SHA512:
-  metadata.gz: 35eeca356c4f4cf3d40760a98780606c4e933375fbdbb736fc2dea2a089dfe2b75c0d88a99d5773afd49b85e8af3192db2f197203685a61ed43811e28227e90e
-  data.tar.gz: f82372393ddadea3a6aa5848558816a081b34f4ef6be0231bf3cd71648ce19d55b43b0b221544304fde2393fccae45eb763c9c931106965cac66cf286cec3ead
+  metadata.gz: 9ecddaacd364b4d63f993da578888bf9ca72c2280c608e36487953f31ee47febddf0abe5a4af850f15cdf51e87c71e6d9280b43f26aa1f44fdfbc7c24a930626
+  data.tar.gz: 7a28d1da8d6a2d212da1ba5b1730ab063baae5a5eeb2c43f5e36c4e828a8cc4d2f1d67f78e470c37bdbc29a0a069b1a0f969ba3b778f388f4f0638699a4812a6

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## unreleased
 
+## 3.0.0 - 2024-01-09
+
+Note: this is identical to 2.12.0, which was yanked because it contained a
+breaking change.
+
+- feat: Add org role/permission helpers [https://github.com/clerk/clerk-sdk-ruby/pull/40]
+- changed: drop create sms endpoint [https://github.com/clerk/clerk-sdk-ruby/pull/39]
+
+## [YANKED] 2.12.0 - 2024-01-09
+
+- feat: Add org role/permission helpers [https://github.com/clerk/clerk-sdk-ruby/pull/40]
+- changed: drop create sms endpoint [https://github.com/clerk/clerk-sdk-ruby/pull/39]
+
+## 2.11.1 - 2023-10-31
+
+- fix: Properly set Clerk API key (secret) when using Faraday v2 [https://github.com/clerkinc/clerk-sdk-ruby/pull/37]
+
 ## 2.11.0 - 2023-10-27
 
 - feat: Added support for Faraday v2 [https://github.com/clerkinc/clerk-sdk-ruby/pull/37]
@@ -74,12 +91,12 @@ Identical to 2.9.0.beta3
 
 ## 2.0.0 - 2021-10-21
 
-This release introduces the new networkless middleware which works with the new 
+This release introduces the new networkless middleware which works with the new
 authentication scheme, [Auth v2](https://clerk.com/docs/upgrade-guides/auth-v2).
 
 It is backwards-incompatible with applications using Auth v1.
 
-- [BREAKING]: In order to use this version, you must set the authVersion prop 
+- [BREAKING]: In order to use this version, you must set the authVersion prop
     accordingly in your frontend: `Clerk.load({authVersion: 2})`
 
 For more information on Auth v2, please refer to

data/CODEOWNERS

@@ -1 +1 @@
-* @clerkinc/backend-team
+* @clerkinc/backend

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clerk-sdk-ruby (2.10.0)
+    clerk-sdk-ruby (2.11.1)
       concurrent-ruby (~> 1.1)
       faraday (>= 1.4.1, < 3.0)
       jwt (~> 2.5)
@@ -19,7 +19,7 @@ GEM
     faraday-net_http (3.0.2)
     jwt (2.7.1)
     minitest (5.20.0)
-    rake (13.0.6)
+    rake (13.1.0)
     ruby2_keywords (0.0.5)
     timecop (0.9.8)
 

data/lib/clerk/authenticatable.rb

@@ -61,6 +61,14 @@ module Clerk
       request.env["clerk"].org_id
     end
 
+    def clerk_organization_role
+      request.env["clerk"].org_role
+    end
+
+    def clerk_organization_permissions
+      request.env["clerk"].org_permissions
+    end
+
     def clerk_user_signed_in?
       !!clerk_verified_session_claims
     end
@@ -82,7 +90,8 @@ module Clerk
         :clerk_verified_session_claims, :clerk_verified_session_token,
         :clerk_user, :clerk_user_id, :clerk_user_signed_in?, :clerk_sign_in_url,
         :clerk_sign_up_url, :clerk_user_profile_url,
-        :clerk_organization, :clerk_organization_id
+        :clerk_organization, :clerk_organization_id, :clerk_organization_role,
+        :clerk_organization_permissions
     end
   end
 end

data/lib/clerk/rack_middleware_v2.rb

@@ -48,6 +48,18 @@ module Clerk
       @session_claims["org_id"]
     end
 
+    def org_role
+      return nil if @session_claims.nil?
+
+      @session_claims["org_role"]
+    end
+
+    def org_permissions
+      return nil if @session_claims.nil?
+
+      @session_claims["org_permissions"]
+    end
+
     private
 
     def fetch_user(user_id)
@@ -203,12 +215,15 @@ module Clerk
     end
 
     def development_or_staging?
-      Clerk.configuration.api_key.start_with?("test_") ||
-        Clerk.configuration.api_key.start_with?("sk_test_")
+      Clerk.configuration.api_key &&
+      (Clerk.configuration.api_key.start_with?("test_") ||
+        Clerk.configuration.api_key.start_with?("sk_test_"))
     end
 
     def production?
-      !development_or_staging?
+      Clerk.configuration.api_key &&
+      (Clerk.configuration.api_key.start_with?("live_") ||
+        Clerk.configuration.api_key.start_with?("sk_live_"))
     end
 
     def cross_origin_request?(req)

data/lib/clerk/resources.rb

@@ -6,6 +6,5 @@ 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/jwks"

data/lib/clerk/sdk.rb

@@ -15,7 +15,6 @@ 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"
@@ -52,10 +51,10 @@ module Clerk
                      URI(base_url)
                    end
 
-        api_key ||= if Faraday::VERSION.to_i < 2
-            Clerk.configuration.api_key
-        elsif Clerk.configuration.api_key.nil?
-          -> { raise ArgumentError, "Clerk secret key is not set" }
+        api_key ||= Clerk.configuration.api_key
+
+        if Faraday::VERSION.to_i >= 2 && api_key.nil?
+          api_key = -> { raise ArgumentError, "Clerk secret key is not set" }
         end
 
         logger = logger || Clerk.configuration.logger
@@ -148,10 +147,6 @@ module Clerk
       Resources::Sessions.new(self)
     end
 
-    def sms_messages
-      Resources::SMSMessages.new(self)
-    end
-
     def users
       Resources::Users.new(self)
     end

data/lib/clerk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Clerk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -126,7 +126,6 @@ files:
 - lib/clerk/resources/plural_resource.rb
 - lib/clerk/resources/sessions.rb
 - lib/clerk/resources/singular_resource.rb
-- lib/clerk/resources/sms_messages.rb
 - lib/clerk/resources/users.rb
 - lib/clerk/sdk.rb
 - lib/clerk/utils.rb

data/lib/clerk/resources/sms_messages.rb

@@ -1,16 +0,0 @@
-require "forwardable"
-require_relative "plural_resource"
-
-module Clerk
-  module Resources
-    class SMSMessages
-      extend Forwardable
-
-      def initialize(client)
-        @resource = PluralResource.new(client, "sms_messages")
-      end
-
-      def_delegators :@resource, :create
-    end
-  end
-end