restme 0.0.38 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65794fd40e07c3dad593d15b93cbdfd860dfed7dbc4efcf960c410eedc9bd7ec
-  data.tar.gz: d688961f322dc7caabc5e6c7c28e362a237097e7fababbcf7f3c40bf45cd8582
+  metadata.gz: 34e6f83a9517ad4596b91a677ea60bc4520a6d074684ba31069a33967252e520
+  data.tar.gz: 94a3e5fee24cd500c7b1904b048f76df2831f22363a463c1273603f56e996fde
 SHA512:
-  metadata.gz: 7c67210649fc7511aa4150f14fbf262c76357d667c05c541fe7f0850c8ca7570f6c503d98f6109ffc5ef15be34b875d23a120b528c6c4edce73e1b620c032099
-  data.tar.gz: 1a6eb52d9fbe9f2d6c4b568f4b6d80ee12f22693698bd993b9175c09f946ef4943b063b218a6a1f5aeb868f86c6e25ca47aa0898a4c4fdca67542bf57c1c6633
+  metadata.gz: 42e31bc636a89203a07f9b068ba6916cf6b1df32e978d01bbc01a1f4168c825137c367a5bc6d73c3584b485f8768f32184a2eb026ccd5b78a22f5dcea1a08e74
+  data.tar.gz: 4fc46af681505a061ea78d606410b8dcf7bc490ccf34deae1ec07f9ad36382bd232c9e550781a8bc55d67012ab8af104d0efa56f38ee0462e3fe6261613be1d1

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

@@ -19,7 +19,7 @@ gem install restme
 OR
 
 ```bash
-gem 'restme', '~> 0.0.37'
+gem 'restme'
 ```
 
 ## Usage

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:
+      - "5442: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

@@ -10,11 +10,28 @@ module Restme
       include ::Restme::Shared::CurrentModel
       include ::Restme::Shared::UserRole
 
-      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)
+      def user_authorized?
+        return true if restme_current_user.blank? || authorize?
 
-        render json: { message: "Action not allowed" }, status: :forbidden
+        authorize_errors
+
+        false
+      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/restme.rb

@@ -18,11 +18,15 @@ module Restme
     def initialize_restme
       use_current_user
 
-      user_authorize
+      restme_authorize_response unless user_authorized?
     end
 
     private
 
+    def restme_authorize_response
+      render json: restme_scope_errors, status: restme_scope_status
+    end
+
     def use_current_user
       @restme_current_user = try(:current_user)
     end

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

@@ -36,16 +36,24 @@ module Restme
         private
 
         def filterable_scope(user_scope)
+          @user_scope = user_scope
+
           return user_scope unless filterable_scope?
-          return user_scope if unallowed_filter_fields_errors
-
-          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)
+          return user_scope if record_not_found_errors
+
+          processed_scope
+        end
+
+        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
@@ -55,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)
 
@@ -74,8 +81,6 @@ module Restme
         end
 
         def filterable_scope?
-          try_insert_id_equal
-
           request.get? && controller_params_filters_fields.present?
         end
 
@@ -86,6 +91,8 @@ module Restme
         end
 
         def unallowed_filter_fields_errors
+          try_insert_id_equal
+
           return unless unallowed_fields_to_filter.present?
 
           restme_scope_errors(
@@ -100,6 +107,16 @@ module Restme
           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

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)
-          return user_scope if 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(

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,8 +48,17 @@ 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
+        @model_scope ||= custom_scope
       end
 
       def pagination
@@ -57,17 +70,15 @@ 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)
         @restme_scope_status ||= status
       end
 
-      def without_item_in_scope?
-        !user_scope.exists?
-      end
-
       def custom_scope
         @filtered_scope = filterable_scope(user_scope)
         @sorted_scope = sortable_scope(filtered_scope)

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.38"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restme
 version: !ruby/object:Gem::Version
-  version: 0.0.38
+  version: 1.0.1
 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