clerk-sdk-ruby 2.5.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70d13c92fd01f471cd31373b72a5c4aa73784cbc4f8259dff001ed54d6bd5b0
-  data.tar.gz: 4d63622da821f4bdca7eaff4efa7d698c7666b8068f0de5add37b309e28e9dd6
+  metadata.gz: a63fa1a8677b50586e50404f49bc11c2b281fa99c2dd56e22f932f14a10c28ad
+  data.tar.gz: 797d3896292214650cd3caf2065d84fe36a6667ab24e2989ccedcde3c0b97b30
 SHA512:
-  metadata.gz: 4ce27dae71ef8f6e6335981041f40881273dc106e06973b288a1c9a089bf35bc03eaa9f561f6c4ca7b21431d7707043365fc77c8306241a85e5e60cd87667d5a
-  data.tar.gz: 8fc64101a4bde21a7ce0e137b395125554150a48bb7c93b83d595b106be7d0eb92b40d299685e98623f35f022a623bdcf6f2818dacd488d91f600aa32200a899
+  metadata.gz: 6194a064d7505ff5d9940e27a37842006401158c60f673f1f3b5425a5da4a52d05b7d77aa984495a9006e77fe376c2a7abedce1086c5c76f5e9430d13bd65a46
+  data.tar.gz: ab494cc80de603e5c9bd15b751219bdbef0ababcd611f9c190f9e1167d4b6abc6328556fcc6dc26521cc449529c028007102d1c15dfe72287056db11eb3ff05e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## 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]

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:

data/lib/clerk/authenticatable.rb

@@ -49,6 +49,18 @@ module Clerk
       request.env["clerk"].user_id
     end
 
+    # Makes a request to the Clerk API to fetch the data of the authenticated
+    # session's organization. If caching is configured (see
+    # Config.middleware_cache_store), subsequent calls will return the cached
+    # object.
+    def clerk_organization
+      request.env["clerk"].org
+    end
+
+    def clerk_organization_id
+      request.env["clerk"].org_id
+    end
+
     def clerk_user_signed_in?
       !!clerk_verified_session_claims
     end
@@ -69,7 +81,8 @@ module Clerk
       helper_method :clerk_session, :clerk_reverify_session!,
         :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_sign_up_url, :clerk_user_profile_url,
+        :clerk_organization, :clerk_organization_id
     end
   end
 end

data/lib/clerk/rack_middleware_v2.rb

@@ -36,6 +36,18 @@ module Clerk
       @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
+
     private
 
     def fetch_user(user_id)
@@ -44,6 +56,12 @@ module Clerk
       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)
@@ -105,7 +123,7 @@ module Clerk
         rescue JWT::DecodeError
           return signed_out(env)  # malformed JSON authorization header
         end
-        
+
         token = verify_token(header_token)
         return signed_in(env, token, header_token) if token
 

data/lib/clerk/resources/organizations.rb

@@ -0,0 +1,73 @@
+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/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.5.0"
+  VERSION = "2.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Clerk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2022-11-02 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