upframework 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5dc4e38225f1091ec9ededb3e0403156c9806a95e0b23c22c03169a030fda1b
-  data.tar.gz: 68be508da24fb695aea2029b0ac78cf0dfb5408ee3d8c3997fb67caf921a7698
+  metadata.gz: d88db49c9f1f7137b98b936cf13792218150eb0cb61c6278ff11fee45f9c8c05
+  data.tar.gz: 5263d90be331e0459b6f3e735052758a539b2a9466987765041df221b8cb572a
 SHA512:
-  metadata.gz: dc9e6fc1fa2df5b5f710a755bf5814e787d06f16c5792fcefaa8339940bdd73dc50eb72e25ca73ee7a2710085ce2472c65f15be4b89dcef13fdce09b61db6aae
-  data.tar.gz: 43d03176e6695273b2216b214d5730f59de656b19dba481fd44e1eb2da78216397db2e9dfeeb032bcb07a729d0ffdd788420080cb0f8720d9de25132344a93c6
+  metadata.gz: 801d5101e0aadd229c9c698dc43dd9850d896fb244274a388d3bcb5df3596a2d83ce3a08ab0645eb4d154d487bdfa8629d63332d4cbf17245c8b1aa1b8eed439
+  data.tar.gz: f21de820db493c15daea315e7fff83439ec5c286da810b22860e6b981e45417c45ea08c201cccc53fb45ac319212c652f6ce77c02ee0bfa1601a58b0fa974d63

data/README.md

@@ -1,8 +1,42 @@
 # 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
+class ProjectsController < Upframework::ResourcesController
+end
+```
+
+####Searches
+```ruby
+#app/searches
+class ProjectSearch < Upframework::BaseSearch
+end
+```
+
+####Services
+```ruby
+#app/services
+class  Project::SubmitService < Upframework::BaseService
+end
+```
+
+####Routes
+app/services
+```ruby
+#config/routes
+mount Upframework::Engine => /path
+```
 
 ## Installation
 Add this line to your application's Gemfile:

data/app/searches/upframework/base_search.rb

@@ -20,4 +20,13 @@ class Upframework::BaseSearch < Upframework::BaseService
   def present_value?(field)
     instance_variable_get("@#{field}").present?
   end
+
+  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.2'
 end

metadata

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