restme 0.0.37 → 0.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b1c3586a14caa25fa15e0d7bcaf12547738e779d43e498c9241dbb198990cbb
-  data.tar.gz: 5ded53d0db89650ebab2580d512912a5939998347367fb7414dbdd07ace50c3e
+  metadata.gz: 66521fd280c2f53800dfece67dc0167d10f25b76a2d435064fdaea3d37f9b260
+  data.tar.gz: 3e8f3889d228f4e051e3516d23fedb16dacea71393667c9acbf6b897f42c5e6f
 SHA512:
-  metadata.gz: 982f4ca537611174ec4a2ef7a768c26e33869b5491fab6ad58ea09189fe21fa9d35875f580982ccbb392ebd13c3d0fa3c8b8d4c5777e4fa4245e80b2585e8520
-  data.tar.gz: 179e7b1f1f7d6604498ac40265c9f0e187781f0432f559997959af21934ef92b46e72fdffb8cfb52ce072af91c7a36695c830a8ddf8822e9453e860fbaed7aa9
+  metadata.gz: c4f29154906b6b23c1d2b2f2b18aa3be16da6c1b6e9d0f0952360eea13c141e05c39a6eaee952d402685e94556a07f2063137cbdcbbabbf8b0046434795e5124
+  data.tar.gz: 58e3f792a2f85054f3a9ff88ab19bd70fd9ceb6c1a3f9308bbdf403b53a6dab56430bc6ddc9af47d83941ef48cc629e2b4d360b523136282b8f543ca9f996c08

data/.env.example

@@ -0,0 +1 @@
+DATABASE_HOST=restme_postgres

data/.rubocop.yml

@@ -1,8 +1,14 @@
 AllCops:
   TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  NewCops: enable
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/lib/restme_controller_spec.rb

data/README.md

@@ -1,7 +1,5 @@
 # Restme
 
-## ⚠️ Do not use this gem yet. In progress
-
 [![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.
@@ -21,7 +19,7 @@ gem install restme
 OR
 
 ```bash
-gem 'restme', '~> 0.0.33'
+gem 'restme'
 ```
 
 ## Usage
@@ -36,6 +34,7 @@ gem 'restme', '~> 0.0.33'
 
 ### Usage examples
 
+Rails API project example here: https://github.com/everson-ever/restme-example/pull/1
 
 #### First of all
 

data/docker-compose.yml

@@ -9,5 +9,25 @@ services:
     volumes:
       - .:/var/www/restme
     mem_limit: 1024mb
+    depends_on:
+      - restme_postgres
+  restme_postgres:
+    image: postgres:15.8-alpine
+    container_name: restme_postgres
+    volumes:
+      - postgres_db:/var/lib/postgresql/data
+    ports:
+      - "5432:5432"
+    mem_limit: 512mb
+    restart: unless-stopped
+    environment:
+      - POSTGRES_PASSWORD=postgres
+      - POSTGRES_USERNAME=postgres
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 5s
+      timeout: 5s
+      retries: 5
 volumes:
   app:
+  postgres_db:

data/lib/restme/authorize/rules.rb

@@ -12,9 +12,25 @@ module Restme
 
       def user_authorize
         return true unless restme_current_user
-        return if super_authorize? || allowed_roles_actions[action_name.to_sym]&.include?(user_role.to_sym)
+        return authorize_errors unless authorize?
 
-        render json: { message: "Action not allowed" }, status: :forbidden
+        true
+      end
+
+      def authorize?
+        super_authorize? ||
+          allowed_roles_actions[action_name.to_sym]&.include?(user_role.to_sym)
+      end
+
+      def authorize_errors
+        restme_scope_errors(
+          {
+            message: "Action not allowed",
+            body: {}
+          }
+        )
+
+        restme_scope_status(:forbidden)
       end
 
       def allowed_roles_actions

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

@@ -10,8 +10,6 @@ module Restme
         include Restme::Scope::Field::Attachable
 
         def fieldable_scope(user_scope)
-          unallowed_select_fields_error
-
           return user_scope unless select_any_field?
 
           scoped = user_scope
@@ -72,12 +70,14 @@ module Restme
             end&.map(&:to_sym)
         end
 
-        def unallowed_select_fields_error
+        def unallowed_select_fields_errors
           return if unallowed_fields_selected.blank?
 
           restme_scope_errors({ body: unallowed_fields_selected, message: "Selected not allowed fields" })
 
           restme_scope_status(:bad_request)
+
+          true
         end
 
         def unallowed_fields_selected

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

@@ -23,22 +23,37 @@ module Restme
 
         ID = :id
 
-        FILTERS_TYPES = %i[equal like bigger_than less_than
-                           bigger_than_or_equal_to less_than_or_equal_to in].freeze
+        FILTERS_TYPES = %i[
+          equal
+          like
+          bigger_than
+          less_than
+          bigger_than_or_equal_to
+          less_than_or_equal_to
+          in
+        ].freeze
 
         private
 
         def filterable_scope(user_scope)
-          return unallowed_filter_fields_response if unallowed_fields_to_filter?
+          @user_scope = user_scope
+
           return user_scope unless filterable_scope?
+          return user_scope if record_not_found_errors
+
+          processed_scope
+        end
 
-          next_scope = where_equal(user_scope)
-          next_scope = where_like(next_scope)
-          next_scope = where_bigger_than(next_scope)
-          next_scope = where_less_than(next_scope)
-          next_scope = where_bigger_than_or_equal_to(next_scope)
-          next_scope = where_less_than_or_equal_to(next_scope)
-          where_in(next_scope)
+        def processed_scope
+          @processed_scope ||= begin
+            next_scope = where_equal(@user_scope)
+            next_scope = where_like(next_scope)
+            next_scope = where_bigger_than(next_scope)
+            next_scope = where_less_than(next_scope)
+            next_scope = where_bigger_than_or_equal_to(next_scope)
+            next_scope = where_less_than_or_equal_to(next_scope)
+            where_in(next_scope)
+          end
         end
 
         def allowed_fields
@@ -48,7 +63,6 @@ module Restme
             end
 
             record_field = param_key.to_s.gsub("_#{filter_type}", "")&.to_sym
-
             next unless filter_type
             next unless filteable_fields.include?(record_field)
 
@@ -66,29 +80,45 @@ module Restme
           [ID]
         end
 
-        def unallowed_fields_to_filter?
-          try_insert_id_equal
-
-          filterable_scope? && unallowed_fields_to_filter.present?
-        end
-
         def filterable_scope?
           request.get? && controller_params_filters_fields.present?
         end
 
-        def unallowed_fields_to_filter
-          @unallowed_fields_to_filter ||= controller_params_filters_fields - allowed_fields
-        end
-
         def try_insert_id_equal
           return if params[:id].blank?
 
           controller_params_filters_fields.push(:id_equal)
         end
 
-        def unallowed_filter_fields_response
-          render json: { message: "Unknown Filter Fields", body: unallowed_fields_to_filter },
-                 status: :bad_request
+        def unallowed_filter_fields_errors
+          try_insert_id_equal
+
+          return unless unallowed_fields_to_filter.present?
+
+          restme_scope_errors(
+            {
+              message: "Unknown Filter Fields",
+              body: unallowed_fields_to_filter
+            }
+          )
+
+          restme_scope_status(:bad_request)
+
+          true
+        end
+
+        def record_not_found_errors
+          return if params[:id].blank? || processed_scope.exists?
+
+          restme_scope_errors({ body: { id: params[:id] }, message: "Record not found" })
+
+          restme_scope_status(:not_found)
+
+          true
+        end
+
+        def unallowed_fields_to_filter
+          @unallowed_fields_to_filter ||= controller_params_filters_fields - allowed_fields
         end
 
         def controller_params_filters_fields

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

@@ -10,8 +10,6 @@ module Restme
         MAX_PER_PAGE = ENV.fetch("PAGINATION_MAX_PER_PAGE", 100)
 
         def paginable_scope(user_scope)
-          per_page_error
-
           user_scope.limit(per_page).offset(paginate_offset)
         end
 
@@ -35,7 +33,7 @@ module Restme
           (page_no - 1) * per_page
         end
 
-        def per_page_error
+        def per_page_errors
           return if per_page <= MAX_PER_PAGE
 
           restme_scope_errors(
@@ -46,6 +44,8 @@ module Restme
           )
 
           restme_scope_status(:bad_request)
+
+          true
         end
       end
     end

data/lib/restme/scope/rules.rb

@@ -23,20 +23,24 @@ module Restme
       include ::Restme::Shared::UserRole
 
       attr_reader :filtered_scope, :sorted_scope, :paginated_scope, :fieldated_scope
-      attr_accessor :restme_scope_errors, :restme_scope_status
+      attr_writer :restme_scope_errors, :restme_scope_status
 
       def pagination_response
         @pagination_response ||= restme_response
       end
 
       def model_scope_object
-        @model_scope_object ||= model_scope.first
+        @model_scope_object ||= begin
+          model_scope unless any_scope_errors.present?
+
+          restme_scope_errors.presence || model_scope.first
+        end
       end
 
       private
 
       def restme_response
-        model_scope
+        any_scope_errors
 
         restme_scope_errors.presence || {
           objects: model_scope,
@@ -44,6 +48,15 @@ module Restme
         }
       end
 
+      def any_scope_errors
+        per_page_errors
+        unknown_sortable_fields_errors
+        unallowed_filter_fields_errors
+        unallowed_select_fields_errors
+
+        restme_scope_errors
+      end
+
       def model_scope
         @model_scope ||= without_item_in_scope? ? user_scope : custom_scope
       end
@@ -57,7 +70,9 @@ module Restme
       end
 
       def restme_scope_errors(error = nil)
-        @restme_scope_errors ||= error
+        @restme_scope_errors ||= []
+        @restme_scope_errors << error if error.present?
+        @restme_scope_errors
       end
 
       def restme_scope_status(status = :ok)

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

@@ -11,7 +11,6 @@ module Restme
 
         def sortable_scope(user_scope)
           return user_scope unless sortable_scope?
-          return user_scope if unknown_sortable_fields_errors
 
           user_scope.order(serialize_sort_params)
         end

data/lib/restme/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restme
 version: !ruby/object:Gem::Version
-  version: 0.0.37
+  version: 0.0.39
 platform: ruby
 authors:
 - everson-ever
@@ -16,6 +16,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -55,6 +56,7 @@ metadata:
   homepage_uri: https://github.com/everson-ever/restme
   source_code_uri: https://github.com/everson-ever/restme
   changelog_uri: https://github.com/everson-ever/restme/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib