upframework 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1acaf495ed6f2835c25eae1905515573ee647802879f43212ad934f6f3a4a3fb
-  data.tar.gz: 670163801f3ead631d142ef5840970833f48c069ba055ed19369a8a9e08fecc7
+  metadata.gz: 3b9df2b3fab51ad8cd9df13ce48c23de3f7de3345a732950f1133de10468443b
+  data.tar.gz: e964a3112339f87964455696b87788e9fca05f75be7fbda0edc4a22a772b667d
 SHA512:
-  metadata.gz: e6c44c39aae828c7b62cf450d47fe2d61200cc2e2e48af25c80abd6d3f631c060518b7fc15a64d912a2e3c386487a3f1b32edc6cef5bd808e22e443d5f7c863c
-  data.tar.gz: fa64458e28228ee45cac5d922ab848962dc313f8fb6481ffeecc1bd2d549512a73a96c6946922c65ffd57ddab6b43ab86db90120fe79440376fd3d0995f32d3e
+  metadata.gz: 3dccc34d6735c68b9bc5ab6e0feb4084bb33ec67df5627a20e8bb6b5e4668795dbc063e399bddf03895168a51b28235b0e7b879f1ae882b4989a7f9a4a670c00
+  data.tar.gz: 0be54b8cad4e95f88314aa60f8ecf9e02f0482fa97f1e202edb4b96a9321beeb16c8b107f0d3245958a85f1965bd8a9944302e98733c505baecc2e9353068f95

data/README.md

@@ -4,39 +4,86 @@ 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
 ```
 
-####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 /services/:service_name
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/lib/upframework/version.rb

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

metadata

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