standardapi 6.0.0.15 → 6.0.0.29

data/lib/standard_api/includes.rb

@@ -17,17 +17,29 @@ module StandardAPI
         includes.flatten.compact.each { |v| normalized.merge!(normalize(v)) }
       when Hash, ActionController::Parameters
         includes.each_pair do |k, v|
-          if ['limit', 'when', 'where', 'order'].include?(k.to_s) # Where and order are not normalized (sanitation happens in activerecord-filter)
-            normalized[k] = case v
+          normalized[k] = case k.to_s
+          when 'when', 'where', 'order'
+            case v
             when Hash then v.to_h
             when ActionController::Parameters then v.to_unsafe_h
             end
-          elsif k.to_s == 'distinct'
-            normalized[k] = case v
+          when 'limit'
+            case v
+            when String then v.to_i
+            when Integer then v
+            end
+          when 'distinct'
+            case v
+            when 'true' then true
+            when 'false' then false
+            end
+          when 'distinct_on'
+            case v
             when String then v
+            when Array then v
             end
           else
-            normalized[k] = normalize(v)
+            normalize(v)
           end
         end
       when nil
@@ -58,14 +70,12 @@ module StandardAPI
 
       permit = normalize(permit.with_indifferent_access)
       includes.each do |k, v|
-        if permit.has_key?(k) || ['limit', 'when', 'where', 'order', 'distinct'].include?(k.to_s)
-          permitted[k] = sanitize(v, permit[k] || {}, true)
+        permitted[k] = if permit.has_key?(k)
+          sanitize(v, permit[k] || {}, true)
+        elsif ['limit', 'when', 'where', 'order', 'distinct', 'distinct_on'].include?(k.to_s)
+          v
         else
-          if [:raise, nil].include?(Rails.configuration.try(:action_on_unpermitted_includes))
-            raise ActionController::UnpermittedParameters.new([k])
-          else
-            Rails.logger.try(:warn, "Invalid Include: #{k}")
-          end
+          raise StandardAPI::UnpermittedParameters.new([k])
         end
       end
 

data/lib/standard_api/orders.rb

@@ -15,11 +15,11 @@ module StandardAPI
             key2, key3 = *key.to_s.split('.')
             permitted << sanitize({key2.to_sym => { key3.to_sym => value } }, permit)
           elsif permit.include?(key.to_s)
-            case value
+            value = case value
             when Hash
               value
             when ActionController::Parameters
-              value.to_unsafe_hash
+              value.permit([:asc, :desc]).to_h
             else
               value
             end
@@ -29,7 +29,7 @@ module StandardAPI
             sanitized_value = sanitize(value, subpermit)
             permitted << { key.to_sym => sanitized_value }
           else
-            raise(ActionController::UnpermittedParameters.new([orders]))
+            raise(StandardAPI::UnpermittedParameters.new([orders]))
           end
         end
       when Array
@@ -48,7 +48,7 @@ module StandardAPI
         elsif permit.include?(orders.to_s)
           permitted = orders
         else
-          raise(ActionController::UnpermittedParameters.new([orders]))
+          raise(StandardAPI::UnpermittedParameters.new([orders]))
         end
       end
 
@@ -57,8 +57,6 @@ module StandardAPI
       else
         permitted
       end
-
-      # permitted
     end
 
   end

data/lib/standard_api/railtie.rb

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

data/lib/standard_api/route_helpers.rb

@@ -24,6 +24,8 @@ module StandardAPI
       resources(*resources, options) do
         get :schema, on: :collection
         get :calculate, on: :collection
+        delete ':relationship/:resource_id' => :remove_resource, on: :member
+        post ':relationship/:resource_id' => :add_resource, on: :member
         block.call if block
       end
     end
@@ -51,6 +53,8 @@ module StandardAPI
       resource(*resource, options) do
         get :schema, on: :collection
         get :calculate, on: :collection
+        delete ':relationship/:resource_id' => :remove_resource, on: :member
+        post ':relationship/:resource_id' => :add_resource, on: :member
         block.call if block
       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 }]
@@ -24,7 +24,9 @@ module StandardAPI
         get resource_path(:calculate, select: selects, format: :json)
         assert_response :ok
         calculations = @controller.instance_variable_get('@calculations')
-        assert_equal [selects.map { |s| model.send(s.keys.first, column.name) }],
+        expectations = selects.map { |s| model.send(s.keys.first, column.name) }
+        expectations = [expectations] if expectations.length > 1
+        assert_equal expectations,
           calculations
       end
 
@@ -33,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.15'
+  VERSION = '6.0.0.29'
 end

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

@@ -5,7 +5,7 @@ record.attributes.each do |name, value|
 end
 
 includes.each do |inc, subinc|
-  next if ["limit", "offset", "order", "when", "where"].include?(inc)
+  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
@@ -14,15 +14,16 @@ includes.each do |inc, subinc|
       partial = model_partial(association.klass)
       json.set! inc do
         # TODO limit causes preloaded assocations to reload
-        if subinc.keys.any? { |x| ["limit", "offset", "order", "when", "where"].include?(x) }
-          if subinc['distinct']
-            json.array! record.send(inc).filter(subinc['where']).limit(subinc['limit']).sort(subinc['order']).distinct_on(subinc['distinct']), partial: partial, as: partial.split('/').last, locals: { includes: subinc }
-          else
-            json.array! record.send(inc).filter(subinc['where']).limit(subinc['limit']).sort(subinc['order']).distinct, partial: partial, as: partial.split('/').last, locals: { includes: subinc }
-          end
-        else
-          json.array! record.send(inc), partial: partial, as: partial.split('/').last, locals: { includes: subinc }
-        end
+        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.array! sub_records, partial: partial, as: partial.split('/').last, locals: { includes: subinc }
       end
     end
   when ActiveRecord::Reflection::BelongsToReflection, ActiveRecord::Reflection::HasOneReflection

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

@@ -7,7 +7,7 @@ json.object! do
   end
 
   includes.each do |inc, subinc|
-    next if ["limit", "offset", "order", "when", "where"].include?(inc)
+    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
@@ -16,15 +16,16 @@ json.object! do
         partial = model_partial(association.klass)
         json.set! inc do
           # TODO limit causes preloaded assocations to reload
-          if subinc.keys.any? { |x| ["limit", "offset", "order", "when", "where"].include?(x) }
-            if subinc['distinct']
-              json.array! record.send(inc).filter(subinc['where']).limit(subinc['limit']).sort(subinc['order']).distinct_on(subinc['distinct']), partial: partial, as: partial.split('/').last, locals: { includes: subinc }
-            else
-              json.array! record.send(inc).filter(subinc['where']).limit(subinc['limit']).sort(subinc['order']).distinct, partial: partial, as: partial.split('/').last, locals: { includes: subinc }
-            end
-          else
-            json.array! record.send(inc), partial: partial, as: partial.split('/').last, locals: { includes: subinc }
-          end
+          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.array! sub_records, partial: partial, as: partial.split('/').last, locals: { includes: subinc }
         end
       end
     when ActiveRecord::Reflection::BelongsToReflection, ActiveRecord::Reflection::HasOneReflection

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/index.json.jbuilder

@@ -1,19 +1,16 @@
-if !includes.empty?
-  instance_variable_set("@#{model.model_name.plural}", preloadables(instance_variable_get("@#{model.model_name.plural}"), includes))
+if !defined?(records)
+  records = instance_variable_get("@#{model.model_name.plural}")
 end
 
-if !includes.empty? && can_cache?(model, includes)
-  partial = model_partial(model)
-  record_name = partial.split('/').last.to_sym
+partial = model_partial(model)
+partial_record_name = partial.split('/').last.to_sym
 
-  json.cache_collection! instance_variable_get("@#{model.model_name.plural}"), key: proc { |record| cache_key(record, includes) } do |record|
-    locals = { record: record, record_name => record, :includes => includes }
-    json.partial! partial, locals
+if !includes.empty? && can_cache?(model, includes)
+  json.cache_collection! records, key: proc { |record| cache_key(record, includes) } do |record|
+    json.partial!(partial, includes: includes, partial_record_name => record)
   end
 else
-  partial = model_partial(model)
-  record_name = partial.split('/').last.to_sym
-  json.array!(instance_variable_get("@#{model.model_name.plural}")) do |record|
+  json.array!(records) do |record|
     sub_includes = includes.select do |key, value|
       case value
       when Hash, ActionController::Parameters
@@ -27,10 +24,6 @@ else
       end
     end
 
-    json.partial! partial, {
-      record: record,
-      record_name => record,
-      includes: sub_includes
-    }
+    json.partial!(partial, includes: sub_includes, partial_record_name => record)
   end
 end