rao-api-resources_controller 0.0.48.pre → 0.0.50.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc5902a08fb2d5bb7d71e7cff3235f41c6a24a2f10c22c72d85ed161a5b79689
-  data.tar.gz: 7bf5109b3949fcfbf37af6de82126fed7899eb18fa65a571b9361555fad878b4
+  metadata.gz: e51753ea3bc71fb2b7922f4797f44866b73458ed4c6aa10c3ab425e85362950b
+  data.tar.gz: 76a1ddc7c9522381e82745fa010c1a622aba6ebc41152004908c564a72bd6bae
 SHA512:
-  metadata.gz: ed4f2cb90c0da490ab9cd5bd47b56bc725b2a540ad56bc55d7aaced3edd30c3f9390af80376e01bf4f8163292f405b9e73c9e31e41115e81c3f013a58371a264
-  data.tar.gz: fdca91415be7fea9647d88b26138838066a9d78a6139e328cf0863edf092ca7d4f44cd49826eb7241a258e39ddab548de171ce04a9103a3495c5274953e6e032
+  metadata.gz: 0f657f1639bcc4960bd5639913b025b87bb9665593fa8bc55fa5875739b83701f2fff9b3f7fd1105b9db88332b5cf77b1292b9cc753377dbff96466e2e905016
+  data.tar.gz: 619a871ff4c23783c93a149dbda62f98b901956f9d685670a6ef1971461bcea5c16aa5d1d06159cc9f60571b804f08731954fd79933bc2e469610f3de8a641f1

data/README.md

@@ -42,6 +42,35 @@ module Api
 end
 ```
 
+### Sorting collections
+
+You can specify the sorting via the params "sort_by" and "sort_direction".
+
+### Including associated records
+
+See rao-query.
+
+### Filtering collections
+
+See rao-query.
+
+### Using the modules instead inheritance
+
+Sometimes you want your controller to inherit from a specific controller. In
+that case you can't use Rao::Api::ResourcesController::Base as the base controller.
+Instead of using inheritance you can include the needed modules directly:
+
+    class CountriesController < ApplicationController
+      include Rao::Api::ResourcesController::RestActionsConcern
+      include Rao::Api::ResourcesController::ResourcesConcern
+      include Rao::Api::ResourcesController::SerializationConcern
+      include Rao::Api::ResourcesController::CountActionConcern
+      include Rao::Api::ResourcesController::DestroyAllActionConcern
+      include Rao::Api::ResourcesController::DeleteAllActionConcern
+      include Rao::Api::ResourcesController::FirstActionConcern
+      include Rao::Api::ResourcesController::LastActionConcern
+      include Rao::Api::ResourcesController::ExceptionHandlingConcern
+    end
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/concerns/rao/api/resource_controller/exception_handling_concern.rb

@@ -0,0 +1,42 @@
+module Rao
+  module Api
+    module ResourceController::ExceptionHandlingConcern
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from Exception do |exception|
+          handle_exception(exception)
+        end
+
+        rescue_from ActiveRecord::RecordNotFound do |exception|
+          handle_404(exception)
+        end
+      end
+
+      private
+
+      def handle_404(exception = nil)
+        respond_to do |format|
+          format.json { render json: { error: (exception.try(:message) || 'Not found') }, status: 404 }
+        end
+      end
+
+      def handle_exception(exception)
+        if Rails.env.development? || Rails.env.test?
+          error = { message: exception.message }
+
+          error[:application_trace] = Rails.backtrace_cleaner.clean(exception.backtrace)
+          error[:full_trace] = exception.backtrace
+
+          respond_to do |format|
+            format.json { render json: error, status: 500 }
+          end
+        else
+          respond_to do |format|
+            format.json { render json: { error: 'Internal server error.' }, status: 500 }
+          end
+        end
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resource_controller/resource_concern.rb

@@ -0,0 +1,11 @@
+module Rao
+  module Api
+    module ResourceController::ResourceConcern
+      extend ActiveSupport::Concern
+
+      def resource_class
+        self.class.resource_class
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resource_controller/rest_actions_concern.rb

@@ -0,0 +1,87 @@
+module Rao
+  module Api
+    module ResourceController::RestActionsConcern
+      extend ActiveSupport::Concern
+
+      included do
+        include ActionController::MimeResponds
+
+        respond_to :json
+
+        before_action :load_resource_for_show, only: [:show]
+        before_action :load_resource, only: [:update, :destroy, :delete]
+        before_action :initialize_resource_for_create, only: [:create]
+      end
+
+      def show
+        respond_to do |format|
+          if @resource.nil?
+            format.json { render json: { error: "Couldn't find #{resource_class} with ID=#{params[:id]}" }, status: :not_found }
+          else
+            format.json { render json: serialize_resource(@resource), status: :ok }
+          end
+        end
+      end
+
+      def create
+        respond_to do |format|
+          if @resource.save
+            format.json { render json: serialize_resource(@resource), status: :created }
+          else
+            format.json { render json: { errors: serialize_errors(@resource.errors) }, status: 422 }
+          end
+        end
+      end
+
+      def update
+        respond_to do |format|
+          if @resource.update(permitted_params)
+            format.json { render json: serialize_resource(@resource) }
+          else
+            format.json { render json: { errors: serialize_errors(@resource.errors) }, status: 422 }
+          end
+        end
+      end
+
+      def destroy
+        @resource.destroy
+        respond_to do |format|
+          format.json { render json: serialize_resource(@resource) }
+        end
+      end
+
+      def delete
+        @resource.delete
+        respond_to do |format|
+          format.json { render json: serialize_resource(@resource) }
+        end
+      end
+
+      private
+
+      def load_resource
+        raise "Please define #load_resource in #{self.class.name} and tell me how to load @resource."
+      end
+
+      def load_resource_for_show
+        begin
+          @resource = load_resource
+        rescue ActiveRecord::RecordNotFound
+          @resource = nil
+        end
+      end
+
+      def initialize_resource
+        @resource = resource_class.new
+      end
+
+      def initialize_resource_for_create
+        @resource = resource_class.new(permitted_params)
+      end
+
+      def permitted_params
+        raise "not implemented"
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resource_controller/serialization_concern.rb

@@ -0,0 +1,19 @@
+module Rao
+  module Api
+    module ResourceController::SerializationConcern
+      extend ActiveSupport::Concern
+
+      private
+
+      def serialize_resource(resource)
+        json = resource.as_json
+        json[:errors] = serialize_errors(resource.errors) if resource.errors.any?
+        json
+      end
+
+      def serialize_errors(errors)
+        errors.as_json(full_messages: true)
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/rest_actions_concern.rb

@@ -49,7 +49,7 @@ module Rao
 
       def update
         respond_to do |format|
-          if @resource.update_attributes(permitted_params)
+          if @resource.update(permitted_params)
             format.json { render json: serialize_resource(@resource) }
           else
             format.json { render json: { errors: serialize_errors(@resource.errors) }, status: 422 }
@@ -73,17 +73,24 @@ module Rao
 
       private
 
-      def load_collection
-        scope = if respond_to?(:with_conditions_from_query, true)
-          scope = with_conditions_from_query(resource_class)
+      def load_collection_scope
+        if respond_to?(:with_conditions_from_query, true)
+          with_conditions_from_query(resource_class)
         else
           resource_class
         end
-        @collection = scope.all
+      end
+
+      def load_collection
+        @collection = load_collection_scope.all
+      end
+
+      def load_resource_scope
+        resource_class
       end
 
       def load_resource
-        @resource = resource_class.find(params[:id])
+        @resource = load_resource_scope.find(params[:id])
       end
 
       def load_resource_for_show
@@ -102,6 +109,10 @@ module Rao
         @resource = resource_class.new(permitted_params)
       end
 
+      def params
+        super.deep_transform_keys!(&:underscore)
+      end
+
       def permitted_params
         raise "not implemented"
       end

data/app/concerns/rao/api/resources_controller/serialization_concern.rb

@@ -17,8 +17,8 @@ module Rao
         json
       end
 
-      def serialize_errors(errors)
-        errors.as_json(full_messages: true)
+      def serialize_errors(errors, full_messages: true)
+        errors.as_json(full_messages: full_messages)
       end
     end
   end

data/app/concerns/rao/api/resources_controller/sorting_concern.rb

@@ -0,0 +1,30 @@
+module Rao
+  module Api
+    module ResourcesController::SortingConcern
+      private
+
+      def load_collection_scope
+        add_order_scope(super)
+      end
+
+      def add_order_scope(base_scope)
+        if params[:sort_by].present?
+          if params[:sort_by].include?(' ') || params[:sort_direction].include?(' ')
+            raise "Possible SQL Injection attempt while trying to sort by #{params[:sort_by]} #{params[:sort_direction]}"
+          end
+
+          sort_by        = params[:sort_by]
+          sort_direction = (params[:sort_direction] || :asc)
+
+          if sort_by.include?('.')
+            base_scope.reorder("#{sort_by} #{sort_direction}")
+          else
+            base_scope.reorder(sort_by => sort_direction)
+          end
+        else
+          base_scope
+        end
+      end
+    end
+  end
+end

data/app/concerns/rao/api/resources_controller/validation_concern.rb

@@ -0,0 +1,30 @@
+module Rao
+  module Api
+    module ResourcesController
+      module ValidationConcern
+        extend ActiveSupport::Concern
+      
+        included do
+          before_action :initialize_resource_for_validation, only: [:validate]
+        end
+
+        def validate
+          respond_to do |format|
+            if @resource.valid?
+              format.json { render json: { errors: serialize_errors(@resource.errors, full_messages: false) }, status: 200 }
+              # format.json { render json: serialize_resource(@resource), status: :created }
+            else
+              format.json { render json: { errors: serialize_errors(@resource.errors, full_messages: false) }, status: 422 }
+            end
+          end
+        end
+
+        private
+
+        def initialize_resource_for_validation
+          initialize_resource_for_create
+        end
+      end
+    end
+  end
+end

data/app/controllers/rao/api/resource_controller/base.rb

@@ -0,0 +1,12 @@
+module Rao
+  module Api
+    module ResourceController
+      class Base < Rao::Api::ResourcesController::Configuration.resources_controller_base_class_name.constantize
+        include RestActionsConcern
+        include ResourceConcern
+        include SerializationConcern
+        include ExceptionHandlingConcern
+      end
+    end
+  end
+end

data/app/controllers/rao/api/resources_controller/base.rb

@@ -11,6 +11,7 @@ module Rao
         include FirstActionConcern
         include LastActionConcern
         include ExceptionHandlingConcern
+        include SortingConcern
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rao-api-resources_controller
 version: !ruby/object:Gem::Version
-  version: 0.0.48.pre
+  version: 0.0.50.pre
 platform: ruby
 authors:
 - Roberto Vasquez Angel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2023-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -160,6 +160,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/concerns/rao/api/resource_controller/exception_handling_concern.rb
+- app/concerns/rao/api/resource_controller/resource_concern.rb
+- app/concerns/rao/api/resource_controller/rest_actions_concern.rb
+- app/concerns/rao/api/resource_controller/serialization_concern.rb
 - app/concerns/rao/api/resources_controller/count_action_concern.rb
 - app/concerns/rao/api/resources_controller/delete_all_action_concern.rb
 - app/concerns/rao/api/resources_controller/destroy_all_action_concern.rb
@@ -169,6 +173,9 @@ files:
 - app/concerns/rao/api/resources_controller/resources_concern.rb
 - app/concerns/rao/api/resources_controller/rest_actions_concern.rb
 - app/concerns/rao/api/resources_controller/serialization_concern.rb
+- app/concerns/rao/api/resources_controller/sorting_concern.rb
+- app/concerns/rao/api/resources_controller/validation_concern.rb
+- app/controllers/rao/api/resource_controller/base.rb
 - app/controllers/rao/api/resources_controller/base.rb
 - config/locales/de.yml
 - config/locales/en.yml
@@ -199,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.24
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
 summary: API Resources Controller for Ruby on Rails.