clerk-sdk-ruby 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d51d412f89ce080c43ba0aae47f5fcdb70e5875dd37824dd492cd3d8c669f0c
-  data.tar.gz: fc772bc04d89b46c6c1e35335f4bdbb24fef2fe10d6589b8a94dd5996658d668
+  metadata.gz: 487a2987f913d5c256ebad719075bbb121af707bc5e2419f12d886f4a7a643f2
+  data.tar.gz: 28af474ba5555c26fafb0f64e4969030f0b4fc56ca3df4db3faca0a3855fd5a2
 SHA512:
-  metadata.gz: ca2fc569dce78598d650d34354d3cb0b92afd8782dc039988c38d5090122740c624780f4f8facfb7fa59902c30b6463adc8c94f40dbdff2717afa8a2a6d568b3
-  data.tar.gz: 5174ca1905a8ebbce46f582e2aac5ba961093a2139d5fe9022b7009050e794df03c904b6de51edab5d6c94a039c08a7623cda1aa4bdc6294c8c547330fbf238c
+  metadata.gz: 307f730b9fa19db0e74954e33241f917699af10d876a8314d309366ff43930c7531d204d6c939003b18cee98d4189ffbd56bc8ea12ac1536e4b7d35be68f3057
+  data.tar.gz: eef7c69d6d233a80f4c4bbd2df328c9fa3ed74cdfaa0548f1200601d1e632906f403c89e6055698c8e092e9923344202501f742be5a183ea774b59ccaecb9143

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## unreleased
 
+## 2.6.0 - 2022-11-01
+
+- feat: Implement Organization endpoints [https://github.com/clerkinc/clerk-sdk-ruby/pull/20]
+
+## 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/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clerk-sdk-ruby (2.4.0)
+    clerk-sdk-ruby (2.6.0)
       faraday (~> 1.4.1)
       jwt (~> 2.2)
 

data/README.md

@@ -1,26 +1,35 @@
-# Clerk Ruby SDK
-
+<p align="center">
+  <a href="https://www.clerk.dev/?utm_source=github&utm_medium=starter_repos&utm_campaign=sdk_ruby" target="_blank" align="center">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="./docs/clerk-logo-dark.png">
+      <img src="./docs/clerk-logo-light.png" height="64">
+    </picture>
+  </a>
+  <br />
+</p>
 
-Thank you for choosing [Clerk](https://clerk.dev/) for your authentication,
-session & user management needs!
-
-This SDK allows you to call the Clerk Backend API from Ruby code without having
-to implement the calls yourself.
+# Clerk Ruby SDK
 
-**Note**: You're looking at the main branch, which requires that you use [Auth 
-v2](https://docs.clerk.dev/main-concepts/auth-v2).
+This SDK allows you to call the [Clerk](https://www.clerk.dev/?utm_source=github&utm_medium=starter_repos&utm_campaign=sdk_ruby) Backend API from Ruby code without having to implement the calls yourself.
 
-If you're looking for the legacy authentication scheme, refer to the 
-[`v1`](https://github.com/clerkinc/clerk-sdk-ruby/tree/v1) branch.
+[![chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://discord.com/invite/b5rXHjAg7A)
+[![documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://docs.clerk.dev)
+[![twitter](https://img.shields.io/twitter/follow/ClerkDev?style=social)](https://twitter.com/intent/follow?screen_name=ClerkDev)
 
 ---
 
 **Clerk is Hiring!**
 
-Would you like to work on Open Source software and help maintain this repository? Apply today https://apply.workable.com/clerk-dev/.
+Would you like to work on Open Source software and help maintain this repository? [Apply today!](https://apply.workable.com/clerk-dev/)
 
 ---
 
+**Note**: You're looking at the main branch, which requires that you use [Auth
+v2](https://clerk.dev/docs/upgrade-guides/auth-v2).
+
+If you're looking for the legacy authentication scheme, refer to the
+[`v1`](https://github.com/clerkinc/clerk-sdk-ruby/tree/v1) branch.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -82,6 +91,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/resources/organizations.rb

@@ -0,0 +1,65 @@
+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
+
+      #
+      # 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/users.rb

@@ -24,6 +24,10 @@ module Clerk
       def disable_mfa(user_id)
         @client.request(:delete, "#{@resource.resource_path(user_id)}/mfa")
       end
+
+      def organization_memberships(user_id, query_params = {})
+        @client.request(:get, "#{@resource.resource_path(user_id)}/organization_memberships", query: query_params)
+      end
     end
   end
 end

data/lib/clerk/resources.rb

@@ -2,6 +2,7 @@ require_relative "resources/allowlist_identifiers"
 require_relative "resources/allowlist"
 require_relative "resources/clients"
 require_relative "resources/emails"
+require_relative "resources/organizations"
 require_relative "resources/sessions"
 require_relative "resources/sms_messages"
 require_relative "resources/users"

data/lib/clerk/sdk.rb

@@ -10,6 +10,7 @@ require_relative "resources/allowlist_identifiers"
 require_relative "resources/allowlist"
 require_relative "resources/clients"
 require_relative "resources/emails"
+require_relative "resources/organizations"
 require_relative "resources/sessions"
 require_relative "resources/sms_messages"
 require_relative "resources/users"
@@ -114,6 +115,10 @@ module Clerk
       Resources::Emails.new(self)
     end
 
+    def organizations
+      Resources::Organizations.new(self)
+    end
+
     def sessions
       Resources::Sessions.new(self)
     end

data/lib/clerk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Clerk
-  VERSION = "2.4.0"
+  VERSION = "2.6.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.6.0
 platform: ruby
 authors:
 - Clerk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-05 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,6 +84,8 @@ files:
 - bin/console
 - bin/setup
 - clerk-sdk-ruby.gemspec
+- docs/clerk-logo-dark.png
+- docs/clerk-logo-light.png
 - lib/clerk.rb
 - lib/clerk/authenticatable.rb
 - lib/clerk/errors.rb
@@ -97,6 +99,7 @@ files:
 - lib/clerk/resources/clients.rb
 - lib/clerk/resources/emails.rb
 - lib/clerk/resources/jwks.rb
+- lib/clerk/resources/organizations.rb
 - lib/clerk/resources/plural_resource.rb
 - lib/clerk/resources/sessions.rb
 - lib/clerk/resources/singular_resource.rb
@@ -127,7 +130,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.