genkan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d80a811e2eee19c521d2ec48d4ef6ba036c693cc
+  data.tar.gz: be34267225708d4a0d809e9441bec4a994c85551
+SHA512:
+  metadata.gz: 336627fca3b0d252fae0661f09a0aedf6c8d592b052c3e1c0e35380a5ab1dbc8df3347dcc5aa140133247b5938a16de93cc6e5097c0c1263ed92d4c11be60d08
+  data.tar.gz: 51d2fac3b7f743b2b5ff59ff6d881348c9517b1e49f53f5b663e84e316286f4b7c10766b8182af7c8689d094d45894f347acc580cc14a714ab9c900f06002e46

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Yoshiyuki Hirano
+
+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,94 @@
+<img width="350" src="https://user-images.githubusercontent.com/15371677/27876034-6f54c860-61f0-11e7-8ebb-0623227ee491.png">
+
+Genkan is authentication engine for Rails
+
+## Installation
+
+```ruby
+gem 'genkan'
+
+# Add any omniauth provider
+gem 'omniauth-google-oauth2'
+gem 'omniauth-facebook'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Getting started
+
+```bash
+$ bin/rails g genkan:install --model User
+      create  config/initializers/genkan.rb
+      create  db/migrate/20170705074103_create_users.rb
+      create  app/models/user.rb
+      insert  app/controllers/application_controller.rb
+       route  mount Genkan::Engine, at: '/'
+      create  app/views/genkan/sessions/new.html.erb
+
+$ bin/rails db:migrate
+```
+
+Some setup you must do manually if you haven't yet:
+
+1. Ensure you have edited config/initializers/genkan.rb.
+   For example:
+
+  ```ruby
+  Genkan.configure do |config|
+    config.user_class_name = 'User'
+    config.auto_acceptance = false
+  end
+
+  Genkan::Engine.configure do |config|
+    config.middleware.use OmniAuth::Builder do
+      # Add omniauth-google-oauth2 to Gemfile:
+      #   gem 'omniauth-google-oauth2'
+      provider(
+        :google_oauth2,
+        ENV['GOOGLE_OAUTH_CLIENT_ID'],
+        ENV['GOOGLE_OAUTH_CLIENT_SECRET'],
+        {
+          name:  'google',
+          scope: 'email',
+          hd:    'host-domain.com'
+        }
+      )
+    end
+  end
+  ```
+
+2. Ensure you have defined root_url to *something* in your config/routes.rb.
+   For example:
+
+  ```ruby
+  root to: "home#index"
+  ```
+
+3. Ensure you have flash messages in app/views/layouts/application.html.erb.
+   For example:
+
+  ```ruby
+  <p class="notice"><%= notice %></p>
+  <p class="alert"><%= alert %></p>
+  ```
+
+## Debugging
+
+You can check on dummy server:
+
+```bash
+$ bundle
+$ bin/rails db:setup
+$ GOOGLE_OAUTH_CLIENT_ID=YOUR_ID GOOGLE_OAUTH_CLIENT_SECRET=YOUR_SECRET bin/rails s
+```
+
+How to create google client id and secret:
+
+- [Creating a Google API Console project and client ID  |  Google Sign-In for Websites  |  Google Developers](https://developers.google.com/identity/sign-in/web/devconsole-project).
+
+## 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,26 @@
+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    = 'Genkan'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/concerns/genkan/authenticatable.rb

@@ -0,0 +1,29 @@
+module Genkan
+   module Authenticatable
+    include Genkan::Helper
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :authenticate
+      helper_method current_user_method_name, :logged_in?
+    end
+
+    private
+
+    def authenticate
+      unless logged_in?
+        session[:referer] = request.fullpath
+        redirect_to genkan.login_path, notice: t('genkan.sessions.required')
+      end
+    end
+
+    define_method(current_user_method_name) do
+      instance_variable_get(:"@#{current_user_method_name}") || \
+        instance_variable_set(:"@#{current_user_method_name}", user_class.active.find_by(remember_token: session[:remember_token]))
+    end
+
+    def logged_in?
+      send(current_user_method_name).present?
+    end
+  end
+end

data/app/controllers/concerns/genkan/helper.rb

@@ -0,0 +1,18 @@
+module Genkan
+  module Helper
+    extend ActiveSupport::Concern
+
+    included do
+      private
+      delegate :user_class, :current_user_method_name, to: :class
+    end
+
+    class_methods do
+      delegate :user_class, :current_user_method_name, to: :genkan_config
+
+      def genkan_config
+        Genkan.config
+      end
+    end
+  end
+end

data/app/controllers/genkan/application_controller.rb

@@ -0,0 +1,7 @@
+module Genkan
+  class ApplicationController < ActionController::Base
+    include ::Genkan::Authenticatable
+    protect_from_forgery with: :exception
+    layout "layouts/application"
+  end
+end

data/app/controllers/genkan/sessions_controller.rb

@@ -0,0 +1,50 @@
+require_dependency "genkan/application_controller"
+
+module Genkan
+  class SessionsController < ApplicationController
+    rescue_from ActiveRecord::RecordInvalid do |_e|
+      redirect_to genkan.login_path, alert: user.errors.full_messages.to_sentence
+    end
+
+    skip_before_action :authenticate, only: %i(new create failure)
+
+    def new; end
+
+    def create
+      user.login!
+      create_session
+      redirect_to referer_or_root_path, notice: t('genkan.sessions.logged_in')
+    end
+
+    def failure
+      redirect_to genkan.login_path, alert: t('genkan.sessions.failure')
+    end
+
+    def destroy
+      destroy_session
+      redirect_to genkan.login_path, notice: t('genkan.sessions.logged_out')
+    end
+
+    private
+
+    def user
+      @user ||= user_class.find_or_create_by(email: auth.dig(:info, :email))
+    end
+
+    def auth
+      request.env['omniauth.auth']
+    end
+
+    def create_session
+      session[:remember_token] = user.remember_token
+    end
+
+    def destroy_session
+      session[:remember_token] = nil
+    end
+
+    def referer_or_root_path
+      session.delete(:referer) || main_app.root_path
+    end
+  end
+end

data/app/models/concerns/genkan/auth.rb

@@ -0,0 +1,78 @@
+module Genkan
+  module Auth
+    extend ActiveSupport::Concern
+
+    included do
+      scope :accepted,   -> { where.not(accepted_at: nil) }
+      scope :not_banned, -> { where(banned_at: nil) }
+      scope :active,     -> { accepted.not_banned }
+
+      validates :email, presence: true, uniqueness: true
+
+      with_options on: :login do
+        validate :ensure_record_has_accepted
+        validate :ensure_record_has_not_banned
+      end
+
+      before_create do
+        self.remember_token = SecureRandom.hex(20)
+      end
+    end
+
+    def login
+      store_last_logged_in_at
+      increment_logged_in_count
+      accept if Genkan.config.auto_acceptance?
+    end
+
+    def login!
+      login
+      save!(context: :login)
+    end
+
+    def accepted?
+      accepted_at.present?
+    end
+
+    def accept
+      self.accepted_at = Time.current
+    end
+
+    def accept!
+      accept
+      save!
+    end
+
+    def banned?
+      self.banned_at.present?
+    end
+
+    def ban
+      self.banned_at = Time.current
+    end
+
+    def ban!
+      ban
+      save!
+    end
+
+    private
+
+    def store_last_logged_in_at
+      self.last_logged_in_at = Time.current
+    end
+
+    def increment_logged_in_count
+      self.logged_in_count ||= 0
+      self.logged_in_count += 1
+    end
+
+    def ensure_record_has_accepted
+      errors.add(:base, :not_accepted) unless accepted?
+    end
+
+    def ensure_record_has_not_banned
+      errors.add(:base, :banned) if banned?
+    end
+  end
+end

data/app/models/genkan/application_record.rb

@@ -0,0 +1,5 @@
+module Genkan
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  genkan:
+    sessions:
+      failure:    Could not authenticated
+      required:   You need to login
+      logged_in:  Logged in successfully
+      logged_out: Logged out successfully
+  errors:
+    messages:
+      not_accepted: Your account is not accepted yet.
+      banned:       Your account is locked.

data/config/locales/ja.yml

@@ -0,0 +1,11 @@
+ja:
+  genkan:
+    sessions:
+      failure:    認証できません
+      required:   ログインが必要です
+      logged_in:  ログインしました
+      logged_out: ログアウトしました
+  errors:
+    messages:
+      not_accepted: 利用が許可されていません
+      banned:       指定したアカウントでは、ご利用いただけません

data/config/routes.rb

@@ -0,0 +1,6 @@
+Genkan::Engine.routes.draw do
+  get  "/login",                   to: "sessions#new"
+  get  "/logout",                  to: "sessions#destroy"
+  get  "/auth/:provider/callback", to: "sessions#create"
+  post "/auth/:provider/callback", to: "sessions#create"
+end

data/lib/generators/genkan/USAGE

@@ -0,0 +1,9 @@
+Description:
+  Generates the necessary files to get you up and running with Genkan gem
+
+Examples:
+  rails generate genkan:install
+
+    This will generate the core migration file, the initializer file and the 'User' model class.
+
+  rails generate genkan:install --model AdminUser

data/lib/generators/genkan/helper.rb

@@ -0,0 +1,57 @@
+module Genkan
+  module Generators
+    module Helper
+      extend ActiveSupport::Concern
+
+      private
+
+      def model_class_name
+        options.key?(:model) ? options[:model].classify : "User"
+      end
+
+      def model_file_path
+        model_name.underscore
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{model_file_path}.rb")
+      end
+
+      def namespace
+        Rails::Generators.namespace if Rails::Generators.respond_to?(:namespace)
+      end
+
+      def namespaced?
+        !!namespace
+      end
+
+      def model_name
+        if namespaced?
+          [namespace.to_s] + [model_class_name]
+        else
+          [model_class_name]
+        end.join("::")
+      end
+
+      def migration_class_name
+        if Rails::VERSION::MAJOR >= 5
+          "ActiveRecord::Migration[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        else
+          "ActiveRecord::Migration"
+        end
+      end
+
+      class_methods do
+        # Define the next_migration_number method (necessary for the migration_template method to work)
+        def next_migration_number(dirname)
+          if ActiveRecord::Base.timestamped_migrations
+            sleep 1 # make sure each time we get a different timestamp
+            Time.new.utc.strftime("%Y%m%d%H%M%S")
+          else
+            format("%.3d", (current_migration_number(dirname) + 1))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/genkan/install_generator.rb

@@ -0,0 +1,45 @@
+require "rails/generators/migration"
+require "generators/genkan/helper"
+
+module Genkan
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      include Genkan::Generators::Helper
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      class_option :model, optional: true,
+                           type:     :string,
+                           banner:   "model",
+                           desc:     "Specify the model class name if you will use anything other than `User`",
+                           default:  "User"
+
+      def prepare_initializer
+        template "initializer.erb", "config/initializers/genkan.rb"
+      end
+
+      def prepare_migration
+        migration_template "migration.erb", "db/migrate/create_#{model_class_name.tableize}.rb", migration_class_name: migration_class_name
+      end
+
+      def prepare_model
+        template "model.erb", "app/models/#{model_file_path}.rb"
+      end
+
+      def prepare_controller
+        inject_into_file "app/controllers/application_controller.rb", after: "class ApplicationController < ActionController::Base\n" do
+          "  include Genkan::Authenticatable\n"
+        end
+      end
+
+      def prepare_routes
+        route "mount Genkan::Engine, at: '/'"
+      end
+
+      def prepare_view
+        template "view.erb", "app/views/genkan/sessions/new.html.erb"
+      end
+    end
+  end
+end

data/lib/generators/genkan/templates/initializer.erb

@@ -0,0 +1,21 @@
+Genkan.configure do |config|
+  config.user_class_name = '<%= model_class_name %>'
+  config.auto_acceptance = false
+end
+
+Genkan::Engine.configure do |config|
+  # config.middleware.use OmniAuth::Builder do
+  #   # Add omniauth-google-oauth2 to Gemfile:
+  #   #   gem 'omniauth-google-oauth2'
+  #   provider(
+  #     :google_oauth2,
+  #     ENV['GOOGLE_OAUTH_CLIENT_ID'],
+  #     ENV['GOOGLE_OAUTH_CLIENT_SECRET'],
+  #     {
+  #       name:  'google',
+  #       scope: 'email',
+  #       hd:    'host-domain.com'
+  #     }
+  #   )
+  # end
+end

data/lib/generators/genkan/templates/migration.erb

@@ -0,0 +1,17 @@
+class Create<%= model_class_name.tableize.camelize %> < <%= migration_class_name %>
+  def change
+    create_table :<%= model_class_name.tableize %> do |t|
+      t.string   :email,           null: false
+      t.string   :remember_token,  null: false
+      t.integer  :logged_in_count, null: false, default: 0
+      t.datetime :last_logged_in_at
+      t.datetime :accepted_at
+      t.datetime :banned_at
+
+      t.timestamp
+
+      t.index :email, unique: true
+      t.index :remember_token, unique: true
+    end
+  end
+end

data/lib/generators/genkan/templates/model.erb

@@ -0,0 +1,3 @@
+class <%= model_class_name %> < ApplicationRecord
+  include Genkan::Auth
+end

data/lib/generators/genkan/templates/view.erb

@@ -0,0 +1,3 @@
+<h1>Genkan::SessionsController#new</h1>
+
+<%%= link_to "login", "/auth/google" %>

data/lib/genkan/config.rb

@@ -0,0 +1,22 @@
+module Genkan
+  class Config
+    attr_accessor :user_class_name, :auto_acceptance
+
+    def initialize
+      @user_class_name = "User"
+      @auto_acceptance = false
+    end
+
+    def user_class
+      @user_class ||= user_class_name.safe_constantize
+    end
+
+    def current_user_method_name
+      @current_user_method_name ||= "current_#{user_class_name.underscore.gsub(/\//, '_')}".freeze
+    end
+
+    def auto_acceptance?
+      !!auto_acceptance
+    end
+  end
+end

data/lib/genkan/engine.rb

@@ -0,0 +1,13 @@
+module Genkan
+  class Engine < ::Rails::Engine
+    isolate_namespace Genkan
+
+    config.generators do |g|
+      g.stylesheets false
+      g.javascripts false
+      g.helper false
+      g.test_framework :rspec, fixture: true
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+  end
+end

data/lib/genkan/version.rb

@@ -0,0 +1,3 @@
+module Genkan
+  VERSION = '0.1.0'
+end

data/lib/genkan.rb

@@ -0,0 +1,12 @@
+require "genkan/config"
+require "genkan/engine"
+
+module Genkan
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @_config ||= Config.new
+  end
+end

data/lib/tasks/genkan_tasks.rake

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

data/spec/controllers/genkan/sessions_controller_spec.rb

@@ -0,0 +1,74 @@
+require 'rails_helper'
+
+RSpec.describe Genkan::SessionsController do
+  routes { Genkan::Engine.routes }
+
+  before do
+    stub_omniauth
+    request.env['omniauth.auth'] = OmniAuth.config.mock_auth[:google]
+  end
+
+  describe 'GET #new' do
+    before { get :new }
+    it { expect(response).to have_http_status(200) }
+  end
+
+  describe 'POST #create' do
+    subject(:execution) { post :create, params: { provider: :google } }
+
+    context 'when auto_acceptance is true' do
+      before { allow_any_instance_of(Genkan::Config).to receive(:auto_acceptance).and_return(true) }
+
+      it 'creates a user' do
+        expect { execution }.to change { User.count }.by(1)
+      end
+
+      it 'creates a session' do
+        expect(session[:remember_token]).to be_nil
+        execution
+        expect(session[:remember_token]).to be_present
+      end
+
+      it 'redirects root_path' do
+        execution
+        expect(response).to have_http_status(302)
+        expect(response).to redirect_to(Dummy::Application.routes.url_helpers.root_path)
+      end
+    end
+
+    context 'when auto_acceptance is false' do
+      before { allow_any_instance_of(Genkan::Config).to receive(:auto_acceptance).and_return(false) }
+
+      it 'creates a user' do
+        expect { execution }.to change { User.count }.by(1)
+      end
+
+      it 'redirects login_path' do
+        execution
+        expect(response).to have_http_status(302)
+        expect(response).to redirect_to(login_path)
+      end
+    end
+  end
+
+  describe 'GET #destroy' do
+    before do
+      allow_any_instance_of(Genkan::Config).to receive(:auto_acceptance).and_return(true)
+      post :create, params: { provider: :google }
+    end
+
+    subject(:execution) { get :destroy }
+
+    it 'destroys a session' do
+      expect(session[:remember_token]).to be_present
+      execution
+      expect(session[:remember_token]).to be_nil
+    end
+
+    it 'redirects login_path' do
+      execution
+      expect(response).to have_http_status(302)
+      expect(response).to redirect_to(login_path)
+    end
+  end
+end