mac_generators 0.0.1 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4a91211b48619c200b3a6d3ac7df516d6a61b60
+  data.tar.gz: 441a52f6322a8d7de17fbe8b2f71c1d47974508b
+SHA512:
+  metadata.gz: e650342c2d53508119153a64f848d0d6fa69a17224094b65fe6edf37feaca9463431a37a394bc890b938acb153769d241a192a204b668084791c3b8fc51955ef
+  data.tar.gz: 7f496bde084ac9cdb7f370b3c461994ace1c394a5d1d928f4801359997fe6559747f46ff622f7796b101518c3c34609ca7a89f514c2de73e858c0c7f7549a5be

data/lib/generators/authentication/email/USAGE

@@ -0,0 +1,39 @@
+Description:
+    Generates files for email/password authentication, based on Rails
+    has_secure_password functionality.
+    It uses warden with a single database authentication strategy.
+
+    By default without parameters all code will be generated for a model Identity
+    which will be used for authetication purposes.
+
+    If you want to generate authentication for another model than Identity then
+    pass it as a first parameter.
+
+    Also if you want signup and signin templates to be haml files pass the option
+    --haml, otherwise they will be erb.
+
+Example:
+    rails generate authentication:email
+
+    This will create:
+        app/controllers/identities_controller.rb
+        app/controllers/sessions_controller.rb
+        app/views/identities/new.html.erb
+        app/views/sessions/new.html.erb
+        app/models/identity.rb
+        config/initializers/warden.rb
+        lib/strategies/database_authentication.rb
+
+    And will modify:
+        app/controllers/application_controller.rb
+        config/locales/en.yml
+
+    And will add the following routes:
+        route  get 'sign_up' => 'identities#new', as: :sign_up
+        route  get 'log_in' => 'sessions#new', as: :log_in
+        route  get 'log_out' => 'sessions#destroy', as: :log_out
+        route  resource :identity, only: [:create, :new]
+        route  resource :sessions, only: [:create, :new]
+
+    And finally will add to Gemfile:
+        warden (~> 1.2.0)

data/lib/generators/authentication/email/email_generator.rb

@@ -0,0 +1,128 @@
+module Authentication
+  module Generators
+    class EmailGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :resource_name, :type => :string, :default => 'identity'
+      class_option :haml, type: :boolean, default: false, description: 'Generate haml templates'
+
+      def copy_controller_files
+        template 'identities_controller.rb', File.join('app/controllers', "#{resource_pluralize}_controller.rb")
+        template 'sessions_controller.rb', 'app/controllers/sessions_controller.rb'
+      end
+
+      def copy_view_files
+        if options[:haml]
+          template 'haml/identity_new.html.haml', "app/views/#{resource_pluralize}/new.html.haml"
+          template 'haml/session_new.html.haml', "app/views/sessions/new.html.haml"
+        else
+          template 'erb/identity_new.html.erb', "app/views/#{resource_pluralize}/new.html.erb"
+          template 'erb/session_new.html.erb', "app/views/sessions/new.html.erb"
+        end
+      end
+
+      def add_routes
+        route "get 'sign_up' => '#{resource_pluralize}#new', as: :sign_up"
+        route "get 'log_in' => 'sessions#new', as: :log_in"
+        route "delete 'log_out' => 'sessions#destroy', as: :log_out"
+
+        route "resource :#{resource_name}, only: [:create, :new]"
+        route "resource :sessions, only: [:create, :new]"
+      end
+
+      def generate_user
+        if Dir["db/migrate/*create_#{resource_pluralize}.rb"].empty?
+          template 'create_identities.rb', "db/migrate/#{migration_name}"
+        end
+        template 'identity.rb', "app/models/#{resource_name}.rb"
+      end
+
+      def add_helper_methods
+        insert_into_file 'app/controllers/application_controller.rb', after: /:exception/ do
+    <<-EOS
+
+
+  helper_method :current_#{resource_name}, :#{resource_name}_signed_in?, :warden_message
+
+protected
+  def current_#{resource_name}
+    warden.user(scope: :#{resource_name})
+  end
+
+  def #{resource_name}_signed_in?
+    warden.authenticate?(scope: :#{resource_name})
+  end
+
+  def authenticate!
+    redirect_to root_path, notice: t('.not_logged') unless #{resource_name}_signed_in?
+  end
+
+  def warden_message
+    warden.message
+  end
+
+  def warden
+    request.env['warden']
+  end
+    EOS
+        end
+
+      end
+
+    def add_gems
+      gem 'warden', '~> 1.2.0'
+      gem 'bcrypt-ruby'
+    end
+
+    def add_translations
+      insert_into_file "config/locales/en.yml", after: 'en:' do
+  <<-EOS
+
+  sessions:
+    new:
+      log_in: 'Log in'
+    create:
+      invalid_credentials: 'Your credentials are invalid'
+      logged_in: 'Welcome back!'
+    destroy:
+      logged_out: 'See you later!'
+  #{resource_pluralize}:
+    new:
+      create: 'Create #{resource_name}'
+    create:
+      sign_up: 'Welcome to your new account!'
+  EOS
+      end
+    end
+
+    def copy_warden_file
+      template 'warden.rb', File.join('config', 'initializers', 'warden.rb')
+    end
+
+    def copy_warden_strategies
+      template 'database_authentication.rb', File.join('lib', 'strategies', 'database_authentication.rb')
+    end
+
+    def instructions
+      message = "There are a few manual steps that you need to take care of\n\n"
+      message << "1. Run bundle command to install new gems.\n"
+      message << "2. Be sure that to have definition for root in your routes.\n"
+      message << "3. Run rake db:migrate to add your #{resource_pluralize} table.\n"
+      message << "4. Inspect warden initializer at config/initializers/warden.rb\n"
+      message << "   and update the failure_app if need it.\n"
+      message << "5. Inspect generated files and learn how authentication was implemented.\n\n"
+
+      puts message
+    end
+
+    private
+      def migration_name
+        date = (DateTime.now.strftime "%Y %m %d %H %M %S").gsub(' ', '')
+        "#{date}_create_#{resource_pluralize}.rb"
+      end
+
+      def resource_pluralize
+        @resource_pluralize ||= resource_name.pluralize
+      end
+    end
+  end
+end

data/lib/generators/authentication/{templates → email/templates}/create_identities.rb

@@ -3,7 +3,7 @@ class Create<%= resource_pluralize.capitalize %> < ActiveRecord::Migration
     create_table :<%= resource_pluralize %> do |t|
       t.string :email
       t.string :password_hash
-      t.string :password_salt
+      t.string :password_digest
 
       t.timestamps
     end

data/lib/generators/authentication/email/templates/database_authentication.rb

@@ -0,0 +1,16 @@
+module Strategies
+  class DatabaseAuthentication < ::Warden::Strategies::Base
+    def valid?
+      params['<%= resource_name %>'].present?
+    end
+
+    def authenticate!
+      <%= resource_name %> = <%= resource_name.classify %>.find_by_email(params['<%= resource_name %>']['email']).try(:authenticate, params['<%= resource_name %>']['password'])
+
+      return success! <%= resource_name %> if <%= resource_name %>
+      fail! I18n.t('sessions.create.invalid_credentials')
+    end
+  end
+end
+
+Warden::Strategies.add(:database_authentication, Strategies::DatabaseAuthentication)

data/lib/generators/authentication/email/templates/erb/session_new.html.erb

@@ -0,0 +1,15 @@
+<%%= form_for @<%= resource_name %>, url: sessions_path do |form| %>
+  <%%- if warden_message %>
+    <div class='alert'><%%= warden_message %></div>
+  <%% end %>
+
+  <p>
+    <%%= form.label :email %><br />
+    <%%= form.text_field :email %>
+  </p>
+  <p>
+    <%%= form.label :password %><br />
+    <%%= form.password_field :password %>
+  </p>
+  <p class='button'><%%= form.submit t('.log_in') %></p>
+<%% end %>

data/lib/generators/authentication/email/templates/haml/session_new.html.haml

@@ -0,0 +1,15 @@
+= form_for @<%= resource_name %>, url: sessions_path do |form|
+  - if warden_message
+    .alert
+      = warden_message
+
+  %p
+    = form.label :email
+    %br/
+    = form.text_field :email
+  %p
+    = form.label :password
+    %br/
+    = form.password_field :password
+  %p.button
+    = form.submit t('.log_in')

data/lib/generators/authentication/{templates → email/templates}/identities_controller.rb

@@ -8,7 +8,7 @@ class <%= resource_pluralize.capitalize %>Controller < ApplicationController
     @<%= resource_name %> = <%= resource_name.classify %>.new <%= resource_name %>_params
 
     if @<%= resource_name %>.save
-      session[:<%=resource_name %>_id] = <%= resource_name %>.id
+      warden.set_user(@<%= resource_name %>, scope: :<%=resource_name %>)
       redirect_to root_url, notice: t('.sign_up')
     else
       render :new

data/lib/generators/authentication/email/templates/identity.rb

@@ -0,0 +1,6 @@
+class <%= resource_name.classify %> < ActiveRecord::Base
+  has_secure_password validations: true
+
+  validates :email, presence: true, uniqueness: true
+  validates :password_confirmation, presence: true, if: -> r { r.password.present? }
+end

data/lib/generators/authentication/email/templates/sessions_controller.rb

@@ -0,0 +1,16 @@
+class SessionsController < ApplicationController
+  def new
+    @<%= resource_name %> = <%= resource_name.classify %>.new
+  end
+
+  def create
+    warden.authenticate!(scope: :<%= resource_name %>)
+    redirect_to root_url, notice: t('.logged_in')
+  end
+
+  def destroy
+    warden.logout(:<%=resource_name %>)
+    redirect_to root_url, notice: t('.logged_out')
+  end
+end
+

data/lib/generators/authentication/email/templates/warden.rb

@@ -0,0 +1,19 @@
+load File.expand_path("../../../lib/strategies/database_authentication.rb",  __FILE__)
+Rails.application.config.middleware.use Warden::Manager do |manager|
+  manager.default_strategies :database_authentication
+
+  # TODO: Setup warden's failure app, this will be called everytime that
+  # and authentication failure happen.
+  # Failure app should be a Rack application.
+  # In Rails a controller can be used as a Rack app, just specify the
+  # controller and the action to be called. Example:
+  manager.failure_app = lambda { |env| SessionsController.action(:new).call(env) }
+end
+
+Warden::Manager.serialize_into_session(:<%= resource_name %>) do |<%= resource_name %>|
+  <%= resource_name %>.id
+end
+
+Warden::Manager.serialize_from_session(:<%= resource_name %>) do |id|
+  <%= resource_name.classify %>.find(id)
+end

data/lib/generators/authentication/omniauth/USAGE

@@ -0,0 +1,32 @@
+Description:
+    Generates files for oauth authentication using omniauth.
+    It uses warden with a single oauth authentication strategy.
+
+    By default without parameters all code will be generated for a model Identity
+    which will be used for authetication purposes.
+
+    If you want to generate authentication for another model than Identity then
+    pass it as a first parameter.
+
+Example:
+    rails generate authentication:omniauth
+
+    This will create:
+        app/controllers/sessions_controller.rb
+        app/models/identity.rb
+        config/initializers/warden.rb
+        config/initializers/omniauth.rb
+        config/initializers/authentication_domain.rb
+        lib/strategies/oauth_authentication.rb
+
+    And will modify:
+        app/controllers/application_controller.rb
+        config/locales/en.yml
+
+    And will add the following routes:
+        route  get 'auth/:provider/callback' => 'sessions#create', as: :log_in
+        route  delete '/sessions/destroy' => 'sessions#destroy', as: :log_out
+
+    And finally will add to Gemfile:
+        warden (~> 1.2.0)
+        omniauth

data/lib/generators/authentication/omniauth/omniauth_generator.rb

@@ -0,0 +1,121 @@
+module Authentication
+  module Generators
+    class OmniauthGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      argument :resource_name, :type => :string, :default => 'identity'
+
+      def copy_controller_files
+        template 'sessions_controller.rb', 'app/controllers/sessions_controller.rb'
+      end
+
+      def add_routes
+        route "get 'auth/:provider/callback' => 'sessions#create', as: :log_in"
+        route "delete '/sessions/destroy' => 'sessions#destroy', as: :log_out"
+      end
+
+      def generate_user
+        if Dir["db/migrate/*create_#{resource_pluralize}.rb"].empty?
+          template 'create_identities.rb', "db/migrate/#{migration_name}"
+        end
+        template 'identity.rb', "app/models/#{resource_name}.rb"
+      end
+
+      def add_helper_methods
+        insert_into_file 'app/controllers/application_controller.rb', after: /:exception/ do
+    <<-EOS
+
+
+  helper_method :current_#{resource_name}, :#{resource_name}_signed_in?, :warden_message
+
+protected
+  def current_#{resource_name}
+    warden.user(scope: :#{resource_name})
+  end
+
+  def #{resource_name}_signed_in?
+    warden.authenticate?(scope: :#{resource_name})
+  end
+
+  def authenticate!
+    redirect_to root_path, notice: t('.not_logged') unless #{resource_name}_signed_in?
+  end
+
+  def warden_message
+    warden.message
+  end
+
+  def warden
+    request.env['warden']
+  end
+    EOS
+        end
+
+      end
+
+    def add_gems
+      gem 'warden', '~> 1.2.0'
+      gem 'omniauth'
+    end
+
+    def add_translations
+      insert_into_file "config/locales/en.yml", after: 'en:' do
+  <<-EOS
+
+  sessions:
+    new:
+      log_in: 'Log in'
+    create:
+      unauthorized_domain: 'Sorry but your domain is not authorized'
+      logged_in: 'Welcome back!'
+    destroy:
+      logged_out: 'See you later!'
+  EOS
+      end
+    end
+
+    def copy_warden_file
+      template 'warden.rb', File.join('config', 'initializers', 'warden.rb')
+    end
+
+    def copy_configuration
+      template 'authentication_domain.rb', File.join('config', 'initializers', 'authentication_domain.rb')
+    end
+
+    def copy_omniauth_configuration
+      template 'omniauth.rb', File.join('config', 'initializers', 'omniauth.rb')
+    end
+
+    def copy_warden_strategies
+      template 'oauth_authentication.rb', File.join('lib', 'strategies', 'oauth_authentication.rb')
+    end
+
+    def instructions
+      message = "There are a few manual steps that you need to take care of\n\n"
+      message << "1. Add an omniauth provider gem like twitter, facebook, etc..\n"
+      message << "2. Modify config/initializers/omniauth.rb and setup your provider\n"
+      message << "   and your provider credentials.\n"
+      message << "3. Run bundle command to install new gems.\n"
+      message << "4. If you want to restrict access to a specific email domain.\n"
+      message << "   modify config/initializers/authentication_domain.rb and add \n"
+      message << "   your allowed domain.\n"
+      message << "5. Inspect warden initializer at config/initializers/warden.rb\n"
+      message << "   and update the failure_app.\n"
+      message << "6. Be sure that to have definition for root in your routes.\n"
+      message << "7. Run rake db:migrate to add your #{resource_pluralize} table.\n"
+      message << "8. Inspect generated files and learn how authentication was implemented.\n\n"
+
+      puts message
+    end
+
+    private
+      def migration_name
+        date = (DateTime.now.strftime "%Y %m %d %H %M %S").gsub(' ', '')
+        "#{date}_create_#{resource_pluralize}.rb"
+      end
+
+      def resource_pluralize
+        @resource_pluralize ||= resource_name.pluralize
+      end
+    end
+  end
+end

data/lib/generators/authentication/omniauth/templates/authentication_domain.rb

@@ -0,0 +1 @@
+Rails.application.config.authentication_domain = ''

data/lib/generators/authentication/omniauth/templates/create_identities.rb

@@ -0,0 +1,12 @@
+class Create<%= resource_pluralize.capitalize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= resource_pluralize %> do |t|
+      t.string :provider
+      t.string :uid
+      t.string :name
+      t.string :email
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/authentication/omniauth/templates/identity.rb

@@ -0,0 +1,9 @@
+class <%= resource_name.classify %> < ActiveRecord::Base
+
+  class << self
+    def find_identity(uid, provider)
+      where(uid: uid, provider: provider).first
+    end
+  end
+
+end

data/lib/generators/authentication/omniauth/templates/oauth_authentication.rb

@@ -0,0 +1,36 @@
+module Strategies
+  class OauthAuthentication < ::Warden::Strategies::Base
+    def valid?
+      request.env['omniauth.auth'].present?
+    end
+
+    def authenticate!
+      auth = request.env['omniauth.auth']
+
+      if authorized_domain?(auth)
+        <%= resource_name %> = <%= resource_name.classify %>.find_<%= resource_name %>(auth['uid'], auth['provider']) || create_<%= resource_name %>(auth)
+        return success! <%= resource_name %>
+      end
+
+      fail! I18n.t('sessions.create.unauthorized_domain')
+    end
+
+  private
+    def authorized_domain?(auth)
+      if Rails.application.config.respond_to?(:authentication_domain) && Rails.application.config.authentication_domain.present?
+        return auth['info']['email'].split('@').last == Rails.application.config.authentication_domain
+      end
+
+      true
+    end
+
+    def create_<%= resource_name %>(auth)
+      params = { uid: auth['uid'], provider: auth['provider'],
+                name: auth['info']['name'], email: auth['info']['email'] }
+
+      <%= resource_name.classify %>.create! params
+    end
+  end
+end
+
+Warden::Strategies.add(:oauth_authentication, Strategies::OauthAuthentication)

data/lib/generators/authentication/omniauth/templates/omniauth.rb

@@ -0,0 +1,3 @@
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :provider, ENV["KEY"], ENV["SECRET"]
+end

data/lib/generators/authentication/omniauth/templates/sessions_controller.rb

@@ -0,0 +1,12 @@
+class SessionsController < ApplicationController
+  def create
+    warden.authenticate!(scope: :<%= resource_name %>)
+    redirect_to root_url, notice: t('.logged_in')
+  end
+
+  def destroy
+    warden.logout(:<%=resource_name %>)
+    redirect_to root_url, notice: t('.logged_out')
+  end
+end
+

data/lib/generators/authentication/omniauth/templates/warden.rb

@@ -0,0 +1,19 @@
+load File.expand_path("../../../lib/strategies/oauth_authentication.rb",  __FILE__)
+Rails.application.config.middleware.use Warden::Manager do |manager|
+  manager.default_strategies :oauth_authentication
+
+  # TODO: Setup warden's failure app, this will be called everytime that
+  # and authentication failure happen.
+  # Failure app should be a Rack application.
+  # In Rails a controller can be used as a Rack app, just specify the
+  # controller and the action to be called. Example:
+  #manager.failure_app = lambda { |env| HomeController.action(:index).call(env) }
+end
+
+Warden::Manager.serialize_into_session(:<%= resource_name %>) do |<%= resource_name %>|
+  <%= resource_name %>.id
+end
+
+Warden::Manager.serialize_from_session(:<%= resource_name %>) do |id|
+  <%= resource_name.classify %>.find(id)
+end

data/lib/mac_generators/version.rb

@@ -1,3 +1,3 @@
 module MacGenerators
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/test/dummy/app/controllers/application_controller.rb

@@ -2,4 +2,28 @@ class ApplicationController < ActionController::Base
   # Prevent CSRF attacks by raising an exception.
   # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
+
+  helper_method :current_identity, :identity_signed_in?, :warden_message
+
+protected
+  def current_identity
+    warden.user(scope: :identity)
+  end
+
+  def identity_signed_in?
+    warden.authenticate?(scope: :identity)
+  end
+
+  def authenticate!
+    redirect_to root_path, notice: t('.not_logged') unless identity_signed_in?
+  end
+
+  def warden_message
+    warden.message
+  end
+
+  def warden
+    request.env['warden']
+  end
+
 end

data/test/dummy/config/database.yml

@@ -5,7 +5,7 @@
 #   gem 'sqlite3'
 development:
   adapter: sqlite3
-  database: db/development.sqlite3
+  database: ":memory:"
   pool: 5
   timeout: 5000
 
@@ -14,12 +14,12 @@ development:
 # Do not set this db to the same as development or production.
 test:
   adapter: sqlite3
-  database: db/test.sqlite3
+  database: ":memory:"
   pool: 5
   timeout: 5000
 
 production:
   adapter: sqlite3
-  database: db/production.sqlite3
+  database: ":memory:"
   pool: 5
   timeout: 5000

data/test/dummy/config/environments/test.rb

@@ -33,7 +33,4 @@ Dummy::Application.configure do
 
   # Print deprecation notices to the stderr.
   config.active_support.deprecation = :stderr
-
-  # Use the synchronous queue to run jobs immediately.
-  config.queue = ActiveSupport::SynchronousQueue.new
 end

data/test/dummy/config/locales/en.yml

@@ -20,4 +20,18 @@
 # available at http://guides.rubyonrails.org/i18n.html.
 
 en:
+    sessions:
+      new:
+        log_in: 'Log in'
+      create:
+        invalid_credentials: 'Your credentials are invalid'
+        logged_in: 'Welcome back!'
+      destroy:
+        logged_out: 'See you later!'
+    identities:
+      new:
+        create: 'Create identity'
+      create:
+        sign_up: 'Welcome to your new account!'
+
   hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -1,4 +1,9 @@
 Dummy::Application.routes.draw do
+  resource :sessions, only: [:create, :new]
+  resource :identity, only: [:create, :new]
+  get 'log_out' => 'sessions#destroy', as: :log_out
+  get 'log_in' => 'sessions#new', as: :log_in
+  get 'sign_up' => 'identities#new', as: :sign_up
   # The priority is based upon order of creation: first created -> highest priority.
   # See how all your routes lay out with "rake routes".