muck-users 0.1.8 → 0.1.9

data/README.rdoc

@@ -39,7 +39,12 @@ Inside of global_config.yml add the following changing the emails to match your
     
 == Usage
 
-Be sure to add this route to your routes.rb file:
+There are a couple of routes that muck-users will look for:
+
+Route to the site home page:
+  map.root '', :controller => 'default', :action => 'index'
+
+Route to a public user page (this could also go to home etc. if needed)
   map.public_user_path '/profiles/:id', :controller => 'profiles', :action => 'show'
 This is the path that a user will be redirected to if they attempt to access another user's dashboard page.
 

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.1.9

data/app/controllers/muck/users_controller.rb

@@ -62,6 +62,7 @@ class Muck::UsersController < ApplicationController
       if GlobalConfig.automatically_login_after_account_create
         if @user.save
           @user.activate!
+          UserSession.create(@user)
           @user.deliver_welcome_email
           flash[:notice] = t('muck.users.thanks_sign_up')
           after_create_response(true, signup_complete_path(@user))
@@ -79,7 +80,7 @@ class Muck::UsersController < ApplicationController
         end
       end
     else
-      if @user.save_without_session_maintenance      
+      if @user.save_without_session_maintenance
         @user.deliver_activation_instructions!
         flash[:notice] = t('muck.users.thanks_sign_up_check')
         after_create_response(true, signup_complete_activation_required_path(@user))
@@ -132,23 +133,38 @@ class Muck::UsersController < ApplicationController
   end
 
   def is_email_available
-    # TODO add in link to let the user recover their password
-    #recover_password_prompt = link_to(t('muck.users.recover_password_prompt'), reset_password_path)
-    recover_password_prompt = ''
-    result = t('muck.users.email_not_available', :reset_password_help => recover_password_prompt)
-    
-    if params[:user_email] && params[:user_email].length <= 0
+    if params[:user_email].nil?
       result = ''
+    elsif params[:user_email].empty?
+      result = t('muck.users.email_empty')
     elsif !User.email_exists?(params[:user_email])
-      result = t('muck.users.email_available')
+      valid, errors = valid_email?(params[:user_email])
+      if valid
+        result = t('muck.users.email_available')
+      else
+        result = t('muck.users.email_invalid')
+      end
+    else
+      recover_password_prompt = render_to_string :partial => 'users/recover_password_via_email_link', :locals => { :email => params[:user_email] }
+      result = t('muck.users.email_not_available', :reset_password_help => recover_password_prompt)
     end
     respond_to do |format|
-      format.html { render :text => result}
+      format.html { render :text => result }
     end
   end
 
   protected 
 
+  def valid_email?(email)
+    user = User.new(:email => email)
+    user.valid?
+    if user.errors[:email]
+      [false, user.errors[:email]]
+    else
+      [true, '']
+    end
+  end
+  
   def standard_response(template)
     respond_to do |format|
       format.html { render :template => "users/#{template}" }
@@ -170,6 +186,7 @@ class Muck::UsersController < ApplicationController
     end
   end
   
+  # override redirect by adding :redirect_to as a hidden field in your form or as a url param
   def after_update_response(success)
     if success
       respond_to do |format|
@@ -188,11 +205,13 @@ class Muck::UsersController < ApplicationController
     end
   end
   
+  # override redirect by adding :redirect_to as a hidden field in your form or as a url param
   def after_destroy_response
     respond_to do |format|
       format.html do
+        flash[:notice] = t('muck.users.login_out_success')
         get_redirect_to do
-          redirect_to(root_url)
+          redirect_to(login_url)
         end
       end
       format.xml { head :ok }

data/app/helpers/muck_users_helper.rb

@@ -0,0 +1,14 @@
+module MuckUsersHelper
+  
+  # Render a basic user registration form
+  def signup_form(user, redirect_to = nil)
+    render :partial => 'users/signup_form', :locals => { :user => user, :redirect_to => redirect_to}
+  end
+  
+  # Sign up javascript is not required but will add script to the sign up form which will make ajax calls
+  # that indicate to the user whether or not the login and email they choose have already been taken.
+  def signup_form_javascript
+    render :partial => 'users/signup_form_javascript'
+  end
+  
+end

data/app/models/user_mailer.rb

@@ -46,7 +46,7 @@ class UserMailer < ActionMailer::Base
   protected
   def setup_email(user)
     recipients  user.email
-    from        "#{GlobalConfig.application_name} <#{GlobalConfig.email_from}>"
+    from        "#{GlobalConfig.application_name} <#{GlobalConfig.from_email_name}>"
     sent_on     Time.now
   end
 

data/app/views/password_resets/new.html.erb

@@ -3,7 +3,7 @@
   <%= output_errors(t('muck.users.reset_password'), {:class => 'help-box'}) %>
   <% custom_form_for :reset_password, :url => password_resets_path do |f| -%>
     <p><%= t('muck.users.email_recover_prompt') %></p>
-    <%= f.text_field :email, { :label => t('muck.users.email_address'), :hide_required => true } -%>
+    <%= f.text_field :email, { :label => t('muck.users.email_address'), :hide_required => true, :value => params[:email] } -%>
     <div class="button form-row">
       <%= submit_tag t('muck.users.reset_password') %>
     </div>

data/app/views/user_mailer/welcome_notification.text.html.erb

@@ -2,4 +2,5 @@
 
 <p>Welcome to <%= GlobalConfig.application_name %>.  Your account has been successfully created.</p>
 
-<a href="<%= @root_url %>"><%= @root_url %></a>
+<p>Click below to visit the site:</p>
+<a href="<%= root_url %>"><%= root_url %></a>

data/app/views/user_mailer/welcome_notification.text.plain.erb

@@ -2,4 +2,6 @@ Hello <%= h(@user.login) %>,
 
 Welcome to <%= GlobalConfig.application_name %>.  Your account has been successfully created.
 
-<%= @root_url %>
+Use this link to visit the site:
+
+<%= root_url %>

data/app/views/users/_recover_password_via_email_link.html.erb

@@ -0,0 +1 @@
+<%= link_to(t('muck.users.recover_password_prompt'), forgot_password_path( :email => email)) %>

data/app/views/users/_signup_form.html.erb

@@ -0,0 +1,29 @@
+<% custom_form_for :user, :url => users_path, :html => {:id => "register-user-form", :name => 'register-user-form'} do |f| -%>
+
+	<%= output_errors(t('muck.users.problem_creating_account'), {:class => 'help-box'}, user) %>
+	
+	<%= f.text_field :login, { :label => t('muck.users.choose_member_name'), 
+	                           :extra_html => '<span id="username-availibility" class="availability"></span>', 
+	                           :tip => t('muck.users.username_help'),
+	                           :required_label => t('muck.users.username') } -%>
+	<%= f.text_field :email, { :label => t('muck.users.email_address'),
+	                           :tip => t('muck.users.email_help'),
+	                           :extra_html => '<span id="email-availibility" class="availability"></span>' } -%>
+	<%= f.password_field :password, { :label => t('muck.users.password'),
+	                                  :tip => t('muck.users.password_help')} -%>
+	<%= f.password_field :password_confirmation, { :label => t('muck.users.confirm_password'),
+                                                 :tip => t('muck.users.password_confirmation_help') } -%>
+	
+	<%= hidden_field_tag :redirect_to, redirect_to -%>
+	
+	<% if GlobalConfig.use_recaptcha -%>
+	<div class="recaptcha">
+		<%= recaptcha_tags %>
+	</div>
+	<% end -%>
+	
+	<div class="button form-row">
+  	<%= f.submit t('muck.users.sign_up_now') %>
+  </div>
+  
+<% end %>

data/app/views/users/_signup_form_javascript.html.erb

@@ -0,0 +1,18 @@
+<% content_for :javascript do -%>
+  jQuery("#user_login").blur(function(){
+    jQuery.post("is_login_available",{ user_login:jQuery(this).val() } ,function(data){
+    	jQuery("#username-availibility").html(data);    
+    }); 
+  });
+	jQuery("#user_login").keydown(function() { 
+		jQuery("#username-availibility").html(''); 
+	});
+	jQuery("#user_email").blur(function(){
+    jQuery.post("is_email_available",{ user_email:jQuery(this).val() } ,function(data){
+    	jQuery("#email-availibility").html(data);    
+    }); 
+  });
+	jQuery("#user_email").keydown(function() { 
+		jQuery("#email-availibility").html(''); 
+	});
+<% end -%>

data/app/views/users/new.html.erb

@@ -1,50 +1,6 @@
 <div id="registration" class="common-form">
 	<h1><%= t('muck.users.register_account', :application_name => GlobalConfig.application_name) %></h1>
 	<p><%= t('muck.users.already_registered') %> <a href="<%=login_url%>"><%= t('muck.users.sign_in_now') %></a></p>
-
-	<% custom_form_for :user, :url => users_path, :html => {:id => "register-user-form", :name => 'register-user-form'} do |f| -%>
-	
-		<%= output_errors(t('muck.users.problem_creating_account'), {:class => 'help-box'}, @user) %>
- 		
- 		<%= f.text_field :login, { :label => t('muck.users.choose_member_name'), 
- 		                           :extra_html => '<span id="username-availibility" class="availability"></span>', 
- 		                           :tip => t('muck.users.username_help'),
- 		                           :required_label => t('muck.users.username') } -%>
- 		<%= f.text_field :email, { :label => t('muck.users.email_address'),
- 		                           :tip => t('muck.users.email_help'),
- 		                           :extra_html => '<span id="email-availibility" class="availability"></span>' } -%>
-		<%= f.password_field :password, { :label => t('muck.users.password'),
-		                                  :tip => t('muck.users.password_help')} -%>
-		<%= f.password_field :password_confirmation, { :label => t('muck.users.confirm_password'),
-                                                   :tip => t('muck.users.password_confirmation_help') } -%>
-		<% if GlobalConfig.use_recaptcha -%>
-		<div class="recaptcha">
-			<%= recaptcha_tags %>
-		</div>
-		<% end -%>
-		
-		<div class="button form-row">
-	  	<%= f.submit t('muck.users.sign_up_now') %>
-	  </div>
-	  
-	<% end %>
+  <%= signup_form(@user) -%>
 </div>
-
-<% content_for :javascript do -%>
-  jQuery("#user_login").blur(function(){
-    jQuery.post("is_login_available",{ user_login:jQuery(this).val() } ,function(data){
-    	jQuery("#username-availibility").html(data);    
-    }); 
-  });
-	jQuery("#user_login").keydown(function() { 
-		jQuery("#username-availibility").html(''); 
-	});
-	jQuery("#user_email").blur(function(){
-    jQuery.post("is_email_available",{ user_email:jQuery(this).val() } ,function(data){
-    	jQuery("#email-availibility").html(data);    
-    }); 
-  });
-	jQuery("#user_email").keydown(function() { 
-		jQuery("#email-availibility").html(''); 
-	});
-<% end -%>
+<%= signup_form_javascript -%>

data/app/views/users/welcome.html.erb

@@ -1,4 +1,5 @@
 <div id="welcome" class="common-content">
-  Welcome to muck.  This system provides the basic components to help you build your website.
+  <%= output_errors('', {:class => 'help-box'}) %>
+  <%= t('muck.users.welcome_message') %>
   <%= link_to 'View Your Account', user_path(current_user) %>
 </div>

data/lib/muck_users.rb

@@ -5,5 +5,6 @@ ActionController::Base.send :include, ActionController::AuthenticApplication
 ActiveRecord::Base.send :include, ActiveRecord::SecureMethods
 ActiveRecord::Base.class_eval { include ActiveRecord::Acts::MuckUser }
 ActiveRecord::Base.class_eval { include MuckUsers::Exceptions }
+ActionController::Base.send :helper, MuckUsersHelper
 
 I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', 'locales', '*.{rb,yml}') ]

data/locales/en.yml

@@ -11,6 +11,7 @@ en:
       thanks_sign_up: Thanks for signing up!
       thanks_sign_up_login: Thanks for signing up! You may login now
       thanks_sign_up_check: "Your account has been created. Please check your e-mail for your account activation instructions!"
+      welcome_message: "Welcome to muck.  This system provides the basic components to help you build your website."
       username_not_available: Username not available
       username_available: Username available
       join_application_name: Join and get it done
@@ -20,7 +21,9 @@ en:
       name: Name
       email_address: Email Address
       email_help: "Please use a valid, current e-mail address. We will never share or spam your e-mail address."
-      email_available: 'Email available'
+      email_available: "Email available"
+      email_invalid: "Invalid email"
+      email_empty: "Please enter an email address"
       username: Username
       username_help: "You can use between 6 and 20 characters. If the name you want isn't available try adding numbers or punctuation."
       password: Password
@@ -28,15 +31,15 @@ en:
       confirm_password: Confirm Password
       password_confirmation_help: "To ensure that your password is correct please enter it again here."
       sign_up_now: Sign-up Now
-      terms_and_service: By clicking 'Sign-up Now' you agree to comply with the {{tos_link_anchor}}Terms and Conditions{{link_end}}.
+      terms_and_service: "By clicking 'Sign-up Now' you agree to comply with the {{tos_link_anchor}}Terms and Conditions{{link_end}}."
       my_dashboard: My Dashboard
       update_user: Update your user information
       problem_editing_account: There was a problem updating your information.
       edit_profile: Edit Profile
       update_profile: Update your profile
       complete_profile: Complete Your Profile
-      email_not_available: Email already in use. {{reset_password_help}}
-      recover_password_prompt: (If you forgot your password recover it here)
+      email_not_available: "Email already in use. {{reset_password_help}}"
+      recover_password_prompt: "(If you forgot your password recover it here)"
       welcome: Welcome
       login_title: Log-in to your Account
       reset_password: "Reset Password"

data/muck-users.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{muck-users}
-  s.version = "0.1.8"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Ball"]
-  s.date = %q{2009-06-24}
+  s.date = %q{2009-06-25}
   s.description = %q{Easily add user signup, login and other features to your application}
   s.email = %q{justinball@gmail.com}
   s.extra_rdoc_files = [
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
      "app/controllers/muck/user_sessions_controller.rb",
      "app/controllers/muck/username_request_controller.rb",
      "app/controllers/muck/users_controller.rb",
+     "app/helpers/muck_users_helper.rb",
      "app/models/permission.rb",
      "app/models/role.rb",
      "app/models/user_mailer.rb",
@@ -59,6 +60,9 @@ Gem::Specification.new do |s|
      "app/views/user_mailer/welcome_notification.text.plain.erb",
      "app/views/user_sessions/new.html.erb",
      "app/views/username_request/new.html.erb",
+     "app/views/users/_recover_password_via_email_link.html.erb",
+     "app/views/users/_signup_form.html.erb",
+     "app/views/users/_signup_form_javascript.html.erb",
      "app/views/users/_user.html.erb",
      "app/views/users/activation_confirmation.html.erb",
      "app/views/users/activation_instructions.html.erb",
@@ -112,6 +116,7 @@ Gem::Specification.new do |s|
      "muck-users.gemspec",
      "pkg/muck-users-0.1.6.gem",
      "pkg/muck-users-0.1.7.gem",
+     "pkg/muck-users-0.1.8.gem",
      "public/images/profile_default.jpg",
      "rails/init.rb",
      "rdoc/classes/ActionController.html",

data/rdoc/created.rid

@@ -1 +1 @@
-Fri, 19 Jun 2009 02:09:54 -0600
+Wed, 24 Jun 2009 22:20:51 -0600

data/rdoc/files/README_rdoc.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jun 18 16:20:25 -0600 2009</td>
+      <td>Tue Jun 23 09:37:16 -0600 2009</td>
     </tr>
     </table>
   </div>
@@ -77,7 +77,7 @@ muck_engine as well as authlogic. Both gems should be installed
 automatically when you install the muck_users engine.
 </p>
 <pre>
-  sudo gem install muck_users
+  sudo gem install muck-users
 </pre>
 <p>
 Use search logic for searching users. Add this to environment.rb:
@@ -96,6 +96,30 @@ into your Rails project:
 <pre>
   ruby script/plugin install ssl_requirement
 </pre>
+<p>
+If you used the muck template to create your rails application you will
+have a global_config.yml file. If not then you will need to create a
+global_config.yml file and then add the following to environment.rb right
+above Rails::Initializer.run do |config|
+</p>
+<pre>
+  require 'ostruct'
+  require 'yaml'
+  ::GlobalConfig = OpenStruct.new(YAML.load_file(&quot;#{RAILS_ROOT}/config/global_config.yml&quot;)[RAILS_ENV])
+</pre>
+<p>
+Inside of global_config.yml add the following changing the emails to match
+your application:
+</p>
+<pre>
+  default: &amp;DEFAULT
+
+    # Sent in emails to users
+    application_name: 'Name of my application'
+    from_email: 'support@example.com'
+    support_email: 'support@example.com'
+    admin_email: 'admin@example.com'
+</pre>
 <h2>Usage</h2>
 <p>
 Be sure to add this route to your routes.rb file:
@@ -126,17 +150,13 @@ Example
 <p>
 After installing the engine just create a user model thus:
 </p>
-<p>
-class User &lt; ActiveRecord::Base
-</p>
 <pre>
-  acts_as_authentic
-  acts_as_muck_user
+  class User &lt; ActiveRecord::Base
+    acts_as_authentic
+    acts_as_muck_user
+  end
 </pre>
 <p>
-end
-</p>
-<p>
 Then you will be able to go to: http//:localhost:3000/login
 http//:localhost:3000/signup
 </p>

data/rdoc/files/lib/active_record/acts/muck_user_rb.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Thu Jun 18 13:49:52 -0600 2009</td>
+      <td>Tue Jun 23 11:08:45 -0600 2009</td>
     </tr>
     </table>
   </div>

data/test/rails_root/public/stylesheets/styles.css

@@ -23,7 +23,7 @@ form fieldset input[type="text"],form fieldset input[type="password"]{width:500p
 .medium{width:300px;height:300px;}
 
 /* tips */
-.availability{color:#b61e12;}
+.availability{color:#b61e12;position:absolute;}
 .hidden-tips{display:none;}
 .required-tip{color:#555555;font-size:1.2em;margin:0pt;font-weight:bolder;height:0px;}
 .tip{position:absolute;z-index:100;border:2px solid #CCCCCC;background-color:#fff;width:400px;}

data/test/rails_root/test/functional/users_controller_test.rb

@@ -25,6 +25,10 @@ class Muck::UsersControllerTest < ActionController::TestCase
         should "activate user" do
           assert assigns(:user).active? == true, "user was not activated"
         end
+        should "be logged in" do
+          user_session = UserSession.find
+          assert user_session, "user is not logged in"
+        end
       end
       context "on POST to :create with bad login (space in login name)" do
         setup do
@@ -229,6 +233,46 @@ class Muck::UsersControllerTest < ActionController::TestCase
     end
   end
 
+  context "on GET to is_email_available" do
+    context "no params" do
+      setup do
+        get :is_email_available
+      end
+      should_respond_with :success
+      should_render_text ""
+    end
+    context "empty email" do
+      setup do
+        get :is_email_available, :user_email => ''
+      end
+      should_respond_with :success
+      should_render_text I18n.t('muck.users.email_empty')
+    end
+    context "valid email" do
+      setup do
+        get :is_email_available, :user_email => 'testdude1945@example.com'
+      end
+      should_respond_with :success
+      should_render_text I18n.t('muck.users.email_available')
+    end
+    context "invalid email" do
+      setup do
+        get :is_email_available, :user_email => 'testdude1945@com'
+      end
+      should_respond_with :success
+      should_render_text I18n.t('muck.users.email_invalid')
+    end
+    context "email not available" do
+      setup do
+        @user = Factory(:user)
+        get :is_email_available, :user_email => @user.email
+      end
+      should_respond_with :success
+      should_render_partial_text I18n.t('muck.users.email_not_available', :reset_password_help => '')
+    end
+  end
+  
+  
   def put_update_user(user, options = {})
     put :update,
       :id => user.id, 

data/test/rails_root/test/shoulda_macros/controller.rb

@@ -40,6 +40,20 @@ module MuckControllerMacros
     end
   end
 
+  # make sure the response body matches the text exactly
+  def should_render_text(text)
+    should "render text #{text}" do
+      assert_equal text, @response.body
+    end
+  end
+
+  # look for the given text in the response body
+  def should_render_partial_text(text)
+    should "contain text #{text}" do
+      assert @response.body.include?(text), "Response did not contain the text '#{text}'"
+    end
+  end
+  
 end
 
 ActionController::TestCase.extend(MuckControllerMacros)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: muck-users
 version: !ruby/object:Gem::Version 
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors: 
 - Justin Ball
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-24 00:00:00 -06:00
+date: 2009-06-25 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,6 +72,7 @@ files:
 - app/controllers/muck/user_sessions_controller.rb
 - app/controllers/muck/username_request_controller.rb
 - app/controllers/muck/users_controller.rb
+- app/helpers/muck_users_helper.rb
 - app/models/permission.rb
 - app/models/role.rb
 - app/models/user_mailer.rb
@@ -107,6 +108,9 @@ files:
 - app/views/user_mailer/welcome_notification.text.plain.erb
 - app/views/user_sessions/new.html.erb
 - app/views/username_request/new.html.erb
+- app/views/users/_recover_password_via_email_link.html.erb
+- app/views/users/_signup_form.html.erb
+- app/views/users/_signup_form_javascript.html.erb
 - app/views/users/_user.html.erb
 - app/views/users/activation_confirmation.html.erb
 - app/views/users/activation_instructions.html.erb
@@ -160,6 +164,7 @@ files:
 - muck-users.gemspec
 - pkg/muck-users-0.1.6.gem
 - pkg/muck-users-0.1.7.gem
+- pkg/muck-users-0.1.8.gem
 - public/images/profile_default.jpg
 - rails/init.rb
 - rdoc/classes/ActionController.html