sinatra_more 0.2.4 → 0.2.5

data/README.rdoc

@@ -411,7 +411,41 @@ provided to make interacting with warden dead simple.
   * Used to require a user be authenticated before routing to an action
   * <tt>must_be_authorized!('/login')</tt>
   
-I am aware of other sinatra/warden extensions which work very similarly to the system I outlined here. 
+There are a few configuration options and details you need to be aware of. By default, the WardenPlugin
+assumes you have a User class which represents the authenticating class type. If your user class has a different
+name then you need to specify that as follows:
+
+  SinatraMore::WardenPlugin::PasswordStrategy.user_class = CustomUser
+
+Similarly, the strategy used expects that you have an <tt>authenticate</tt> method on your user class as follows:
+
+  def authenticate(username, password)
+    # Returns user record if user and password match; otherwise return false
+  end
+
+Using this plugin you also do need to define your own routes for managing warden sessions. An example is below:
+
+  get '/unauthenticated/?' do
+    flash[:notice] = "That username and password are not correct!"
+    status 401
+    haml_template 'session/login'
+  end
+
+  get '/login/?' do
+    haml_template 'session/login'
+  end
+
+  post '/login/?' do
+    authenticate_user!
+    redirect "/dashboard"
+  end
+
+  get '/logout/?' do
+    logout_user!
+    redirect '/session/login'
+  end
+
+I was made aware of other sinatra/warden extensions which work very similarly to the system I outline for this plugin.
 Most notably is the sinatra_warden plugin by Justin Smestad (http://github.com/jsmestad/sinatra_warden)
 Eventually I plan to vendor that gem or just remove support for this piece of my plugin completely. 
 

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/lib/sinatra_more/markup_plugin/form_builder/abstract_form_builder.rb

@@ -2,9 +2,10 @@ class AbstractFormBuilder
   attr_accessor :template, :object
 
   def initialize(template, object)
-    raise "FormBuilder template must be initialized!" unless template
     @template = template
     @object   = build_object(object)
+    raise "FormBuilder template must be initialized!" unless template
+    raise "FormBuilder object must be not be nil value. If there's no object, use a symbol instead! (i.e :user)" unless object
   end
 
   # f.error_messages
@@ -118,11 +119,15 @@ class AbstractFormBuilder
   def field_id(field, value=nil)
     value.blank? ? "#{object_name}_#{field}" : "#{object_name}_#{field}_#{value}"
   end
-  
-  # Either a symbol or a record
-  def build_object(explicit_object)
-    explicit_object.is_a?(Symbol) ? explicit_object.to_s.classify.constantize.new : explicit_object
-    raise "FormBuilder object must be initialized or use a symbol instead! (i.e :user)" unless explicit_object
-    explicit_object
+
+  # explicit_object is either a symbol or a record
+  # Returns a new record of the type specified in the object
+  def build_object(object_or_symbol)
+    object_or_symbol.is_a?(Symbol) ? object_class(object_or_symbol).new : object_or_symbol
+  end
+
+  # Returns the class type for the given object
+  def object_class(explicit_object)
+    explicit_object.is_a?(Symbol) ? explicit_object.to_s.classify.constantize : explicit_object.class
   end
 end

data/lib/sinatra_more/support_lite.rb

@@ -3,6 +3,7 @@
 unless String.method_defined?(:titleize)
   require 'active_support/inflector'
   require 'active_support/core_ext/blank'
+  require 'active_support/core_ext/class/attribute_accessors'
 end
 
 unless Hash.method_defined?(:reverse_merge!)

data/lib/sinatra_more/warden_plugin.rb

@@ -1,11 +1,35 @@
 require File.dirname(__FILE__) + '/support_lite'
+require 'warden' unless defined?(Warden)
 load File.dirname(__FILE__) + '/markup_plugin/output_helpers.rb'
 Dir[File.dirname(__FILE__) + '/warden_plugin/**/*.rb'].each {|file| load file }
 
 module SinatraMore
   module WardenPlugin
+    # This is the basic password strategy for authentication
+    class PasswordStrategy < Warden::Strategies::Base
+      cattr_accessor :user_class
+
+      def valid?
+        username || password
+      end
+
+      def authenticate!
+        raise "Please either define a user class or set SinatraMore::WardenPlugin::PasswordStrategy.user_class" unless user_class
+        u = user_class.authenticate(username, password)
+        u.nil? ? fail!("Could not log in") : success!(u)
+      end
+
+      def username
+        params['username'] || params['nickname'] || params['login'] || params['email']
+      end
+
+      def password
+        params['password'] || params['pass']
+      end
+    end
+
     def self.registered(app)
-      raise "WardenPlugin::Error - Install with 'sudo gem install warden' or require 'warden' in your app." unless Warden::Manager
+      raise "WardenPlugin::Error - Install warden with 'sudo gem install warden' to use plugin!" unless Warden && Warden::Manager
       app.use Warden::Manager do |manager|
         manager.default_strategies :password
         manager.failure_app = app
@@ -13,28 +37,11 @@ module SinatraMore
       app.helpers SinatraMore::OutputHelpers
       app.helpers SinatraMore::WardenHelpers
 
-      # TODO Improve serializing methods
-      Warden::Manager.serialize_into_session{ |user| user.nil? ? nil : user.id }
-      Warden::Manager.serialize_from_session{ |id|   id.nil? ? nil : User.find(id) }
-
-      Warden::Strategies.add(:password) do
-        def valid?
-          username || password
-        end
-
-        def authenticate!
-          u = User.authenticate(username, password)
-          u.nil? ? fail!("Could not log in") : success!(u)
-        end
-        
-        def username
-          params['username'] || params['nickname'] || params['login'] || params['email']
-        end
-        
-        def password
-          params['password'] || params['pass']
-        end
-      end
+      Warden::Manager.before_failure { |env,opts| env['REQUEST_METHOD'] = "POST" }
+      Warden::Manager.serialize_into_session { |user| user.nil? ? nil : user.id }
+      Warden::Manager.serialize_from_session { |id| id.nil? ? nil : PasswordStrategy.user_class.find(id) }
+      Warden::Strategies.add(:password, PasswordStrategy)
+      PasswordStrategy.user_class = User if defined?(User)
     end
   end
 end

data/sinatra_more.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_more}
-  s.version = "0.2.4"
+  s.version = "0.2.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]

data/test/fixtures/markup_app/views/form_for.haml

@@ -41,4 +41,7 @@
   = f.check_box_block :remember_me, { :class => 'checker' }
   = f.select_block :state, :options => ['California', 'Texas'], :class => 'selector'
   = f.submit_block "Create", { :class => 'button' }
-  = f.image_submit_block "buttons/ok.png", { :class => 'image' }
+  = f.image_submit_block "buttons/ok.png", { :class => 'image' }
+  
+- form_for :markup_user, '/third_demo', :id => 'demo3', :method => 'get' do |f|
+  = f.text_field_block :username

data/test/fixtures/warden_app/app.rb

@@ -2,63 +2,64 @@ require 'sinatra/base'
 require 'sinatra_more'
 require 'warden'
 
-class User
+class WardenUser
   attr_accessor :id, :name, :username, :password
-  
+
   def initialize(id, name, username, password)
     self.id, self.name, self.username, self.password = id, name, username, password
   end
-  
+
   def self.find(id)
     return self.john_user if id == self.john_user.id
   end
-  
+
   def self.authenticate(username, password)
     return self.john_user if username == self.john_user.username && password == self.john_user.password
   end
-  
+
   def self.john_user
-    @john ||= User.new(21, "John", 'john21', 'secret')
+    @john ||= WardenUser.new(21, "John", 'john21', 'secret')
   end
 end
 
 class WardenDemo < Sinatra::Base
   use Rack::Session::Cookie
   register SinatraMore::WardenPlugin
-  
+  SinatraMore::WardenPlugin::PasswordStrategy.user_class = WardenUser
+
   configure do
     set :root, File.dirname(__FILE__)
   end
-  
+
   get '/login' do
     "<h1>Please login!</h1>"
   end
-  
+
   post '/login' do
     authenticate_user!
   end
-  
+
   get '/logout' do
     logout_user!
   end
-  
+
   get '/logged_in' do
     "<h1>logged_in? #{logged_in?}</h1>"
   end
-  
+
   get '/authenticated' do
     haml :dashboard
   end
-  
+
   get '/unregistered' do
     haml :dashboard
   end
-  
+
   get '/must_be_authorized' do
     must_be_authorized!('/login')
     "<h1>Valid Authorized Page</h1>"
   end
-  
+
   get '/current_user' do
     if current_user
       "<h1>#{current_user.name}</h1>"
@@ -66,4 +67,4 @@ class WardenDemo < Sinatra::Base
       "<h2>Not logged in</h2>"
     end
   end
-end
+end

data/test/markup_plugin/test_form_builder.rb

@@ -26,7 +26,7 @@ class TestFormBuilder < Test::Unit::TestCase
       assert_has_tag('form', :action => '/register', :id => 'register', :method => 'post', :content => "Demo") { actual_html }
       assert_has_tag('form input[type=hidden]', :name => '_method', :count => 0) { actual_html } # no method action field
     end
-    
+
     should "display correct form html with fake object" do
       actual_html = form_for(:markup_user, '/register', :id => 'register', :method => 'post') { |f| f.text_field :username }
       assert_has_tag('form', :action => '/register', :id => 'register', :method => 'post') { actual_html }
@@ -61,16 +61,22 @@ class TestFormBuilder < Test::Unit::TestCase
       assert_has_tag('form p input[type=text]') { actual_html }
     end
 
+    should "display fail for form with no object" do
+      assert_raises(RuntimeError) { form_for(@not_real, '/register', :id => 'register', :method => 'post') { "Demo" } }
+    end
+
     should "display correct form in haml" do
       visit '/haml/form_for'
       assert_have_selector :form, :action => '/demo', :id => 'demo'
       assert_have_selector :form, :action => '/another_demo', :id => 'demo2', :method => 'get'
+      assert_have_selector :form, :action => '/third_demo', :id => 'demo3', :method => 'get'
     end
 
     should "display correct form in erb" do
       visit '/erb/form_for'
       assert_have_selector :form, :action => '/demo', :id => 'demo'
       assert_have_selector :form, :action => '/another_demo', :id => 'demo2', :method => 'get'
+      assert_have_selector :form, :action => '/third_demo', :id => 'demo3', :method => 'get'
     end
   end
 

data/test/markup_plugin/test_form_helpers.rb

@@ -241,6 +241,7 @@ class TestFormHelpers < Test::Unit::TestCase
     should "display check_box tag in ruby" do
       actual_html = check_box_tag("clear_session")
       assert_has_tag(:input, :type => 'checkbox', :value => '1', :name => 'clear_session') { actual_html }
+      assert_has_no_tag(:input, :type => 'hidden') { actual_html }
     end
 
     should "display check_box tag in ruby with extended attributes" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_more
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors: 
 - Nathan Esquenazi