merbful_authentication 0.1.0

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2007 Daniel Neighman
+
+All permissions are as per the original restful_authentication project. 
+
+Licence of restful_authentication
+
+Copyright (c) 2005 Rick Olson
+
+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

@@ -0,0 +1,69 @@
+merbful_authentication
+=================
+
+This is a port of the rails plugin "restful_authentication" by Rick Olson to the Merb Web Framework.
+
+It is currently very freshly ported.  Please report any bugs / patches to 
+has.sox /at/ gmail /dot/ com
+
+You can find the original at http://svn.techno-weenie.net/projects/plugins/restful_authentication/
+
+To use:
+
+  ./script/generate authenticated user sessions \
+		--include-activation
+		
+The first parameter specifies the model that gets created in signup
+(typically a user or account model).  A model with migration is 
+created (if migrations are available), as well as a basic controller with the create method.
+
+The second parameter specifies the sessions controller name.  This is
+the controller that handles the actual login/logout function on the 
+site.
+
+The third parameter (--include-activation) generates the code for a 
+ActionMailer and its respective Activation Code through email.
+
+===  Currently supported ORMs
+Active Record
+Datamapper
+
+=== Required Routes
+
+At the moment this version of the plugin requires some named routes
+    
+    In config/router.rb
+    
+      r.resources :users
+      r.match("/login").to(:controller => "Sessions", :action => "create").name(:login)
+      r.match("/logout").to(:controller => "Sessions", :action => "destroy").name(:logout)
+      r.match("/users/activate/:activation_code").to(:controller => "Users", :action => "activate").name(:user_activation)
+
+
+Note:  
+  When using activation don't forget to setup your mailer.
+
+
+Copyright of original project
+
+Copyright (c) 2005 Rick Olson
+
+Unless noted specifically, all plugins in this repository are MIT licensed:
+
+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,35 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+PLUGIN = "merbful_authentication"
+NAME = "merbful_authentication"
+VERSION = "0.1.0"
+AUTHOR = "Daniel Neighman"
+EMAIL = "has.sox@gmail.com"
+HOMEPAGE = "http://rubyforge.org/projects/merbful-auth/"
+SUMMARY = "A Merb plugin that is essentially a port of Rick Olsons restful_authentication plugin for rails"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 0.4.0')
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs,merb_generators,datamapper_generators,activerecord_generators,rspec_generators,test_unit_generators}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{NAME}-#{VERSION}}
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merbful_authentication.rb
+Add your Merb rake tasks to lib/merbful_authentication/merbtasks.rb

data/activerecord_generators/merbful_authentication_model/merbful_authentication_model_generator.rb

@@ -0,0 +1,65 @@
+class MerbfulAuthenticationModelGenerator < RubiGen::Base
+  
+  attr_reader   :name,  
+                :class_name, 
+                :class_path, 
+                :file_name, 
+                :class_nesting, 
+                :class_nesting_depth, 
+                :plural_name, 
+                :singular_name,
+                :include_activation
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    runtime_options.each{ |k,v| self.instance_variable_set("@#{k}", v) }
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.class_collisions [], 'AuthenticatedSystem::OrmMap'
+      
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('lib')
+      
+      m.template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'authenticated_system_orm_map.rb', "lib/authenticated_system_orm_map.rb"
+      
+      m.migration_template('migration.rb', 'schema/migrations', :migration_file_name => "create_#{plural_name}", 
+                                                                :assigns => {
+                                                                  :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}"
+                                                                })
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/activerecord_generators/merbful_authentication_model/templates/authenticated_system_orm_map.rb

@@ -0,0 +1,34 @@
+module AuthenticatedSystem
+  module OrmMap
+    
+    def find_authenticated_model_with_id(id)
+      <%= class_name %>.find_by_id(id)
+    end
+    
+    def find_authenticated_model_with_remember_token(rt)
+      <%= class_name %>.find_by_remember_token(rt)
+    end
+    
+    def find_activated_authenticated_model_with_login(login)
+      if <%= class_name %>.instance_methods.include?("activated_at")
+        <%= class_name %>.find(:first, :conditions => ["login=? AND activated_at IS NOT NULL", login])
+      else
+        <%= class_name %>.find_by_login(login)
+      end
+    end
+    
+    def find_activated_authenticated_model(activation_code)
+      <%= class_name %>.find_by_activation_code(activation_code)
+    end  
+    
+    def find_with_conditions(conditions)
+      <%= class_name %>.find(:first, :conditions => conditions)
+    end
+    
+    # A method to assist with specs
+    def clear_database_table
+      <%= class_name %>.delete_all
+    end
+  end
+  
+end

data/activerecord_generators/merbful_authentication_model/templates/migration.rb

@@ -0,0 +1,20 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table "<%= plural_name %>", :force => true do |t|
+      t.column :login,                     :string
+      t.column :email,                     :string
+      t.column :crypted_password,          :string, :limit => 40
+      t.column :salt,                      :string, :limit => 40
+      t.column :created_at,                :datetime
+      t.column :updated_at,                :datetime
+      t.column :remember_token,            :string
+      t.column :remember_token_expires_at, :datetime
+      <% if options[:include_activation] %>t.column :activation_code, :string, :limit => 40
+      t.column :activated_at, :datetime<% end %>
+    end
+  end
+
+  def self.down
+    drop_table "<%= singular_name %>"
+  end
+end

data/activerecord_generators/merbful_authentication_model/templates/model.rb

@@ -0,0 +1,63 @@
+require 'digest/sha1'
+require 'authenticated_system_model'
+class <%= class_name %> < ActiveRecord::Base
+  include AuthenticatedSystem::Model
+  
+  # Virtual attribute for the unencrypted password
+  attr_accessor :password
+
+  validates_presence_of     :login, :email
+  validates_presence_of     :password,                   :if => :password_required?
+  validates_presence_of     :password_confirmation,      :if => :password_required?
+  validates_length_of       :password, :within => 4..40, :if => :password_required?
+  validates_confirmation_of :password,                   :if => :password_required?
+  validates_length_of       :login,    :within => 3..40
+  validates_length_of       :email,    :within => 3..100
+  validates_uniqueness_of   :login, :email, :case_sensitive => false
+  before_save :encrypt_password
+<% if include_activation -%>
+  before_create :make_activation_code
+  after_create :send_signup_notification
+<% end -%>
+  # prevents a user from submitting a crafted form that bypasses activation
+  # anything else you want your user to change should be added here.
+  attr_accessible :login, :email, :password, :password_confirmation
+  
+  def login=(login_name)
+    self[:login] = login_name.downcase unless login_name.nil?
+  end
+
+<% if options[:include_activation] -%>
+  EMAIL_FROM = "info@mysite.com"
+  SIGNUP_MAIL_SUBJECT = "Welcome to MYSITE.  Please activate your account."
+  ACTIVATE_MAIL_SUBJECT = "Welcome to MYSITE"
+
+  # Activates the <%= singular_name %> in the database
+  def activate
+    @activated = true
+    self.activated_at = Time.now.utc
+    self.activation_code = nil
+    save
+
+    # send mail for activation
+    <%= class_name %>Mailer.dispatch_and_deliver(  :activation_notification,
+                                  {   :from => <%= class_name %>::EMAIL_FROM,
+                                      :to   => self.email,
+                                      :subject => <%= class_name %>::ACTIVATE_MAIL_SUBJECT },
+
+                                      :<%= singular_name %> => self )
+
+  end
+
+  def send_signup_notification
+    <%= class_name %>Mailer.dispatch_and_deliver(
+        :signup_notification,
+      { :from => <%= class_name %>::EMAIL_FROM,
+        :to  => self.email,
+        :subject => <%= class_name %>::SIGNUP_MAIL_SUBJECT },
+        :<%= singular_name %> => self        
+    )
+  end
+
+<% end -%>
+end

data/datamapper_generators/merbful_authentication_model/merbful_authentication_model_generator.rb

@@ -0,0 +1,60 @@
+class MerbfulAuthenticationModelGenerator < RubiGen::Base
+
+  attr_reader   :name,  
+                :class_name, 
+                :class_path, 
+                :file_name, 
+                :class_nesting, 
+                :class_nesting_depth, 
+                :plural_name, 
+                :singular_name,
+                :include_activation
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    runtime_options.each{ |k,v| self.instance_variable_set("@#{k}", v) }
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.class_collisions [], 'AuthenticatedSystem::OrmMap'
+      
+      m.directory File.join('app/models', class_path)
+      m.directory File.join('lib')
+      
+      m.template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb")
+      m.template 'authenticated_system_orm_map.rb', "lib/authenticated_system_orm_map.rb"         
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/datamapper_generators/merbful_authentication_model/templates/authenticated_system_orm_map.rb

@@ -0,0 +1,34 @@
+module AuthenticatedSystem
+  module OrmMap
+    
+    def find_authenticated_model_with_id(id)
+      <%= class_name %>.first(:id => id)
+    end
+    
+    def find_authenticated_model_with_remember_token(rt)
+      <%= class_name %>.first(:remember_token => rt)
+    end
+    
+    def find_activated_authenticated_model_with_login(login)
+      if <%= class_name %>.instance_methods.include?("activated_at")
+        <%= class_name %>.first(:login => login, :activated_at.not => nil)
+      else
+        <%= class_name %>.first(:login => login)
+      end
+    end
+    
+    def find_activated_authenticated_model(activation_code)
+      <%= class_name %>.first(:activation_code => activation_code)
+    end  
+    
+    def find_with_conditions(conditions)
+      <%= class_name %>.first(conditions)
+    end
+    
+    # A method to assist with specs
+    def clear_database_table
+      <%= class_name %>.auto_migrate!
+    end
+  end
+  
+end

data/datamapper_generators/merbful_authentication_model/templates/model.rb

@@ -0,0 +1,78 @@
+require 'digest/sha1'
+require 'authenticated_system_model'
+class <%= class_name %> < DataMapper::Base
+  include AuthenticatedSystem::Model
+  
+  attr_accessor :password, :password_confirmation
+  
+  property :login,                      :string
+  property :email,                      :string
+  property :crypted_password,           :string
+  property :salt,                       :string
+<% if include_activation -%>
+  property :activation_code,            :string
+  property :activated_at,               :datetime
+<% end -%>
+  property :remember_token_expires_at,  :datetime
+  property :remember_token,             :string
+  property :created_at,                 :datetime
+  property :updated_at,                 :datetime
+  
+  validates_length_of         :login,                   :within => 3..40
+  validates_uniqueness_of     :login
+  validates_presence_of       :email
+  # validates_format_of         :email,                   :as => :email_address
+  validates_length_of         :email,                   :within => 3..100
+  validates_uniqueness_of     :email
+  validates_presence_of       :password,                :if => proc {password_required?}
+  validates_presence_of       :password_confirmation,   :if => proc {password_required?}
+  validates_length_of         :password,                :within => 4..40, :if => proc {password_required?}
+  validates_confirmation_of   :password,                :groups => :create
+    
+  before_save :encrypt_password
+<% if include_activation -%>
+  before_create :make_activation_code
+  after_create :send_signup_notification
+<% end -%>
+  
+  def login=(value)
+    @login = value.downcase unless value.nil?
+  end
+    
+<% if include_activation -%>  
+  EMAIL_FROM = "info@mysite.com"
+  SIGNUP_MAIL_SUBJECT = "Welcome to MYSITE.  Please activate your account."
+  ACTIVATE_MAIL_SUBJECT = "Welcome to MYSITE"
+  
+  # Activates the <%= singular_name %> in the database
+  def activate
+    @activated = true
+    self.activated_at = Time.now.utc
+    self.activation_code = nil
+    save
+
+    # send mail for activation
+    <%= class_name %>Mailer.dispatch_and_deliver(  :activation_notification,
+                                  {   :from => <%= class_name %>::EMAIL_FROM,
+                                      :to   => self.email,
+                                      :subject => <%= class_name %>::ACTIVATE_MAIL_SUBJECT },
+
+                                      :<%= singular_name %> => self )
+
+  end
+  
+  def send_signup_notification
+    <%= class_name %>Mailer.dispatch_and_deliver(
+        :signup_notification,
+      { :from => <%= class_name %>::EMAIL_FROM,
+        :to  => self.email,
+        :subject => <%= class_name %>::SIGNUP_MAIL_SUBJECT },
+        :<%= singular_name %> => self        
+    )
+  end
+  
+<% end -%>
+
+
+  
+end