standardapi 6.0.0.24 → 6.0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5c4c41da6b869e919e53b048048c8b3c69aae01c1ce04ec3ebddf03d7e6217a
-  data.tar.gz: df1ab4c4111e74959f85cc0ba5a79cd580d419d97a90adcfb08dac70335fd74c
+  metadata.gz: bf7ed75a06eda9f024ebd87caccab44573802435d0494944137d92da6403fca2
+  data.tar.gz: f44ad9cdd0d8bb87bc971f0b11b8f50b5f5f1289911d7bf4764f6f867b59b407
 SHA512:
-  metadata.gz: a035e59b5e886a620d9ccb95d316ca436a72c5b9ac4fb59b7cd85e4d484931d33c349a162ba0bd79bc6f09169ec8bb842902b984b356d83a9844f696dd643fde
-  data.tar.gz: 5e0e1df8b36ab9bfa6ef7c2043b32c36cc6df9e4b1b772e8b848034a18cadafddaaa9b561e54aad4d2c2e46512c6a1f0cd0b0b8ff8a52e2b2b4c82acc2d51bb1
+  metadata.gz: 2f0f4ba53a851f87467a584b0a37708a1d2c6a52fc3360c31fbd50462af17918b7c43b435001410984291db24a451940e97487fc549f993d35ecc63d832d3b20
+  data.tar.gz: 26d70be42fd115039c04a4a0ba614225c05a549af0847d3473659c9d593002cd11addcfd330000163eb9d1597843c274593ba99ddd6f9a57ee39b83e8a05fcbb

data/README.md

@@ -105,11 +105,12 @@ including the author, the photos that the author took can also be included.
 # 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
+GET     /records/:id        fetch record
+PATCH   /records/:id        update record
+GET     /records/           fetch records
+GET     /records/calculate  apply count and other functions on record(s)
+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.
@@ -163,8 +164,16 @@ location: {within: 0106000020e6...}         WHERE ST_Within("listings"."location
 
 // On Relationships
 property: {size: 10000}         JOIN properties WHERE properties.size = 10000"
+```
+## Calculations
+
+The only change on calculate routes is the `selects` paramater contains the functions to apply. Currently just `minimum`, `maximum`, `average`, `sum`, and `count`.
 
-// 
+```
+{ count: '*' }                                          SELECT COUNT(*)
+[{ count: '*' }]                                        SELECT COUNT(*)
+[{ count: '*', maximum: :id, minimum: :id }]            SELECT COUNT(*), MAXIMUM(id), MINIMUM(id)
+[{ maximum: :id }, { maximum: :count }]                 SELECT MAXIMUM(id), MAXIMUM(count)
 ```
 
 # Testing

data/lib/standard_api.rb

@@ -14,4 +14,5 @@ require 'standard_api/includes'
 require 'standard_api/controller'
 require 'standard_api/helpers'
 require 'standard_api/route_helpers'
+require 'standard_api/active_record/connection_adapters/postgresql/schema_statements'
 require 'standard_api/railtie'

data/lib/standard_api/active_record/connection_adapters/postgresql/schema_statements.rb

@@ -0,0 +1,21 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter < AbstractAdapter
+
+      # Returns a comment stored in database for given table
+      def database_comment(database_name=nil) # :nodoc:
+        database_name ||= current_database
+
+        scope = quoted_scope(database_name, type: "BASE TABLE")
+        if scope[:name]
+          query_value(<<~SQL, "SCHEMA")
+            SELECT pg_catalog.shobj_description(d.oid, 'pg_database')
+            FROM   pg_catalog.pg_database d
+            WHERE  datname = #{scope[:name]};
+          SQL
+        end
+      end
+
+    end
+  end
+end

data/lib/standard_api/controller.rb

@@ -1,23 +1,32 @@
 module StandardAPI
   module Controller
 
+    delegate :preloadables, to: :helpers
+
     def self.included(klass)
-      klass.helper_method :includes, :orders, :model, :resource_limit,
-        :default_limit, :preloadables
+      klass.helper_method :includes, :orders, :model, :models, :resource_limit,
+        :default_limit
       klass.before_action :set_standardapi_headers
+      klass.rescue_from StandardAPI::ParameterMissing, with: :bad_request
       klass.rescue_from StandardAPI::UnpermittedParameters, with: :bad_request
       klass.append_view_path(File.join(File.dirname(__FILE__), 'views'))
       klass.extend(ClassMethods)
     end
 
     def tables
-      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)
-      render json: controllers
+      Rails.application.eager_load! if !Rails.application.config.eager_load
+
+      tables = ApplicationController.descendants
+      tables.select! { |c| c.ancestors.include?(self.class) && c != self.class }
+      tables.map!(&:model).compact!
+      tables.map!(&:table_name)
+      render json: tables
+    end
+
+    if Rails.env == 'development'
+      def schema
+        Rails.application.eager_load! if !Rails.application.config.eager_load
+      end
     end
 
     def index
@@ -34,7 +43,7 @@ module StandardAPI
         end
       end
       @calculations = Hash[@calculations] if @calculations[0].is_a?(Array) && params[:group_by]
-      
+
       render json: @calculations
     end
 
@@ -95,12 +104,12 @@ module StandardAPI
       resources.find(params[:id]).destroy!
       head :no_content
     end
-    
+
     def remove_resource
       resource = resources.find(params[:id])
       subresource_class = resource.association(params[:relationship]).klass
       subresource = subresource_class.find_by_id(params[:resource_id])
-      
+
       if(subresource)
         result = resource.send(params[:relationship]).delete(subresource)
         head result ? :no_content : :bad_request
@@ -108,10 +117,10 @@ module StandardAPI
         head :not_found
       end
     end
-    
+
     def add_resource
       resource = resources.find(params[:id])
-      
+
       subresource_class = resource.association(params[:relationship]).klass
       subresource = subresource_class.find_by_id(params[:resource_id])
       if(subresource)
@@ -120,7 +129,7 @@ module StandardAPI
       else
         head :not_found
       end
-      
+
     end
 
     # Override if you want to support masking
@@ -129,7 +138,7 @@ module StandardAPI
     end
 
     module ClassMethods
-    
+
       def model
         return @model if defined?(@model)
         @model = name.sub(/Controller\z/, '').singularize.camelize.safe_constantize
@@ -151,6 +160,15 @@ module StandardAPI
       self.class.model
     end
 
+    def models
+      return @models if defined?(@models)
+      Rails.application.eager_load! if !Rails.application.config.eager_load
+
+      @models = ApplicationController.descendants
+      @models.select! { |c| c.ancestors.include?(self.class) && c != self.class }
+      @models.map!(&:model).compact!
+    end
+
     def model_includes
       if self.respond_to?("#{model.model_name.singular}_includes", true)
         self.send("#{model.model_name.singular}_includes")
@@ -190,81 +208,39 @@ module StandardAPI
 
     def resources
       query = model.filter(params['where']).filter(current_mask[model.table_name])
-      
+
       if params[:distinct_on]
         query = query.distinct_on(params[:distinct_on])
       elsif params[:distinct]
         query = query.distinct
       end
-      
+
       if params[:join]
         query = query.joins(params[:join].to_sym)
       end
-      
+
       if params[:group_by]
         query = query.group(params[:group_by])
       end
-      
+
       query
     end
 
     def includes
       @includes ||= StandardAPI::Includes.sanitize(params[:include], model_includes)
     end
-    
-    def preloadables(record, includes)
-      preloads = {}
-      
-      includes.each do |key, value|
-        if reflection = record.klass.reflections[key]
-          case value
-          when true
-            preloads[key] = value
-          when Hash, ActiveSupport::HashWithIndifferentAccess
-            if !value.keys.any? { |x| ['when', 'where', 'limit', 'offset', 'order', 'distinct'].include?(x) }
-              if !reflection.polymorphic?
-                preloads[key] = preloadables_hash(reflection.klass, value)
-              end
-            end
-          end
-        end
-      end
-      
-      preloads.empty? ? record : record.preload(preloads)
-    end
-
-    def preloadables_hash(klass, iclds)
-      preloads = {}
-
-      iclds.each do |key, value|
-        if reflection = klass.reflections[key] 
-          case value
-          when true
-            preloads[key] = value
-          when Hash, ActiveSupport::HashWithIndifferentAccess
-            if !value.keys.any? { |x| ['when', 'where', 'limit', 'offset', 'order', 'distinct'].include?(x) }
-              if !reflection.polymorphic?
-                preloads[key] = preloadables_hash(reflection.klass, value)
-              end
-            end
-          end
-        end
-      end
-  
-      preloads
-    end
-    
+
     def required_orders
       []
     end
-    
+
     def default_orders
       nil
     end
 
     def orders
       exluded_required_orders = required_orders.map(&:to_s)
-      
+
       case params[:order]
       when Hash, ActionController::Parameters
         exluded_required_orders -= params[:order].keys.map(&:to_s)
@@ -280,7 +256,7 @@ module StandardAPI
       when String
         exluded_required_orders.delete(params[:order])
       end
-      
+
       if !exluded_required_orders.empty?
         params[:order] = exluded_required_orders.unshift(params[:order])
       end
@@ -309,9 +285,9 @@ module StandardAPI
         limit = params.permit(:limit)[:limit]&.to_i || default_limit
 
         if !limit
-          raise ActionController::ParameterMissing.new(:limit)
+          raise StandardAPI::ParameterMissing.new(:limit)
         elsif limit > resource_limit
-          raise ActionController::UnpermittedParameters.new([:limit, limit])
+          raise StandardAPI::UnpermittedParameters.new([:limit, limit])
         end
 
         limit
@@ -338,7 +314,7 @@ module StandardAPI
             @model = parts[0].singularize.camelize.constantize
             column = parts[1]
           end
-          
+
           column = column == '*' ? Arel.star : column.to_sym
           if functions.include?(func.to_s.downcase)
             node = (defined?(@model) ? @model : model).arel_table[column].send(func)

data/lib/standard_api/errors.rb

@@ -2,6 +2,15 @@ module StandardAPI
   class StandardAPIError < StandardError
   end
 
+  class ParameterMissing < StandardAPIError
+    attr_reader :param
+
+    def initialize(param)
+      @param = param
+      super("param is missing or the value is empty: #{param}")
+    end
+  end
+
   class UnpermittedParameters < StandardAPIError
     attr_reader :params
 

data/lib/standard_api/helpers.rb

@@ -1,6 +1,58 @@
 module StandardAPI
   module Helpers
-    
+
+    def preloadables(record, includes)
+      preloads = {}
+
+      includes.each do |key, value|
+        if reflection = record.klass.reflections[key]
+          case value
+          when true
+            preloads[key] = value
+          when Hash, ActiveSupport::HashWithIndifferentAccess
+            if !value.keys.any? { |x| ['when', 'where', 'limit', 'offset', 'order', 'distinct'].include?(x) }
+              if !reflection.polymorphic?
+                preloads[key] = preloadables_hash(reflection.klass, value)
+              end
+            end
+          end
+        end
+      end
+
+      preloads.empty? ? record : record.preload(preloads)
+    end
+
+    def preloadables_hash(klass, iclds)
+      preloads = {}
+
+      iclds.each do |key, value|
+        if reflection = klass.reflections[key]
+          case value
+          when true
+            preloads[key] = value
+          when Hash, ActiveSupport::HashWithIndifferentAccess
+            if !value.keys.any? { |x| ['when', 'where', 'limit', 'offset', 'order', 'distinct'].include?(x) }
+              if !reflection.polymorphic?
+                preloads[key] = preloadables_hash(reflection.klass, value)
+              end
+            end
+          end
+        end
+      end
+
+      preloads
+    end
+
+    def schema_partial(model)
+      path = model.model_name.plural
+
+      if lookup_context.exists?("schema", path, true)
+        [path, "schema"].join('/')
+      else
+        'application/schema'
+      end
+    end
+
     def model_partial(record)
       if lookup_context.exists?(record.model_name.element, record.model_name.plural, true)
         [record.model_name.plural, record.model_name.element].join('/')
@@ -17,7 +69,7 @@ module StandardAPI
         false
       end
     end
-    
+
     def cache_key(record, includes)
       timestamp_keys = ['cached_at'] + record.class.column_names.select{|x| x.ends_with? "_cached_at"}
       if includes.empty?
@@ -27,7 +79,7 @@ module StandardAPI
         "#{record.model_name.cache_key}/#{record.id}-#{digest_hash(sort_hash(includes))}-#{timestamp.utc.to_s(record.cache_timestamp_format)}"
       end
     end
-    
+
     def can_cache_relation?(klass, relation, subincludes)
       cache_columns = ["#{relation}_cached_at"] + cached_at_columns_for_includes(subincludes).map {|c| "#{relation}_#{c}"}
       if (cache_columns - klass.column_names).empty?
@@ -36,12 +88,12 @@ module StandardAPI
         false
       end
     end
-    
+
     def association_cache_key(record, relation, subincludes)
       timestamp = ["#{relation}_cached_at"] + cached_at_columns_for_includes(subincludes).map {|c| "#{relation}_#{c}"}
       timestamp.map! { |col| record.send(col) }
       timestamp = timestamp.max
-      
+
       case association = record.class.reflect_on_association(relation)
       when ActiveRecord::Reflection::HasManyReflection, ActiveRecord::Reflection::HasAndBelongsToManyReflection, ActiveRecord::Reflection::HasOneReflection, ActiveRecord::Reflection::ThroughReflection
         "#{record.model_name.cache_key}/#{record.id}/#{includes_to_cache_key(relation, subincludes)}-#{timestamp.utc.to_s(record.cache_timestamp_format)}"
@@ -56,13 +108,13 @@ module StandardAPI
         raise ArgumentError, 'Unkown association type'
       end
     end
-    
+
     def cached_at_columns_for_includes(includes)
       includes.select { |k,v| !['when', 'where', 'limit', 'order', 'distinct', 'distinct_on'].include?(k) }.map do |k, v|
         ["#{k}_cached_at"] + cached_at_columns_for_includes(v).map { |v2| "#{k}_#{v2}" }
       end.flatten
     end
-    
+
     def includes_to_cache_key(relation, subincludes)
       if subincludes.empty?
         relation.to_s
@@ -70,7 +122,7 @@ module StandardAPI
         "#{relation}-#{digest_hash(sort_hash(subincludes))}"
       end
     end
-    
+
     def sort_hash(hash)
       hash.keys.sort.reduce({}) do |seed, key|
         if seed[key].is_a?(Hash)
@@ -81,7 +133,7 @@ module StandardAPI
         seed
       end
     end
-    
+
     def digest_hash(*hashes)
       hashes.compact!
       hashes.map! { |h| sort_hash(h) }
@@ -141,4 +193,4 @@ module StandardAPI
     end
 
   end
-end
+end

data/lib/standard_api/test_case.rb

@@ -18,7 +18,7 @@ module StandardAPI::TestCase
       assert_equal(expected, *args)
     end
   end
-      
+
   def self.included(klass)
     [:filters, :orders, :includes].each do |attribute|
       klass.send(:class_attribute, attribute)
@@ -53,14 +53,14 @@ module StandardAPI::TestCase
     end
   end
 
-  def supports_format(format)
+  def supports_format(format, action=nil)
     count = controller_class.view_paths.count do |path|
-      !Dir.glob("#{path.instance_variable_get(:@path)}/{#{model.name.underscore},application}/**/*.#{format}*").empty?
+      !Dir.glob("#{path.instance_variable_get(:@path)}/{#{model.name.underscore},application}/**/#{action || '*'}.#{format}*").empty?
     end
-    
+
     count > 0
   end
-  
+
   def default_orders
     controller_class.new.send(:default_orders)
   end
@@ -76,7 +76,7 @@ module StandardAPI::TestCase
   def model
     self.class.model
   end
-  
+
   def mask
     {}
   end
@@ -98,11 +98,11 @@ module StandardAPI::TestCase
   def singular_name
     model.model_name.singular
   end
-  
+
   def plural_name
     model.model_name.plural
   end
-    
+
   def create_webmocks(attributes)
     attributes.each do |attribute, value|
       self.class.model.validators_on(attribute)
@@ -122,7 +122,7 @@ module StandardAPI::TestCase
       value
     end
   end
-    
+
   def normalize_to_json(record, attribute, value)
     value = normalize_attribute(record, attribute, value)
     return nil if value.nil?
@@ -149,7 +149,7 @@ module StandardAPI::TestCase
 
     def controller_class
       controller_class_name = self.name.gsub(/Test$/, '')
-      controller_class_name.constantize 
+      controller_class_name.constantize
     rescue NameError => e
       raise e if e.message != "uninitialized constant #{controller_class_name}"
     end
@@ -166,7 +166,7 @@ module StandardAPI::TestCase
       return @model if defined?(@model) && @model
 
       klass_name = controller_class.name.gsub(/Controller$/, '').singularize
-        
+
       begin
         @model = klass_name.constantize
       rescue NameError

data/lib/standard_api/test_case/calculate_tests.rb

@@ -12,7 +12,7 @@ module StandardAPI
         create_model
 
         math_column = model.columns.find { |x| CALCULATE_COLUMN_TYPES.include?(x.sql_type) }
-        
+
         if math_column
           column = math_column
           selects = [{ count: column.name }, { maximum: column.name }, { minimum: column.name }, { average: column.name }]
@@ -35,7 +35,7 @@ module StandardAPI
         create_model
 
         math_column = model.columns.find { |x| CALCULATE_COLUMN_TYPES.include?(x.sql_type) }
-        
+
         if math_column
           column = math_column
           selects = [{ count: column.name}, { maximum: column.name }, { minimum: column.name }, { average: column.name }]

data/lib/standard_api/test_case/create_tests.rb

@@ -85,15 +85,15 @@ module StandardAPI
       end
 
       test '#create.html' do
-        return unless supports_format(:html)
+        return unless supports_format(:html, :create)
+
+        attrs = attributes_for(singular_name, :nested).select do |k,v|
+          !model.readonly_attributes.include?(k.to_s)
+        end
 
-        attrs = attributes_for(singular_name, :nested).select{ |k,v| !model.readonly_attributes.include?(k.to_s) }
         mask.each { |k, v| attrs[k] = v }
         create_webmocks(attrs)
 
-        file_upload = attrs.any? { |k, v| v.is_a?(Rack::Test::UploadedFile) }
-        as = file_upload ? nil : :json
-
         assert_difference("#{model.name}.count") do
           post resource_path(:create), params: { singular_name => attrs }, as: :html
           assert_response :redirect
@@ -101,7 +101,7 @@ module StandardAPI
       end
 
       test '#create.html with invalid attributes renders edit action' do
-        return unless supports_format(:html)
+        return unless supports_format(:html, :create)
 
         trait = FactoryBot.factories[singular_name].definition.defined_traits.any? { |x| x.name.to_s == 'invalid' }
 

data/lib/standard_api/test_case/index_tests.rb

@@ -37,10 +37,10 @@ module StandardAPI
 
       test '#index.json params[:limit] does not exceed maximum limit' do
         return if !resource_limit || resource_limit == Float::INFINITY
-        
-        assert_raises ActionController::UnpermittedParameters do
-          get resource_path(:index, format: :json), params: { limit: resource_limit + 1 }
-        end
+
+        get resource_path(:index, format: :json), params: { limit: resource_limit + 1 }
+        assert_response :bad_request
+        assert_equal 'found unpermitted parameters: :limit, 1001', response.body
       end
 
       test '#index.json params[:where]' do

data/lib/standard_api/test_case/schema_tests.rb

@@ -9,13 +9,29 @@ module StandardAPI
         get resource_path(:schema, format: :json)
         assert_response :ok
         json = JSON(@response.body)
-        assert json['columns']
+        assert json['attributes']
+
         model.columns.map do |column|
-          assert json['columns'][column.name]['type'], "Missing `type` for \"#{model}\" attribute \"#{column.name}\""
+          actual_column = json['attributes'][column.name]
+          assert_not_nil actual_column['type'], "Missing `type` for \"#{model}\" attribute \"#{column.name}\""
+          assert_equal_or_nil model.primary_key == column.name, actual_column['primary_key']
+          assert_equal_or_nil column.null, actual_column['null']
+          assert_equal_or_nil column.array, actual_column['array']
+          assert_equal_or_nil column.comment, actual_column['comment']
+          assert_equal_or_nil (column.default || column.default_function), actual_column['default']
         end
+
         assert json['limit']
+        assert_equal_or_nil model.connection.table_comment(model.table_name), json['comment']
       end
 
+      def assert_equal_or_nil(expected, actual, msg=nil)
+        if expected.nil?
+          assert_nil actual, msg
+        else
+          assert_equal expected, actual, msg
+        end
+      end
     end
   end
-end
+end

data/lib/standard_api/version.rb

@@ -1,3 +1,3 @@
 module StandardAPI
-  VERSION = '6.0.0.24'
+  VERSION = '6.0.0.30'
 end

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

@@ -0,0 +1,68 @@
+if model.nil? && controller_name == "application"
+  routes = Rails.application.routes.routes.reject(&:internal).collect do |route|
+    { name: route.name,
+      verb: route.verb,
+      path: route.path.spec.to_s.gsub(/\(\.format\)\Z/, ''),
+      controller: route.requirements[:controller],
+      action: route.requirements[:action],
+      array: ['index'].include?(route.requirements[:action]) }
+  end
+
+  json.set! 'comment', ActiveRecord::Base.connection.database_comment
+
+  json.set! 'routes' do
+    json.array!(routes) do |route|
+      controller = if controller_name = route[:controller]
+        begin
+          controller_param = controller_name.underscore
+          const_name = "#{controller_param.camelize}Controller"
+          const = ActiveSupport::Dependencies.constantize(const_name)
+          if const.ancestors.include?(StandardAPI::Controller)
+            const
+          else
+            nil
+          end
+        rescue NameError
+        end
+      end
+
+      next if controller.nil?
+
+      resource_limit = controller.resource_limit if controller.respond_to?(:resource_limit)
+
+      json.set! 'path', route[:path]
+      json.set! 'method', route[:verb]
+      json.set! 'model', controller.model&.name
+      json.set! 'array', route[:array]
+      json.set! 'limit', resource_limit
+    end
+  end
+
+  json.set! 'models' do
+    models.each do |model|
+      json.set! model.name do
+        json.partial! partial: schema_partial(model), model: model
+      end
+    end
+  end
+
+else
+
+  json.set! 'attributes' do
+    model.columns.each do |column|
+      json.set! column.name, {
+        type: json_column_type(column.sql_type),
+        default: column.default || column.default_function,
+        primary_key: column.name == model.primary_key,
+        null: column.null,
+        array: column.array,
+        comment: column.comment
+      }
+    end
+  end
+
+  json.set! 'limit', resource_limit # This should be removed?
+  json.set! 'comment', model.connection.table_comment(model.table_name)
+
+end
+

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

@@ -0,0 +1,78 @@
+if model.nil? && controller_name == "application"
+  routes = Rails.application.routes.routes.reject(&:internal).collect do |route|
+    { name: route.name,
+      verb: route.verb,
+      path: route.path.spec.to_s.gsub(/\(\.:format\)\Z/, ''),
+      controller: route.requirements[:controller],
+      action: route.requirements[:action],
+      array: ['index'].include?(route.requirements[:action]) }
+  end
+
+  json.object! do
+    json.set! 'comment', ActiveRecord::Base.connection.database_comment
+
+    json.set! 'routes' do
+      json.array!(routes) do |route|
+        controller = if controller_name = route[:controller]
+          begin
+            controller_param = controller_name.underscore
+            const_name = "#{controller_param.camelize}Controller"
+            const = ActiveSupport::Dependencies.constantize(const_name)
+            if const.ancestors.include?(StandardAPI::Controller)
+              const
+            else
+              nil
+            end
+          rescue NameError
+          end
+        end
+
+        next if controller.nil?
+
+        resource_limit = controller.resource_limit if controller.respond_to?(:resource_limit)
+
+        json.object! do
+          json.set! 'path', route[:path]
+          json.set! 'method', route[:verb]
+          json.set! 'model', controller.model&.name
+          json.set! 'array', route[:array]
+          json.set! 'limit', resource_limit
+        end
+      end
+    end
+
+
+    json.set! 'models' do
+      json.object! do
+        models.each do |model|
+          json.set! model.name do
+            json.partial!(schema_partial(model), model: model)
+          end
+        end
+      end
+    end
+
+  end
+else
+
+  json.object! do
+    json.set! 'attributes' do
+      json.object! do
+        model.columns.each do |column|
+          json.set! column.name, {
+            type: json_column_type(column.sql_type),
+            default: column.default || column.default_function,
+            primary_key: column.name == model.primary_key,
+            null: column.null,
+            array: column.array,
+            comment: column.comment
+          }
+        end
+      end
+    end
+
+    json.set! 'limit', resource_limit
+    json.set! 'comment', model.connection.table_comment(model.table_name)
+  end
+
+end

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

@@ -1,12 +1 @@
-json.set! 'columns' do
-  model.columns.each do |column|
-    json.set! column.name, {
-      type: json_column_type(column.sql_type),
-      primary_key: column.name == model.primary_key,
-      null: column.null,
-      array: column.array
-    }
-  end
-end
-
-json.set! 'limit', resource_limit
+json.partial!('schema', model: model)

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

@@ -1,16 +1 @@
-json.object! do
-  json.set! 'columns' do
-    json.object! do
-      model.columns.each do |column|
-        json.set! column.name, {
-          type: json_column_type(column.sql_type),
-          primary_key: column.name == model.primary_key,
-          null: column.null,
-          array: column.array
-        }
-      end
-    end
-  end
-
-  json.set! 'limit', resource_limit
-end
+json.partial!('schema', model: model)

data/test/standard_api/test_app.rb

@@ -0,0 +1,55 @@
+require "rails"
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "rails/test_unit/railtie"
+Bundler.require(*Rails.groups)
+
+require 'standard_api'
+
+# Test Application Config
+Rails.env = 'test'
+
+class TestApplication < Rails::Application
+  config.root = File.join(File.dirname(__FILE__), 'test_app')
+  config.secret_key_base = 'test key base'
+  config.eager_load = true
+  config.cache_classes = true
+  config.action_controller.perform_caching = true
+  config.cache_store = :memory_store, { size: 8.megabytes }
+  config.action_dispatch.show_exceptions = false
+
+  # if defined?(FactoryBotRails)
+  #   config.factory_bot.definition_file_paths += [ '../factories' ]
+  # end
+end
+
+# Test Application initialization
+TestApplication.initialize!
+
+# Test Application Models
+require 'standard_api/test_app/models'
+
+# Test Application Controllers
+require 'standard_api/test_app/controllers'
+
+# Test Application Routes
+Rails.application.routes.draw do
+  get :tables, to: 'application#tables', as: :tables
+  get :schema, to: 'application#schema', as: :schema
+
+  [:properties, :photos, :documents, :references, :sessions, :unlimited, :default_limit].each do |r|
+    standard_resources r
+  end
+
+  standard_resource :account
+end
+
+# Test Application Helpers
+Object.const_set(:ApplicationHelper, Module.new)
+
+# require 'turbostreamer'
+# require 'wankel'
+# ActionView::Template.unregister_template_handler :jbuilder
+# ActionView::Template.register_template_handler :streamer, TurboStreamer::Handler

data/test/standard_api/test_app/config/database.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  database: standardapi-test
+  encoding: utf8

data/test/standard_api/test_app/controllers.rb

@@ -0,0 +1,107 @@
+class ApplicationController < ActionController::Base
+  include StandardAPI::Controller
+  prepend_view_path File.join(File.dirname(__FILE__), 'views')
+
+  private
+
+  def account_params
+    [ "property_id", "name" ]
+  end
+
+  def account_orders
+    [ "id" ]
+  end
+
+  def account_includes
+    [ "photos" ]
+  end
+
+  def property_params
+    [ :name,
+      :aliases,
+      :description,
+      :constructed,
+      :size,
+      :active,
+      :photos_attributes,
+      { photos_attributes: [ :id, :account_id, :property_id, :format] }
+    ]
+  end
+
+  def property_orders
+    ["id", "name", "aliases", "description", "constructed", "size", "created_at", "active"]
+  end
+
+  def property_includes
+    [:photos, :landlord, :english_name]
+  end
+
+  def reference_includes
+    { subject: [ :landlord, :photos ] }
+  end
+
+end
+
+class PropertiesController < ApplicationController
+end
+
+class AccountsController < ApplicationController
+end
+
+class DocumentsController < ApplicationController
+
+  def document_params
+    [ :file, :type ]
+  end
+  
+  def document_orders
+    [:id]
+  end
+
+end
+
+class PhotosController < ApplicationController
+
+  def photo_params
+    [ :id, :account_id, :property_id, :format ]
+  end
+
+  def photo_orders
+    [:id]
+  end
+
+  def photo_includes
+    [:account]
+  end
+
+end
+
+class ReferencesController < ApplicationController
+end
+
+class SessionsController < ApplicationController
+end
+
+class UnlimitedController < ApplicationController
+
+  def self.model
+    Account
+  end
+
+  def resource_limit
+    nil
+  end
+
+end
+
+class DefaultLimitController < ApplicationController
+
+  def self.model
+    Account
+  end
+
+  def default_limit
+    100
+  end
+
+end

data/test/standard_api/test_app/models.rb

@@ -0,0 +1,94 @@
+# = Models
+
+class Account < ActiveRecord::Base
+  has_many :photos
+  belongs_to :property
+end
+
+class Photo < ActiveRecord::Base
+  belongs_to :account, :counter_cache => true
+  has_and_belongs_to_many :properties
+end
+
+class Document < ActiveRecord::Base
+  attr_accessor :file
+end
+
+class Pdf < Document
+end
+
+class Property < ActiveRecord::Base
+  has_and_belongs_to_many :photos
+  has_many :accounts
+  has_one :landlord, class_name: 'Account'
+
+  validates :name, presence: true
+  accepts_nested_attributes_for :photos
+
+  def english_name
+    'A Name'
+  end
+end
+
+class Reference < ActiveRecord::Base
+  belongs_to :subject, polymorphic: true
+end
+
+# = Migration
+
+class CreateModelTables < ActiveRecord::Migration[6.0]
+
+  def self.up
+
+    comment = "test comment"
+    exec_query(<<-SQL, "SQL")
+      COMMENT ON DATABASE #{quote_column_name(current_database)} IS #{quote(comment)};
+    SQL
+
+    create_table "accounts", force: :cascade do |t|
+      t.string   'name',                 limit: 255
+      t.integer  'property_id'
+      t.integer  'photos_count', null: false, default: 0
+    end
+
+    create_table "photos", force: :cascade do |t|
+      t.integer  "account_id"
+      t.integer  "property_id"
+      t.string   "format",                 limit: 255
+    end
+
+    create_table "properties", force: :cascade do |t|
+      t.string   "name",                 limit: 255
+      t.string   "aliases",              default: [],   array: true
+      t.text     "description"
+      t.integer  "constructed"
+      t.decimal  "size"
+      t.datetime "created_at",                         null: false
+      t.boolean  "active",             default: false
+    end
+
+    create_table "references", force: :cascade do |t|
+      t.integer  "subject_id"
+      t.string   "subject_type",         limit: 255
+      t.string   "key"
+      t.string   "value"
+    end
+    
+    create_table "photos_properties", force: :cascade do |t|
+      t.integer  "photo_id"
+      t.integer  "property_id"
+    end
+    
+    create_table "landlords_properties", force: :cascade do |t|
+      t.integer  "landlord_id"
+      t.integer  "property_id"
+    end
+
+    create_table "documents", force: :cascade do |t|
+      t.string   'type'
+    end
+  end
+
+end
+ActiveRecord::Migration.verbose = false
+CreateModelTables.up

data/test/standard_api/test_app/test/factories.rb

@@ -0,0 +1,50 @@
+FactoryBot.define do
+  factory :account do
+    name            { Faker::Name.name }
+
+    trait(:nested)  { }
+    trait(:invalid) do
+      name { nil }
+    end
+  end
+  
+  factory :landlord do
+    name            { Faker::Name.name }
+  end
+
+  factory :photo do
+    format          { ['jpg', 'png', 'tiff'].sample }
+  end
+
+  factory :document do
+    file            { fixture_file_upload(Rails.root + 'test/fixtures/photo.png', 'image/png') }
+  end
+
+  factory :pdf do
+    type            { 'Pdf' }
+    file            { fixture_file_upload(Rails.root + 'test/fixtures/photo.png', 'image/png') }
+  end
+
+  factory :reference do
+    subject_type  { 'Photo' }
+    subject_id    { create(:photo).id }
+  end
+
+  factory :property do
+    name            { Faker::Lorem.words(number: Kernel.rand(1..4)).join(' ') }
+    description     { Faker::Lorem.paragraphs.join("\n\n") }
+    constructed     { Kernel.rand(1800..(Time.now.year - 2)) }
+    size            { Kernel.rand(1000..10000000).to_f / 100 }
+    active          { [true, false].sample }
+    photos          { [create(:photo)] }
+
+    trait(:nested)  do
+      photos_attributes { [attributes_for(:photo)] }
+    end
+
+    trait(:invalid) do
+      name { nil }
+    end
+  end
+
+end

data/test/standard_api/test_app/views/photos/_photo.json.jbuilder

@@ -0,0 +1,15 @@
+json.set! :id,          photo.id
+json.set! :account_id,  photo.account_id
+json.set! :property_id, photo.property_id
+json.set! :format,      photo.format
+json.set! :template,    'photos/_photo'
+
+if includes[:account]
+  json.set! :account do
+    if photo.account
+      json.partial! 'application/record', record: photo.account, includes: includes[:account]
+    else
+      json.null!
+    end
+  end
+end

data/test/standard_api/test_app/views/photos/_photo.streamer

@@ -0,0 +1,17 @@
+json.object! do
+    json.set! :id,          photo.id
+    json.set! :account_id,  photo.account_id
+    json.set! :property_id, photo.property_id
+    json.set! :format,      photo.format
+    json.set! :template,    'photos/_photo'
+
+    if includes[:account]
+        json.set! :account do
+            if photo.account
+                json.partial! 'application/record', record: photo.account, includes: includes[:account]
+            else
+                json.null!
+            end
+        end
+    end
+end

data/test/standard_api/test_app/views/photos/_schema.json.jbuilder

@@ -0,0 +1 @@
+json.set! 'template', 'photos/schema'

data/test/standard_api/test_app/views/photos/_schema.streamer

@@ -0,0 +1,3 @@
+json.object! do
+  json.set! 'template', 'photos/schema'
+end

data/test/standard_api/test_app/views/photos/schema.json.jbuilder

@@ -0,0 +1 @@
+json.partial! 'schema'

data/test/standard_api/test_app/views/photos/schema.streamer

@@ -0,0 +1 @@
+json.partial! 'schema'

data/test/standard_api/test_app/views/properties/edit.html.erb

@@ -0,0 +1 @@
+properties#edit.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standardapi
 version: !ruby/object:Gem::Version
-  version: 6.0.0.24
+  version: 6.0.0.30
 platform: ruby
 authors:
 - James Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-14 00:00:00.000000000 Z
+date: 2020-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -245,6 +245,7 @@ extra_rdoc_files:
 files:
 - README.md
 - lib/standard_api.rb
+- lib/standard_api/active_record/connection_adapters/postgresql/schema_statements.rb
 - lib/standard_api/controller.rb
 - lib/standard_api/errors.rb
 - lib/standard_api/helpers.rb
@@ -265,6 +266,8 @@ files:
 - lib/standard_api/version.rb
 - lib/standard_api/views/application/_record.json.jbuilder
 - lib/standard_api/views/application/_record.streamer
+- lib/standard_api/views/application/_schema.json.jbuilder
+- lib/standard_api/views/application/_schema.streamer
 - lib/standard_api/views/application/index.json.jbuilder
 - lib/standard_api/views/application/index.streamer
 - lib/standard_api/views/application/new.json.jbuilder
@@ -273,6 +276,20 @@ files:
 - lib/standard_api/views/application/schema.streamer
 - lib/standard_api/views/application/show.json.jbuilder
 - lib/standard_api/views/application/show.streamer
+- test/standard_api/test_app.rb
+- test/standard_api/test_app/config/database.yml
+- test/standard_api/test_app/controllers.rb
+- test/standard_api/test_app/models.rb
+- test/standard_api/test_app/test/factories.rb
+- test/standard_api/test_app/test/fixtures/photo.png
+- test/standard_api/test_app/views/photos/_photo.json.jbuilder
+- test/standard_api/test_app/views/photos/_photo.streamer
+- test/standard_api/test_app/views/photos/_schema.json.jbuilder
+- test/standard_api/test_app/views/photos/_schema.streamer
+- test/standard_api/test_app/views/photos/schema.json.jbuilder
+- test/standard_api/test_app/views/photos/schema.streamer
+- test/standard_api/test_app/views/properties/edit.html.erb
+- test/standard_api/test_app/views/sessions/new.html.erb
 homepage: https://github.com/waratuman/standardapi
 licenses:
 - MIT
@@ -283,6 +300,7 @@ rdoc_options:
 - README.md
 require_paths:
 - lib
+- test
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="