upframework 0.2.1 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5dc4e38225f1091ec9ededb3e0403156c9806a95e0b23c22c03169a030fda1b
-  data.tar.gz: 68be508da24fb695aea2029b0ac78cf0dfb5408ee3d8c3997fb67caf921a7698
+  metadata.gz: 56bea5267caba929195f4ff4692e20b9d82fa351fdb1817b3b104097e8e4f820
+  data.tar.gz: 9af1be007b1c7fa9555c58bb285f747f0a6130ba54185c2133a3d629a65fe3bd
 SHA512:
-  metadata.gz: dc9e6fc1fa2df5b5f710a755bf5814e787d06f16c5792fcefaa8339940bdd73dc50eb72e25ca73ee7a2710085ce2472c65f15be4b89dcef13fdce09b61db6aae
-  data.tar.gz: 43d03176e6695273b2216b214d5730f59de656b19dba481fd44e1eb2da78216397db2e9dfeeb032bcb07a729d0ffdd788420080cb0f8720d9de25132344a93c6
+  metadata.gz: 39c6363e11e759b624d708c43746b7c6bc932303cdd707a68dfab54df484794fb805db17a7beb2a09a48adc533d24be93c3afc50f850af2aadd19250c4a03cdb
+  data.tar.gz: f9fba79249385101c923241637c772a0e44b057223c71e30ae9af2ab9e9014601f7dd32c73f9fa5c8edf01a1c2dfbcb028fe3e1f68fc4028c4acb0140565f135

data/README.md

@@ -1,8 +1,89 @@
 # Upframework
-Short description and motivation.
+Add features on top of Rails, Especially for APIs. This was created to make structural code reusable to other projects (not solving the same problem all over again). And to make the main application less bloated and only contain domain specific code as much as possible.
 
-## Usage
-How to use my plugin.
+#### 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) 
+- 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
+```ruby
+# 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
+```
+
+#### 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
+```ruby
+#app/services
+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
+```ruby
+#config/routes
+mount Upframework::Engine => /path
+```
+routes being available
+```
+GET /search
+POST /services/:service_name
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/searches/upframework/base_search.rb

@@ -7,17 +7,24 @@ 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?
+  module ExecuteWrapper
+    def execute
+      super
+      paginate_scope
+    end
   end
+
+  include ExecuteWrapper
 end

data/lib/upframework/version.rb

@@ -1,3 +1,3 @@
 module Upframework
-  VERSION = '0.2.1'
+  VERSION = '0.2.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: upframework
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.7
 platform: ruby
 authors:
 - jude_cali
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails