sinatra-session_helpers 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1055db28b1aa44b5fa3791f60ba17fdb3f407db7
-  data.tar.gz: 327271558c5b3496b2ee52de0c3fcd93d710d4b9
+  metadata.gz: 7838404449cb5ca64f475784682933a9908da031
+  data.tar.gz: 9fb0e9582dd20b644428ffa758c163db4e0da060
 SHA512:
-  metadata.gz: 1f2aeec69bc7a26d48596b4f7c9abc05b66fc595d08019ef0d2ee7e5b817627cda9b93b18becdf1014087abecf9f6d37d6eedc9ead81f19b27fd3d10f0cc227d
-  data.tar.gz: e8695777493c024fd6cb1f39df6785aeff3e0bdbb1781cf2ab932b32f6bcf010bdde6343577e4255f20e0a0aac3b87564013b00479451cc3be035f5825d6b365
+  metadata.gz: 382c9678756366ac115562877839f8fe98797c2750ae52cf762bed9ba48ef950a49497afd8408dc23849d43e9aafe87e890adec6114644a0741d9cd3cdd7ed78
+  data.tar.gz: f6f8f5ee6bcc5039e8d37ce54e7542b93031c33d84bd66419370357405890f4cf19a049f96a3ee440349b50859ca3c9e62a9532a160c76fe44d06671773bbbfb

data/README.md

@@ -22,34 +22,44 @@ Or install it yourself as:
 
 ## Usage
 
-### Helper Methods
+### [Enable Sessions](http://www.sinatrarb.com/faq.html#sessions)
+
+Since 0.2.0, this gem doesn't automatically enable sessions.
+This means **you have to enable sessions in your app.**
+
+This is so you can choose how to enable them, like using `Rack::Session::Cookie` if you need.
+
+Enable Sinatra built-in sessions:
 
 ```ruby
-`session_start!`             -> Starts the session
-`session_end!(destroy=true)` -> Ends the session. If `destroy` is false then 
-                                session data will be preserved, even though future calls to `session?` will return false
-`session?`                   -> Returns true if the session is valid
-`session!`                   -> Redirects the client to the URL specified in 
-                                the `session_fail` option unless the session is valid
+enable :sessions
 ```
 
-### Settings
+Or, if you need to set additional parameters for sessions, like expiration date, use `Rack::Session::Cookie` directly instead of `enable :sessions` (example from Rack documentation):
 
+```ruby
+use Rack::Session::Cookie, :key => 'rack.session',
+                           :domain => 'foo.com',
+                           :path => '/',
+                           :expire_after => 2592000, # In seconds
+                           :secret => 'change_me'
 ```
-`session_fail`   -> A URL in your app that the client will be redirected to
-                    when `session!` is called and the session is not valid.
-                    Defaults to '/login'
-```
+
+#### Advanced Sinatra built-in sessions parameters
+
+Here's how to do if you want to use Sinatra's built-in sessions, instead of `Rack::Session::Cookie`, and still specify additional parameters.
 
 You can force a specific secret key on the session:
 
 ```ruby
+enable :sessions
 set :session_secret, '$ecR3t'
 ```
 
 Or other optional parameters like this:
 
 ```ruby
+enable :sessions
 set :sessions, :key          => 'sinatra.session',
                :path         => '/',
                :domain       => 'foo.com',
@@ -57,6 +67,25 @@ set :sessions, :key          => 'sinatra.session',
                :secret       => 'change_me'
 ```
 
+### Helper Methods
+
+```ruby
+`session_start!`             -> Starts the session
+`session_end!(destroy=true)` -> Ends the session. If `destroy` is false then 
+                                session data will be preserved, even though future calls to `session?` will return false
+`session?`                   -> Returns true if the session is valid
+`session!`                   -> Redirects the client to the URL specified in 
+                                the `session_fail` option unless the session is valid
+```
+
+### Settings
+
+```
+`session_fail`   -> A URL in your app that the client will be redirected to
+                    when `session!` is called and the session is not valid.
+                    Defaults to '/login'
+```
+
 ## Examples
 
 As with all Sinatra extensions, Sinatra::SessionHelpers may be used in both classic and modular-style apps. First, classic.
@@ -65,6 +94,7 @@ As with all Sinatra extensions, Sinatra::SessionHelpers may be used in both clas
 require 'sinatra'
 require 'sinatra/session_helpers'
 
+enable :sessions
 set :session_fail, '/login'
 set :session_secret, 'So0perSeKr3t!'
 set :sessions, :key => 'my_app'

data/lib/sinatra/session_helpers.rb

@@ -35,9 +35,6 @@ module Sinatra
 
       # This should be set to the redirect URL the client will be sent to if the session is not valid.
       app.set :session_fail, '/login'
-
-      # Enable Sinatra built-in sessions
-      app.enable :sessions
     end
   end
 

data/lib/sinatra/session_helpers/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module SessionHelpers
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-session_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Julien Ma
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra