auth_three 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4963b95a4a2af52430d8fd08e5326114dd16c119
+  data.tar.gz: d2d693276a15bc58ba76244e437af622210a63a7
+SHA512:
+  metadata.gz: f55db84bea441008016308734d9dcb8bc5737aed7e9a8a97f4d26faec40f47012dadbc4add90160d8ad12275798ea999fceffa9ec54861f893d81614716951c5
+  data.tar.gz: 286250c6d441e0aafe3d1b1010eaf0534c6af327307d46034504983e2809264180072a78a292eae874be24aba67f6b7b59e0b62e7eeb73d2618a503bf6b892f9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Michael Chilton
+
+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 @@
+# AuthThree
+This is a small gem that will generate the necessary files and configuration for
+a simple, effective authentication pattern.
+
+## Usage
+After installation, run `rails g auth_three:install`, and the generator will
+separate the appropriate files and run the necessary database migrations.
+
+There is also a setting for controller namespacing, which is intended to make namespaced api
+controllers and routes. Add a `--namespace=api` argument to your generation command to generate
+namespaced controllers and routes. Note, this option is intended to be used to make namespaced
+api controllers, and so will output controller files and routes that by default will respond with JSON.
+All output may be modified later.
+
+This pattern requires BCrypt for securing passwords. Be sure to have it in your Gemfile and run `bundle install` if necessary.
+
+A database is required to use this pattern and run the generator. Be sure to run bundle exec rake db:create
+if one does not yet exist.
+
+
+*It is recommended to run this generator at the start of a project to avoid conflicts with other content already present.*
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auth_three'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install auth_three
+```
+
+## Contributing
+Contributions are always welcome.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AuthThree'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/auth_three/version.rb

@@ -0,0 +1,3 @@
+module AuthThree
+  VERSION = '0.1.1'
+end

data/lib/auth_three.rb

@@ -0,0 +1,10 @@
+module AuthThree
+  
+
+  require 'rails/generators'
+
+  require 'generators/orm_helpers'
+  require 'generators/controller_helpers'
+
+  require 'generators/install_generator'
+end

data/lib/generators/controller_helpers.rb

@@ -0,0 +1,147 @@
+module AuthThree
+  module Generators
+    module ControllerHelpers
+      def users_controller_contents
+<<RUBY
+  def show
+    @user = User.find(params[:id])
+    render :show
+  end
+
+  def new
+    @user = User.new
+    render :new
+  end
+
+  def create
+    @user = User.new(user_params)
+
+    if @user.save
+      sign_in(@user)
+      redirect_to links_url
+    else
+      flash.now[:errors] = @user.errors.full_messages
+      render :new
+    end
+  end
+
+  def edit
+    @user = User.find(params[:id])
+    render :edit
+  end
+
+  def update
+    @user = User.find(params[:id])
+    if @user.update
+      # default will redirect to root_url, change as you wish
+      redirect_to root_url
+    else
+      flash.now[:errors] = @user.errors.full_messages
+      render :edit
+    end
+  end
+RUBY
+      end
+
+      def sessions_controller_contents
+<<RUBY
+  def new
+    render :new
+  end
+
+  def create
+    user = User.find_by_credentials(
+      params[:user][:username],
+      params[:user][:password]
+    )
+
+    if user
+      login!(user)
+      # requires root_url to be set in routes.rb
+      redirect_to root_url
+    else
+      flash.now[:errors] = ["Invalid username or password"]
+      render :new
+    end
+  end
+
+  def destroy
+    logout!
+    redirect_to new_session_url
+  end
+RUBY
+      end
+
+      def namespace_sessions_contents(namespace_label)
+<<RUBY
+  def create
+    @user = User.find_by_credentials(
+      params[:user][:username],
+      params[:user][:password]
+    )
+
+    if @user
+      login!(@user)
+      render :"#{namespace_label}/users/show"
+    else
+      render(json: ['Sorry, you entered an incorrect email address or password.'], status: 401)
+    end
+  end
+
+  def destroy
+    @user = current_user
+      if @user
+        logout!
+        render json: @user
+      else
+        render(json: ["You are not signed in"], status: 404)
+      end
+  end
+RUBY
+      end
+
+      def namespace_users_contents(namespace_label)
+<<RUBY
+  def create
+    @user = User.new(user_params)
+    if @user.save
+      login!(@user)
+      render :show
+    else
+      errors = @user.errors.full_messages
+      render(json: errors, status: 422)
+    end
+  end
+
+  def show
+    @user = User.find(params[:id])
+    render :show
+  end
+
+  def update
+    @user = User.find(params[:user][:id])
+    if @user.update(user_params)
+      render :show
+    else
+      errors = @user.errors.full_messages
+      render(json: errors, status: 422)
+    end
+  end
+RUBY
+      end
+
+      def router_contents(namespace_label)
+<<-RUBY
+
+  namespace :#{namespace_label}, defaults: {format: :json} do
+    resources :users
+  end
+  namespace :#{namespace_label}, defaults: {format: :json} do
+    resource :session
+  end
+RUBY
+      end
+
+    end
+  end
+end

data/lib/generators/install_generator.rb

@@ -0,0 +1,109 @@
+module AuthThree
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include AuthThree::Generators::OrmHelpers
+      include AuthThree::Generators::ControllerHelpers
+      source_root File.expand_path("../../templates", __FILE__)
+      class_option :namespace, type: :string, description: "Namespace your controllers"
+
+      def generate_db_content
+        invoke "active_record:model", ['user'], migration: true
+      end
+
+      def inject_create_users_migration_content
+        content = migration_data
+        indent_depth = 0
+        content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+        index_content = migration_index_data
+        require create_users_migration_file
+        insert_into_file(create_users_migration_file, content, after: ":users do |t|\n")
+        insert_into_file(create_users_migration_file, index_content, after: "t.timestamps\n    end")
+      end
+
+      def migrate_users_data
+        rake "db:migrate"
+      end
+
+      def inject_user_model_content
+        content = model_contents
+
+        indent_depth = 0
+        content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+        inject_into_class("#{model_path}/user.rb", User, content)
+      end
+
+      def copy_application_controller
+        copy_file(controller_source("application_controller.rb"), "#{File.join("app", "controllers")}/application_controller.rb", force: true)
+      end
+
+      def generate_user_controllers
+        controller_names = ['users', 'sessions']
+        controller_names.each do |name|
+          if options[:namespace]
+            generate "controller", "#{options[:namespace]}/#{name} --no-helper --no-assets"
+            content = send("namespace_#{name}_contents".to_sym, options[:namespace])
+            indent_depth = 0
+            content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+            inject_into_class("#{controllers_path}/#{name}_controller.rb", ("#{options[:namespace]}::".camelcase + "#{name}_controller".camelcase).constantize, content)
+          else
+            generate "controller", "#{name} --no-helper --no-assets"
+            content = send("#{name}_controller_contents".to_sym)
+            indent_depth = 0
+            content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+            inject_into_class("#{controllers_path}/#{name}_controller.rb", "#{name}_controller".camelcase.constantize, content)
+          end
+        end
+      end
+
+      def generate_routes
+        if options[:namespace]
+          content = router_contents(options[:namespace])
+          indent_depth = 0
+          content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+          route(content)
+        else
+          route "resources :users"
+          route "resource :session"
+        end
+      end
+
+
+      def further_instructions
+        readme "README.md"
+      end
+      private
+
+      def controllers_path
+        if options[:namespace]
+          File.join("app", "controllers", "#{options[:namespace]}")
+        else
+          File.join("app", "controllers")
+        end
+      end
+
+      def controller_source(controller_name)
+        if options[:namespace]
+          File.expand_path("../../templates/json_controllers/#{controller_name}", __FILE__)
+        else
+          File.expand_path("../../templates/html_controllers/#{controller_name}", __FILE__)
+        end
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def create_users_migration_file
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_create_users.rb$/).first
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models")
+      end
+
+
+    end
+  end
+end

data/lib/generators/orm_helpers.rb

@@ -0,0 +1,96 @@
+module AuthThree
+  module Generators
+    module OrmHelpers
+
+      def model_contents
+<<RUBY
+  validates :username, :email, :session_token, presence: true
+  validates :username, uniqueness: true
+  validates :password_digest, presence: { message: "Password can't be blank."}
+  validates :password, length: { minimum: 6, allow_nil: true }
+
+  after_initialize :ensure_session_token
+
+  def self.token
+    SecureRandom::urlsafe_base64(16)
+  end
+
+  def self.find_by_credentials(username, password)
+    user = User.find_by(username: username)
+    return nil if user.nil?
+    if user.is_password?(password)
+      return user
+    else
+      return nil
+    end
+  end
+
+  attr_reader :password
+
+  def password=(password)
+    @password = password
+    self.password_digest = digest(password)
+  end
+
+  def digest(string)
+    string_digest = BCrypt::Password.create(string)
+  end
+
+  def is_password?(password)
+    BCrypt::Password.new(self.password_digest).is_password?(password)
+  end
+
+  def reset_session_token!
+    self.session_token = User.token
+    self.save
+    self.session_token
+  end
+
+  private
+
+  def ensure_session_token
+    self.session_token ||= User.token
+  end
+RUBY
+      end
+
+      def migration_data
+<<RUBY
+      t.string :username, null: false
+
+      t.string :email, null: false
+
+      t.string :password_digest, null: false
+      t.string :session_token, null: false
+RUBY
+      end
+
+      def migration_index_data
+<<RUBY
+
+    add_index :users, :username, unique: true
+    add_index :users, :email, unique: true
+    add_index :users, :session_token, unique: true
+RUBY
+      end
+
+      private
+
+      def model_exists?
+        File.exist?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_create_users.rb$/).first
+      end
+
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/tasks/auth_three_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :auth_three do
+#   # Task goes here
+# end

data/lib/templates/README.md

@@ -0,0 +1,19 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. This authentication pattern depends on the BCrypt library for securing
+     passwords. If you have not done so already, uncomment or add in
+
+     gem 'bcrypt'
+
+     and then run
+
+     bundle install
+
+  2. Ensure you have defined root_url to *something* in your config/routes.rb.
+     For example:
+
+       root to: "home#index"
+
+===============================================================================

data/lib/templates/html_controllers/application_controller.rb

@@ -0,0 +1,42 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  helper_method :current_user, :logged_in?
+
+  def current_user
+    @current_user ||= User.find_by(session_token: session[:session_token])
+  end
+
+  def login!(user)
+    @current_user = user
+    session[:session_token] = user.reset_session_token!
+  end
+
+  def logout!
+    current_user.reset_session_token!
+    session[:session_token] = nil
+  end
+
+  def logged_in?
+    !!current_user
+  end
+
+  private
+
+  def require_logged_in
+    unless logged_in?
+      redirect_to new_session_url
+    end
+  end
+
+  def require_logged_out
+    if logged_in?
+      # redirect to a root of your choosing if users are in a place that should
+      # not be accessible when logged in
+    end
+  end
+
+  def user_params
+    params.require(:user).permit(:username, :password, :email)    
+  end
+end

data/lib/templates/json_controllers/application_controller.rb

@@ -0,0 +1,42 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+
+  helper_method :current_user, :logged_in?
+
+  def current_user
+    @current_user ||= User.find_by(session_token: session[:session_token])
+  end
+
+  def login!(user)
+    @current_user = user
+    session[:session_token] = user.reset_session_token!
+  end
+
+  def logout!
+    current_user.reset_session_token!
+    session[:session_token] = nil
+  end
+
+  def logged_in?
+    !!current_user
+  end
+
+  private
+
+  def require_logged_in
+    unless logged_in?
+      render json: { errors: ['Not signed in.'] }
+    end
+  end
+
+  def require_logged_out
+    if logged_in?
+      # redirect to a root of your choosing if users are in a place that should
+      # not be accessible when logged in
+    end
+  end
+
+  def user_params
+    params.require(:user).permit(:username, :password, :email)
+  end
+end

data/lib/templates/user.rb

@@ -0,0 +1,50 @@
+class User < ApplicationRecord
+  validates :username, :email, :session_token, presence: true
+  validates :username, uniqueness: true
+  validates :password_digest, presence: { message: "Password can't be blank."}
+  validates :password, length: { minimum: 6, allow_nil: true }
+
+  after_initialize :ensure_session_token
+
+  def self.token
+    SecureRandom::urlsafe_base64(16)
+  end
+
+  def self.find_by_credentials(username, password)
+    user = User.find_by(username: username)
+    return nil if user.nil?
+    if user.is_password?(password)
+      return user
+    else
+      return nil
+    end
+  end
+
+  attr_reader :password
+
+  def password=(password)
+    @password = password
+    self.password_digest = digest(password)
+  end
+
+  def digest(string)
+    string_digest = BCrypt::Password.create(string)
+  end
+
+  def is_password?(password)
+    BCrypt::Password.new(self.password_digest).is_password?(password)
+  end
+
+  def reset_session_token!
+    self.session_token = User.token
+    self.save
+    self.session_token
+  end
+
+  private
+
+  def ensure_session_token
+    self.session_token ||= User.token
+  end
+
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: auth_three
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Michael Chilton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automate basic authentication for your coding challenges
+email:
+- michaelc962@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/auth_three.rb
+- lib/auth_three/version.rb
+- lib/generators/controller_helpers.rb
+- lib/generators/install_generator.rb
+- lib/generators/orm_helpers.rb
+- lib/tasks/auth_three_tasks.rake
+- lib/templates/README.md
+- lib/templates/html_controllers/application_controller.rb
+- lib/templates/json_controllers/application_controller.rb
+- lib/templates/user.rb
+homepage: https://github.com/mc962/auth_three
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Automation for a basic authentication pattern
+test_files: []