restme 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a6deb0be1cd7ca4a0835d7fc1211057a944237a4370ce576f3a6e8bc067738
-  data.tar.gz: 60fb44729f7721fc885224b2df4f7dcd3ec7ac07efaeacbee0ccd42dcece913c
+  metadata.gz: cccc4f918f72719fedda5f137e14cdccf49de3931209a7adf2e9f7d7a974068c
+  data.tar.gz: 0e3a7821d6883250e28bb75b5f6ca50841166f6fff2a180740daf8f59dd323df
 SHA512:
-  metadata.gz: 633737ce0a993e839281b86d9a2d686f098a585d43b608aabb1c770b6b4a8f5c75c6faa0480e75c3c5a7d8089c01666aafd7c1d299415c4f0f391f8958ef209a
-  data.tar.gz: 9d859f78801920fca33bd80ab075e6f00e0a7d54e098dd5d2f66defa19481d66c23650f5a21b703b6640ed1e09fe2450c549168b63d0f41e9504ca38669038ea
+  metadata.gz: ef683d119c129847df93624eb7f5480db6ec8bb190fe2aff432c59bb228aecec0a699ce1eb9cd91b23e73888fb1d03abe6c01accf1fe278d5ffab57ef51963f3
+  data.tar.gz: bcfefa780c6c4303e47b85492cd80ca51d404c83c8f68976bb0750a949236c0ccc45cd2278a4741747fa877a45b87e418cee46f6675c212e2a80f6572c6ec0bf

data/README.md

@@ -13,7 +13,7 @@ This gem manages your controller's responsibilities for:
 
 GEMFILE:
 ```bash
-gem 'restme', '~> 1.0', '>= 1.0.1'
+gem 'restme', '~> 1.1'
 ```
 
 INSTALL:
@@ -28,6 +28,35 @@ gem 'restme'
  - You must create a folder inside app named restfy to define controller rules for authorization, scoping, creation, updating, and field selection (see example below).
 
 
+<br>
+
+## Optional Configuration (Available from version 1.1 or higher)
+
+You can create a `restme.rb` file inside `config/initializers` to customize Restme's behavior:
+
+- Define the name of the controller variable that holds the current user (default: `current_user`).
+- Define the name of the user field that identifies the user's role (default: `role`).
+- Set the default number of items returned per page (default: `12`).
+- Set the default starting page (default: `1`).
+- Define the maximum number of items allowed per page (default: `100`).
+
+Example:
+
+```ruby
+# config/initializers/restme.rb
+
+Restme.configure do |config|
+  config.current_user_variable = :current_user
+  config.user_role_field = :role
+  config.pagination_default_per_page = 12
+  config.pagination_default_page = 1
+  config.pagination_max_per_page = 100
+end
+```
+
+<br>
+
+
 ### Usage examples
 
 Rails API project example here: https://github.com/everson-ever/restme-example/pull/1

data/lib/restme/authorize/rules.rb

@@ -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?

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

@@ -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
 

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

@@ -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
@@ -64,8 +64,8 @@ module Restme
       def pagination
         {
           page: page_no,
-          pages: pages(model_scope),
-          total_items: total_items(model_scope)
+          pages: pages(filtered_scope),
+          total_items: total_items(filtered_scope)
         }
       end
 

data/lib/restme/shared/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
+    module RestmeCurrentUserRole
       def restme_current_user_role
-        restme_current_user&.try(:role)
+        restme_current_user&.try(::Restme::Configuration.user_role_field)
       end
     end
   end

data/lib/restme/update/rules.rb

@@ -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
 

data/lib/restme/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restme
-  VERSION = "1.0.2"
+  VERSION = "1.1.1"
 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.2
+  version: 1.1.1
 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