api_authorization 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94acc2d7dd25207a51d40cfb954a679042f15a0b9d9b68c4fd36f75cfea3fbd9
-  data.tar.gz: cdef5a4d61e6f6d83f8787016281ff959bd2e0e820fd45d9eb4c7030239dac98
+  metadata.gz: '058cb751c71438f05f1c62821556d1a9f5f3c12ab98a4d3dcebeaab49ffdb37a'
+  data.tar.gz: 159943ea62e15a42aee687d4f409b27ddfd0fd60396638b635e8830162aceab3
 SHA512:
-  metadata.gz: ecf08b501bf862dcef4b1bb603c2255aee2c5db3d724a3aeafc171829d1cf303582cca2568aae82a85519e682a0809c8345880a2e6a62729663fea2ed06b8be4
-  data.tar.gz: 46fd8d2142abd9038bbffd6c232a9a68df34c1beca042f3c0adfd07de2587f6b7675a71dc11957c1500621d9fcc289f9ebb4f2096ebac804f38c1b9f294ba368
+  metadata.gz: a2f0dd92a53740aae4997bd9443cc39f7353c71920da460c1b4f9a2334e329444ea86c84a077c814f6133431612b30bd56946ff9ff2c40081d10a746c4dd7e75
+  data.tar.gz: 812cf69c1b185414645fcf6be3989d49829ef7d0e92e65a911a55b837c2f29fbf8b5b4e3ce257ac7c13628f98c9bcaec4d73328923f3a7654844e14d384ac007

data/README.md

@@ -27,11 +27,11 @@ $ gem install api_authorization
 ## Usage
 1. After you have created your users_table(through devise or manually) next run 
 ```bash
-$ rails api_auth:initialize
+$ rails api_auth:install
 ```
 2. Next populate permissions table with your controllers and actions run:
 ```bash
-$ rails api_auth:create_permissions
+$ rails api_auth:re_populate_permissions
 ```
 3. Include the Authorization module on your `ApplicationController` :
 ```ruby
@@ -39,10 +39,20 @@ $ rails api_auth:create_permissions
   include ApiAuthorization
   enable_role_authorization
 ```
-4. DONE
-
-##### More CLI commands will be published soon
+4. You can create/read/update/delete roles and permissions for the user through [CLI commands](cli.MD) or by
+using the dashboard which you need to install seperately by running:
+```bash
+rails api_auth:install_dashboard
+```
+5. And after running the rails app visit:
+```
+http://localhost:3000/auth_dashboard
+```
+#
+### [CLI commands](cli.MD)
 
+### Managing Roles and Permissions
+There are two ways to manage your roles and
 ## Contributing
 Feel free to suggest a feature or report a bug.
 #### [Code Of Conduct](CODE_OF_CONDUCT.md)

data/bin/api_auth

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-rake api_auth: init
+CLI.start(ARGV)

data/lib/api_authorization/railtie.rb

@@ -19,15 +19,19 @@ module ApiAuthorization
       roles = current_user.try(:roles)
       return if roles.find { |role| role.try(:name).try(:downcase) == 'superadmin' }
 
-      return render json: { error: 'You are not authorized' }, status: 403 if current_user.roles.empty?
+      # return render json: { error: 'You are not authorized' }, status: 403 if current_user.roles.empty?
+      return not_authorized if current_user.roles.empty?
+
 
       current_user.roles.each do |role|
         return if role.permissions.where(controller: params['controller'], action: params['action']).count.positive?
       end
 
-      render json: { error: 'You are not authorized' }, status: 403
+      # render json: { error: 'You are not authorized' }, status: 403
+      not_authorized
     rescue StandardError => e
-      render json: { error: 'You are not authorized' }, status: 403
+      # render json: { error: 'You are not authorized' }, status: 403
+      not_authorized
     end
 
     # Filter the request params to know wether or not a user has
@@ -42,7 +46,6 @@ module ApiAuthorization
     # @params [Action::Parameters]
     # @return [Action::Parameters] without the disallowed key/values.
     def check_allowed_params(params, controller, action)
-      puts 'AUTHORIZATION: Checking the request params' if Rails.env == 'development'
 
       roles = current_user.try(:permissions)
       return params if roles.find { |role| role.try(:name).try(:downcase) == 'superadmin' }
@@ -63,12 +66,29 @@ module ApiAuthorization
 
       params
     end
+
+    # a wrapper around respond_to helper that returns
+    # content as json, and html
+    #
+    # @params [String,Fixnum]
+    # @return [ActionController::MimeResponds] 
+    def not_authorized(message = 'You are not authorized', status = 403)
+      respond_to do |format|
+        format.json do
+          return render json: { error: message }, status: status
+        end
+        format.html do
+          return render html: "<h2> Forbidden #{status}</h2>".html_safe, status: status
+        end
+      end
+    end
   end
 
   class Railtie < ::Rails::Railtie
-    # exportin rake tasks
+    # exporting rake tasks
     rake_tasks do
-      load 'tasks/initialize.rake'
+      load 'tasks/main_tasks.rake'
+      load 'tasks/dashboard_tasks.rake'
       load 'tasks/user_tasks.rake'
     end
   end

data/lib/api_authorization/version.rb

@@ -1,3 +1,3 @@
 module ApiAuthorization
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/lib/tasks/cli.thor

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'thor'
+class CLI < Thor
+  include Thor::Actions
+
+  def self.source_root
+    File.dirname(__FILE__)
+  end
+
+  desc 'append_has_and_belongs_to_many', 'append has_and_belongs_to_many'
+  def append_has_and_belongs_to_many(model_filename, belongs_to)
+    inject_into_file "./app/models/#{model_filename}.rb", "  has_and_belongs_to_many :#{belongs_to}\n", before: /^end/
+  end
+
+  desc 'append_config', 'insert config code'
+  def append_config(config_file, config_code)
+    inject_into_file "./config/initializers/#{config_file}.rb", "  #{config_code}\n", before: /^end/
+  end
+end

data/lib/tasks/dashboard_tasks.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :api_auth do
+  desc 'Create the dashboard'
+  task :install_dashboard, :environment do |_t, args|
+    sh 'rails g rails_admin:install auth_dashboar', verbose: false
+    sh 'thor cli:append_config rails_admin "config.included_models = [\"User\", \"Role\", \"Permission\"]"', verbose: false
+  end
+end

data/lib/tasks/{initialize.rake → main_tasks.rake}

@@ -3,8 +3,8 @@
 require_relative './../app_routes/application_routes.rb'
 
 namespace :api_auth do
-  desc 'Create the initial tables and populate the permissions table'
-  task :init, %i[tenant single_role] => [:environment] do |_t, args|
+  desc 'Create the initial tables'
+  task :install, %i[tenant single_role] => [:environment] do |_t, args|
     Apartment::Tenant.switch! args[:tenant] if args[:tenant]
 
     puts 'Initializing'
@@ -14,25 +14,32 @@ namespace :api_auth do
 
       if args[:single_role].nil?
         # creating roles table
-        sh 'rails g model role name:string description:text'
-        Rake::Task['db:migrate'].invoke
+        sh 'rails g model role name:string description:text', verbose: false
+        sh 'rails db:migrate', verbose: false
+
+        # adding has_many_and_belongs_to with thor
+        sh 'thor cli:append_has_and_belongs_to_many role users', verbose: false
+        sh 'thor cli:append_has_and_belongs_to_many user roles', verbose: false
 
         # creating a join table between users and roles
-        sh 'rails g migration CreateJoinTableUserRole user role'
-        sh 'rails db:migrate'
+        sh 'rails g migration CreateJoinTableUserRole user role', verbose: false
+        sh 'rails db:migrate', verbose: false
 
       else
-        sh 'rails g model role name:string description:text user:references'
-        sh 'rails db:migrate'
+        sh 'rails g model role name:string description:text user:references', verbose: false
+        sh 'rails db:migrate', verbose: false
       end
 
       # creating permissions table
-      sh 'rails g model permission controller:string action:string allowed_params:json'
-      sh 'rails db:migrate'
+      sh 'rails g model permission controller:string action:string allowed_params:json', verbose: false
+      sh 'rails db:migrate', verbose: false
+
+      sh 'thor cli:append_has_and_belongs_to_many role permissions', verbose: false
+      sh 'thor cli:append_has_and_belongs_to_many permission roles', verbose: false
 
       # creating a join table between roles and permissions
-      sh 'rails g migration CreateJoinTableRolePermission role permission'
-      sh 'rails db:migrate'
+      sh 'rails g migration CreateJoinTableRolePermission role permission', verbose: false
+      sh 'rails db:migrate', verbose: false
 
     else
       puts 'users table does not exist !'
@@ -42,7 +49,7 @@ namespace :api_auth do
   end
 
   desc 'Populate the permissions table with all the controllers and actions of the application'
-  task :create_permissions, %i[tenant] => [:environment] do |_t, args|
+  task :re_populate_permissions, %i[tenant] => [:environment] do |_t, args|
     Apartment::Tenant.switch! args[:tenant] if args[:tenant]
     AppRoutes::ApplicationRoutes.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_authorization
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Giovanni Panasiti
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -32,21 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.3.2
 - !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: byebug
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -77,7 +63,9 @@ files:
 - lib/api_authorization/railtie.rb
 - lib/api_authorization/version.rb
 - lib/app_routes/application_routes.rb
-- lib/tasks/initialize.rake
+- lib/tasks/cli.thor
+- lib/tasks/dashboard_tasks.rake
+- lib/tasks/main_tasks.rake
 - lib/tasks/user_tasks.rake
 homepage: https://montedelgallo.com/
 licenses: