sinatra-session_helpers 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1055db28b1aa44b5fa3791f60ba17fdb3f407db7
+  data.tar.gz: 327271558c5b3496b2ee52de0c3fcd93d710d4b9
+SHA512:
+  metadata.gz: 1f2aeec69bc7a26d48596b4f7c9abc05b66fc595d08019ef0d2ee7e5b817627cda9b93b18becdf1014087abecf9f6d37d6eedc9ead81f19b27fd3d10f0cc227d
+  data.tar.gz: e8695777493c024fd6cb1f39df6785aeff3e0bdbb1781cf2ab932b32f6bcf010bdde6343577e4255f20e0a0aac3b87564013b00479451cc3be035f5825d6b365

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-session_helpers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Julien Ma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+# Sinatra::SessionHelpers
+
+Helper methods for Sinatra's :sessions management
+
+This is the same code than https://github.com/mjackson/sinatra-session, but adapted to use Sinatra's built-in `sessions`, instead of `Rack::Session::Cookie`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-session_helpers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-session_helpers
+
+## Usage
+
+### 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'
+```
+
+You can force a specific secret key on the session:
+
+```ruby
+set :session_secret, '$ecR3t'
+```
+
+Or other optional parameters like this:
+
+```ruby
+set :sessions, :key          => 'sinatra.session',
+               :path         => '/',
+               :domain       => 'foo.com',
+               :expire_after => 2592000, # 30 days
+               :secret       => 'change_me'
+```
+
+## Examples
+
+As with all Sinatra extensions, Sinatra::SessionHelpers may be used in both classic and modular-style apps. First, classic.
+
+```ruby
+require 'sinatra'
+require 'sinatra/session_helpers'
+
+set :session_fail, '/login'
+set :session_secret, 'So0perSeKr3t!'
+set :sessions, :key => 'my_app'
+
+get '/' do
+  session!
+  'Hello, ' + session[:name] + '! Click <a href="/logout">here</a> to logout.'
+end
+
+get '/login' do
+  if session?
+    redirect '/'
+  else
+    '<form method="POST" action="/login">' +
+    'Please enter your name: <input type="text" name="name">' +
+    '<input type="submit" value="Submit">' +
+    '</form>'
+  end
+end
+
+post '/login' do
+  if params[:name]
+    session_start!
+    session[:name] = params[:name]
+    redirect '/'
+  else
+    redirect '/login'
+  end
+end
+
+get '/logout' do
+  session_end!
+  redirect '/'
+end
+```
+
+Modular apps use very similar code but must also mixin Sinatra::Session via Sinatra#register, like so:
+
+```ruby
+require 'sinatra/base'
+require 'sinatra/session_helpers'
+
+class MyApp < Sinatra::Base
+  register Sinatra::Session
+
+  # insert settings and routes here, same as in
+  # classic example above
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julienma/sinatra-session_helpers.
+
+
+## License
+
+Copyright 2016 Julien Ma
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+Based on software code Copyright 2012 Michael Jackson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+The software is provided "as is", without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and non-infringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sinatra/session_helpers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sinatra/session_helpers/version.rb

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

data/lib/sinatra/session_helpers.rb

@@ -0,0 +1,45 @@
+require 'sinatra/base'
+require "sinatra/session_helpers/version"
+
+module Sinatra
+  module SessionHelpers
+
+    module Helpers
+      # After this method is called, calls to #session? will return +true+.
+      def session_start!
+        session[:authorized] = true
+      end
+
+      # After this method is called, calls to #session? will return +false+. If you want to keep the old session data around in the cookie for some reason, set +destroy+ to +false+.
+      def session_end!(destroy=true)
+        if destroy
+          session.clear
+        else
+          session[:authorized] = false
+        end
+      end
+
+      # Returns +true+ if the current session is valid, +false+ otherwise.
+      def session?
+        !! session[:authorized]
+      end
+
+      # Redirects the client to the URL given in the +session_fail+ setting if #session? returns +false+.
+      def session!
+        redirect(settings.session_fail) unless session? || settings.session_fail == request.path_info
+      end
+    end
+
+    def self.registered(app)
+      app.helpers SessionHelpers::Helpers
+
+      # 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
+
+  register SessionHelpers
+end

data/sinatra-session_helpers.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/session_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-session_helpers"
+  spec.version       = Sinatra::SessionHelpers::VERSION
+  spec.authors       = ["Julien Ma"]
+  spec.email         = ["julienma@users.noreply.github.com"]
+
+  spec.summary       = %q{Helper methods for Sinatra's :sessions management.}
+  spec.homepage      = "https://github.com/julienma/sinatra-session_helpers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sinatra", "~> 1.4.0"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-session_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Julien Ma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- julienma@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sinatra/session_helpers.rb
+- lib/sinatra/session_helpers/version.rb
+- sinatra-session_helpers.gemspec
+homepage: https://github.com/julienma/sinatra-session_helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.1
+signing_key: 
+specification_version: 4
+summary: Helper methods for Sinatra's :sessions management.
+test_files: []