clerk-sdk-ruby 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d51d412f89ce080c43ba0aae47f5fcdb70e5875dd37824dd492cd3d8c669f0c
-  data.tar.gz: fc772bc04d89b46c6c1e35335f4bdbb24fef2fe10d6589b8a94dd5996658d668
+  metadata.gz: f70d13c92fd01f471cd31373b72a5c4aa73784cbc4f8259dff001ed54d6bd5b0
+  data.tar.gz: 4d63622da821f4bdca7eaff4efa7d698c7666b8068f0de5add37b309e28e9dd6
 SHA512:
-  metadata.gz: ca2fc569dce78598d650d34354d3cb0b92afd8782dc039988c38d5090122740c624780f4f8facfb7fa59902c30b6463adc8c94f40dbdff2717afa8a2a6d568b3
-  data.tar.gz: 5174ca1905a8ebbce46f582e2aac5ba961093a2139d5fe9022b7009050e794df03c904b6de51edab5d6c94a039c08a7623cda1aa4bdc6294c8c547330fbf238c
+  metadata.gz: 4ce27dae71ef8f6e6335981041f40881273dc106e06973b288a1c9a089bf35bc03eaa9f561f6c4ca7b21431d7707043365fc77c8306241a85e5e60cd87667d5a
+  data.tar.gz: 8fc64101a4bde21a7ce0e137b395125554150a48bb7c93b83d595b106be7d0eb92b40d299685e98623f35f022a623bdcf6f2818dacd488d91f600aa32200a899

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## unreleased
 
+## 2.5.0 - 2022-09-20
+
+- feat: Add support for disabling the middleware on specific routes [https://github.com/clerkinc/clerk-sdk-ruby/pull/19]
+
+## 2.4.0 - 2022-09-05
+
+- feat: Add support for the users.disable_mfa endpoint
+
 ## 2.3.0 - 2022-08-30
 
 - feat: Add support for the users.verify_password endpoint

data/README.md

@@ -82,6 +82,7 @@ Clerk.configure do |c|
   c.base_url = "https://..." # if omitted: "https://api.clerk.dev/v1/"
   c.logger = Logger.new(STDOUT) # if omitted, no logging
   c.middleware_cache_store = ActiveSupport::Cache::FileStore.new("/tmp/clerk_middleware_cache") # if omitted: no caching
+  c.excluded_routes ["/foo", "/bar/*"]
 end
 ```
 

data/lib/clerk/rack_middleware_v2.rb

@@ -60,11 +60,34 @@ module Clerk
   class RackMiddlewareV2
     def initialize(app)
       @app = app
+      @excluded_routes = {}
+      @excluded_routes_wildcards = []
+
+      Clerk.configuration.excluded_routes.each do |route|
+        route = route.strip
+
+        if route.ends_with?("/*")
+          @excluded_routes_wildcards << route[0..-2]
+        else
+          @excluded_routes[route] = true
+        end
+      end
+
+      @excluded_routes_wildcards.uniq!
     end
 
     def call(env)
       env = env
       req = Rack::Request.new(env)
+
+      if @excluded_routes[req.path]
+        return @app.call(env)
+      end
+
+      @excluded_routes_wildcards.each do |route|
+        return @app.call(env) if req.path.starts_with?(route)
+      end
+
       env["clerk"] = Clerk::ProxyV2.new
       header_token = req.env["HTTP_AUTHORIZATION"]
       header_token = header_token.strip.sub(/\ABearer /, '') if header_token

data/lib/clerk/version.rb

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

data/lib/clerk.rb

@@ -18,9 +18,33 @@ module Clerk
     PRODUCTION_BASE_URL = "https://api.clerk.dev/v1/".freeze
     attr_accessor :api_key, :base_url, :logger, :middleware_cache_store
 
+    # An array of route paths on which the middleware will not execute.
+    #
+    # Only request paths that match _exactly_ one of the routes will be skipped.
+    # As a special case, if a route ends with '/*', then all request paths that
+    # match the route's prefix will be skipped.
+    #
+    # For example, given the following configuration:
+    #
+    #     excluded_routes = ["/foo", "/bar/*"]
+    #
+    # the following requests will be excluded:
+    #
+    # - /foo
+    # - /bar/baz
+    # - /bar/abc/xyz
+    #
+    # while the following requests will NOT be excluded:
+    #
+    # - /foo/bar
+    # - /bar
+    #
+    attr_accessor :excluded_routes
+
     def initialize
       @base_url = ENV.fetch("CLERK_API_BASE", PRODUCTION_BASE_URL)
       @api_key = ENV["CLERK_API_KEY"]
+      @excluded_routes = []
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Clerk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Clerk SDK for Ruby.