standardapi 6.0.0.26 → 6.1.0

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
@@ -69,9 +69,12 @@ module StandardAPI
       end
 
       test '#index.json params[:include]' do
+        next if includes.empty?
+
         travel_to Time.now do
           create_model
           get resource_path(:index, format: :json), params: { limit: 100, include: includes }
+          assert_response :ok
 
           json = JSON.parse(response.body)[0]
           assert json.is_a?(Hash)
@@ -128,6 +131,13 @@ module StandardAPI
         models = @controller.instance_variable_get("@#{plural_name}")
         assert_equal model.where(id: m.id).sort(required_orders).to_sql, models.to_sql
         @controller.current_mask.delete(plural_name)
+
+        @controller.current_mask[plural_name.to_sym] = { id: m.id }
+        get :index, format: :json
+        models = @controller.instance_variable_get("@#{plural_name}")
+        assert_equal model.where(id: m.id).sort(required_orders).to_sql, models.to_sql
+        @controller.current_mask.delete(plural_name.to_sym)
+
       end
     end
   end

data/lib/standard_api/test_case/schema_tests.rb

@@ -9,13 +9,35 @@ 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']
+
+          if column.default
+            default = model.connection.lookup_cast_type_from_column(column).deserialize(column.default)
+            assert_equal default, actual_column['default']
+          else
+            assert_nil column.default
+          end
         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/test_case/show_tests.rb

@@ -15,6 +15,7 @@ module StandardAPI
       test '#show.json params[:include]' do
         m = create_model
         get resource_path(:show, id: m.id, include: includes, format: :json)
+        assert_response :ok
 
         json = JSON.parse(response.body)
         includes.each do |included|

data/lib/standard_api/test_case/update_tests.rb

@@ -16,7 +16,7 @@ module StandardAPI
         put resource_path(:update, :id => m.id, format: format), params: { singular_name => attrs }, as: as
         assert_response :ok, "Updating #{m.class.name} with #{attrs.inspect}"
 
-        view_attributes(m.reload).select { |x| attrs.keys.map(&:to_s).include?(x) }.each do |key, value|
+        update_attributes(m.reload).select { |x| attrs.keys.map(&:to_s).include?(x) }.each do |key, value|
           message = "Model / Attribute: #{m.class.name}##{key}"
           if value.is_a?(BigDecimal)
             assert_equal_or_nil normalize_attribute(m, key, attrs[key.to_sym]).to_s.to_f, value.to_s.to_f, message
@@ -34,7 +34,7 @@ module StandardAPI
         get resource_path(:show, id: m.id), as: :json
 
         return if @controller.method(:update).owner != StandardAPI
-        
+
         attrs = attributes_for(singular_name).select{|k,v| !model.readonly_attributes.include?(k.to_s) }
         create_webmocks(attrs)
 
@@ -57,9 +57,9 @@ module StandardAPI
         assert_response :ok, "Updating #{m.class.name} with #{attrs.inspect}"
 
         # (m.attribute_names & attrs.keys.map(&:to_s)).each do |test_key|
-        view_attributes(m.reload).select { |x| attrs.keys.map(&:to_s).include?(x) }.each do |key, value|
+        update_attributes(m.reload).select { |x| attrs.keys.map(&:to_s).include?(x) }.each do |key, value|
           message = "Model / Attribute: #{m.class.name}##{key}"
-          assert_equal_or_nil normalize_attribute(m, key, attrs[key.to_sym]), value, message
+          assert_equal_or_nil normalize_attribute(m, key, attrs[key.to_sym]), normalize_attribute(m, key, value), message
         end
         assert JSON.parse(@response.body).is_a?(Hash)
       end
@@ -68,8 +68,7 @@ module StandardAPI
         trait = FactoryBot.factories[singular_name].definition.defined_traits.any? { |x| x.name.to_s == 'invalid' }
 
         if !trait
-          Rails.logger.try(:warn, "No invalid trait for #{model.name}. Skipping invalid tests")
-          warn("No invalid trait for #{model.name}. Skipping invalid tests")
+          skip("No invalid trait for #{model.name}. Skipping invalid tests")
           return
         end
 
@@ -94,7 +93,7 @@ module StandardAPI
 
           put resource_path(:update, :id => m.id, format: format), params: { include: includes, singular_name => attrs }, as: as
           assert_response :ok, "Updating #{m.class.name} with #{attrs.inspect}"
-        
+
           controller_model = @controller.instance_variable_get("@#{singular_name}")
           json = JSON.parse(response.body)
           includes.each do |included|
@@ -104,7 +103,7 @@ module StandardAPI
             next if !association
 
             if ['belongs_to', 'has_one'].include?(association.macro.to_s)
-              view_attributes(controller_model.send(included)) do |key, value|
+              update_attributes(controller_model.send(included)) do |key, value|
                 message = "Model / Attribute: #{controller_model.send(included).class.name}##{key}"
                 assert_equal json[included.to_s][key.to_s], value, message
               end
@@ -118,7 +117,7 @@ module StandardAPI
                 nil
               end
 
-              view_attributes(m).each do |key, value|
+              update_attributes(m).each do |key, value|
                 message = "Model / Attribute: #{m.class.name}##{key}"
                 if m_json[key.to_s].nil?
                   assert_nil normalize_to_json(m, key, value), message

data/lib/standard_api/version.rb

@@ -1,3 +1,3 @@
 module StandardAPI
-  VERSION = '6.0.0.26'
+  VERSION = '6.1.0'
 end

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

@@ -6,39 +6,42 @@ end
 
 includes.each do |inc, subinc|
   next if ["limit", "offset", "order", "when", "where", "distinct", "distinct_on"].include?(inc)
-  
+
   case association = record.class.reflect_on_association(inc)
-  when ActiveRecord::Reflection::HasManyReflection, ActiveRecord::Reflection::HasAndBelongsToManyReflection, ActiveRecord::Reflection::ThroughReflection
-    can_cache = can_cache_relation?(record.class, inc, subinc)
-    json.cache_if!(can_cache, can_cache ? association_cache_key(record, inc, subinc) : nil) do
-      partial = model_partial(association.klass)
+  when ActiveRecord::Reflection::AbstractReflection
+    if association.collection?
+      can_cache = can_cache_relation?(record, inc, subinc)
       json.set! inc do
-        # TODO limit causes preloaded assocations to reload
-        sub_records = record.send(inc)
-        
-        sub_records = sub_records.limit(subinc['limit']) if subinc['limit']
-        sub_records = sub_records.offset(subinc['offset']) if subinc['offset']
-        sub_records = sub_records.order(subinc['order']) if subinc['order']
-        sub_records = sub_records.filter(subinc['where']) if subinc['where']
-        sub_records = sub_records.distinct if subinc['distinct']
-        sub_records = sub_records.distinct_on(subinc['distinct_on']) if subinc['distinct_on']
+        json.cache_if!(can_cache, can_cache ? association_cache_key(record, inc, subinc) : nil) do
+          partial = model_partial(association.klass)
+
+          # TODO limit causes preloaded assocations to reload
+          sub_records = record.send(inc)
 
-        json.array! sub_records, partial: partial, as: partial.split('/').last, locals: { includes: subinc }
+          sub_records = sub_records.limit(subinc['limit']) if subinc['limit']
+          sub_records = sub_records.offset(subinc['offset']) if subinc['offset']
+          sub_records = sub_records.reorder(subinc['order']) if subinc['order']
+          sub_records = sub_records.filter(subinc['where']) if subinc['where']
+          sub_records = sub_records.distinct if subinc['distinct']
+          sub_records = sub_records.distinct_on(subinc['distinct_on']) if subinc['distinct_on']
+
+          json.array! sub_records, partial: partial, as: partial.split('/').last, locals: { includes: subinc }
+        end
       end
-    end
-  when ActiveRecord::Reflection::BelongsToReflection, ActiveRecord::Reflection::HasOneReflection
-    can_cache = can_cache_relation?(record.class, inc, subinc)
-    if association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
-      can_cache = can_cache && !record.send(association.foreign_key).nil?
-    end
-    json.cache_if!(can_cache, can_cache ? association_cache_key(record, inc, subinc) : nil) do
-      value = record.send(inc)
-      if value.nil?
-        json.set! inc, nil
-      else
-        partial = model_partial(value)
-        json.set! inc do
-          json.partial! partial, partial.split('/').last.to_sym => value, includes: subinc
+    else
+      can_cache = can_cache_relation?(record, inc, subinc)
+      if association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+        can_cache = can_cache && !record.send(association.foreign_key).nil?
+      end
+      json.set! inc do
+        json.cache_if!(can_cache, can_cache ? association_cache_key(record, inc, subinc) : nil) do
+          value = record.send(inc)
+          if value.nil?
+            json.null!
+          else
+            partial = model_partial(value)
+            json.partial! partial, partial.split('/').last.to_sym => value, includes: subinc
+          end
         end
       end
     end
@@ -57,7 +60,7 @@ includes.each do |inc, subinc|
       end
     end
   end
-  
+
 end
 
 if !record.errors.blank?

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

@@ -1,5 +1,5 @@
 json.object! do
-  
+
   record.attributes.each do |name, value|
     # Skip if attribute is included in excludes
     next if defined?(excludes) && excludes[record.model_name.singular.to_sym].try(:find) { |x| x.to_s == name.to_s }
@@ -8,39 +8,41 @@ json.object! do
 
   includes.each do |inc, subinc|
     next if ["limit", "offset", "order", "when", "where", "distinct", "distinct_on"].include?(inc)
-    
+
     case association = record.class.reflect_on_association(inc)
-    when ActiveRecord::Reflection::HasManyReflection, ActiveRecord::Reflection::HasAndBelongsToManyReflection, ActiveRecord::Reflection::ThroughReflection
-      can_cache = can_cache_relation?(record.class, inc, subinc)
-      json.cache_if!(can_cache, can_cache ? association_cache_key(record, inc, subinc) : nil) do
-        partial = model_partial(association.klass)
-        json.set! inc do
-          # TODO limit causes preloaded assocations to reload
-          sub_records = record.send(inc)
+    when ActiveRecord::Reflection::AbstractReflection
+      if association.collection?
+        can_cache = can_cache_relation?(record, inc, subinc)
+        json.cache_if!(can_cache, can_cache ? [inc, association_cache_key(record, inc, subinc)] : nil) do
+          json.set! inc do
+            partial = model_partial(association.klass)
+            # TODO limit causes preloaded assocations to reload
+            sub_records = record.send(inc)
 
-          sub_records = sub_records.limit(subinc['limit']) if subinc['limit']
-          sub_records = sub_records.offset(subinc['offset']) if subinc['offset']
-          sub_records = sub_records.order(subinc['order']) if subinc['order']
-          sub_records = sub_records.filter(subinc['where']) if subinc['where']
-          sub_records = sub_records.distinct if subinc['distinct']
-          sub_records = sub_records.distinct_on(subinc['distinct_on']) if subinc['distinct_on']
+            sub_records = sub_records.limit(subinc["limit"]) if subinc["limit"]
+            sub_records = sub_records.offset(subinc["offset"]) if subinc["offset"]
+            sub_records = sub_records.reorder(subinc["order"]) if subinc["order"]
+            sub_records = sub_records.filter(subinc["where"]) if subinc["where"]
+            sub_records = sub_records.distinct if subinc["distinct"]
+            sub_records = sub_records.distinct_on(subinc["distinct_on"]) if subinc["distinct_on"]
 
-          json.array! sub_records, partial: partial, as: partial.split('/').last, locals: { includes: subinc }
+            json.array! sub_records, partial: partial, as: partial.split("/").last, locals: { includes: subinc }
+          end
         end
-      end
-    when ActiveRecord::Reflection::BelongsToReflection, ActiveRecord::Reflection::HasOneReflection
-      can_cache = can_cache_relation?(record.class, inc, subinc)
-      if association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
-        can_cache = can_cache && !record.send(association.foreign_key).nil?
-      end
-      json.cache_if!(can_cache, can_cache ? association_cache_key(record, inc, subinc) : nil) do
-        value = record.send(inc)
-        if value.nil?
-          json.set! inc, nil
-        else
-          partial = model_partial(value)
+      else
+        can_cache = can_cache_relation?(record, inc, subinc)
+        if association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+          can_cache = can_cache && !record.send(association.foreign_key).nil?
+        end
+        json.cache_if!(can_cache, can_cache ? [inc, association_cache_key(record, inc, subinc)] : nil) do
           json.set! inc do
-            json.partial! partial, partial.split('/').last.to_sym => value, includes: subinc
+            value = record.send(inc)
+            if value.nil?
+              json.value! nil
+            else
+              partial = model_partial(value)
+              json.partial! partial, partial.split("/").last.to_sym => value, includes: subinc
+            end
           end
         end
       end
@@ -52,20 +54,20 @@ json.object! do
         elsif value.is_a?(ActiveModel::Model)
           json.set! inc do
             partial = model_partial(value)
-            json.partial! partial, partial.split('/').last.to_sym => value, includes: subinc
+            json.partial! partial, partial.split("/").last.to_sym => value, includes: subinc
           end
         else
           json.set! inc, value.as_json
         end
       end
     end
-    
+
   end
-  
+
   if !record.errors.blank?
     errs = record.errors.to_hash
     errs.default_proc = nil
-    json.set! 'errors', errs
+    json.set! "errors", errs
   end
-  
+
 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 ? model.connection.lookup_cast_type_from_column(column).deserialize(column.default) : nil,
+        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 ? model.connection.lookup_cast_type_from_column(column).deserialize(column.default) : nil,
+            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