jt-rails-generator-user 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0f5b69d33209d4864f7bd83f4fca4af58259746f
+  data.tar.gz: fa045b65a2bd51a7599a36c56ad7c904b318ad97
+SHA512:
+  metadata.gz: a1049df6a02d21388947ccd4bc19f7bf1cad9ec9c2d0b792920b65eb10d933514ccbb0faac0c18e875e0a5eac364cb550df403bc56448fd1840bfdcd628df881
+  data.tar.gz: 48e1a357772036978a584b29b91db88a717ac641188bd7ead43a4231c47ce71d52e893517c5d46bd74ad0f1adaa8c0db37d03f3293bc095d879cb0bbcbc7e3c8

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Jonathan Tribouharet
+
+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.md

@@ -0,0 +1,44 @@
+# JTRailsGeneratorUser
+
+[![Gem Version](https://badge.fury.io/rb/jt-rails-generator-user.svg)](http://badge.fury.io/rb/jt-rails-generator-user)
+
+JTRailsGeneratorUser is a generator for user authentication. You have the login and sign up page, password forgot feature.
+
+## Installation
+
+JTRailsGeneratorUser is distributed as a gem, which is how it should be used in your app.
+
+Include the gem in your Gemfile:
+
+    gem 'jt-rails-generator-user', '~> 1.0'
+
+## Usage
+
+You just have to use the generator with:
+
+	rails g jt:user
+
+Include `CurrentUser` in your `ApplicationController`:
+
+```ruby
+class ApplicationController < ActionController::Base
+	include CurrentUser
+	...
+end
+```
+
+## What's does it generate?
+
+- `User` model with only email, password and password_token (for password forgot feature)
+- `SessionController` for the login
+- `UsersController` for the sign up and password forgot feature
+- `UserMailer` for sending password reset instructions 
+- `CurrentUser` module which manage `current_user` variable and `require_user` filter 
+
+## Author
+
+- [Jonathan Tribouharet](https://github.com/jonathantribouharet) ([@johntribouharet](https://twitter.com/johntribouharet))
+
+## License
+
+JTRailsGeneratorUser is released under the MIT license. See the LICENSE file for more info.

data/jt-rails-generator-user.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+	s.name = 'jt-rails-generator-user'
+	s.summary = "Generate a scaffold for user authentication in Ruby On Rails"
+	s.description = "JTRailsGeneratorUser is a generator for user authentication. You have the login and sign up page, password forgot feature."
+	s.homepage = 'https://github.com/jonathantribouharet/jt-rails-generator-user'
+	s.version = '1.0.0'
+	s.files = `git ls-files`.split("\n")
+	s.require_paths = ['lib']
+	s.authors = ['Jonathan TRIBOUHARET']
+	s.email = 'jonathan.tribouharet@gmail.com'
+	s.license = 'MIT'
+	s.platform = Gem::Platform::RUBY
+end

data/lib/generators/jt/user/USAGE

@@ -0,0 +1,3 @@
+Create a scaffold for user authentication to your Rails App.
+
+  rails g jt:user

data/lib/generators/jt/user/templates/controllers/concerns/current_user.rb

@@ -0,0 +1,29 @@
+module CurrentUser
+	extend ActiveSupport::Concern
+
+	included do
+		helper_method :current_user
+	end
+
+	def set_current_user(user)
+		session[:user_id] = user.id
+	end
+
+	def current_user
+		@current_user ||= User.find_by_id(session[:user_id]) if session[:user_id]
+		@current_user
+	end
+
+	def require_user
+		if !current_user
+			redirect_to login_url
+		end
+	end
+	
+	def require_no_user
+		if current_user
+			redirect_to root_url
+		end
+	end	
+
+end

data/lib/generators/jt/user/templates/controllers/sessions_controller.rb

@@ -0,0 +1,24 @@
+class SessionsController < ApplicationController
+
+	before_action :require_no_user, except: [:destroy]
+	
+	def new
+	end
+
+	def create
+		user = User.authenticate(params[:email], params[:password])
+
+		if user
+			set_current_user(user)
+			redirect_to root_url
+		else
+			render :new
+		end
+	end
+	
+	def destroy
+		reset_session
+		redirect_to root_url
+	end	
+
+end

data/lib/generators/jt/user/templates/controllers/users_controller.rb

@@ -0,0 +1,49 @@
+class UsersController < ApplicationController
+
+	before_action :require_no_user
+
+	def new
+		@user = User.new
+	end
+
+	def create
+		@user = User.new(user_params)
+		if @user.save
+			set_current_user(@user)
+			redirect_to root_url
+		else
+			render :new
+		end
+	end
+
+	def password_forgot
+		if request.post?
+			@user = User.search_by_email_for_authentication(params[:email]).first
+			if @user
+				@user.generate_new_password_token!
+				UserMailer.reset_password(@user.id).deliver_later
+
+				redirect_to root_url
+			end
+		end
+	end
+
+	def reset_password
+		user = User.where(password_token: params[:token]).first
+		if user
+			set_current_user(user)
+			user.clear_password_token!
+
+			redirect_to root_url
+		else
+			redirect_to root_url
+		end
+	end
+
+private
+
+	def user_params
+		params.require(:user).permit(:email, :password)
+	end
+
+end

data/lib/generators/jt/user/templates/mailers/user_mailer.rb

@@ -0,0 +1,8 @@
+class UserMailer < ApplicationMailer
+
+	def reset_password(user_id)
+		@user = User.find(user_id)
+		mail(to: @user.email, subject: 'Reset password')
+	end
+
+end

data/lib/generators/jt/user/templates/models/concerns/user_authentication.rb

@@ -0,0 +1,41 @@
+module UserAuthentication
+	extend ActiveSupport::Concern
+
+	included do
+
+		has_secure_password(validations: false)
+
+		validates :email, presence: true, email_format: true, uniqueness: { case_sensitive: false}
+		validates :password_token, uniqueness: true, if: Proc.new {|u| !u.password_token.blank? }
+		
+		before_save :downcase_email
+
+		scope :search_by_email_for_authentication, ->(email = nil) { where(email: email.to_s.downcase).where('password_digest IS NOT NULL') }
+
+	end
+
+	module ClassMethods
+
+		def authenticate(email, password)
+			self.search_by_email_for_authentication(email).first.try(:authenticate, password)
+		end
+
+	end
+
+	def downcase_email
+		self.email.downcase! if self.email
+	end
+
+	def generate_new_password_token!
+		self.password_token = loop do
+			random_token = SecureRandom.urlsafe_base64(128, false)
+			break random_token unless self.class.exists?(password_token: random_token)
+		end
+		self.save!
+	end
+
+	def clear_password_token!
+		self.update_column(:password_token, nil)
+	end
+
+end

data/lib/generators/jt/user/templates/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+
+	include UserAuthentication
+
+end

data/lib/generators/jt/user/templates/views/sessions/new.html.erb

@@ -0,0 +1,8 @@
+<%= form_tag login_path do %>
+
+	<%= text_field_tag :email, params[:email] %>
+	<%= password_field_tag :password %>
+
+	<%= submit_tag 'Login' %>
+
+<% end %>

data/lib/generators/jt/user/templates/views/user_mailer/reset_password.html.erb

@@ -0,0 +1 @@
+<%= link_to reset_password_users_url(@user.password_token), reset_password_users_url(@user.password_token) %>

data/lib/generators/jt/user/templates/views/users/new.html.erb

@@ -0,0 +1,8 @@
+<%= form_for @user do |f| %>
+
+	<%= f.text_field :email %>
+	<%= f.password_field :password %>
+
+	<%= f.submit %>
+
+<% end %>

data/lib/generators/jt/user/templates/views/users/password_forgot.html.erb

@@ -0,0 +1,7 @@
+<%= form_tag password_forgot_users_path do %>
+
+	<%= text_field_tag :email %>
+
+	<%= submit_tag 'Reset my password' %>
+
+<% end %>

data/lib/generators/jt/user/user_generator.rb

@@ -0,0 +1,28 @@
+module Jt
+	class UserGenerator < Rails::Generators::Base
+
+		source_root File.expand_path("../templates", __FILE__)
+
+		def create_initializer_file
+			generate "migration", "CreateUsers", "email:string password_digest:string password_token:string"
+
+			directory 'controllers', 'app/controllers'
+			directory 'mailers', 'app/mailers'
+			directory 'models', 'app/models'
+			directory 'views', 'app/views'
+
+			route "resources :users, only: [:new, :create] do
+  collection do
+    get 'password_forgot' => 'users#password_forgot', as: :password_forgot
+    post 'password_forgot' => 'users#password_forgot'
+
+    get 'reset_password/:token' => 'users#reset_password', as: :reset_password
+  end
+end"
+
+			route "get 'logout' => 'sessions#destroy', as: :logout"
+			route "post 'login' => 'sessions#create'"
+			route "get 'login' => 'sessions#new', as: :login"
+		end
+	end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: jt-rails-generator-user
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan TRIBOUHARET
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-02 00:00:00.000000000 Z
+dependencies: []
+description: JTRailsGeneratorUser is a generator for user authentication. You have
+  the login and sign up page, password forgot feature.
+email: jonathan.tribouharet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- jt-rails-generator-user.gemspec
+- lib/generators/jt/user/USAGE
+- lib/generators/jt/user/templates/controllers/concerns/current_user.rb
+- lib/generators/jt/user/templates/controllers/sessions_controller.rb
+- lib/generators/jt/user/templates/controllers/users_controller.rb
+- lib/generators/jt/user/templates/mailers/user_mailer.rb
+- lib/generators/jt/user/templates/models/concerns/user_authentication.rb
+- lib/generators/jt/user/templates/models/user.rb
+- lib/generators/jt/user/templates/views/sessions/new.html.erb
+- lib/generators/jt/user/templates/views/user_mailer/reset_password.html.erb
+- lib/generators/jt/user/templates/views/users/new.html.erb
+- lib/generators/jt/user/templates/views/users/password_forgot.html.erb
+- lib/generators/jt/user/user_generator.rb
+homepage: https://github.com/jonathantribouharet/jt-rails-generator-user
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Generate a scaffold for user authentication in Ruby On Rails
+test_files: []