upframework 0.2.4 → 0.2.91

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9df2b3fab51ad8cd9df13ce48c23de3f7de3345a732950f1133de10468443b
-  data.tar.gz: e964a3112339f87964455696b87788e9fca05f75be7fbda0edc4a22a772b667d
+  metadata.gz: 801f75afeb73f9ebbaa429e0699f8e808f258a58debe206ed5cda954fb97fdb8
+  data.tar.gz: b40be74dab664d2c3fcd5997bafd797a578c71a767bb15db07f93e01f8bf5cba
 SHA512:
-  metadata.gz: 3dccc34d6735c68b9bc5ab6e0feb4084bb33ec67df5627a20e8bb6b5e4668795dbc063e399bddf03895168a51b28235b0e7b879f1ae882b4989a7f9a4a670c00
-  data.tar.gz: 0be54b8cad4e95f88314aa60f8ecf9e02f0482fa97f1e202edb4b96a9321beeb16c8b107f0d3245958a85f1965bd8a9944302e98733c505baecc2e9353068f95
+  metadata.gz: 7d79cfd3ca644a503593cdaeaad0692074261cddc045960a33190bd33c199c7b993f60386fc88b892754cc3711b6a52f47a9ec6c666ca90cf50e7cf53f3338bf
+  data.tar.gz: 05a7471d324141b0db6c68ef55498a8ed016eb90b1634e89dc40a0f0415bb96016eef220d89709c7d3c72416bfcbc7acbee5ca1acaabfd4ffe07db1a563b97c1

data/README.md

@@ -30,6 +30,20 @@ class ProjectsController < Upframework::ResourcesController
 end
 ```
 
+
+#### Serializers
+```ruby
+# app/serializers
+# classes extending Upframework::BaseSerializer has pagination and meta data enabled
+class ProjectSerializer < Upframework::BaseSerializer
+  belongs_to :user
+
+  has_many :tasks
+
+  default_includes [:user]
+end
+```
+
 #### Searches
 ```ruby
 #app/searches
@@ -82,7 +96,7 @@ mount Upframework::Engine => /path
 routes being available
 ```
 GET /search
-POST /services/:service_name
+POST /{resource}/services/:service_name
 ```
 
 ## Installation

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

@@ -22,10 +22,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

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/serializers/upframework/base_serializer.rb

@@ -0,0 +1,56 @@
+module Upframework
+  class BaseSerializer
+    include JSONAPI::Serializer
+
+    attr_reader :resource, :current_controller
+
+    delegate :view_context, to: :current_controller
+
+    set_key_transform :camel_lower
+    attributes :created_at, :updated_at
+
+    def initialize(resource, current_controller: nil, **args)
+      @resource = resource
+      @current_controller = current_controller
+
+      if args[:format] == :minimal
+        args[:fields] = set_format
+      end
+
+      if @current_controller && resource.respond_to?(:total_pages)
+        args.merge!(pagination)
+      end
+
+      super(resource, **args)
+    end
+
+    def set_format
+      resource_klass   = resource.class.name
+      resource_klass   = resource.klass.name if resource_klass == 'ActiveRecord::Relation'
+      resource_klass   = resource.first.class.name if resource.kind_of?(Array)
+
+      { resource_klass.camelize(:lower) => [:id] }
+    end
+
+    def pagination
+      {
+        meta: {
+          per_page:    resource.size,
+          total_pages: resource.total_pages,
+        },
+        links: {
+          prev: view_context.path_to_prev_page(resource),
+          next: view_context.path_to_next_page(resource),
+        },
+      }.deep_transform_keys { |key| key.to_s.camelize(:lower).to_sym }
+    end
+
+    def self.default_includes(relations = [])
+      @relations ||= relations
+    end
+
+    class << self
+      delegate :url_helpers, to: :'Rails.application.routes'
+    end
+  end
+end

data/lib/upframework/version.rb

@@ -1,3 +1,3 @@
 module Upframework
-  VERSION = '0.2.4'
+  VERSION = '0.2.91'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upframework
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.91
 platform: ruby
 authors:
 - jude_cali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,19 +45,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: fast_jsonapi
+  name: jsonapi-serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 description: Rails framework extensions
 email:
 - jcalimbas@fullscale.io
@@ -82,6 +82,7 @@ files:
 - app/mailers/upframework/application_mailer.rb
 - app/models/upframework/application_record.rb
 - app/searches/upframework/base_search.rb
+- app/serializers/upframework/base_serializer.rb
 - app/services/concerns/upframework/service_endpoint.rb
 - app/services/upframework/base_service.rb
 - app/views/layouts/upframework/application.html.erb