password_resetter 1.0.2 → 1.0.4

data/README.md

@@ -0,0 +1,75 @@
+## PasswordResetter
+
+PasswordResetter is a simple gem used to give Users the ability to reset their password within your Rails application.
+
+#### The gem assumes to following about your Rails application:
+
+* There exists a User model with an `:email` attribute.
+* The application stores a logged in User with `session[:user_id]`
+* You already have the [BCrypt gem](https://github.com/codahale/bcrypt-ruby)
+
+## Getting Started
+
+Get it.
+
+```ruby
+gem 'password_resetter'
+```
+
+Install it.
+
+```console
+bundle install
+```
+
+Migrate it.
+
+```console
+rake password_resetter_engine:install:migrations
+rake db:migrate
+```
+
+If you haven't already, set your action mailer host in config/environments.
+Simply place the following lines at the bottom of the necessary environment files
+
+```ruby
+# Action mailer for reset passwords
+config.action_mailer.default_url_options = { :host => "localhost:3000" }
+```
+
+Lastly, throw the following link into the appropriate view file (i.e. views/sessions/new.html.erb)
+
+```ruby
+<%= link_to "Forgot Password?", new_password_reset_path %>
+```
+
+## Visual Customization
+
+To match the style of your own app, every element of the html.erb files comes tagged with a css id.
+
+### New Password Reset Page
+#### The page a User is directed when they click on the "Forgot Password?" link
+
+Email input field is tagged with 
+```ruby
+:class => "password-reset-input email"
+```
+
+Reset Password button:
+```ruby
+:class => "password-reset-button reset"
+```
+
+### Complete Password Reset Page
+#### The page a User is directed when they follow the link emailed to them after initializing the reset process
+
+Password and Password Confirmation fields tagged respectively with:
+```ruby
+:class => "password-reset-input password"
+:class => "password-reset-input password_confirmation"
+```
+
+Update Password button:
+```ruby
+:class => "password-reset-buton update"
+```

data/lib/password_resetter/version.rb

@@ -1,3 +1,3 @@
 module PasswordResetter
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: password_resetter
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +155,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: And it will be sweet
+description: Allowing Users to reset their password through email
 email:
 - efatsi@comcast.net
 executables: []
@@ -163,7 +179,7 @@ files:
 - lib/tasks/password_resetter_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
 - spec/dummy/app/controllers/application_controller.rb
@@ -209,7 +225,7 @@ files:
 - spec/support/account_helper.rb
 - spec/support/controller_login_helper.rb
 - spec/support/making_helper.rb
-homepage: http://efatsi.github.com
+homepage: https://github.com/efatsi/password_resetter
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -232,7 +248,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: This will work one day.
+summary: Allowing Users to reset their password through email
 test_files:
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css

data/README.rdoc

@@ -1,3 +0,0 @@
-= PasswordResetter
-
-This project rocks and uses MIT-LICENSE.