standardapi 6.0.0.27 → 6.0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa65660e373b200d71d61e7afba4fef6a44223cb368a952769e6a23b33c11e66
-  data.tar.gz: 1816cce08cdcf2633388d40bacacca0cbd43254f38f563e07a70be1d901f7d68
+  metadata.gz: 3670132e90418137f095c8e7741310e2911bfde21e78579e27ea6c54ae88d0f1
+  data.tar.gz: 205778759e7188eda509e289495a383d6a5ff037116fd5043a519f95c5b7222d
 SHA512:
-  metadata.gz: 127c5829c1edccd069e6e266b06f7d5b6273677c1ff9003ae5afde2c2d63575a7a19f03ee33a628cac01b5e22cdea31be315ac0cc1d0a006b70279a31a5fb255
-  data.tar.gz: 6e366bb60ad67ff5ce426d012109b508abda0f0196bedbc11045d32f067d7cf3f553df39b8dfe149a50a3a99c2f7a8347c1c94ed38e017231f6a92a7696c4671
+  metadata.gz: 2d4a009d0ea47b18ebc5088d81bdf4518e9a22749b1ea0a17e8f7b5504be42dbeea60945ad75eeb5a4cdfda866f39edc12391262ff64b2a5cc3748011cb0c4bc
+  data.tar.gz: 49a638815647e3fbe6d63dc4eda87eda4703425b2c36e4565763cc0aad1abf0934d54d8f18858d00ac733f1e4662873f5ff586e1cdf27aafdaebfbc825703b71

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

@@ -4,7 +4,7 @@ module StandardAPI
     delegate :preloadables, to: :helpers
 
     def self.included(klass)
-      klass.helper_method :includes, :orders, :model, :resource_limit,
+      klass.helper_method :includes, :orders, :model, :models, :resource_limit,
         :default_limit
       klass.before_action :set_standardapi_headers
       klass.rescue_from StandardAPI::UnpermittedParameters, with: :bad_request
@@ -15,11 +15,17 @@ module StandardAPI
     def tables
       Rails.application.eager_load! if !Rails.application.config.eager_load
 
-      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
+      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
@@ -36,7 +42,7 @@ module StandardAPI
         end
       end
       @calculations = Hash[@calculations] if @calculations[0].is_a?(Array) && params[:group_by]
-      
+
       render json: @calculations
     end
 
@@ -97,12 +103,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
@@ -110,10 +116,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)
@@ -122,7 +128,7 @@ module StandardAPI
       else
         head :not_found
       end
-      
+
     end
 
     # Override if you want to support masking
@@ -131,7 +137,7 @@ module StandardAPI
     end
 
     module ClassMethods
-    
+
       def model
         return @model if defined?(@model)
         @model = name.sub(/Controller\z/, '').singularize.camelize.safe_constantize
@@ -153,6 +159,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")
@@ -192,21 +207,21 @@ 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
 
@@ -224,7 +239,7 @@ module StandardAPI
 
     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)
@@ -240,7 +255,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
@@ -298,7 +313,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/helpers.rb

@@ -18,7 +18,7 @@ module StandardAPI
           end
         end
       end
-      
+
       preloads.empty? ? record : record.preload(preloads)
     end
 
@@ -26,7 +26,7 @@ module StandardAPI
       preloads = {}
 
       iclds.each do |key, value|
-        if reflection = klass.reflections[key] 
+        if reflection = klass.reflections[key]
           case value
           when true
             preloads[key] = value
@@ -39,10 +39,20 @@ module StandardAPI
           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('/')
@@ -59,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?
@@ -69,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?
@@ -78,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)}"
@@ -112,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)
@@ -123,7 +133,7 @@ module StandardAPI
         seed
       end
     end
-    
+
     def digest_hash(*hashes)
       hashes.compact!
       hashes.map! { |h| sort_hash(h) }
@@ -183,4 +193,4 @@ module StandardAPI
     end
 
   end
-end
+end

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

@@ -91,9 +91,6 @@ module StandardAPI
         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

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.27'
+  VERSION = '6.0.0.29'
 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

@@ -37,6 +37,7 @@ 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

data/test/standard_api/test_app/models.rb

@@ -36,10 +36,15 @@ end
 
 # = Migration
 
-class CreateModelTables < ActiveRecord::Migration[5.2]
+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'

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

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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standardapi
 version: !ruby/object:Gem::Version
-  version: 6.0.0.27
+  version: 6.0.0.29
 platform: ruby
 authors:
 - James Bracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2019-12-12 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
@@ -280,7 +283,11 @@ files:
 - 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