sinatra-portier 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5775c72ef60b996019c367445bd97aa6a4dd708586e1b16017a211bd5d8f26fa
-  data.tar.gz: 0432d790f5786785e7cc27747183530e6fd3d175953124ecc55c0624d3c92441
+  metadata.gz: 642765d420d438014584936cf81a6b0d837e8d0121063a20103360a042cdbc7b
+  data.tar.gz: 917725a06011719d6e6cf490772222d939d3a050c80a433e9de52adee903f669
 SHA512:
-  metadata.gz: 1de7ef55a194edae5ed32618be1527e5b9873b6f5a80406e167f4883c07757c2284b3eb86b187254241f305ef7642ebfd63e3fc8691baf139b15f8ffaad589c1
-  data.tar.gz: ebbb833c8dc072e230edbee513c29736165d93301dde85d4714bd0e6f9b7405208ead1220a45782a22e7dc8f7a7fd304b745ccda983428c26d2d5bdc837b4cf1
+  metadata.gz: 35d28839424d126f05eda54d752357d290e4bbcba7aa7f45de5bd9464f2756abe65e55e540851e1e71f7afd2693e9a003c87a6934b9c167df0e455bf9b098f1f
+  data.tar.gz: b549f301831e584ab7ff45e4afe85547d75c2de6e287a9922b080fa0d20e0e1acee83146d45188cfca186c6fe4a99df55433af987910aeac6e133094b85124ca

data/README.md

@@ -1,4 +1,6 @@
-Sinatra plugin that allows authentication against portier, the successor for [Persona](https://github.com/mozilla/persona). Like Persona, this lets you verify the email identity of a user.
+Sinatra plugin that allows authentication against portier, the successor for
+[Persona](https://github.com/mozilla/persona). Like Persona, this lets you verify the email
+identity of a user.
 
 To be a drop-in replacement, the code keeps using the browserid namespace.
 
@@ -6,7 +8,8 @@ To be a drop-in replacement, the code keeps using the browserid namespace.
 
 To learn more, [read about portier](https://portier.github.io/).
 
-Note that logins are not done from within a form on your site -- you provide a login form, and that will start up the login flow and redirect back to your main page.
+Note that logins are not done from within a form on your site -- you provide a login form, and that
+will start up the login flow and redirect back to your main page.
 
 ## How to get started
 
@@ -66,6 +69,21 @@ Available sinatra settings:
  * <tt>:browserid_url</tt>: If you're using an alternate auth provider
   other than https://broker.portier.io
  * <tt>:browserid_login_url</tt>: URL users get redirected to when the
-  <tt>authorize!(redirect: nil)</tt> helper is called and a user is not logged in. `redirect` is an optional parameter to set the redirect target on the function call instead.
+  <tt>authorize!(redirect: nil)</tt> helper is called and a user is not logged in. `redirect` is an
+  optional parameter to set the redirect target on the function call instead.
  * <tt>:browserid_button_class</tt>: Css class of the login button
  * <tt>:browserid_button_text</tt>: Text of the login button
+
+## Multiprocess environment
+
+To use this gem with a multiprocess app server (like when puma got started with `-w n` and n > 1),
+you can use memcached. Install the `dalli` gem with a working memcached server.
+
+Background: Originally, this gem used the session to store a nonce whenever a user was sent off to
+the broker. However, in some server or browser configurations that session was reset when the user
+came back (see https://github.com/sinatra/sinatra/issues/1742). As a workaround a local cache is
+used that was initially only stored in memory - but this wasn't shared over multiple processes in
+at least one test environment. The memcached server is a solution for that, as its content does get
+shared over multiple processes.
+
+To be extended in future iterations.

data/lib/sinatra/browserid.rb

@@ -19,18 +19,18 @@ require 'moneta'
 module Sinatra
     module BrowserID
 
-        # Init an in-memory cache via the cachy gem. We use this
+        # Init an cache via the cachy gem. We use this
         # instead of the session because of dropped sessions
         # after redirects, see https://github.com/sinatra/sinatra/issues/1742.
-        #Cachy.cache_store = Moneta.new(settings.browserid_cache_store == :memcached ? :Memcached : :Memory, expires: 600) # 10 minutes
         begin
+            # To avoid issues when the outer server is run in multiprocess mode (like puma -w), we
+            # offer the option here to use a cache backend that will remain consistent over
+            # processes. Currently dalli for memcached, can be expanded.
             require 'dalli'
             Cachy.cache_store = Moneta.new(:Memcached, expires: 600)
-            p 'dalli'
-        rescue
+        rescue LoadError
             Cachy.cache_store = Moneta.new(:Memory, expires: 600) # 10 minutes
                                                               # We need to set a global :expires here because of https://github.com/grosser/cachy/issues/7
-            p 'memory'
         end
     
         def self.registered(app)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-portier
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Pete Fritchman
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Sinatra extension for user authentication with portier