upframework 0.2.2 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d88db49c9f1f7137b98b936cf13792218150eb0cb61c6278ff11fee45f9c8c05
-  data.tar.gz: 5263d90be331e0459b6f3e735052758a539b2a9466987765041df221b8cb572a
+  metadata.gz: 65b7cd4203031fe204ae2db4b2e9f15234f70b9f8319c0b0eb0479a93b8d775d
+  data.tar.gz: bab9c34c224ae19444350453b103a6658bba142351ef54a516d602b34f869ca5
 SHA512:
-  metadata.gz: 801d5101e0aadd229c9c698dc43dd9850d896fb244274a388d3bcb5df3596a2d83ce3a08ab0645eb4d154d487bdfa8629d63332d4cbf17245c8b1aa1b8eed439
-  data.tar.gz: f21de820db493c15daea315e7fff83439ec5c286da810b22860e6b981e45417c45ea08c201cccc53fb45ac319212c652f6ce77c02ee0bfa1601a58b0fa974d63
+  metadata.gz: 98e0d8b2a6405ccd13098554c6c219b9b1f3bc551c9d321f4378a71bb39cbd468a34260818b2f0a14abeba83060a9692fdf86163fbf8d92d2121b836ea67efcd
+  data.tar.gz: 93d0add617417cfd7fe6052d6557525fc22626069032a37677e9b9d5ba43257828694ad35edca4eec0f676e75f8ec510ffc876c2aa9cd208442dbf48dc12492e

data/README.md

@@ -4,39 +4,100 @@ Add features on top of Rails, Especially for APIs. This was created to make stru
 #### The following features are available.
 - Creates (create, read, update, destroy) action methods for resources.
 - Has render helpers for API or socket responses. ex. Converting models to its designated serializer.
-- Converts snake case request params (from js standard) to underscore params (ruby standard)
+- Converts snake case request params (from js standard) to underscore params (ruby standard) 
 - Searches layer under app/searches. Usually used for form searches.
 - Services layer under app/services. For single responsibility domain-specific logic code.
 - Exception notifier and API error response handler.
 
 ##  Basic Usage
-####Controllers
+#### Controllers
 ```ruby
-#app/controllers
+# app/controllers
+# create,show,update,destroy methods are available by default
 class ProjectsController < Upframework::ResourcesController
+  # Example of broadcasting with a serialized object using ActionCables.
+  def udate
+    super do
+      channel = @project.user
+      broadcast_serialized(channel, resource: @project, event: "Project Updated")
+    end
+  end
+
+  # Example of rendering serialized responsed. This is using fast_jsonapi serializer.
+  def custom_action
+    render_serialized @project
+  end
+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
+#### Searches
 ```ruby
 #app/searches
 class ProjectSearch < Upframework::BaseSearch
+  def post_initialize
+    @per_page = 10
+    @scope = Project.accessible_by(@current_ability)
+  end
+
+  def execute
+    # query logic here using scope object defined above
+    # by default results are paginated
+  end
 end
 ```
+```
+#search api available in
+/search?resource=Project&arg1=""&arg2=""
+```
 
-####Services
+#### Services
 ```ruby
 #app/services
-class  Project::SubmitService < Upframework::BaseService
+class Project::SubmitService < Upframework::BaseService
+  def post_initialize(id:, **attrs)
+    @project = Project.find(id)
+  end
+
+  def execute
+    # put main logic here
+    # ...
+    project.save
+  end
+
+  def result
+    project
+  end
 end
+
+service = Project::SubmitService.run
+service.result => <Project: Instance>
+service.success? => true/false
 ```
 
-####Routes
-app/services
+#### Routes
 ```ruby
 #config/routes
 mount Upframework::Engine => /path
 ```
+routes being available
+```
+GET /search
+POST /{resource}/services/:service_name
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/searches/upframework/base_search.rb

@@ -7,20 +7,18 @@ class Upframework::BaseSearch < Upframework::BaseService
   end
 
   def query(field)
-    @model_scope = yield if present_value?(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
 
-  def present_value?(field)
-    instance_variable_get("@#{field}").present?
-  end
-
   module ExecuteWrapper
     def execute
       super

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

metadata

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