clerk-sdk-ruby 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 348624d72466db1c264e0ba1044b4dcda33e1d7327791bc1732266d45a84ca00
-  data.tar.gz: 1f4732763f8b27000fc55949652bad8d8ed36b54bb52ee8d43c0875b9c61e272
+  metadata.gz: cef3c6d803258b6f1e265dad2cd2de936f96c50df20b87cfbf2b925c37ecd443
+  data.tar.gz: d280a0b94a0fa8a89d267a7af6915171c5e4860a21fafad2c400f9c3a1610126
 SHA512:
-  metadata.gz: de828320ec3e92b3e3d0b5b9f584058fff86fe8b632616fd82af3de5a5398c5459b747262deed243c83319641e5a294d0c01b30bd1714e4711d72007d3b5e722
-  data.tar.gz: e65292535f0d1fa5a0a01e24d832af97b467c8a563cff73c08eb64b54a9946440c2888bcf18125dbdc7fc7b97404aa69d85bb3e982b1a826567fa7e63affb25a
+  metadata.gz: 3784def3d89def58174ee71733119162a4e579ac99ee4b016bbea7d234e28caa71e59d0c74e3cf3b06b557164ed81c9cdb9630d000929656e4cc4dcb16254861
+  data.tar.gz: 0f71e96b2781cdfbade6173cb28f9ea14d6f61b4dcd11014dc95b8baa2d45c660ea4d1c21ff5fa87c1bbb60daff8d6eab1c61d354a8f45be21e282e585390ef3

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## unreleased
+
+## 1.0.2 - 2021-06-03
+
+- fix: Instantiation of `Clerk::SDK` without prior call to `Clerk.configure`
+
+## 1.0.1 - 2021-06-03
+
+### enhancements
+
+- Middleware now uses a proxy object which lazy loads the Clerk session and user only when needed
+
+## 1.0.0 - 2021-05-27
+
+- initial release

data/Gemfile.lock

@@ -1,18 +1,22 @@
 PATH
   remote: .
   specs:
-    clerk-sdk-ruby (1.0.0)
+    clerk-sdk-ruby (1.0.2)
       faraday (~> 1.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    faraday (1.4.1)
+    faraday (1.4.2)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
       faraday-net_http (~> 1.0)
       faraday-net_http_persistent (~> 1.1)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.1.0)

data/README.md

@@ -63,10 +63,10 @@ supported configuration settings their environment variable equivalents:
 
 ```ruby
 Clerk.configure do |c|
-  c.api_key = "your_api_key" # if omitted: ENV.fetch("CLERK_API_KEY") - will fail if unset
+  c.api_key = "your_api_key" # if omitted: ENV["CLERK_API_KEY"] - API calls will fail if unset
   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: Rails.cache or no caching (if not in a Rails app)
+  c.middleware_cache_store = ActiveSupport::Cache::FileStore.new("/tmp/clerk_middleware_cache") # if omitted: no caching
 end
 ```
 
@@ -94,17 +94,17 @@ for details.
 
 ## Rack middleware
 
-The SDK comes with a Rack middleware which sets the Clerk session and user in
-the Rack environment. The keys are: `clerk_session` and `clerk_user` for the
-session and user respectively. If the API responds with an error `clerk_error`
-will be set.
+The SDK comes with a Rack middleware which lazily loads the Clerk session and
+user. It inserts a `clerk` key in the Rack environment, which is an instance
+of `Clerk::Proxy`. To get the session or the user of the session, you call
+`session` or `user` respectively. In case there is no session, you can retrieve
+the API error with the `error` getter method.
 
 ## Rails integration
 
 The SDK will automatically add the [Rack middleware](#rack-middleware) to the
-middleware stack, using `Rails.cache` for its cache. For easier access to the
-Clerk session and user, include the `Clerk::Authenticatable` concern in your
-controller:
+middleware stack. For easier access to the Clerk session and user, include the
+`Clerk::Authenticatable` concern in your controller:
 
 ```ruby
 require "clerk/authenticatable"

data/lib/clerk.rb

@@ -5,12 +5,13 @@ require_relative "clerk/sdk"
 
 module Clerk
   class << self
-    attr_accessor :configuration
-
     def configure
-      self.configuration ||= Config.new
       yield(configuration)
     end
+
+    def configuration
+      @configuration ||= Config.new
+    end
   end
 
   class Config
@@ -19,7 +20,7 @@ module Clerk
 
     def initialize
       @base_url = ENV.fetch("CLERK_API_BASE", PRODUCTION_BASE_URL)
-      @api_key = ENV.fetch("CLERK_API_KEY")
+      @api_key = ENV["CLERK_API_KEY"]
     end
   end
 end

data/lib/clerk/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clerk-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Clerk
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt