phcdevworks_accounts_devise 0.1.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a59f872567bbbd92218ad9594a4e47bf580fafc0b3b1df76d4fcd6f314ea2452
+  data.tar.gz: 6a511dc4386446b24ef853ffdea4a67301596dcab4ee80fef42f2c0589e9a701
+SHA512:
+  metadata.gz: b2902a85a120873ee02f2aeed4de6027d3fe6795d97216505391a347b5157791aa821dde7453101d387fde5ded74c43da88b8d622d2da1691c82c041b831fd07
+  data.tar.gz: 3329c5f33718e0c415713531491b9b153aa58312b6f8205c23bfc63d2702d52c82dc34f03d1c359c1eca6e67b960408640162b13fa7317d1687e1f1384c1225a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 PHCDevworks
+
+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,11 @@
+### PHCDevworks Accounts (Devise)
+  
+Rails devise based user accounts and administration engine.  
+  
+- Using Devise for Authentication
+- Extra user information built in
+- Custom login views included
+
+### Status  
+  
+[![Gem Version](https://badge.fury.io/rb/phcdevworks_accounts_devise.svg)](https://badge.fury.io/rb/phcdevworks_accounts_devise) [![Publish to Github.com](https://github.com/phcdevworks/phcdevworks_accounts_devise/actions/workflows/publish_gem_github_com.yml/badge.svg)](https://github.com/phcdevworks/phcdevworks_accounts_devise/actions/workflows/publish_gem_github_com.yml) [![Publish to Rubygems.org](https://github.com/phcdevworks/phcdevworks_accounts_devise/actions/workflows/publish_gem_rubygems_org.yml/badge.svg)](https://github.com/phcdevworks/phcdevworks_accounts_devise/actions/workflows/publish_gem_rubygems_org.yml)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/test_app/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/phcdevworks_accounts_devise_manifest.js

@@ -0,0 +1,2 @@
+//= link coloradmin/default/phcthemes_admin_panel_pack_coloradmin.css
+//= link coloradmin/phcthemes_admin_panel_pack_coloradmin.js

data/app/controllers/phcdevworks_accounts_devise/admin/pages_controller.rb

@@ -0,0 +1,25 @@
+require_dependency "phcdevworks_accounts_devise/application_controller"
+
+module PhcdevworksAccountsDevise
+    class Admin::PagesController < ApplicationController
+
+        # Filters
+        include PhcdevworksCore::PhcdevworksPluginsHelper
+        before_action :phcdevworks_accounts_admin_only
+        layout "phcdevworks_accounts_devise/application_profile", :only => [ :user_profile ]
+
+        # Account Admin
+        def dashboard
+        end
+
+        # User Admin
+        def users_list
+            @admin_users = User.all
+        end
+
+        def user_profile
+            @admin_user = User.find_by_id(params[:id])
+        end
+
+    end
+end

data/app/controllers/phcdevworks_accounts_devise/application_controller.rb

@@ -0,0 +1,25 @@
+module PhcdevworksAccountsDevise
+    class ApplicationController < ActionController::Base
+
+        # Devise Filter
+        before_action :phcdevworks_accounts_devise_permitted_parameters, if: :devise_controller?
+
+        # Security Filters
+        protect_from_forgery with: :exception
+
+        # Load Requried Helper Files
+        helper PhcdevworksActiveMenus::Engine.helpers
+        helper PhcdevworksNotifications::Engine.helpers
+        helper PhcdevworksTitleseo::Engine.helpers
+
+        private
+
+        # Whitelist Additional Fields
+        def phcdevworks_accounts_devise_permitted_parameters
+            added_attrs = [:username, :firstname, :lastname, :email, :terms_of_service, :payments_customer_id, :payments_subscription_id, :payments_plan_id, :password, :password_confirmation, :remember_me]
+            devise_parameter_sanitizer.permit :sign_up, keys: added_attrs
+            devise_parameter_sanitizer.permit :account_update, keys: added_attrs
+        end
+
+    end
+end

data/app/controllers/phcdevworks_accounts_devise/user/pages_controller.rb

@@ -0,0 +1,15 @@
+require_dependency "phcdevworks_accounts_devise/application_controller"
+
+module PhcdevworksAccountsDevise
+    class User::PagesController < ApplicationController
+
+        # Security Filters
+        before_action :authenticate_user!
+
+        # Pages - User
+        def profile
+            @user_profile = User.find_by_id(params[:id])
+        end
+
+    end
+end

data/app/controllers/users/confirmations_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Users::ConfirmationsController < Devise::ConfirmationsController
+  # GET /resource/confirmation/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/confirmation
+  # def create
+  #   super
+  # end
+
+  # GET /resource/confirmation?confirmation_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after resending confirmation instructions.
+  # def after_resending_confirmation_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+
+  # The path used after confirmation.
+  # def after_confirmation_path_for(resource_name, resource)
+  #   super(resource_name, resource)
+  # end
+end

data/app/controllers/users/omniauth_callbacks_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  # You should configure your model like this:
+  # devise :omniauthable, omniauth_providers: [:twitter]
+
+  # You should also create an action method in this controller like this:
+  # def twitter
+  # end
+
+  # More info at:
+  # https://github.com/heartcombo/devise#omniauth
+
+  # GET|POST /resource/auth/twitter
+  # def passthru
+  #   super
+  # end
+
+  # GET|POST /users/auth/twitter/callback
+  # def failure
+  #   super
+  # end
+
+  # protected
+
+  # The path used when OmniAuth fails
+  # def after_omniauth_failure_path_for(scope)
+  #   super(scope)
+  # end
+end

data/app/controllers/users/passwords_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class Users::PasswordsController < Devise::PasswordsController
+  # GET /resource/password/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/password
+  # def create
+  #   super
+  # end
+
+  # GET /resource/password/edit?reset_password_token=abcdef
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource/password
+  # def update
+  #   super
+  # end
+
+  # protected
+
+  # def after_resetting_password_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sending reset password instructions
+  # def after_sending_reset_password_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+end

data/app/controllers/users/registrations_controller.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+class Users::RegistrationsController < Devise::RegistrationsController
+  # before_action :configure_sign_up_params, only: [:create]
+  # before_action :configure_account_update_params, only: [:update]
+  after_action :phcdevworks_accounts_devise_payments_add_customer, :only => :create, if: -> {defined?(PhcdevworksAccountsStripe)}
+
+  # GET /resource/sign_up
+  # def new
+  #   super
+  # end
+
+  # POST /resource
+  def create
+    super
+  end
+
+  # GET /resource/edit
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource
+  # def update
+  #   super
+  # end
+
+  # DELETE /resource
+  # def destroy
+  #   super
+  # end
+
+  # GET /resource/cancel
+  # Forces the session data which is usually expired after sign
+  # in to be expired now. This is useful if the user wants to
+  # cancel oauth signing in/up in the middle of the process,
+  # removing all OAuth session data.
+  # def cancel
+  #   super
+  # end
+
+  # protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_up_params
+  #   devise_parameter_sanitizer.permit(:sign_up, keys: [:attribute])
+  # end
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_account_update_params
+  #   devise_parameter_sanitizer.permit(:account_update, keys: [:attribute])
+  # end
+
+  # The path used after sign up.
+  # def after_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sign up for inactive accounts.
+  # def after_inactive_sign_up_path_for(resource)
+  #   super(resource)
+  # end
+
+  def phcdevworks_accounts_payments_add_customer
+    if resource.valid?
+      phcdevworks_accounts_devise_customer = Stripe::Customer.create({
+        email: current_user.email, name: current_user.firstname + " " + current_user.lastname
+      })
+      @user.payments_customer_id = phcdevworks_accounts_customer.id
+      @user.save
+    end
+  end
+
+end

data/app/controllers/users/sessions_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Users::SessionsController < Devise::SessionsController
+  # before_action :configure_sign_in_params, only: [:create]
+
+  # GET /resource/sign_in
+  # def new
+  #   super
+  # end
+
+  # POST /resource/sign_in
+  # def create
+  #   super
+  # end
+
+  # DELETE /resource/sign_out
+  # def destroy
+  #   super
+  # end
+
+  # protected
+
+  # If you have extra params to permit, append them to the sanitizer.
+  # def configure_sign_in_params
+  #   devise_parameter_sanitizer.permit(:sign_in, keys: [:attribute])
+  # end
+end

data/app/controllers/users/unlocks_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class Users::UnlocksController < Devise::UnlocksController
+  # GET /resource/unlock/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/unlock
+  # def create
+  #   super
+  # end
+
+  # GET /resource/unlock?unlock_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after sending unlock password instructions
+  # def after_sending_unlock_instructions_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after unlocking the resource
+  # def after_unlock_path_for(resource)
+  #   super(resource)
+  # end
+end

data/app/helpers/phcdevworks_accounts_devise/admin/pages_helper.rb

@@ -0,0 +1,4 @@
+module PhcdevworksAccountsDevise
+  module Admin::PagesHelper
+  end
+end

data/app/helpers/phcdevworks_accounts_devise/application_helper.rb

@@ -0,0 +1,4 @@
+module PhcdevworksAccountsDevise
+  module ApplicationHelper
+  end
+end

data/app/helpers/phcdevworks_accounts_devise/user/pages_helper.rb

@@ -0,0 +1,4 @@
+module PhcdevworksAccountsDevise
+  module User::PagesHelper
+  end
+end

data/app/jobs/phcdevworks_accounts_devise/application_job.rb

@@ -0,0 +1,4 @@
+module PhcdevworksAccountsDevise
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/phcdevworks_accounts_devise/application_mailer.rb

@@ -0,0 +1,6 @@
+module PhcdevworksAccountsDevise
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/phcdevworks_accounts_devise/application_record.rb

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

data/app/models/phcdevworks_accounts_devise/user.rb

@@ -0,0 +1,39 @@
+module PhcdevworksAccountsDevise
+  class User < ApplicationRecord
+
+    # Autogenerate Organization ID
+    before_create :phcdevworks_generate_org_id
+
+    # User Gravatar Support
+    include Gravtastic
+    gravtastic
+
+    # Add Users Roles
+    enum role: [:user, :editor, :admin]
+    after_initialize :phcdevworks_set_default_role
+
+    # Include default devise modules. Others available are:
+    # :trackable, :confirmable, :lockable and :omniauthable
+    devise :database_authenticatable, :registerable, :recoverable, :rememberable, :validatable, :timeoutable
+
+    # Validations
+    validates :username, :presence => true, :uniqueness => true
+
+    private
+
+    # Autogenerate User Organization ID
+    def phcdevworks_generate_org_id
+      self.org_id = SecureRandom.hex(5)
+    end
+
+    # First Signup Admin and Rest Default to User
+    def phcdevworks_set_default_role
+      if User.all.count < 1
+        self.role ||= :admin
+      elsif
+        self.role ||= :user
+      end
+    end
+
+  end
+end

data/app/views/layouts/phcdevworks_accounts_devise/application.html.erb

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html>
+<head>
+
+    <!-- SEO System -->
+    <% phc_seo_title "PHCDevworks Accounts" %>
+    <% phc_seo_description "Ruby on Rails 6 Authentication and User Management Engine." %>
+    <!-- SEO System -->
+
+    <!-- SEO and Site Description -->
+	<meta charset="utf-8">
+	<title><%= yield(:phc_seo_title) %></title>
+    <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport" />
+	<meta name="description" content="<%= yield(:phc_seo_description) %>">
+    <!-- SEO and Site Description -->
+
+    <!-- Rails Security Tags -->
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <!-- Rails Security Tags -->
+
+    <!-- CSS Styles -->
+    <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet" />
+    <%= stylesheet_link_tag "coloradmin/default/phcthemes_admin_panel_pack_coloradmin", media: "all" %>
+    <!-- CSS Styles -->
+
+</head>
+<body>
+
+    <!-- -PHCDev- Page Container -->
+    <div id="app" class="app app-header-fixed app-sidebar-fixed app-with-wide-sidebar">
+
+        <!-- -PHCDev- Page Container - Header -->
+        <div id="header" class="app-header">
+            <%= render "layouts/phcdevworks_accounts_devise/components/backend/navigation/top_menu" %>
+        </div>
+        <!-- -PHCDev- Page Container - Header -->
+
+        <!-- -PHCDev- Page Container - Sidebar -->
+        <div id="sidebar" class="app-sidebar" data-disable-slide-animation="true">
+            <%= render "layouts/phcdevworks_accounts_devise/components/backend/sidebars/side_menu" %>
+        </div>
+        <div class="app-sidebar-bg"></div>
+        <div class="app-sidebar-mobile-backdrop"><a href="#" data-dismiss="app-sidebar-mobile" class="stretched-link"></a></div>
+        <!-- -PHCDev- Page Container - Sidebar -->
+
+        <!-- -PHCDev- Page Container - Content -->
+        <div id="app" class="app app-content-full-height">
+            <div id="content" class="app-content d-flex flex-column p-0">
+                <!-- -PHCDev- Page Container - Main -->
+                <div class="app-content-padding flex-grow-1 overflow-hidden" data-scrollbar="true" data-height="100%">
+                    <%= render "phcdevworks_notifications/bootstrap/notifications" %>
+                    <%= yield %>
+                </div>
+                <!-- -PHCDev- Page Container - Main -->
+                <!-- -PHCDev- Page Container - Footer -->
+                <div id="footer" class="app-footer m-0">
+                    <%= render "layouts/phcdevworks_accounts_devise/components/backend/footer/footer" %>
+                </div>
+                <!-- -PHCDev- Page Container - Footer -->
+            </div>
+        </div>
+        <!-- -PHCDev- Page Container - Content -->
+
+    </div>
+    <!-- -PHCDev- Page Container -->
+
+    <!-- JavaScript -->
+    <%= javascript_include_tag "coloradmin/phcthemes_admin_panel_pack_coloradmin" %>
+    <!-- JavaScript -->
+
+</body>
+</html>

data/app/views/layouts/phcdevworks_accounts_devise/application_full_width.html.erb

@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html>
+<head>
+
+    <!-- SEO System -->
+    <% phc_seo_title "PHCDevworks Accounts" %>
+    <% phc_seo_description "Ruby on Rails 6 Authentication and User Management Engine." %>
+    <!-- SEO System -->
+
+    <!-- SEO and Site Description -->
+	<meta charset="utf-8">
+	<title><%= yield(:phc_seo_title) %></title>
+    <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport" />
+	<meta name="description" content="<%= yield(:phc_seo_description) %>">
+    <!-- SEO and Site Description -->
+
+    <!-- Rails Security Tags -->
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <!-- Rails Security Tags -->
+
+    <!-- CSS Styles -->
+    <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet" />
+    <%= stylesheet_link_tag "coloradmin/default/phcthemes_admin_panel_pack_coloradmin", media: "all" %>
+    <!-- CSS Styles -->
+
+</head>
+<body>
+
+    <!-- -PHCDev- Page Container -->
+    <div id="app" class="app app-header-fixed app-sidebar-fixed app-with-wide-sidebar">
+
+        <!-- -PHCDev- Page Container - Header -->
+        <div id="header" class="app-header">
+            <%= render "layouts/phcdevworks_accounts_devise/components/backend/navigation/top_menu" %>
+        </div>
+        <!-- -PHCDev- Page Container - Header -->
+
+        <!-- -PHCDev- Page Container - Sidebar -->
+        <div id="sidebar" class="app-sidebar" data-disable-slide-animation="true">
+            <%= render "layouts/phcdevworks_accounts_devise/components/backend/sidebars/side_menu" %>
+        </div>
+        <div class="app-sidebar-bg"></div>
+        <div class="app-sidebar-mobile-backdrop"><a href="#" data-dismiss="app-sidebar-mobile" class="stretched-link"></a></div>
+        <!-- -PHCDev- Page Container - Sidebar -->
+
+        <!-- -PHCDev- Page Container - Content -->
+        <div id="app" class="app app-content-full-height">
+            <div id="content" class="app-content d-flex flex-column p-0">
+                <!-- -PHCDev- Page Container - Main -->
+                <div class="app-content-padding flex-grow-1 overflow-hidden" data-scrollbar="true" data-height="100%">
+                    <%= render "phcdevworks_notifications/bootstrap/notifications" %>
+                    <%= yield %>
+                </div>
+                <!-- -PHCDev- Page Container - Main -->
+                <!-- -PHCDev- Page Container - Footer -->
+                <div id="footer" class="app-footer m-0">
+                    <%= render "layouts/phcdevworks_accounts_devise/components/backend/footer/footer" %>
+                </div>
+                <!-- -PHCDev- Page Container - Footer -->
+            </div>
+        </div>
+        <!-- -PHCDev- Page Container - Content -->
+
+    </div>
+    <!-- -PHCDev- Page Container -->
+
+    <!-- JavaScript -->
+    <%= javascript_include_tag "coloradmin/phcthemes_admin_panel_pack_coloradmin" %>
+    <!-- JavaScript -->
+
+</body>
+</html>

data/app/views/layouts/phcdevworks_accounts_devise/application_no_sidebar.html.erb

@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html>
+<head>
+
+    <!-- SEO System -->
+    <% phc_seo_title "PHCDevworks Accounts" %>
+    <% phc_seo_description "Ruby on Rails 6 Authentication and User Management Engine." %>
+    <!-- SEO System -->
+
+    <!-- SEO and Site Description -->
+	<meta charset="utf-8">
+	<title><%= yield(:phc_seo_title) %></title>
+    <meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" name="viewport" />
+	<meta name="description" content="<%= yield(:phc_seo_description) %>">
+    <!-- SEO and Site Description -->
+
+    <!-- Rails Security Tags -->
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <!-- Rails Security Tags -->
+
+    <!-- CSS Styles -->
+    <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet" />
+    <%= stylesheet_link_tag "coloradmin/default/phcthemes_admin_panel_pack_coloradmin", media: "all" %>
+    <!-- CSS Styles -->
+
+</head>
+<body>
+
+    <!-- -PHCDev- Page Container -->
+    <div id="app" class="app app-header-fixed app-without-sidebar">
+
+        <!-- -PHCDev- Page Container - Header -->
+        <div id="header" class="app-header">
+            <%= render "layouts/phcdevworks_accounts_devise/components/backend/navigation/top_menu" %>
+        </div>
+        <!-- -PHCDev- Page Container - Header -->
+
+        <!-- -PHCDev- Page Container - Content -->
+        <div id="content" class="app-content" style="margin-left:0px;">
+
+            <!-- -PHCDev- Page Container - Main -->
+            <%= render "phcdevworks_notifications/bootstrap/notifications" %>
+            <%= yield %>
+            <!-- -PHCDev- Page Container - Main -->
+
+            <!-- -PHCDev- Page Container - Footer -->
+            <div id="footer" class="app-footer m-0">
+            <%= render "layouts/phcdevworks_accounts_devise/components/backend/footer/footer" %>
+            </div>
+            <!-- -PHCDev- Page Container - Footer -->
+
+        </div>
+        <!-- -PHCDev- Page Container - Content -->
+
+    </div>
+    <!-- -PHCDev- Page Container -->
+
+    <!-- JavaScript -->
+    <%= javascript_include_tag "coloradmin/phcthemes_admin_panel_pack_coloradmin" %>
+    <!-- JavaScript -->
+
+</body>
+</html>