upframework 0.2.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b7cd4203031fe204ae2db4b2e9f15234f70b9f8319c0b0eb0479a93b8d775d
-  data.tar.gz: bab9c34c224ae19444350453b103a6658bba142351ef54a516d602b34f869ca5
+  metadata.gz: 3d78ce308cddeb5a32b7797a7e26d25cfdf1f0709a17e81a600861d8b82076e8
+  data.tar.gz: c31b0a99dc060af46a8bf1f7d749f129df8064fd8e56c46a3226a6d215f94ebf
 SHA512:
-  metadata.gz: 98e0d8b2a6405ccd13098554c6c219b9b1f3bc551c9d321f4378a71bb39cbd468a34260818b2f0a14abeba83060a9692fdf86163fbf8d92d2121b836ea67efcd
-  data.tar.gz: 93d0add617417cfd7fe6052d6557525fc22626069032a37677e9b9d5ba43257828694ad35edca4eec0f676e75f8ec510ffc876c2aa9cd208442dbf48dc12492e
+  metadata.gz: 8ca6e587887c644c1d3067ac8bd50b0b85a55e52c73cd5e3734f052bc93b8f5c68e9135ce45695b9937b75b6bc6dfc66bee00ef8484ae093ab9cf3aa12f9a519
+  data.tar.gz: 918fe786f0fcd0364d306623e1d5c06be4ebcf4fe2fc342f79542c0da6ec7f8ff42074939b30154cd4f3652f8e525a16c1f1ad8911eeba5cc7cbb9b46f07ad59

data/app/controllers/concerns/upframework/error_handler.rb

@@ -16,7 +16,9 @@ module Upframework::ErrorHandler
       ExceptionNotifier.notify_exception(error, env: request.env)
 
       error_info = {
+        success: false,
         error: 'Internal Server Error',
+        status_code: 500,
         exception: "#{error.class.name} : #{error.message}"
       }
 

data/app/controllers/concerns/upframework/render_extensions.rb

@@ -11,8 +11,11 @@ module Upframework
       # format        => format can be :full(returns all default) or :minimal(returns only ids an types)
       # compound_opts => options, e.g: meta or links
       # opts          => extra options from render
-      def render_serialized(resource, includes: [], format: :full, compound_opts: {}, **opts)
-        render json: serialize_resource(resource, includes, format, compound_opts), **opts
+      def render_serialized(resource, options)
+        options = options.is_a?(ActionController::Parameters) ? options.to_unsafe_h.symbolize_keys : options
+        options[:current_controller] = self
+
+        render json: serialize_resource(resource, options).as_json, **options.except(:format)
       end
 
       # Args
@@ -22,10 +25,7 @@ module Upframework
       # format        => format can be :full(returns all default) or :minimal(returns only ids an types)
       # compound_opts => options, e.g: meta or links
       # opts          => extra options from render
-      def broadcast_serialized(channel, resource:, event:, includes: [], format: :full, compound_opts: {})
-        includes << :events
-        resource.add_event(event, creator: current_member)
-
+      def broadcast_serialized(channel, resource:, includes: [], format: :full, compound_opts: {})
         channel_klass = "::#{channel.class.name}Channel".constantize
         channel_klass.broadcast_to(channel, serialize_resource(resource, includes, format, compound_opts))
       end
@@ -36,20 +36,14 @@ module Upframework
 
       protected
 
-      def serialize_resource(resource, includes, format, compound_opts)
+      def serialize_resource(resource, options)
         resource_klass = resource.class.name
-        if resource_klass == 'ActiveRecord::Relation'
-          resource_klass = resource.klass.name
-        end
-        # TODO: support empty arrays
-        resource_klass = resource.first.class.name if resource.is_a? Array
 
-        serializer_klass = "#{resource_klass}Serializer".constantize
-
-        relations = serializer_klass.default_includes
-        relations.concat(Array(includes).map(&:to_sym)) if includes
-
-        serializer_klass.new(resource, include: relations, format: format, current_controller: self, **compound_opts).serializable_hash
+        if resource.respond_to? :each
+          ::Serializer::Collection.new(resource, **options)
+        else
+          ::Serializer::Item.new(resource, **options)
+        end
       end
     end
   end

data/app/controllers/upframework/api_extensions.rb

@@ -15,7 +15,7 @@ module Upframework
 
       rescue_from CanCan::AccessDenied do |exception|
         respond_to do |format|
-          format.json { render json: { success: false, error: exception.message }, status: :forbidden }
+          format.json { render json: { success: false, error: exception.message, status_code: 403 }, status: :forbidden }
           format.html { redirect_to main_app.root_url, alert: exception.message }
         end
       end

data/app/controllers/upframework/resources_controller.rb

@@ -6,13 +6,13 @@ module Upframework
       base_resource
 
       yield if block_given?
-      render_serialized base_resource
+      render_serialized base_resource, params
     end
 
     def update
       if base_resource.update(base_resource_params)
         yield if block_given?
-        render_serialized base_resource
+        render_serialized base_resource, params
       else
         render_errors base_resource.errors.full_messages
       end
@@ -22,14 +22,14 @@ module Upframework
       base_resource
 
       yield if block_given?
-      render_serialized base_resource, includes: params[:includes]
+      render_serialized base_resource, params
     end
 
     def create
       if base_resource.save
 
         yield if block_given?
-        render_serialized base_resource
+        render_serialized base_resource, params
       else
         render_errors base_resource.errors.full_messages
       end
@@ -81,7 +81,7 @@ module Upframework
     end
 
     def accessors
-      current_user
+      super || current_user
     end
 
     def base_resource_name

data/app/lib/serializer/collection.rb

@@ -0,0 +1,37 @@
+class Serializer::Collection
+  attr_accessor :records, :includes, :compound_opts, :format, :current_controller
+
+  def initialize(records, includes: [], compound_opts: {}, **params)
+    @records = ::Serializer::Pagination.run(records: records, page: params[:page], per_page: params[:per_page], **params).result
+    @records = ::Serializer::Sort.run(records: @records, sort: params[:sort], **params).result
+
+    @includes = includes
+    @compound_opts = compound_opts
+    @format = params[:format]
+    @current_controller = params[:current_controller]
+  end
+
+  def as_json
+    serializer_klass.new(records, include: relation_includes, format: format, current_controller: current_controller, **compound_opts).serializable_hash
+  end
+
+  def serializer_klass
+    resource_klass = records.klass if records.is_a? ActiveRecord::Relation
+    resource_klass = records.first.class if records.is_a? Array
+
+    "#{resource_klass.name}Serializer".constantize
+  end
+
+  def relation_includes
+    relations = serializer_klass.default_includes
+
+    @includes =
+      if includes.is_a? String
+        includes.split(",").map(&:underscore).map(&:to_sym)
+      else
+        Array(includes).map(&:to_sym)
+      end
+
+    relations.concat(includes.compact)
+  end
+end

data/app/lib/serializer/item.rb

@@ -0,0 +1,32 @@
+class Serializer::Item
+  attr_accessor :record, :includes, :compound_opts, :current_controller, :format
+
+  def initialize(item, includes: [], compound_opts: {}, **params)
+    @record = item
+    @includes = includes
+    @compound_opts = compound_opts
+    @current_controller = params[:current_controller]
+    @format = params[:format]
+  end
+
+  def serializer_klass
+    "#{record.class.name}Serializer".constantize
+  end
+
+  def as_json
+    serializer_klass.new(record, include: relation_includes, format: format, current_controller: current_controller, **compound_opts).serializable_hash
+  end
+
+  def relation_includes
+    relations = serializer_klass.default_includes
+
+    @includes =
+      if includes.is_a? String
+        includes.split(",").map(&:underscore).map(&:to_sym)
+      else
+        Array(includes).map(&:to_sym)
+      end
+
+    relations.concat(includes.compact)
+  end
+end

data/app/lib/serializer/pagination.rb

@@ -0,0 +1,26 @@
+class Serializer::Pagination < Upframework::BaseService
+  DEFAULT_PAGE = 1
+  DEFAULT_PER_PAGE = 20
+
+  attr_accessor :records, :page, :per_page
+
+  def initialize(records: [], page:, per_page:, **params)
+    @records = records
+    @page = page
+    @per_page = per_page
+  end
+
+  def execute
+    paginate_scope
+  end
+
+  def result
+    records
+  end
+
+  def paginate_scope
+    @records = records.
+      page(page || DEFAULT_PAGE).
+      per(per_page || DEFAULT_PER_PAGE)
+  end
+end

data/app/lib/serializer/sort.rb

@@ -0,0 +1,20 @@
+class Serializer::Sort < Upframework::BaseService
+  attr_accessor :records
+
+  def initialize(records: [], sort: nil, **params)
+    @records = records
+    @sort = sort
+  end
+
+  def execute
+    sort_scope
+  end
+
+  def result
+    records
+  end
+
+  def sort_scope
+    #TODO sort scope here
+  end
+end

data/app/searches/upframework/base_search.rb

@@ -9,22 +9,4 @@ class Upframework::BaseSearch < Upframework::BaseService
   def query(field)
     @model_scope = yield if field.present?
   end
-
-  def paginate_scope
-    return if @model_scope.nil?
-
-    @model_scope = @model_scope.
-      page(@page || DEFAULT_PAGE).
-      per(@per_page || DEFAULT_PER_PAGE).
-      order(created_at: :desc)
-  end
-
-  module ExecuteWrapper
-    def execute
-      super
-      paginate_scope
-    end
-  end
-
-  include ExecuteWrapper
 end

data/app/services/upframework/base_service.rb

@@ -27,6 +27,7 @@ module Upframework
 
     def execute
     end
+    alias_method :run, :execute
 
     def result
     end

data/lib/upframework/version.rb

@@ -1,3 +1,3 @@
 module Upframework
-  VERSION = '0.2.8'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upframework
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.4.0
 platform: ruby
 authors:
 - jude_cali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-02 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -70,7 +70,6 @@ files:
 - Rakefile
 - app/assets/config/upframework_manifest.js
 - app/assets/stylesheets/upframework/application.css
-- app/controllers/concerns/upframework/crud_endpoint.rb
 - app/controllers/concerns/upframework/error_handler.rb
 - app/controllers/concerns/upframework/render_extensions.rb
 - app/controllers/concerns/upframework/transform_param_keys.rb
@@ -79,6 +78,10 @@ files:
 - app/controllers/upframework/searches_controller.rb
 - app/helpers/upframework/application_helper.rb
 - app/jobs/upframework/application_job.rb
+- app/lib/serializer/collection.rb
+- app/lib/serializer/item.rb
+- app/lib/serializer/pagination.rb
+- app/lib/serializer/sort.rb
 - app/mailers/upframework/application_mailer.rb
 - app/models/upframework/application_record.rb
 - app/searches/upframework/base_search.rb

data/app/controllers/concerns/upframework/crud_endpoint.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-module Upframework::CrudEndpoint
-  extend ::ActiveSupport::Concern
-
-  included do
-    before_action :set_base_resource
-  end
-
-  def show
-    base_resource
-
-    yield if block_given?
-    render_serialized base_resource
-  end
-
-  def update
-    if base_resource.update(base_resource_params)
-      yield if block_given?
-      render_serialized base_resource
-    else
-      render_errors base_resource.errors.full_messages
-    end
-  end
-
-  def index
-    base_resource
-
-    yield if block_given?
-    render_serialized base_resource, includes: params[:includes]
-  end
-
-  def create
-    if base_resource.save
-
-      yield if block_given?
-      render_serialized base_resource
-    else
-      render_errors base_resource.errors.full_messages
-    end
-  end
-
-  def destroy
-    base_resource.destroy
-    head :no_content
-  end
-
-  private
-
-  def base_resource
-    if params[:id]
-      instance_variable_get("@#{base_resource_name}")
-    else
-      instance_variable_get("@#{base_resource_name.pluralize}")
-    end
-  end
-
-  def set_base_resource
-    data =
-      if params[:id]
-        base_resource_class.find(params[:id])
-      elsif action_name == 'index'
-        base_resource_class.accessible_by(current_ability).where(base_resource_params || {})
-      elsif action_name == 'create'
-        base_resource_class.new(base_resource_params)
-      end
-
-    resource_name = %w[index create].include?(action_name) \
-      ? base_resource_name.pluralize \
-      : base_resource_name
-
-    instance_variable_set("@#{resource_name}", data) if data
-  end
-
-  def base_resource_params
-    base_name = base_resource_name
-
-    base_name = base_name.pluralize unless params.key?(base_name)
-
-    params.fetch(base_name).permit(*permitted_columns)
-  end
-
-  def permitted_columns
-    columns = base_resource_class.accessible_fields_by(accessors)
-    columns.concat(extra_params)
-  end
-
-  def accessors
-    current_user
-  end
-
-  def base_resource_name
-    controller_name.singularize
-  end
-
-  def base_resource_class
-    base_resource_name.classify.safe_constantize
-  end
-end