cmor_user_area 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 577ff124ebe4064684580550735d5f1ce9270912d1dd375e6d2daddc6e672910
+  data.tar.gz: 13a7aebd005de71bfd7a250fc030c3b089af281fe7e5dda588e4b809db3abd44
+SHA512:
+  metadata.gz: 7431a27ce166f7504d3811ace8abd77c7690f1ff4b44e04d7ac5e2e8fdf2de4d627c0ac3a5f05b04ba0b2869c8cce909f08d4878755214fb15387995ee5d648c
+  data.tar.gz: 6f279ac3d656247ec55d4a156b4e6e24e809fdb0e131fb67fc7fedafe248f033f3b9f1330834b9613c27f0cdcb45b0ce4020a92458b174e538b0a39a42a3715f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Roberto Vasquez Angel
+
+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.rdoc

@@ -0,0 +1,78 @@
+= CMOR User Area
+
+= Migration to 4.0.0
+
+Defining after_sign_in_url in the controller is not supported anymore. Control
+the after sign in location by configuring it in the initializer:
+
+    # config/initalizers/cmor_user_area.rb
+    Cmor::UserArea.configure do |config|
+      config.after_sign_in_url = ->(controller) { last_location || main_app.root_path }
+    end
+
+= Installation
+
+Add it to your Gemfile:
+
+  # Gemfile
+  gem 'cmor_user_area2'
+
+Install:
+
+  rails g cmor:user_area:install
+
+Add Migrations and migrate:
+
+  rake cmor_user_area:install:migrations && rake db:migrate
+
+Optionally, create a default user (user@example.com/password):
+
+  rake cmor:user_area:create_default_user
+  
+Add routes:
+
+  # config/routes.rb
+  mount Cmor::UserArea::Engine, at: '/auth'
+
+Add current_user helpers to your application controller:
+
+  # app/controllers/application_controller.rb
+  include Cmor::UserArea::Controller::RedirectBackConcern
+  include Cmor::UserArea::Controller::CurrentUserConcern
+
+
+= Usage
+
+to secure a controller, add following before_action:
+
+  # app/controllers/my_secure_controller.rb
+  before_action :authenticate_user!
+
+When you visit any controller actions, you will be redirected to the sign in form.
+
+
+= Adding helper methods
+
+  # app/controllers/application_controller.rb
+  include Cmor::UserArea::Controller::CurrentUserConcern
+
+This gives you #current_user_session, #current_user, user_signed_in?
+
+
+= Using the navigation helper
+
+  # app/controllers/application_controller.rb
+  view_helper Cmor::UserArea::ApplicationViewHelper, as: :user_area_helper
+
+  # app/views/layouts/application.html.erb
+  <%= user_area_helper(self).render_navigation %>
+
+
+= Running Specs
+
+    gem install bundler
+    bundle
+    cd spec/dummy && rake db:migrate RAILS_ENV=test && cd ../..
+    guard
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,19 @@
+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    = 'Cmor::UserArea'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rails/dummy/tasks'

data/app/concerns/cmor/user_area/controller/current_user_concern.rb

@@ -0,0 +1,64 @@
+module Cmor
+  module UserArea
+    module Controller
+      module CurrentUserConcern
+        extend ActiveSupport::Concern
+
+        included do
+          helper_method :current_user_session, :current_user, :user_signed_in?
+        end
+
+        private
+
+        def after_sign_out_url
+          "/#{I18n.locale}"
+        end
+
+        def authenticate_user!
+          unless user_signed_in?
+            store_location
+            handle_authentication_failure
+            return false
+          end
+          true
+        end
+
+        def current_user_session
+          return @current_user_session if defined?(@current_user_session)
+          @current_user_session = ::Cmor::UserArea::UserSession.find
+        end
+
+        def current_user
+          return @current_user if defined?(@current_user)
+          @current_user = current_user_session && current_user_session.user
+        end
+
+        def user_authentication_failed_path
+          cmor_user_area.new_user_session_path
+        end
+
+        def user_signed_in?
+          !current_user.nil?
+        end
+
+        def sign_out_user
+          @current_user = nil
+          redirect_to after_sign_out_url
+        end
+
+        def current_session(type)
+          type = type.to_s
+          type << '_session' unless type.end_with?('_session')
+          send("current_#{type}".to_sym)
+        end
+
+        def handle_authentication_failure
+          respond_to do |format|
+            format.json { render json: { error: :forbidden }, status: :forbidden }
+            format.html { redirect_to(user_authentication_failed_path, notice: t('messages.failures.cmor_user_area.authentication_failed')) }
+          end
+        end
+      end
+    end
+  end
+end

data/app/concerns/cmor/user_area/controller/redirect_back_concern.rb

@@ -0,0 +1,32 @@
+module Cmor
+  module UserArea
+    module Controller
+      module RedirectBackConcern
+        extend ActiveSupport::Concern
+
+        private
+
+        def store_location
+          self.original_location = request.url if request.get?
+        end
+
+        def redirect_back_or(url)
+          redirect_to(original_location || url)
+          clear_original_location
+        end
+
+        def clear_original_location
+          session.delete(:original_location)
+        end
+
+        def original_location
+          session[:original_location]
+        end
+
+        def original_location=(location)
+          session[:original_location] = location
+        end
+      end
+    end
+  end
+end

data/app/concerns/cmor/user_area/controller/store_current_user_concern.rb

@@ -0,0 +1,25 @@
+module Cmor
+  module UserArea
+    module Controller
+      module StoreCurrentUserConcern
+        extend ActiveSupport::Concern
+
+        included do
+          before_action :store_current_user_id
+          before_action :store_current_user
+        end
+
+        private
+
+        def store_current_user_id
+          RequestLocals.store[:current_user_id] = current_user.try(:id)
+        end
+
+
+        def store_current_user
+          RequestLocals.store[:current_user] = current_user
+        end
+      end
+    end
+  end
+end

data/app/controllers/cmor/user_area/current_users_controller.rb

@@ -0,0 +1,11 @@
+module Cmor
+  module UserArea
+    class CurrentUsersController < Users::BaseController
+      helper Rao::Component::ApplicationHelper
+
+      def self.resource_class
+        Cmor::UserArea::User
+      end
+    end
+  end
+end

data/app/controllers/cmor/user_area/password_reset_requests.rb

@@ -0,0 +1,6 @@
+module Cmor
+  module UserArea
+    module PasswordResetRequests
+    end
+  end
+end

data/app/controllers/cmor/user_area/password_reset_requests/base_controller.rb

@@ -0,0 +1,48 @@
+module Cmor
+  module UserArea
+    module PasswordResetRequests
+      class BaseController < Cmor::UserArea::Configuration.base_controller.constantize
+        include Rao::ResourcesController::ResourcesConcern
+        include Rao::ResourcesController::ResourceInflectionsConcern
+        include Rao::ResourcesController::RestResourceUrlsConcern
+        include Rao::ResourcesController::RestActionsConcern
+        include Controller::RedirectBackConcern
+
+        if Rails.version < '5'
+          skip_before_action :authenticate_user!
+        else
+          skip_before_action :authenticate_user!, raise: false
+        end
+
+        def create
+          @resource = resource_class.new(permitted_params)
+          @resource.host = request.host
+          @resource.save
+          respond_with @resource, location: after_create_location
+        end
+
+        def edit
+          @resource = load_user_by_token
+          unless @resource
+            flash[:error] = t('.user_not_found')
+            redirect_to new_user_session_path
+            return
+          end
+          respond_with @resource
+        end
+
+
+        private
+
+        def load_user_by_token
+          User.find_using_perishable_token(params[:token])
+        end
+
+
+        def permitted_params
+          params.require(resource_class.name.demodulize.underscore.to_sym).permit(:email)
+        end
+      end
+    end
+  end
+end

data/app/controllers/cmor/user_area/password_resets.rb

@@ -0,0 +1,6 @@
+module Cmor
+  module UserArea
+    module PasswordResets
+    end
+  end
+end

data/app/controllers/cmor/user_area/password_resets/base_controller.rb

@@ -0,0 +1,48 @@
+module Cmor
+  module UserArea
+    module PasswordResets
+      class BaseController < Cmor::UserArea::Configuration.base_controller.constantize
+        include Rao::ResourcesController::ResourcesConcern
+        include Rao::ResourcesController::ResourceInflectionsConcern
+        include Rao::ResourcesController::RestResourceUrlsConcern
+        include Rao::ResourcesController::RestActionsConcern
+        include Controller::RedirectBackConcern
+
+        if Rails.version < '5'
+          skip_before_action :authenticate_user!
+        else
+          skip_before_action :authenticate_user!, raise: false
+        end
+
+        before_action :find_using_perishable_token
+
+        private
+
+        def load_resource
+          @resource
+        end
+
+        def load_resource
+          User.find_using_perishable_token(params[:token])
+        end
+
+        def permitted_params
+          params.require(:user).permit(:password, :password_confirmation)
+        end
+
+        def after_update_location
+          new_user_session_path
+        end
+
+        def handle_user_not_found
+          redirect_to new_user_session_path, notice: t("messages.failures.cmor_user_area.perishable_token_invalid")
+        end
+
+        def find_using_perishable_token
+          @resource =  User.find_using_perishable_token(params[:token])
+          handle_user_not_found if @resource.nil?
+        end
+      end
+    end
+  end
+end

data/app/controllers/cmor/user_area/sessions.rb

@@ -0,0 +1,6 @@
+module Cmor
+  module UserArea
+    module Sessions
+    end
+  end
+end

data/app/controllers/cmor/user_area/sessions/base_controller.rb

@@ -0,0 +1,53 @@
+module Cmor
+  module UserArea
+    module Sessions
+      class BaseController < Cmor::UserArea::Configuration.base_controller.constantize
+        include Rao::ResourcesController::ResourcesConcern
+        include Rao::ResourcesController::ResourceInflectionsConcern
+        include Rao::ResourcesController::RestResourceUrlsConcern
+        include Rao::ResourcesController::RestActionsConcern
+        include Rao::ResourcesController::LocationHistoryConcern
+
+        skip_before_action :authenticate_user!, only: [:new, :create], raise: false
+        skip_before_action :store_location, only: [:new, :create]
+
+        def new
+          @session = initialize_resource
+          respond_with @session
+        end
+
+        def create
+          @session = resource_class.new(permitted_params)
+
+          if @session.save
+            flash[:notice] = I18n.t('messages.success.cmor_user_area.signed_in') unless request.xhr?
+            redirect_to(instance_eval(&Configuration.after_sign_in_url))
+            return
+          else
+            render action: :new
+          end
+        end
+
+        def destroy
+          current_session(resource_class.name.demodulize.underscore.to_sym).destroy
+          flash[:notice] = I18n.t('messages.success.cmor_user_area.signed_out') unless request.xhr?
+          redirect_to after_sign_out_url
+        end
+
+        def self.resource_class
+          fail 'please define self.session_class in your controller.'
+        end
+
+        private
+
+        def permitted_params
+          if Rails.version < '5'
+            params.require(resource_class.name.demodulize.underscore.tr('/', '_')).permit(:email, :password)
+          else
+            params.require(resource_class.name.demodulize.underscore.tr('/', '_')).permit(:email, :password).to_h
+          end
+        end
+      end
+    end
+  end
+end