clerk-sdk-ruby 4.0.0.beta3 → 4.0.0.beta4

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta3
+  version: 4.0.0.beta4
 platform: ruby
 authors:
 - Clerk
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,6 +43,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: clerk-http-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -86,23 +99,183 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.4
-description: Client SDK for the Clerk backend API.
+description: Client SDK for the Clerk
 email:
 - ruby-sdk@clerk.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".github/workflows/main.yml"
 - ".github/workflows/semgrep.yml"
 - ".gitignore"
+- ".rspec"
+- ".ruby-version"
 - CHANGELOG.md
-- CODEOWNERS
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- apps/rack/app.rb
+- apps/rack/config.ru
+- apps/rack/middleware/disable_paths.rb
+- apps/rails-api/.dockerignore
+- apps/rails-api/.gitattributes
+- apps/rails-api/.gitignore
+- apps/rails-api/.kamal/hooks/docker-setup.sample
+- apps/rails-api/.kamal/hooks/post-deploy.sample
+- apps/rails-api/.kamal/hooks/post-proxy-reboot.sample
+- apps/rails-api/.kamal/hooks/pre-build.sample
+- apps/rails-api/.kamal/hooks/pre-connect.sample
+- apps/rails-api/.kamal/hooks/pre-deploy.sample
+- apps/rails-api/.kamal/hooks/pre-proxy-reboot.sample
+- apps/rails-api/.kamal/secrets
+- apps/rails-api/.rubocop.yml
+- apps/rails-api/.ruby-version
+- apps/rails-api/Dockerfile
+- apps/rails-api/Gemfile
+- apps/rails-api/Gemfile.lock
+- apps/rails-api/README.md
+- apps/rails-api/Rakefile
+- apps/rails-api/app/controllers/application_controller.rb
+- apps/rails-api/app/controllers/home_controller.rb
+- apps/rails-api/app/jobs/application_job.rb
+- apps/rails-api/app/mailers/application_mailer.rb
+- apps/rails-api/app/models/application_record.rb
+- apps/rails-api/app/views/layouts/mailer.html.erb
+- apps/rails-api/app/views/layouts/mailer.text.erb
+- apps/rails-api/bin/brakeman
+- apps/rails-api/bin/bundle
+- apps/rails-api/bin/dev
+- apps/rails-api/bin/docker-entrypoint
+- apps/rails-api/bin/jobs
+- apps/rails-api/bin/kamal
+- apps/rails-api/bin/rails
+- apps/rails-api/bin/rake
+- apps/rails-api/bin/rubocop
+- apps/rails-api/bin/setup
+- apps/rails-api/bin/thrust
+- apps/rails-api/config.ru
+- apps/rails-api/config/application.rb
+- apps/rails-api/config/boot.rb
+- apps/rails-api/config/cable.yml
+- apps/rails-api/config/cache.yml
+- apps/rails-api/config/credentials.yml.enc
+- apps/rails-api/config/database.yml
+- apps/rails-api/config/deploy.yml
+- apps/rails-api/config/environment.rb
+- apps/rails-api/config/environments/development.rb
+- apps/rails-api/config/environments/production.rb
+- apps/rails-api/config/environments/test.rb
+- apps/rails-api/config/initializers/cors.rb
+- apps/rails-api/config/initializers/filter_parameter_logging.rb
+- apps/rails-api/config/initializers/inflections.rb
+- apps/rails-api/config/locales/en.yml
+- apps/rails-api/config/puma.rb
+- apps/rails-api/config/queue.yml
+- apps/rails-api/config/recurring.yml
+- apps/rails-api/config/routes.rb
+- apps/rails-api/config/storage.yml
+- apps/rails-api/db/cable_schema.rb
+- apps/rails-api/db/cache_schema.rb
+- apps/rails-api/db/queue_schema.rb
+- apps/rails-api/db/seeds.rb
+- apps/rails-api/public/robots.txt
+- apps/rails-api/test/controllers/home_controller_test.rb
+- apps/rails-api/test/test_helper.rb
+- apps/rails-full/.dockerignore
+- apps/rails-full/.gitattributes
+- apps/rails-full/.gitignore
+- apps/rails-full/.kamal/hooks/docker-setup.sample
+- apps/rails-full/.kamal/hooks/post-deploy.sample
+- apps/rails-full/.kamal/hooks/post-proxy-reboot.sample
+- apps/rails-full/.kamal/hooks/pre-build.sample
+- apps/rails-full/.kamal/hooks/pre-connect.sample
+- apps/rails-full/.kamal/hooks/pre-deploy.sample
+- apps/rails-full/.kamal/hooks/pre-proxy-reboot.sample
+- apps/rails-full/.kamal/secrets
+- apps/rails-full/.rubocop.yml
+- apps/rails-full/.ruby-version
+- apps/rails-full/Dockerfile
+- apps/rails-full/Gemfile
+- apps/rails-full/Gemfile.lock
+- apps/rails-full/README.md
+- apps/rails-full/Rakefile
+- apps/rails-full/app/assets/stylesheets/application.css
+- apps/rails-full/app/controllers/application_controller.rb
+- apps/rails-full/app/controllers/home_controller.rb
+- apps/rails-full/app/helpers/application_helper.rb
+- apps/rails-full/app/helpers/home_helper.rb
+- apps/rails-full/app/javascript/application.js
+- apps/rails-full/app/javascript/controllers/application.js
+- apps/rails-full/app/javascript/controllers/hello_controller.js
+- apps/rails-full/app/javascript/controllers/index.js
+- apps/rails-full/app/jobs/application_job.rb
+- apps/rails-full/app/mailers/application_mailer.rb
+- apps/rails-full/app/models/application_record.rb
+- apps/rails-full/app/views/home/index.html.erb
+- apps/rails-full/app/views/layouts/application.html.erb
+- apps/rails-full/app/views/layouts/mailer.html.erb
+- apps/rails-full/app/views/layouts/mailer.text.erb
+- apps/rails-full/app/views/pwa/manifest.json.erb
+- apps/rails-full/app/views/pwa/service-worker.js
+- apps/rails-full/bin/brakeman
+- apps/rails-full/bin/bundle
+- apps/rails-full/bin/dev
+- apps/rails-full/bin/docker-entrypoint
+- apps/rails-full/bin/importmap
+- apps/rails-full/bin/jobs
+- apps/rails-full/bin/kamal
+- apps/rails-full/bin/rails
+- apps/rails-full/bin/rake
+- apps/rails-full/bin/rubocop
+- apps/rails-full/bin/setup
+- apps/rails-full/bin/thrust
+- apps/rails-full/config.ru
+- apps/rails-full/config/application.rb
+- apps/rails-full/config/boot.rb
+- apps/rails-full/config/cable.yml
+- apps/rails-full/config/cache.yml
+- apps/rails-full/config/credentials.yml.enc
+- apps/rails-full/config/database.yml
+- apps/rails-full/config/deploy.yml
+- apps/rails-full/config/environment.rb
+- apps/rails-full/config/environments/development.rb
+- apps/rails-full/config/environments/production.rb
+- apps/rails-full/config/environments/test.rb
+- apps/rails-full/config/importmap.rb
+- apps/rails-full/config/initializers/assets.rb
+- apps/rails-full/config/initializers/clerk.rb
+- apps/rails-full/config/initializers/content_security_policy.rb
+- apps/rails-full/config/initializers/filter_parameter_logging.rb
+- apps/rails-full/config/initializers/inflections.rb
+- apps/rails-full/config/locales/en.yml
+- apps/rails-full/config/puma.rb
+- apps/rails-full/config/queue.yml
+- apps/rails-full/config/recurring.yml
+- apps/rails-full/config/routes.rb
+- apps/rails-full/config/storage.yml
+- apps/rails-full/db/cable_schema.rb
+- apps/rails-full/db/cache_schema.rb
+- apps/rails-full/db/queue_schema.rb
+- apps/rails-full/db/seeds.rb
+- apps/rails-full/public/400.html
+- apps/rails-full/public/404.html
+- apps/rails-full/public/406-unsupported-browser.html
+- apps/rails-full/public/422.html
+- apps/rails-full/public/500.html
+- apps/rails-full/public/icon.png
+- apps/rails-full/public/icon.svg
+- apps/rails-full/public/robots.txt
+- apps/rails-full/test/application_system_test_case.rb
+- apps/rails-full/test/controllers/home_controller_test.rb
+- apps/rails-full/test/test_helper.rb
+- apps/sinatra/app.rb
+- apps/sinatra/config.ru
+- apps/sinatra/views/index.erb
 - bin/console
 - bin/setup
 - clerk-sdk-ruby.gemspec
@@ -112,26 +285,17 @@ files:
 - lib/clerk/authenticatable.rb
 - lib/clerk/authenticate_context.rb
 - lib/clerk/authenticate_request.rb
+- lib/clerk/configuration.rb
 - lib/clerk/constants.rb
-- lib/clerk/errors.rb
+- lib/clerk/error.rb
 - lib/clerk/jwks_cache.rb
+- lib/clerk/proxy.rb
+- lib/clerk/rack.rb
 - lib/clerk/rack_middleware.rb
-- lib/clerk/rack_middleware_v2.rb
+- lib/clerk/rails.rb
 - lib/clerk/railtie.rb
-- lib/clerk/resources.rb
-- 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
-- lib/clerk/resources/users.rb
 - lib/clerk/sdk.rb
+- lib/clerk/sinatra.rb
 - lib/clerk/utils.rb
 - lib/clerk/version.rb
 homepage: https://github.com/clerkinc/clerk-sdk-ruby
@@ -141,7 +305,6 @@ 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
@@ -152,12 +315,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Clerk SDK for Ruby.
 test_files: []

data/CODEOWNERS

@@ -1 +0,0 @@
-* @clerkinc/backend

data/lib/clerk/errors.rb

@@ -1,22 +0,0 @@
-module Clerk
-  module Errors
-    class Base < StandardError
-      attr_reader :status
-
-      def initialize(msg, status:)
-        @errors = msg["errors"]
-        @status = status
-        super(msg.merge("status" => status))
-      end
-    end
-
-    class Fatal < Base
-    end
-
-    class Authentication < Base
-    end
-
-    class Configuration < StandardError
-    end
-  end
-end

data/lib/clerk/rack_middleware_v2.rb

@@ -1,167 +0,0 @@
-require "clerk"
-require_relative "authenticate_context"
-require_relative "authenticate_request"
-
-module Clerk
-  class ProxyV2
-    CACHE_TTL = 60 # seconds
-
-    attr_reader :session_claims, :session_token
-
-    def initialize(session_claims: nil, session_token: nil)
-      @session_claims = session_claims
-      @session_token = session_token
-      @session = nil
-    end
-
-    def session
-      return nil if @session_claims.nil?
-
-      @session ||= verify_session
-    end
-
-    def verify_session
-      return nil if @session_claims.nil?
-
-      sdk.sessions.verify_token(@session_claims["sid"], @session_token)
-    end
-
-    def user
-      return nil if user_id.nil?
-
-      @user ||= fetch_user(user_id)
-    end
-
-    def user_id
-      return nil if @session_claims.nil?
-
-      @session_claims["sub"]
-    end
-
-    def org
-      return nil if org_id.nil?
-
-      @org ||= fetch_org(org_id)
-    end
-
-    def org_id
-      return nil if user_id.nil?
-
-      @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)
-      cached_fetch("clerk_user:#{user_id}") do
-        sdk.users.find(user_id)
-      end
-    end
-
-    def fetch_org(org_id)
-      cached_fetch("clerk_org:#{org_id}") do
-        sdk.organizations.find(org_id)
-      end
-    end
-
-    def cached_fetch(key, &block)
-      if store = Clerk.configuration.middleware_cache_store
-        store.fetch(key, expires_in: CACHE_TTL, &block)
-      else
-        yield
-      end
-    end
-
-    def sdk
-      @sdk ||= Clerk::SDK.new
-    end
-  end
-
-  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
-
-      auth_context = AuthenticateContext.new(req, Clerk.configuration)
-      auth_request = AuthenticateRequest.new(auth_context)
-
-      status, auth_request_headers, body = auth_request.resolve(env)
-      return [status, auth_request_headers, body] if status
-      
-      status, headers, body = @app.call(env)
-
-      if !auth_request_headers.empty?
-        # Remove them to avoid overriding existing cookies set in headers by other middlewares
-        auth_request_cookies = auth_request_headers.delete(COOKIE_HEADER)
-        # merge non-cookie related headers into response headers
-        headers.merge!(auth_request_headers)
-
-        set_cookie_headers!(headers, auth_request_cookies) if auth_request_cookies
-      end
-
-      [status, headers, body]
-    end
-
-    private
-
-    def set_cookie_headers!(headers, cookie_headers)
-      cookie_headers.each do |cookie_header|
-        cookie_key = cookie_header.split(';')[0].split('=')[0]
-        cookie =  Rack::Utils.parse_cookies_header(cookie_header)
-        cookie_params = convert_http_cookie_to_cookie_setter_params(cookie, cookie_key)
-        Rack::Utils.set_cookie_header!(headers, cookie_key, cookie_params)
-      end
-    end
-
-    def convert_http_cookie_to_cookie_setter_params(cookie, cookie_key)
-      # convert cookie to to match cookie setter method params (lowercase symbolized keys with `:value` key)
-      cookie_params = cookie.transform_keys { |k| k.downcase.to_sym }
-      # drop the current cookie name key to avoid polluting the expected cookie params
-      cookie_params[:value] = cookie.delete(cookie_key)
-      # fix issue with cookie expiration expected to be Date type
-      cookie_params[:expires] = Date.parse(cookie_params[:expires]) if cookie_params[:expires]
-      
-      cookie_params
-    end
-  end
-end

data/lib/clerk/resources/allowlist.rb

@@ -1,16 +0,0 @@
-require "forwardable"
-require_relative "singular_resource"
-
-module Clerk
-  module Resources
-    class Allowlist
-      extend Forwardable
-
-      def initialize(client)
-        @resource = SingularResource.new(client, "beta_features/allowlist")
-      end
-
-      def_delegators :@resource, :update
-    end
-  end
-end

data/lib/clerk/resources/allowlist_identifiers.rb

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

data/lib/clerk/resources/clients.rb

@@ -1,23 +0,0 @@
-require "forwardable"
-require_relative "plural_resource"
-
-module Clerk
-  module Resources
-    class Clients
-      extend Forwardable
-
-      def initialize(client)
-        @client = client
-        @resource = PluralResource.new(client, "clients")
-      end
-
-      def verify_token(token)
-        @client.request(:post, "#{@resource.collection_path}/verify",
-                        body: {token: token})
-      end
-
-      def_delegators :@resource, :all, :find
-    end
-  end
-end
-

data/lib/clerk/resources/email_addresses.rb

@@ -1,17 +0,0 @@
-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/emails.rb

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

data/lib/clerk/resources/jwks.rb

@@ -1,18 +0,0 @@
-require "forwardable"
-require_relative "plural_resource"
-
-module Clerk
-  module Resources
-    class JWKS
-      extend Forwardable
-
-      def initialize(client)
-        @client = client
-      end
-
-      def all(timeout: 5)
-        @client.request(:get, "jwks", timeout: timeout)
-      end
-    end
-  end
-end

data/lib/clerk/resources/organizations.rb

@@ -1,73 +0,0 @@
-require "forwardable"
-require_relative "plural_resource"
-
-module Clerk
-  module Resources
-    class Organizations
-      extend Forwardable
-
-      def initialize(client)
-        @client = client
-        @resource = PluralResource.new(client, "organizations")
-      end
-
-      def_delegators :@resource, :all, :find, :create, :update, :delete
-
-      def update_metadata(org_id, private_metadata: {}, public_metadata: {})
-        data = {}
-        data["private_metadata"] = private_metadata.to_json if !private_metadata.empty?
-        data["public_metadata"] = public_metadata.to_json if !public_metadata.empty?
-
-        @client.request(:patch, "#{@resource.resource_path(org_id)}/metadata", body: data)
-      end
-
-      #
-      # Invitations
-      #
-      def pending_invitations(org_id, query_params = {})
-        @client.request(:get, "#{invitations_path(org_id)}/pending", query: query_params)
-      end
-
-      def create_invitation(org_id, data)
-        @client.request(:post, invitations_path(org_id), body: data)
-      end
-
-      def revoke_invitation(org_id, invitation_id, data)
-        @client.request(:post, "#{invitations_path(org_id, invitation_id)}/revoke", body: data)
-      end
-
-      #
-      # Memberships
-      #
-      def memberships(org_id, query_params = {})
-        @client.request(:get, memberships_path(org_id), query: query_params)
-      end
-
-      def create_membership(org_id, data)
-        @client.request(:post, memberships_path(org_id), body: data)
-      end
-
-      def update_membership(org_id, user_id, data)
-        @client.request(:patch, memberships_path(org_id, user_id), body: data)
-      end
-
-      def delete_membership(org_id, user_id)
-        @client.request(:delete, memberships_path(org_id, user_id))
-      end
-
-      private
-
-      def invitations_path(org_id, invitation_id=nil)
-        path = "#{@resource.resource_path(org_id)}/invitations"
-        path << "/#{invitation_id}" if invitation_id
-        path
-      end
-
-      def memberships_path(org_id, user_id=nil)
-        path = "#{@resource.resource_path(org_id)}/memberships"
-        path << "/#{user_id}" if user_id
-        path
-      end
-    end
-  end
-end

data/lib/clerk/resources/phone_numbers.rb

@@ -1,17 +0,0 @@
-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