standardapi 5.2.0.7 → 5.2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3957c161eeaacb9d65db690f90ed3f229b4a09518fe76a9b43e76b60118892c
-  data.tar.gz: 74be1b993b808bb6f91abdcf3da4558c65873ca4a4201d138bdbdc19808ae401
+  metadata.gz: cc7347ed6a4d47843612e12b7278e2cf6f75f44b96b64ef5677ed04cee4e2974
+  data.tar.gz: a9d2e82efbf35bc54d0b21dd94de196a931d72dc1f58c36c8578abff69433909
 SHA512:
-  metadata.gz: b54ce14e9c544ea3b2cc6cb555ea5c58da2ba920818e33c595d4c15ae03b6b0856c9755ff1f7e15b9d75e8518fb5c7fb90ab09dd77a7971d650c80bb8e703209
-  data.tar.gz: 53ec52f5704a7cb2fef62df2160c496799a6bfd6f47dba72f985cdf201f79a447606fa80c5966dcfc5a5993075cd90c02324575e5d4ae5f6c15b62e7d7e145c7
+  metadata.gz: 41c4ba5e6bcc543fa8a823a6c4422b6773735a57fe1d5be418f712617b1d695c0cd4e437afeedd33dd686cdbed295f3e10fb0d27da165600d99576a8c7e49de2
+  data.tar.gz: 349e1314c7bc7f3a3955eb88bc906749e2217ba9edd3903ea210f82f02ff9ce78afd2ee521f43381bb68b81b3d4ba1034b3ec3b35fc40c40d51e1625fbcd6204

data/README.md

@@ -35,7 +35,7 @@ In `config/application.rb:
       end
     end
 
-# Usage
+# Implementation
 
 StandardAPI is a module that can be included into any controller to expose a API
 for. Alternatly, it can be included into `ApplicationController`, giving all
@@ -102,12 +102,73 @@ Full Example:
 Note how includes can also support nested includes. So in this case when
 including the author, the photos that the author took can also be included.
 
-# Interface Specification
+# API Usage
+Resources can be queried via REST style end points
+```
+GET     /records/:id    fetch record
+PATCH   /records/:id    update record
+GET     /records        fetch records
+POST    /records        create record
+DELETE  /records        destroy record
+```
+
+All resource end points can be filtered, ordered, limited, offset, and have includes. All options are passed via query string in a nested URI encoded format.
+
+```javascript
+// Example
+params = {
+    limit: 5,
+    offset: 0,
+    where: {
+        region_ids: {
+            contains: newyork.id
+        }
+    },
+    include: {
+        property: {
+            addresses: true
+        },
+        photos: true
+    },
+    order: {
+        created_at: 'desc'
+    }
+}
+// should be
+'limit=5&offset=0&where%5Bregion_ids%5D%5Bcontains%5D=20106&include%5Bproperty%5D%5Baddresses%5D=true&include%5Bphotos%5D=true&order%5Bcreated_at%5D=desc'
+```
+### Include Options
+Preload some relationships and have it delivered with each record in the resource.
+
+### Where Options
+```
+id: 5               WHERE properties.id = 5
+id: [5, 10, 15]     WHERE properties.id IN (5, 10, 15)
+id: {gt: 5}         WHERE properties.id > 5
+id: {gte: 5}        WHERE properties.id >= 5
+id: {lt: 5}         WHERE properties.id < 5
+id: {lte: 5}        WHERE properties.id <= 5
+address_id: nil     WHERE properties.address_id IS NULL
+address_id: false   WHERE properties.address_id IS NULL..."
+address_id: true    WHERE properties.address_id IS NOT NULL..."
+
+// Array columns
+tags: 'Skyscraper'                          WHERE properties.tags = {"Skyscraper"}
+tags: ['Skyscraper', 'Brick']               WHERE properties.tags = '{"Skyscraper", "Brick"}'
+tags: {overlaps: ['Skyscraper', 'Brick']}   WHERE properties.tags && '{"Skyscraper", "Brick"}'
+tags: {contains: ['Skyscraper', 'Brick']}   WHERE accounts.tags @> '{"Skyscraper", "Brick"}'
+
+// Geospatial
+location: {within: 0106000020e6...}         WHERE ST_Within("listings"."location", ST_GeomFromEWKB(E'\\x0106000020e6...)
+
+// On Relationships
+property: {size: 10000}         JOIN properties WHERE properties.size = 10000"
+
+// 
+```
 
 # Testing
 
-##
-
 And example contoller and it's tests.
 
     class PhotosController < ApplicationController

data/lib/standard_api/controller.rb

@@ -10,7 +10,9 @@ module StandardAPI
     end
 
     def tables
-      controllers = ApplicationController.descendants# Dir[Rails.root.join('app/controllers/*_controller.rb')].map{ |path| path.match(/(\w+)_controller.rb/)[1].camelize+"Controller" }.map(&:safe_constantize)
+      Rails.application.eager_load! if Rails.env == 'development'.freeze
+      
+      controllers = ApplicationController.descendants
       controllers.select! { |c| c.ancestors.include?(self.class) && c != self.class }
       controllers.map!(&:model).compact!
       controllers.map!(&:table_name)

data/lib/standard_api/includes.rb

@@ -69,4 +69,4 @@ module StandardAPI
     end
 
   end
-end
+end

data/lib/standard_api/version.rb

@@ -1,3 +1,3 @@
 module StandardAPI
-  VERSION = '5.2.0.7'
+  VERSION = '5.2.0.8'
 end

data/lib/standard_api/views/application/index.json.jbuilder

@@ -1,12 +1,16 @@
+if !includes.empty?
+  instance_variable_set("@#{model.model_name.plural}", instance_variable_get("@#{model.model_name.plural}").preload(includes.keys))
+end
+
 if !includes.empty? && can_cache?(model, includes)
   partial = model_partial(model)
   record_name = partial.split('/').last.to_sym
-  locals = { record_name => nil, :includes => includes}
-  
-  json.cache_collection! instance_variable_get("@#{model.model_name.plural}"), key: proc {|record| cache_key(record, includes) } do |record|
+  locals = { record_name => nil, :includes => includes }
+
+  json.cache_collection! instance_variable_get("@#{model.model_name.plural}"), key: proc { |record| cache_key(record, includes) } do |record|
     locals[record_name] = record
     json.partial! partial, locals
   end
 else
   json.array! instance_variable_get("@#{model.model_name.plural}"), partial: model_partial(model), as: model_partial(model).split('/').last, includes: includes
-end
+end

data/lib/standard_api/views/application/index.streamer

@@ -1,7 +1,11 @@
+if !includes.empty?
+  instance_variable_set("@#{model.model_name.plural}", instance_variable_get("@#{model.model_name.plural}").preload(includes.keys))
+end
+
 if !includes.empty? && can_cache?(model, includes)
   partial = model_partial(model)
   record_name = partial.split('/').last.to_sym
-  locals = { record_name => nil, :includes => includes}
+  locals = { record_name => nil, :includes => includes }
   
   json.cache_collection! instance_variable_get("@#{model.model_name.plural}"), key: proc {|record| cache_key(record, includes) } do |record|
     locals[record_name] = record
@@ -9,4 +13,4 @@ if !includes.empty? && can_cache?(model, includes)
   end
 else
   json.array! instance_variable_get("@#{model.model_name.plural}"), partial: model_partial(model), as: model_partial(model).split('/').last, includes: includes
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standardapi
 version: !ruby/object:Gem::Version
-  version: 5.2.0.7
+  version: 5.2.0.8
 platform: ruby
 authors:
 - James Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-19 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -74,22 +74,22 @@ dependencies:
   name: activerecord-sort
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activerecord-filter
   requirement: !ruby/object:Gem::Requirement
@@ -323,8 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: StandardAPI makes it easy to expose a query interface for your Rails models