sinatra_more 0.0.3 → 0.0.4

data/README.rdoc

@@ -1,6 +1,74 @@
 = sinatra_more
 
-This will be a plugin which expands sinatra in a variety of ways. Not ready to be used yet!
+== Introduction
+
+This will be a plugin which expand sinatra's capabilities in many ways. Not ready to be used yet!
+
+Let me expand briefly on what I want to accomplish with this gem. I love sinatra but if I want to use it
+for any non-trivial application I very quickly miss a lot of the extra tools provided by rails.
+
+Now the obvious question is, why not just use rails? Well, that would be the easy answer. However, until
+version 3 comes along, Rails is quite a large framework and I love the spirit of sinatra which acts
+as a thin wrapper on top of rack allowing middleware to do most of the work and pulling in complexity
+only as needed. 
+
+My goal with this extension is to maintain the spirit of Sinatra and at the same time create a standard library
+of tools, helpers and components that will make Sinatra scale to allow for extremely complex apps.
+
+Here is a small list of what sinatra_more might contain:
+
+* Lots of generic view helpers (tag, content_tag, ...)
+* Asset helpers (link_to, image_tag, javascript_include_tag, ...)
+* Form helpers and form builder support (form_tag, form_for, text_field, ...)
+* Plug and play components for Warden (authentication), ActiveRecord (datastore) and MongoMapper (datastore)
+
+Keep in mind, the user will be able to pull in components as necessary and leave out any that are not required.
+
+Obviously the project isn't ready for primetime yet but please help me brainstorm and 
+fork the project if you have any ideas that will help flesh out this project!
+
+== Usage
+
+This extension can be easily registered into any existing sinatra application. You can require
+different components based on which pieces are useful for your application.
+
+  # app.rb 
+  require 'sinatra/base'
+  require 'sinatra_more'
+
+  class Application < Sinatra::Base
+    register SinatraMore
+    register SinatraMore::WardenPlugin
+    # (Not yet) register SinatraMore::MarkupHelpers
+    # (Not yet) register SinatraMore::RenderHelpers
+    # (Not yet) register SinatraMore::FormHelpers
+  end
+
+This will then allow you to use whichever components that have been registered. A breakdown is below:
+
+=== MarkupPlugin
+
+This component provides a great deal of view helpers related to html markup generation.
+There are helpers for generating tags, forms, links, images, and more. Most of the basic
+methods should be very familiar to anyone who has used rails view helpers.
+
+...list methods here...
+
+=== RenderPlugin
+
+This component provides a number of rendering helpers for sinatra, making the process
+of displaying templates far smoother. This plugin also has support for useful additions
+such as partials (with support for :collection) into the templating system.
+
+...list methods here...
+
+=== WardenPlugin
+
+This component provides out-of-the-box support for Warden authentication. With this
+plugin registered, warden will be automatically required, configured and helpers will be
+provided to make interacting with warden dead simple.
+
+...list methods here...
 
 == Note on Patches/Pull Requests
  

data/TODO

@@ -1,2 +1,3 @@
 * Pull from sinatra-helpers to make erb work (and credit keldredd)
-  - http://github.com/kelredd/sinatra-helpers/tree/master/lib/sinatra_helpers/erb/
+  - http://github.com/kelredd/sinatra-helpers/tree/master/lib/sinatra_helpers/erb/
+* Become total warden solution (basically just require warden installed, do everything else)

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/sinatra_more.rb

@@ -1,5 +1,6 @@
 require 'sinatra/base'
 
+require File.join(File.dirname(__FILE__) + '/sinatra_more/warden_helpers')
 require File.join(File.dirname(__FILE__) + '/sinatra_more/view_helpers')
 Dir.glob(File.dirname(__FILE__) + '/sinatra_more/form_builder/*.rb').each  { |f| require f }
 

data/lib/sinatra_more/warden_helpers.rb

@@ -0,0 +1,66 @@
+module SinatraMore
+  module WardenHelpers
+    # Returns the current authenticated user
+    def current_user
+      warden_handler.user
+    end
+
+    # Login the user through the specified warden strategy
+    def authenticate_user!
+      warden_handler.authenticate!
+    end
+
+    # Signs out the user
+    def logout_user!
+      warden_handler.logout
+    end
+
+    # Returns true if the user has authenticated
+    def logged_in?
+      warden_handler.authenticated?
+    end
+
+    # If a block is given, only yields the content if the user is authenticated
+    # If no block is given, returns true if the user is logged in
+    def authenticated?(&block)
+      if block_given?
+        authenticated_content = capture_haml(&block)
+        logged_in? ? haml_concat(authenticated_content) : ''
+      else
+        return logged_in?
+      end
+    end
+
+    # Forces a user to return to a fail path unless they are authorized
+    # Used to require a user be authenticated before routing to an action
+    def must_be_authorized!(failure_path=nil)
+      redirect_to(failure_path ? failure_path : '/') unless authenticated?
+    end
+
+    # Returns the raw warden authentication handler
+    def warden_handler
+      request.env['warden']
+    end
+  end
+
+  module WardenPlugin
+    def self.registered(app)
+      app.helpers SinatraMore::WardenHelpers
+
+      # TODO Improve serializing
+      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?
+          params['username'] || params['password']
+        end
+
+        def authenticate!
+          u = User.authenticate(params['username'], params['password'])
+          u.nil? ? fail!("Could not log in") : success!(u)
+        end
+      end
+    end
+  end
+end

data/sinatra_more.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sinatra_more}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nathan Esquenazi"]
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
      "lib/sinatra_more/view_helpers/format_helpers.rb",
      "lib/sinatra_more/view_helpers/render_helpers.rb",
      "lib/sinatra_more/view_helpers/tag_helpers.rb",
+     "lib/sinatra_more/warden_helpers.rb",
      "sinatra_more.gemspec",
      "test/helper.rb",
      "test/test_sinatra_more.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinatra_more
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -48,6 +48,7 @@ files:
 - lib/sinatra_more/view_helpers/format_helpers.rb
 - lib/sinatra_more/view_helpers/render_helpers.rb
 - lib/sinatra_more/view_helpers/tag_helpers.rb
+- lib/sinatra_more/warden_helpers.rb
 - sinatra_more.gemspec
 - test/helper.rb
 - test/test_sinatra_more.rb