restme 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34e6f83a9517ad4596b91a677ea60bc4520a6d074684ba31069a33967252e520
-  data.tar.gz: 94a3e5fee24cd500c7b1904b048f76df2831f22363a463c1273603f56e996fde
+  metadata.gz: 852b2273c90c0c2eb2673bed5fe62a28df112f2eddd55287c415afff487647db
+  data.tar.gz: 746415d80a0fd053b9fb89e86f06116416c16c978727472475d6e22bf2c974ae
 SHA512:
-  metadata.gz: 42e31bc636a89203a07f9b068ba6916cf6b1df32e978d01bbc01a1f4168c825137c367a5bc6d73c3584b485f8768f32184a2eb026ccd5b78a22f5dcea1a08e74
-  data.tar.gz: 4fc46af681505a061ea78d606410b8dcf7bc490ccf34deae1ec07f9ad36382bd232c9e550781a8bc55d67012ab8af104d0efa56f38ee0462e3fe6261613be1d1
+  metadata.gz: 981cfa7a02a73c7024cab361704daf3151660abf062324ce3ad44ecf121083349272782a72df26349f58c0550d7f3b7287b71e03e2fdb8502e386267ef1b3464
+  data.tar.gz: a5d92fa8e80b2f1ff7fceee0c0e0c5d42067b4908d07e45fcf461ebcc6528559dec7b4422ba4c8ae42ab0f7c422482c08fdbe57425d4b0efed0f115975221fc7

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/restme.svg)](https://badge.fury.io/rb/restme)
 
-Adds support for new **Rails** controller actions such as pagination, filtering, sorting, and selecting specific model fields. Easily implement full CRUD functionality by importing Restme into your controller.
+Adds support for new **Rails/Postgres** controller actions such as pagination, filtering, sorting, and selecting specific model fields. Easily implement full CRUD functionality by importing Restme into your controller.
 
 This gem manages your controller's responsibilities for:
 - Read Actions: Provide complete pagination, filtering, sorting, and field selection for records, all handled through query parameters (e.g., `http://127.0.0.1/products?name_equal=foo`).
@@ -11,13 +11,12 @@ This gem manages your controller's responsibilities for:
 ## Installation
 
 
-
+GEMFILE:
 ```bash
-gem install restme
+gem 'restme', '~> 1.0', '>= 1.0.2'
 ```
 
-OR
-
+INSTALL:
 ```bash
 gem 'restme'
 ```
@@ -25,10 +24,7 @@ gem 'restme'
 ## Usage
 
 #### ℹ️ Current Version of gem require the following pré configs
-
- - If your controller defines an instance variable named `current_user`, Restme will automatically assign it to `model.current_user` during create and update actions—provided your model responds to the `current_user` method.
- - Your user model must have a role attribute (user.role).
- - Your controllers must be named using the plural form of the model (e.g., Product → ProductsController). Alternatively, you can manually set the model name by defining the MODEL_NAME constant (e.g., MODEL_NAME = "Shopping").
+ - Your controllers must be named using the plural form of the model (e.g., Product → ProductsController). Alternatively, you can manually set the model name by defining the MODEL_NAME constant (e.g., MODEL_NAME = "Product").
  - You must create a folder inside app named restfy to define controller rules for authorization, scoping, creation, updating, and field selection (see example below).
 
 

data/lib/restme/authorize/rules.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../shared/user_role"
+require_relative "../shared/restme_current_user_role"
 require_relative "../shared/current_model"
 
 module Restme
@@ -8,7 +8,7 @@ module Restme
     # Defines the rules used to authotize user
     module Rules
       include ::Restme::Shared::CurrentModel
-      include ::Restme::Shared::UserRole
+      include ::Restme::Shared::RestmeCurrentUserRole
 
       def user_authorized?
         return true if restme_current_user.blank? || authorize?
@@ -19,8 +19,8 @@ module Restme
       end
 
       def authorize?
-        super_authorize? ||
-          allowed_roles_actions[action_name.to_sym]&.include?(user_role.to_sym)
+        allowed_roles_actions[action_name.to_sym]
+          &.include?(restme_current_user_role&.to_sym)
       end
 
       def authorize_errors
@@ -35,17 +35,13 @@ module Restme
       end
 
       def allowed_roles_actions
-        return {} unless authorize_rules_class.const_defined?(:ALLOWED_ROLES_ACTIONS)
+        return {} unless authorize_rules_class&.const_defined?(:ALLOWED_ROLES_ACTIONS)
 
         authorize_rules_class::ALLOWED_ROLES_ACTIONS
       end
 
-      def super_authorize?
-        restme_current_user&.super_admin?
-      end
-
       def authorize_rules_class
-        "#{controller_class.to_s.split("::").last}::Authorize::Rules".constantize
+        "#{controller_class.to_s.split("::").last}::Authorize::Rules".safe_constantize
       end
     end
   end

data/lib/restme/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Restme
+  # Defines the initialization configuration for restme gem
+  module Configuration
+    @current_user_variable = :current_user
+    @user_role_field = :role
+    @pagination_default_per_page = 12
+    @pagination_default_page = 1
+    @pagination_max_per_page = 100
+
+    class << self
+      attr_accessor :current_user_variable,
+                    :user_role_field,
+                    :pagination_default_per_page,
+                    :pagination_default_page,
+                    :pagination_max_per_page
+    end
+  end
+end

data/lib/restme/create/rules.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../shared/user_role"
+require_relative "../shared/restme_current_user_role"
 require_relative "../shared/current_model"
 require_relative "../shared/controller_params"
 
@@ -10,7 +10,7 @@ module Restme
     module Rules
       include ::Restme::Shared::ControllerParams
       include ::Restme::Shared::CurrentModel
-      include ::Restme::Shared::UserRole
+      include ::Restme::Shared::RestmeCurrentUserRole
 
       attr_reader :create_temp_record
 
@@ -64,13 +64,9 @@ module Restme
       def createable_scope?
         return true unless restme_current_user
 
-        method_scope = "#{creatable_current_action}_#{user_role}_scope?"
+        method_scope = "#{creatable_current_action}_#{restme_current_user_role}_scope?"
 
-        createable_super_admin_scope? || create_rules_class.try(method_scope) || false
-      end
-
-      def createable_super_admin_scope?
-        restme_current_user.super_admin?
+        create_rules_class.try(method_scope) || false
       end
 
       def createable_object_errors_messages

data/lib/restme/restme.rb

@@ -28,7 +28,8 @@ module Restme
     end
 
     def use_current_user
-      @restme_current_user = try(:current_user)
+      @restme_current_user =
+        try(::Restme::Configuration.current_user_variable)
     end
   end
 end

data/lib/restme/scope/paginate/rules.rb

@@ -5,16 +5,12 @@ module Restme
     module Paginate
       # Defines pagination rules
       module Rules
-        DEFAULT_PER_PAGE = ENV.fetch("PAGINATION_DEFAULT_PER_PAGE", 12)
-        DEFAULT_PAGE = ENV.fetch("PAGINATION_DEFAULT_PAGE", 1)
-        MAX_PER_PAGE = ENV.fetch("PAGINATION_MAX_PER_PAGE", 100)
-
         def paginable_scope(user_scope)
           user_scope.limit(per_page).offset(paginate_offset)
         end
 
         def page_no
-          params[:page]&.to_i || DEFAULT_PAGE
+          params[:page]&.to_i || ::Restme::Configuration.pagination_default_page
         end
 
         def pages(user_scope)
@@ -26,7 +22,7 @@ module Restme
         end
 
         def per_page
-          params[:per_page]&.to_i || DEFAULT_PER_PAGE
+          params[:per_page]&.to_i || ::Restme::Configuration.pagination_default_per_page
         end
 
         def paginate_offset
@@ -34,12 +30,12 @@ module Restme
         end
 
         def per_page_errors
-          return if per_page <= MAX_PER_PAGE
+          return if per_page <= ::Restme::Configuration.pagination_max_per_page
 
           restme_scope_errors(
             {
               message: "Invalid per page value",
-              body: { per_page_max_value: MAX_PER_PAGE }
+              body: { per_page_max_value: ::Restme::Configuration.pagination_max_per_page }
             }
           )
 

data/lib/restme/scope/rules.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../shared/user_role"
+require_relative "../shared/restme_current_user_role"
 require_relative "../shared/current_model"
 require_relative "../shared/controller_params"
 require_relative "filter/rules"
@@ -20,7 +20,7 @@ module Restme
       include ::Restme::Scope::Filter::Rules
       include ::Restme::Shared::ControllerParams
       include ::Restme::Shared::CurrentModel
-      include ::Restme::Shared::UserRole
+      include ::Restme::Shared::RestmeCurrentUserRole
 
       attr_reader :filtered_scope, :sorted_scope, :paginated_scope, :fieldated_scope
       attr_writer :restme_scope_errors, :restme_scope_status
@@ -87,11 +87,11 @@ module Restme
       end
 
       def user_scope
-        @user_scope ||= super_admin_scope || scope_rules_class.try(method_scope) || none_scope
+        @user_scope ||= none_user_scope || scope_rules_class.try(method_scope) || none_scope
       end
 
-      def super_admin_scope
-        klass.all if restme_current_user&.super_admin? || restme_current_user.blank?
+      def none_user_scope
+        klass.all if restme_current_user.blank?
       end
 
       def none_scope
@@ -99,7 +99,7 @@ module Restme
       end
 
       def method_scope
-        "#{user_role}_scope"
+        "#{restme_current_user_role}_scope"
       end
 
       def scope_rules_class

data/lib/restme/shared/{user_role.rb → restme_current_user_role.rb}

@@ -3,9 +3,9 @@
 module Restme
   module Shared
     # Returns the roles associated with the user, if any exist.
-    module UserRole
-      def user_role
-        restme_current_user&.role
+    module RestmeCurrentUserRole
+      def restme_current_user_role
+        restme_current_user&.try(::Restme::Configuration.user_role_field)
       end
     end
   end

data/lib/restme/update/rules.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../shared/user_role"
+require_relative "../shared/restme_current_user_role"
 require_relative "../shared/current_model"
 require_relative "../shared/controller_params"
 
@@ -10,7 +10,7 @@ module Restme
     module Rules
       include ::Restme::Shared::ControllerParams
       include ::Restme::Shared::CurrentModel
-      include ::Restme::Shared::UserRole
+      include ::Restme::Shared::RestmeCurrentUserRole
 
       attr_reader :update_temp_record
 
@@ -74,13 +74,9 @@ module Restme
       def updateable_scope?
         return true unless restme_current_user
 
-        method_scope = "#{updateable_current_action}_#{user_role}_scope?"
+        method_scope = "#{updateable_current_action}_#{restme_current_user_role}_scope?"
 
-        updateable_super_admin_scope? || update_rules_class.try(method_scope) || false
-      end
-
-      def updateable_super_admin_scope?
-        restme_current_user&.super_admin?
+        update_rules_class.try(method_scope) || false
       end
 
       def updateable_record_errors_messages

data/lib/restme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restme
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/restme.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
 require_relative "restme/version"
+require_relative "restme/configuration"
 require_relative "restme/restme"
 
+# Restme gem
 module Restme
   class Error < StandardError; end
   # Your code goes here...
+
+  def self.configure
+    yield(Configuration)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restme
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - everson-ever
@@ -28,6 +28,7 @@ files:
 - docker-compose.yml
 - lib/restme.rb
 - lib/restme/authorize/rules.rb
+- lib/restme/configuration.rb
 - lib/restme/create/rules.rb
 - lib/restme/restme.rb
 - lib/restme/scope/field/attachable.rb
@@ -45,7 +46,7 @@ files:
 - lib/restme/scope/sort/rules.rb
 - lib/restme/shared/controller_params.rb
 - lib/restme/shared/current_model.rb
-- lib/restme/shared/user_role.rb
+- lib/restme/shared/restme_current_user_role.rb
 - lib/restme/update/rules.rb
 - lib/restme/version.rb
 - sig/restme.rbs