sinatra_warden 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+bin
+vendor
+
+## PROJECT::SPECIFIC

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://gemcutter.org"
+
+gem 'sinatra', '~> 0.9.4'
+gem 'warden',  '~> 0.5.0'
+
+gem 'rake',                         :only => [:test]
+gem 'rspec',          '~> 1.2.9',   :only => [:test], :require_as => 'spec'
+gem 'yard',                         :only => [:test]
+gem 'rack-test',      '~> 0.5.0',   :only => [:test], :require_as => 'rack/test'
+gem 'rcov',                         :only => [:test]
+
+gem 'do_sqlite3',     '~> 0.10.0',  :only => [:test]
+gem 'dm-core',        '~> 0.10.1',  :only => [:test]
+gem 'bcrypt-ruby',                  :only => [:test], :require_as => 'bcrypt'
+
+disable_system_gems

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 jsmestad
+
+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.rdoc

@@ -0,0 +1,43 @@
+= sinatra_warden
+
+Provides a module for basic helpers and actions needed for user 
+authentication using Warden with Sinatra. In addition to a
+collection of authentication strategies.
+
+== Usage
+
+  require 'sinatra'
+  require 'sinatra_warden'
+
+  class Application < Sinatra::Base
+    register SinatraWarden
+
+    get '/admin' do
+      authorize!('/login') # require session, redirect to '/login' instead of work
+      haml :admin
+    end
+
+    get '/dashboard' do
+      authorize! # require a session for this action
+      haml :dashboard
+    end
+  end
+
+== Issues
+
+* Currently assumes you have a model named 'User' and an email &  password field.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Justin Smestad. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+require 'bundler'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sinatra_warden"
+    gem.summary = %Q{authentication system for using warden with sinatra}
+    gem.description = %Q{basic helpers and authentication methods for using warden with sinatra also providing some hooks into Rack::Flash}
+    gem.email = "justin.smestad@gmail.com"
+    gem.homepage = "http://github.com/jsmestad/sinatra_warden"
+    gem.authors = ["Justin Smestad"]
+
+    manifest = Bundler::Environment.load(File.dirname(__FILE__) + '/Gemfile')
+    manifest.dependencies.each do |d|
+      next if d.only && d.only.include?('test')
+      gem.add_dependency(d.name, d.version)
+    end
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/sinatra_warden.rb

@@ -0,0 +1,11 @@
+require 'sinatra'
+require 'warden'
+
+require File.join(File.dirname(__FILE__) + '/sinatra_warden/sinatra')
+
+Warden::Manager.before_failure do |env,opts|
+  # Sinatra is very sensitive to the request method
+  # since authentication could fail on any type of method, we need
+  # to set it for the failure app so it is routed to the correct block
+  env['REQUEST_METHOD'] = "POST"
+end

data/lib/sinatra_warden/sinatra.rb

@@ -0,0 +1,57 @@
+module SinatraWarden
+  module Helpers
+    # The main accessor for the warden proxy instance
+    def warden
+      request.env['warden']
+    end
+
+    # Proxy to the authenticated? method on warden
+    def authenticated?(*args)
+      warden.authenticated?(*args)
+    end
+    alias_method :logged_in?, :authenticated?
+
+    # Access the currently logged in user
+    def user(*args)
+      warden.user(*args)
+    end
+    alias_method :current_user, :user
+
+    # Set the currently logged in user
+    def user=(user)
+      warden.set_user user
+    end
+    alias_method :current_user=, :user=
+
+    # Require authorization for an action
+    def authorize!(failure_path=nil)
+      redirect(failure_path ? failure_path : '/') unless authenticated?
+    end
+  end
+
+  def self.registered(app)
+    app.helpers SinatraWarden::Helpers
+
+    app.post '/unauthenticated/?' do
+      status 401
+      flash[:error] = "Could not log you in" if defined?(Rack::Flash)
+      haml :login
+    end
+
+    app.get '/login/?' do
+      haml :login
+    end
+
+    app.post '/login/?' do
+      env['warden'].authenticate!
+      flash[:success] = "You have logged in successfully." if defined?(Rack::Flash)
+      redirect back
+    end
+
+    app.get '/logout/?' do
+      env['warden'].logout
+      flash[:success] = "You are now logged out." if defined?(Rack::Flash)
+      redirect back
+    end
+  end
+end

data/lib/sinatra_warden/strategies/bcrypt_activerecord.rb

@@ -0,0 +1,21 @@
+Warden::Manager.serialize_into_session{ |user| [user.class, user.id] }
+Warden::Manager.serialize_from_session{ |klass, id| klass.find(id) }
+
+Warden::Strategies.add(:bcrypt_activerecord) do
+
+  def valid?
+    params["login"] || params["password"]
+  end
+
+  def authenticate!
+    return fail! unless user = User.find(params["login"])
+
+    if user.password == params["password"]
+      success!(user)
+    else
+      errors.add(:login, "Login or Password incorrect")
+      fail!
+    end
+  end
+
+end

data/lib/sinatra_warden/strategies/bcrypt_datamapper.rb

@@ -0,0 +1,16 @@
+require 'dm-core'
+require 'bcrypt'
+
+Warden::Manager.serialize_into_session{|user| user.id }
+Warden::Manager.serialize_from_session{|id| User.get(id) }
+
+Warden::Strategies.add(:bcrypt_datamapper) do
+  def valid?
+    params["email"] || params["password"]
+  end
+
+  def authenticate!
+    return fail!("Could not log in") unless user = User.first(:email => params["email"])
+    user.password == params["password"] ? success!(user) : fail!("Could not log in")
+  end
+end

data/spec/fixtures/testing_login.rb

@@ -0,0 +1,12 @@
+class TestingLogin < Sinatra::Base
+  register SinatraWarden
+
+  get '/dashboard' do
+    authorize!('/login')
+  end
+
+  get '/admin' do
+    authorize!
+  end
+
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,20 @@
+require 'dm-core'
+require 'bcrypt'
+
+class User
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :email, String
+  property :encrypted_password, String
+
+  def password=(new_password)
+    @password = BCrypt::Password.create(new_password)
+    self.encrypted_password = @password
+  end
+
+  def password
+    @password ||= BCrypt::Password.new(encrypted_password)
+  end
+
+end

data/spec/sinatra_warden_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SinatraWarden" do
+  before(:each) do
+    @user = User.create(:email => 'justin.smestad@gmail.com', :password => 'thedude')
+  end
+
+  it "should be a valid user" do
+    @user.new?.should be_false
+  end
+
+  context "the authentication system" do
+
+    it "should allow us to login as that user"
+
+    it "should allow us to logout after logging in"
+
+    it "should redirect to root"
+
+  end
+
+  context "the helpers" do
+
+    context "the authorize! helper" do
+
+      it "should redirect to root if not logged in"
+
+      it "should redirect to the passed path if available"
+
+      it "should allow access if user is logged in"
+
+    end
+
+    context "the user helper" do
+
+      it "should be aliased to current_user"
+
+      it "should allow assignment of the user (user=)"
+
+      it "should return the current logged in user"
+
+    end
+
+    context "the authenticated? helper" do
+
+      it "should be aliased as logged_in?"
+
+      it "should return true when a user is authenticated"
+
+      it "should return false when a user is not authenticated"
+
+    end
+
+    context "the warden helper" do
+
+      it "returns the environment variables from warden"
+
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+ENV['RACK_ENV'] ||= 'test'
+project_root = File.expand_path(File.dirname(__FILE__))
+require File.join(project_root, '..', 'vendor', 'gems', 'environment')
+Bundler.require_env(:test)
+
+require 'sinatra_warden'
+require 'spec'
+require 'spec/autorun'
+
+DataMapper.setup(:default, 'sqlite3::memory:')
+
+%w(fixtures support).each do |path|
+  Dir[ File.join( project_root, path, '/**/*.rb') ].each do |m|
+    require m
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(Rack::Test::Methods)
+
+  config.before(:each) do
+    DataMapper.auto_migrate!
+  end
+
+  def app
+    @app ||= Rack::Builder.app do
+      use Rack::Session::Cookie
+      run TestingLogin.app
+    end
+  end
+end
+

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra_warden
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Justin Smestad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-26 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: warden
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+    version: 
+description: basic helpers and authentication methods for using warden with sinatra also providing some hooks into Rack::Flash
+email: justin.smestad@gmail.com
+executables: 
+- autospec
+- rackup
+- rake
+- rcov
+- spec
+- yard-graph
+- yardoc
+- yri
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/sinatra_warden.rb
+- lib/sinatra_warden/sinatra.rb
+- lib/sinatra_warden/strategies/bcrypt_activerecord.rb
+- lib/sinatra_warden/strategies/bcrypt_datamapper.rb
+- spec/fixtures/bcrypt_strategy.rb
+- spec/fixtures/testing_login.rb
+- spec/fixtures/user.rb
+- spec/sinatra_warden_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jsmestad/sinatra_warden
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: authentication system for using warden with sinatra
+test_files: 
+- spec/fixtures/bcrypt_strategy.rb
+- spec/fixtures/testing_login.rb
+- spec/fixtures/user.rb
+- spec/sinatra_warden_spec.rb
+- spec/spec_helper.rb