sinatra-session 0.1

data/README

@@ -0,0 +1,119 @@
+Sinatra::Session
+================
+
+Sinatra::Session is a small extension for Sinatra apps that provides several
+convenience settings and methods when working with cookie-based sessions.
+
+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'
+  session_name   -> The name to use for the session cookie
+  session_path   -> The session cookie path
+  session_domain -> The session cookie domain
+  session_expire -> The number of seconds from now the cookie will be valid
+  session_secret -> A secret key that is used to check the integrity of
+                    session data
+
+Helper Methods
+--------------
+
+  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
+
+Installation
+------------
+
+Via Rubygems:
+
+    $ sudo gem install sinatra-session
+
+From a local copy:
+
+    $ git clone git://github.com/mjijackson/sinatra-session.git
+    $ cd sinatra-session
+    $ rake package && sudo rake install
+
+Usage
+-----
+
+As with all Sinatra extensions, Sinatra::Session may be used in both classic
+and modular-style apps. First, classic.
+
+    set :session_fail, '/login'
+    set :session_secret, 'So0perSeKr3t!'
+
+    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:
+
+    require 'sinatra/base'
+    require 'sinatra/session'
+
+    class MyApp < Sinatra::Base
+      register Sinatra::Session
+
+      # insert settings and routes here, same as in
+      # classic example above
+    end
+
+License
+-------
+
+Copyright 2010 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 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/Rakefile

@@ -0,0 +1,39 @@
+require 'rake/clean'
+
+task :default => :package
+
+CLEAN.include %w< dist >
+
+# PACKAGING & INSTALLATION ####################################################
+
+if defined?(Gem)
+  $spec = eval("#{File.read('sinatra-session.gemspec')}")
+
+  directory 'dist'
+
+  def package(ext='')
+    "dist/#{$spec.name}-#{$spec.version}" + ext
+  end
+
+  file package('.gem') => %w< dist > + $spec.files do |f|
+    sh "gem build sinatra-session.gemspec"
+    mv File.basename(f.name), f.name
+  end
+
+  file package('.tar.gz') => %w< dist > + $spec.files do |f|
+    sh "git archive --format=tar HEAD | gzip > #{f.name}"
+  end
+
+  desc "Build packages"
+  task :package => %w< .gem .tar.gz >.map {|e| package(e) }
+
+  desc "Build and install as local gem"
+  task :install => package('.gem') do |t|
+    sh "gem install #{package('.gem')}"
+  end
+
+  desc "Upload gem to rubygems.org"
+  task :release => package('.gem') do |t|
+    sh "gem push #{package('.gem')}"
+  end
+end

data/lib/sinatra/session.rb

@@ -0,0 +1,72 @@
+require 'sinatra/base'
+
+module Sinatra
+  module Session
+
+    # Request-level helper methods for Sinatra routes.
+    module Helpers
+      # After this method is called, calls to #sesson? will return +true+.
+      def session_start!
+        session['sinatra.session'] = 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['sinatra.session'] = false
+        end
+      end
+
+      # Returns +true+ if the current session is valid, false otherwise.
+      def session?
+        !! session['sinatra.session']
+      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?
+      end
+    end
+
+    # A wrapper for Rack::Session::Cookie middleware that allows an options
+    # hash to be returned from the block given to the `use` statement instead
+    # of being provided up front.
+    module Cookie
+      def self.new(app, options={})
+        options.merge!(yield) if block_given?
+        Rack::Session::Cookie.new(app, options)
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Session::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'
+
+      # Parameters for the session cookie.
+      app.set :session_name, 'sinatra.session'
+      app.set :session_path, '/'
+      app.set :session_domain, nil
+      app.set :session_expire, nil
+      app.set :session_secret, nil
+
+      app.use(Session::Cookie) do
+        { :key          => app.session_name,
+          :path         => app.session_path,
+          :domain       => app.session_domain,
+          :expire_after => app.session_expire,
+          :secret       => app.session_secret
+        }
+      end
+    end
+  end
+
+  register Session
+end

data/sinatra-session.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name = 'sinatra-session'
+  s.version = '0.1'
+  s.date = '2010-04-21'
+
+  s.summary = 'Simple session support for Sinatra apps'
+  s.description = 'Simple session support for Sinatra apps'
+
+  s.author = 'Michael Jackson'
+  s.email = 'mjijackson@gmail.com'
+
+  s.require_paths = %w< lib >
+
+  s.files = Dir['lib/**/*.rb'] +
+    %w< sinatra-session.gemspec Rakefile README >
+
+  s.add_dependency('sinatra', '>= 1.0')
+  s.add_development_dependency('rake')
+
+  s.has_rdoc = true
+  s.rdoc_options = %w< --line-numbers --inline-source --title Sinatra::Session --main Sinatra::Session >
+  s.extra_rdoc_files = %w< README >
+
+  s.homepage = 'http://github.com/mjijackson/sinatra-session'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-session
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Michael Jackson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-21 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Simple session support for Sinatra apps
+email: mjijackson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/sinatra/session.rb
+- sinatra-session.gemspec
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://github.com/mjijackson/sinatra-session
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Sinatra::Session
+- --main
+- Sinatra::Session
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple session support for Sinatra apps
+test_files: []
+