upframework 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56bea5267caba929195f4ff4692e20b9d82fa351fdb1817b3b104097e8e4f820
-  data.tar.gz: 9af1be007b1c7fa9555c58bb285f747f0a6130ba54185c2133a3d629a65fe3bd
+  metadata.gz: 65b7cd4203031fe204ae2db4b2e9f15234f70b9f8319c0b0eb0479a93b8d775d
+  data.tar.gz: bab9c34c224ae19444350453b103a6658bba142351ef54a516d602b34f869ca5
 SHA512:
-  metadata.gz: 39c6363e11e759b624d708c43746b7c6bc932303cdd707a68dfab54df484794fb805db17a7beb2a09a48adc533d24be93c3afc50f850af2aadd19250c4a03cdb
-  data.tar.gz: f9fba79249385101c923241637c772a0e44b057223c71e30ae9af2ab9e9014601f7dd32c73f9fa5c8edf01a1c2dfbcb028fe3e1f68fc4028c4acb0140565f135
+  metadata.gz: 98e0d8b2a6405ccd13098554c6c219b9b1f3bc551c9d321f4378a71bb39cbd468a34260818b2f0a14abeba83060a9692fdf86163fbf8d92d2121b836ea67efcd
+  data.tar.gz: 93d0add617417cfd7fe6052d6557525fc22626069032a37677e9b9d5ba43257828694ad35edca4eec0f676e75f8ec510ffc876c2aa9cd208442dbf48dc12492e

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/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.7'
+  VERSION = '0.2.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upframework
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - jude_cali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-30 00:00:00.000000000 Z
+date: 2020-07-02 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