dash_api 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41b4f85f96294e8f796ac017f3d52452c2dc13b963f6af9056d614ac5ee6ddb4
-  data.tar.gz: 0ceb837310db910dadd6c21937b9224832d5f498782ea9e964f68564f2d3cc28
+  metadata.gz: e3166c565503b2ccd94b3beb84b0aa75097de7cd746bcd62a29fca359b53b7d3
+  data.tar.gz: 14c183d50bbe19b1ca7082a542ee25a1190707e966a21ac85958139d800fb240
 SHA512:
-  metadata.gz: 3de8da8ec097ac9416550900b89b539c90bce4791925957bf0299df328faa58ccce6ec6dec7178b432c9ee850ea1f8e9a21024de28fe7727b04dc1133b2995c1
-  data.tar.gz: 1099ea57ccb8c4bc6e8770da6150f00b9459fac78d3a15fb8190f96147ae86b123e602be6c625e8f9ec145c766284142578e51c2997b4f3dd9f1fac09429ae77
+  metadata.gz: 9e8895ed01f5d98068301c2564a5528769929b65edd2ee7246647d4f5161b550185022814241d3e7613fe01a3b459e69045fbb9a699d31d435cd4e023e5f3b7e
+  data.tar.gz: 159f36163bd351307e91d4a11a3ad512d388445c495f4f65731326ba08021da67fd11a13327889509c3a65843c0afef9d7fc0e3372ca5c7b8d9ea6566053023c

data/README.md

@@ -14,6 +14,7 @@ DashAPI supports several features out of the box with little or no configuration
  - Sorting
  - Selects 
  - Associations
+ - Statistics 
  - Pagination
  - JWT token authorization
  - Firebase authorization
@@ -218,11 +219,40 @@ GET /dash/api/books?includes=reviews
 ```
 
 To combine associations together comma seperate the included tables:
-
 ```
 GET /dash/api/books?includes=author,reviews 
 ```
 
+### Statistics 
+
+You can perform calculations for the `minimum`, `maximum`, `average` or `count` of any field in a table. 
+You may also combine filters or other query parameters to refine results before performing the calculation. 
+
+Maxixum
+```
+max=<field>
+```
+
+Minimum
+```
+min=<field>
+```
+
+Average
+```
+avg=<field>
+```
+
+Count
+```
+count=<field>
+```
+
+Example: 
+```
+GET /dash/api/books?avg=ratings 
+```
+
 
 ### Create
 

data/app/controllers/dash_api/api_controller.rb

@@ -14,15 +14,21 @@ module DashApi
       @filters.each{|filter| resources = resources.where(filter) }            
       resources = resources.pg_search(@keywords) if @keywords.present?      
       resources = resources.order(@order) if @order.present?          
-      resources = resources.select(@select) if @select.present?      
-      resources = resources.page(@page).per(@per_page)
+      resources = resources.select(@select) if @select.present?    
+      
+      if @stats.present?
+        statistic, value = @stats.keys[0], @stats.values[0]&.to_sym
+        resources = resources.send(statistic, value)
+      else 
+        resources = resources.page(@page).per(@per_page)
+      end 
 
       render json: { 
-        data: DashApi::Serializer.to_json(resources, includes: @includes),
+        data: DashApi::Serializer.render(resources, includes: @includes),
         meta: {
           page: @page,
           per_page: @per_page,
-          total_count: resources.total_count
+          total_count: resources.respond_to?(:total_count) ? resources.total_count : 1
         }        
       }
     end 
@@ -31,7 +37,7 @@ module DashApi
       resource = dash_scope.find(params[:id])
       authorize resource, :show? 
       render json: { 
-        data: DashApi::Serializer.to_json(resource, includes: @includes) 
+        data: DashApi::Serializer.render(resource, includes: @includes) 
       }
     end 
 
@@ -39,7 +45,7 @@ module DashApi
       resource = dash_scope.create!(dash_params)
       authorize resource, :create? 
       render json: { 
-        data: DashApi::Serializer.to_json(resource) 
+        data: DashApi::Serializer.render(resource) 
       }    
     end 
 
@@ -48,7 +54,7 @@ module DashApi
       authorize resource, :update? 
       if resource.update(dash_params)
         render json: {           
-          data: DashApi::Serializer.to_json(resource)
+          data: DashApi::Serializer.render(resource)
         }
       else 
         render json: { error: resource.errors.full_messages }, status: 422
@@ -59,21 +65,21 @@ module DashApi
       resource = dash_scope.find(params[:id])
       authorize resource, :destroy? 
       resource.destroy 
-      render json: { data: DashApi::Serializer.to_json(resource) }    
+      render json: { data: DashApi::Serializer.render(resource) }    
     end 
 
     def update_many 
       resources = dash_scope.where(id: params[:ids])
       authorize resources, :update? 
       resources.update(dash_params)
-      render json: { data: DashApi::Serializer.to_json(resources) }
+      render json: { data: DashApi::Serializer.render(resources) }
     end 
 
     def delete_many       
       resources = dash_scope.where(id: params[:ids])
       authorize resources, :destroy? 
       resources.destroy_all
-      render json: { data: DashApi::Serializer.to_json(resources) }
+      render json: { data: DashApi::Serializer.render(resources) }
     end 
 
     private
@@ -85,8 +91,9 @@ module DashApi
       @per_page = query[:per_page]
       @order = query[:order]
       @filters = query[:filters]
+      @stats = query[:stats]
       @select = query[:select_fields]
-      @includes = query[:associations]
+      @includes = query[:associations]            
     end 
 
     def load_dash_table 

data/app/services/dash_api/query.rb

@@ -47,19 +47,38 @@
         end  
       end 
 
+      stats = nil
+      if params[:max]
+        stats = {maximum: params[:max]}
+      end 
+
+      if params[:min]
+        stats = {minimum: params[:min]}
+      end 
+
+      if params[:avg]
+        stats = {average: params[:avg]}
+      end 
+
+      if params[:count]
+        stats = {count: params[:count]}
+      end 
+
+
       page = params[:page]&.to_i || 1 
       per_page = params[:per_page]&.to_i || PER_PAGE 
 
       {
+        associations: associations,
+        filters: filters,
         keywords: keywords,
-        select_fields: select_fields,
         order: order,
-        sort_by: sort_by,
-        sort_direction: sort_direction,
-        filters: filters,
         page: page,
-        associations: associations,
-        per_page: per_page 
+        per_page: per_page, 
+        select_fields: select_fields,        
+        sort_by: sort_by,
+        sort_direction: sort_direction,        
+        stats: stats
       }
     end 
 

data/app/services/dash_api/serializer.rb

@@ -1,7 +1,7 @@
 module DashApi 
   module Serializer 
 
-    def self.to_json(current_scope, includes: nil)             
+    def self.render(current_scope, includes: nil)             
       opts = { except: DashApi.exclude_attributes }
       if includes
         include_hash = {}

data/lib/dash_api/version.rb

@@ -1,3 +1,3 @@
 module DashApi
-  VERSION = '0.0.24'
+  VERSION = '0.0.25'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dash_api
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
 platform: ruby
 authors:
 - Rami Bitar
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: REST API for your postgres database.