rack-devise_cookie_auth 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## 0.1.0 - January 9, 2013
+
+### Initial release
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+[@rymai]: https://github.com/rymai

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jilion SA
+
+MIT License
+
+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,85 @@
+Rack::DeviseCookieAuth [![Build Status](https://secure.travis-ci.org/jilion/rack-devise_cookie_auth.png?branch=master)](http://travis-ci.org/jilion/rack-devise_cookie_auth) [![Dependency Status](https://gemnasium.com/jilion/rack-devise_cookie_auth.png)](https://gemnasium.com/jilion/rack-devise_cookie_auth) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jilion/rack-devise_cookie_auth)
+=====
+
+Rack::DeviseCookieAuth allows to log-in from a [Devise](https://github.com/plataformatec/devise) remember-me token stored in a cookie.
+
+It depends on Active::Support >= 2.3.2 and is tested against Ruby 1.9.2, 1.9.3, ruby-head and the latest versions of Rubinius & JRuby.
+
+## Installation
+
+Add this line to your application's Gemfile (probably in the `:production` group only):
+
+```ruby
+gem 'rack-devise_cookie_auth'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Basic Usage
+
+If you don't use Bundler, be sure to require Rack::DeviseCookieAuth manually before actually using the middleware:
+
+```ruby
+ require 'rack/devise_cookie_auth'
+ use Rack::DeviseCookieAuth, secret: 'YOUR_SESSION_SECRET'
+```
+
+To use Rack::DeviseCookieAuth in your Rails application, add the following line to your application config file (`config/application.rb` or `config/environments/production.rb`) for Rails 3, `config/environment.rb` for Rails 2):
+
+```ruby
+config.use Rack::DeviseCookieAuth, secret: 'YOUR_SESSION_SECRET'
+
+# or if you're using Rack::Cache, be sure to insert Rack::DeviseCookieAuth before
+config.middleware.insert_before Rack::Cache, Rack::DeviseCookieAuth, secret: 'YOUR_SESSION_SECRET'
+```
+
+Please note that the `:secret` option is mandatory and can normally be found in the 'config/initializers/secret_token.rb' file of your Rails app.
+
+## Options
+
+### Resource name
+
+By default, the middleware will look for the user resource cookie named "remember_user_token" but if want to use authenticate againts another resource name you can set it with the `:resource` option:
+
+```ruby
+config.middleware.use Rack::DeviseCookieAuth, secret: 'YOUR_SESSION_SECRET', resource: 'admin'
+```
+
+### Redirection URL
+
+By default, the middleware will redirect to the root path of the current domain but you can customize the redirection path with the `:redirect_to` option:
+
+```ruby
+# It can be a path...
+config.middleware.use Rack::DeviseCookieAuth, secret: 'YOUR_SESSION_SECRET', redirect_to: '/login'
+
+# ... or a full URL
+config.middleware.use Rack::DeviseCookieAuth, secret: 'YOUR_SESSION_SECRET', redirect_to: 'https://yourdomain.com/login'
+```
+
+Development
+-----------
+
+* Documentation hosted at [RubyDoc](http://rubydoc.info/github/jilion/rack-devise_cookie_auth/master/frames).
+* Source hosted at [GitHub](https://github.com/jilion/rack-devise_cookie_auth).
+
+Pull requests are very welcome! Please try to follow these simple rules if applicable:
+
+* Please create a topic branch for every separate change you make.
+* Make sure your patches are well tested.
+* Update the [README](https://github.com/jilion/rack-devise_cookie_auth/blob/master/README.md).
+* Update the [CHANGELOG](https://github.com/jilion/rack-devise_cookie_auth/blob/master/CHANGELOG.md) for noteworthy changes.
+* Please **do not change** the version number.
+
+### Authors
+
+* [Rémy Coutable](https://github.com/rymai) ([@rymai](http://twitter.com/rymai), [rymai.me](http://rymai.me))
+* [Thibaud Guillaume-Gentil](https://github.com/thibaudgg) ([@thibaudgg](http://twitter.com/thibaudgg), [thibaud.me](http://thibaud.me))
+
+### Contributors
+
+[https://github.com/jilion/rack-devise_cookie_auth/graphs/contributors](https://github.com/jilion/rack-devise_cookie_auth/contributors)

data/lib/rack/devise_cookie_auth.rb

@@ -0,0 +1,59 @@
+require 'rack/devise_cookie_auth/version'
+require 'active_support/message_verifier'
+
+module Rack
+  class DeviseCookieAuth
+    DEFAULT_OPTIONS = {
+      resource: 'user',
+      redirect_to: nil
+    }
+    def initialize(app, options = {})
+      raise ArgumentError, 'Cookie secret must be set!' if options[:secret].nil?
+
+      @app, @options = app, DEFAULT_OPTIONS.merge(options)
+    end
+
+    def call(env)
+      @request = Rack::Request.new(env)
+
+      verifier = ActiveSupport::MessageVerifier.new(@options[:secret])
+      resource_ids, remember_key = verifier.verify(@request.cookies[cookie_name])
+      env["current_#{resource}_id"] = resource_ids.first
+
+      @app.call(env)
+    rescue ActiveSupport::MessageVerifier::InvalidSignature
+      redirect!
+    end
+
+    private
+
+    def redirect!
+      [302, { 'Content-Type' => 'text/html', 'Location' => redirect_url }, ["Redirected to #{redirect_url}!"]]
+    end
+
+    def resource
+      @options[:resource].to_s
+    end
+
+    def cookie_name
+      "remember_#{resource}_token"
+    end
+
+    def redirect_url
+      [redirect_to, return_to].compact.join('?')
+    end
+
+    def redirect_to
+      if @options[:redirect_to] =~ %r{\Ahttps?://}
+        @options[:redirect_to]
+      else
+        @request.url.sub(@request.fullpath, "/#{@options[:redirect_to]}".squeeze('/').sub(%r{/\z}, '') || '')
+      end
+    end
+
+    def return_to
+      "#{resource}_return_to=#{@request.url}"
+    end
+
+  end
+end

data/lib/rack/devise_cookie_auth/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class DeviseCookieAuth
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: rack-devise_cookie_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rémy Coutable
+- Thibaud Guillaume-Gentil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Rack middleware to log in from a "remember me" Devise cookie.
+email:
+- remy@jilion.com
+- thibaud@jilion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/devise_cookie_auth/version.rb
+- lib/rack/devise_cookie_auth.rb
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+homepage: https://github.com/jilion/rack-devise_cookie_auth
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rack middleware to log admin in from a "remember me" Devise cookie.
+test_files: []