standardapi 6.1.0 → 7.1.1

data/lib/standard_api/route_helpers.rb

@@ -22,11 +22,38 @@ module StandardAPI
       options = resources.extract_options!.dup
 
       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
+        block.call if block # custom routes take precedence over standardapi routes
+
+        available_actions = if only = parent_resource.instance_variable_get(:@only)
+          Array(only).map(&:to_sym)
+        else
+          if parent_resource.instance_variable_get(:@api_only)
+            [:index, :create, :show, :update, :destroy]
+          else
+            [:index, :create, :new, :show, :update, :destroy, :edit]
+          end + [ :schema, :calculate, :add_resource, :remove_resource, :create_resource ]
+        end
+
+        actions = if except = parent_resource.instance_variable_get(:@except)
+          available_actions - Array(except).map(&:to_sym)
+        else
+          available_actions
+        end
+
+        get :schema, on: :collection if actions.include?(:schema)
+        get :calculate, on: :collection if actions.include?(:calculate)
+
+        if actions.include?(:add_resource)
+          post ':relationship/:resource_id' => :add_resource, on: :member
+        end
+        
+        if actions.include?(:create_resource)
+          post ':relationship' => :create_resource, on: :member
+        end
+
+        if actions.include?(:remove_resource)
+          delete ':relationship/:resource_id' => :remove_resource, on: :member
+        end
       end
     end
 
@@ -51,10 +78,33 @@ module StandardAPI
       options = resource.extract_options!.dup
 
       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
+        available_actions = if only = parent_resource.instance_variable_get(:@only)
+          Array(only).map(&:to_sym)
+        else
+          if parent_resource.instance_variable_get(:@api_only)
+            [:index, :create, :show, :update, :destroy]
+          else
+            [:index, :create, :new, :show, :update, :destroy, :edit]
+          end + [ :schema, :calculate, :add_resource, :remove_resource ]
+        end
+
+        actions = if except = parent_resource.instance_variable_get(:@except)
+          available_actions - Array(except).map(&:to_sym)
+        else
+          available_actions
+        end
+
+        get :schema, on: :collection if actions.include?(:schema)
+        get :calculate, on: :collection if actions.include?(:calculate)
+
+        if actions.include?(:add_resource)
+          post ':relationship/:resource_id' => :add_resource, on: :member
+        end
+
+        if actions.include?(:remove_resource)
+          delete ':relationship/:resource_id' => :remove_resource, on: :member
+        end
+
         block.call if block
       end
     end

data/lib/standard_api/test_case/calculate_tests.rb

@@ -59,22 +59,23 @@ module StandardAPI
         #   calculations
       end
 
-      test '#calculate.json mask' do
+      test '#calculate.json mask_for' do
         # This is just to instance @controller
         get resource_path(:calculate)
 
-        # If #current_mask isn't defined by StandardAPI we don't know how to
-        # test other's implementation of #current_mask. Return and don't test.
-        return if @controller.method(:current_mask).owner != StandardAPI
+        # If #mask isn't defined by StandardAPI we don't know how to
+        # test other's implementation of #mask_for. Return and don't test.
+        return if @controller.method(:mask_for).owner != StandardAPI
 
         m = create_model
 
-        @controller.current_mask[plural_name] = { id: m.id + 100 }
+        @controller.define_singleton_method(:mask_for) do |table_name|
+          { id: m.id + 100 }
+        end
         selects = [{ count: :id}, { maximum: :id }, { minimum: :id }, { average: :id }]
         get :calculate, select: selects, format: 'json'
         assert_response :ok
         assert_equal [[0, nil, nil, nil]], @controller.instance_variable_get('@calculations')
-        @controller.current_mask.delete(plural_name)
       end
 
     end

data/lib/standard_api/test_case/destroy_tests.rb

@@ -13,23 +13,35 @@ module StandardAPI
         end
       end
 
-      test '#destroy.json mask' do
+      test '#destroy.json mask_for' do
         m = create_model
 
         # This is just to instance @controller
         get resource_path(:show, id: m.id, format: 'json')
 
-        # If #current_mask isn't defined by StandardAPI we don't know how to
-        # test other's implementation of #current_mask. Return and don't test.
-        return if @controller.method(:current_mask).owner != StandardAPI
+        # If #mask_for isn't defined by StandardAPI we don't know how to
+        # test other's implementation of #mask_for. Return and don't test.
+        return if @controller.method(:mask_for).owner != StandardAPI
 
-        @controller.current_mask[plural_name] = { id: m.id + 1 }
+        @controller.define_singleton_method(:mask_for) do |table_name|
+          { id: m.id + 1 }
+        end
         assert_raises(ActiveRecord::RecordNotFound) do
           delete resource_path(:destroy, id: m.id, format: :json)
         end
-        @controller.current_mask.delete(plural_name)
       end
 
+      test '#destroy.json with comma separated ids' do
+        m1 = create_model
+        m2 = create_model
+        m3 = create_model
+
+        assert_difference("#{model.name}.count", -3) do
+          delete resource_path(:destroy, id: "#{m1.id},#{m2.id},#{m3.id}", format: :json)
+          assert_response :no_content
+          assert_equal '', response.body
+        end
+      end
     end
   end
-end
+end

data/lib/standard_api/test_case/index_tests.rb

@@ -117,27 +117,21 @@ module StandardAPI
         end
       end
 
-      test '#index.json mask' do
+      test '#index.json mask_for' do
         # This is just to instance @controller
         get resource_path(:index, format: :json), params: { limit: 1 }
 
-        # If #current_mask isn't defined by StandardAPI we don't know how to
-        # test other's implementation of #current_mask. Return and don't test.
-        return if @controller.method(:current_mask).owner != StandardAPI
+        # If #mask_for isn't defined by StandardAPI we don't know how to
+        # test other's implementation of #mask_for. Return and don't test.
+        return if @controller.method(:mask_for).owner != StandardAPI
 
         m = create_model
-        @controller.current_mask[plural_name] = { 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)
-
-        @controller.current_mask[plural_name.to_sym] = { id: m.id }
+        @controller.define_singleton_method(:mask_for) do |table_name|
+          { id: m.id }
+        end
         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/show_tests.rb

@@ -52,22 +52,22 @@ module StandardAPI
         end
       end
 
-      test '#show.json mask' do
+      test '#show.json mask_for' do
         m = create_model
 
         # This is just to instance @controller
         get resource_path(:show, id: m.id, format: :json)
 
-        # If #current_mask isn't defined by StandardAPI we don't know how to
-        # test other's implementation of #current_mask. Return and don't test.
-        return if @controller.method(:current_mask).owner != StandardAPI
+        # If #mask_for isn't defined by StandardAPI we don't know how to
+        # test other's implementation of #mask_for. Return and don't test.
+        return if @controller.method(:mask_for).owner != StandardAPI
 
-
-        @controller.current_mask[plural_name] = { id: m.id + 1 }
+        @controller.define_singleton_method(:mask_for) do |table_name|
+          { id: m.id + 1 }
+        end
         assert_raises(ActiveRecord::RecordNotFound) do
           get resource_path(:show, id: m.id, format: :json)
         end
-        @controller.current_mask.delete(plural_name)
       end
 
     end

data/lib/standard_api/test_case/update_tests.rb

@@ -131,21 +131,22 @@ module StandardAPI
         end
       end
 
-      test '#update.json mask' do
+      test '#update.json mask_for' do
         m = create_model
 
         # This is just to instance @controller
         get resource_path(:index, format: :json), params: { limit: 1 }
 
-        # If #current_mask isn't defined by StandardAPI we don't know how to
-        # test other's implementation of #current_mask. Return and don't test.
-        return if @controller.method(:current_mask).owner != StandardAPI
+        # If #mask_for isn't defined by StandardAPI we don't know how to
+        # test other's implementation of #mask_for. Return and don't test.
+        return if @controller.method(:mask_for).owner != StandardAPI
 
-        @controller.current_mask[plural_name] = { id: m.id + 1 }
+        @controller.define_singleton_method(:mask_for) do |table_name|
+          { id: m.id + 1 }
+        end
         assert_raises(ActiveRecord::RecordNotFound) do
           put resource_path(:update, :id => m.id), as: :json
         end
-        @controller.current_mask.delete(plural_name)
       end
 
     end

data/lib/standard_api/version.rb

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

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

@@ -1,7 +1,8 @@
-record.attributes.each do |name, value|
+record.attribute_names.each do |name|
   # 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 }
-  json.set! name, value
+  next if defined?(excludes) && excludes[record.model_name.singular.to_sym].try(:find) { |x| x.to_s == name }
+
+  serialize_attribute(json, record, name, record.type_for_attribute(name).type)
 end
 
 includes.each do |inc, subinc|
@@ -30,11 +31,21 @@ includes.each do |inc, subinc|
       end
     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?
+      cache_key = nil
+
+      if can_cache
+        if association.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+          can_cache = can_cache && !record.send(association.foreign_key).nil?
+        end
+
+        if can_cache
+          cache_key = association_cache_key(record, inc, subinc)
+          can_cache = cache_key.present?
+        end
       end
+
       json.set! inc do
-        json.cache_if!(can_cache, can_cache ? association_cache_key(record, inc, subinc) : nil) do
+        json.cache_if!(can_cache, can_cache ? cache_key : nil) do
           value = record.send(inc)
           if value.nil?
             json.null!

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

@@ -1,9 +1,10 @@
 json.object! do
 
-  record.attributes.each do |name, value|
+  record.attribute_names.each do |name|
     # 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 }
-    json.set! name, value
+    next if defined?(excludes) && excludes[record.model_name.singular.to_sym].try(:find) { |x| x.to_s == name }
+
+    serialize_attribute(json, record, name, record.type_for_attribute(name).type)
   end
 
   includes.each do |inc, subinc|

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

@@ -50,14 +50,26 @@ 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
-      }
+      default = column.default ? model.connection.lookup_cast_type_from_column(column).deserialize(column.default) : nil
+      type = case model.type_for_attribute(column.name)
+      when ActiveRecord::Enum::EnumType
+        default = model.defined_enums[column.name].key(default)
+        "string"
+      else
+        json_column_type(column.sql_type)
+      end
+
+      json.set! column.name do
+        json.set! 'type', type
+        json.set! 'default', default
+        json.set! 'primary_key', column.name == model.primary_key
+        json.set! 'null', column.null
+        json.set! 'array', column.array
+        json.set! 'comment', column.comment
+        # TODO: it would be nice if rails responded with a true or false here
+        # instead of the function itself
+        json.set! 'auto_populated', !!column.auto_populated? if column.respond_to?(:auto_populated?)
+      end
     end
   end
 

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

@@ -59,14 +59,28 @@ else
     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
-          }
+          default = column.default ? model.connection.lookup_cast_type_from_column(column).deserialize(column.default) : nil
+          type = case model.type_for_attribute(column.name)
+          when ActiveRecord::Enum::EnumType
+            default = model.defined_enums[column.name].key(default)
+            "string"
+          else
+            json_column_type(column.sql_type)
+          end
+
+          json.set! column.name do
+            json.object! do
+              json.set! 'type', type
+              json.set! 'default', default
+              json.set! 'primary_key', column.name == model.primary_key
+              json.set! 'null', column.null
+              json.set! 'array', column.array
+              json.set! 'comment', column.comment
+              # TODO: it would be nice if rails responded with a true or false here
+              # instead of the function itself
+              json.set! 'auto_populated', !!column.auto_populated? if column.respond_to?(:auto_populated?)
+            end
+          end
         end
       end
     end

data/lib/standard_api.rb

@@ -19,4 +19,5 @@ require 'standard_api/railtie'
 
 module StandardAPI
   autoload :AccessControlList, 'standard_api/access_control_list'
+  autoload :Middleware, 'standard_api/middleware'
 end

data/test/standard_api/caching_test.rb

@@ -32,8 +32,8 @@ class AccountsControllerTest < ActionDispatch::IntegrationTest
     # Two associations that reference the same model
     property = create(:property)
     account = create(:account, property: property, subject: property)
-    Account.any_instance.expects(:property_cached_at).returns(t1)
-    Account.any_instance.expects(:subject_cached_at).returns(t1)
+    Account.any_instance.expects(:property_cached_at).twice.returns(t1)
+    Account.any_instance.expects(:subject_cached_at).twice.returns(t1)
     get account_path(account, include: { property: true, subject: true }, format: 'json')
     json = JSON(response.body)
     assert json.has_key?('property')

data/test/standard_api/controller/include_test.rb

@@ -0,0 +1,107 @@
+require 'standard_api/test_helper'
+
+class ControllerIncludesTest < ActionDispatch::IntegrationTest
+
+  # = Including an invalid include
+
+  test "Controller#create with a valid include" do
+    property = build(:property)
+
+    json = assert_difference 'Property.count', 1 do
+      post "/properties", params: { property: property.attributes, include: [:photos] }, as: :json
+      JSON.parse(response.body)
+    end
+
+    assert_response :created
+    assert_equal [], json['photos']
+  end
+
+  test "Controller#update with a valid include" do
+    photo = create(:photo)
+    property = create(:property, {name: "A", photos: [photo]})
+    patch "/properties/#{property.id}", params: { property: {name: "B"}, include: [:photos] }, as: :json
+
+    json = JSON.parse(response.body)
+    assert_response :ok
+    assert_equal [photo.id], json['photos'].map { |j| j['id'] }
+  end
+
+  # test "Controller#destroy with a valid include" do
+  #   No body is returned on a destroy so includes are used
+  # end
+
+  test "Controller#create_resource with a valid include" do
+    property = create(:property, accounts: [])
+    account = build(:account)
+
+    post "/properties/#{property.id}/accounts", params: { account: account.attributes, include: [:photos] }, as: :json
+
+    json = JSON.parse(response.body)
+    assert_response :created
+    assert_equal [], json['photos']
+  end
+
+  # test "Controller#add_resource with a valid include" do
+  #   No body is returned on a destroy so includes are used
+  # end
+
+  # test "Controller#remove_resource with an invalid include" do
+  #   No body is returned on a destroy so includes are used
+  # end
+
+  # = Including an invalid include
+
+  test "Controller#create with an invalid include" do
+    property = build(:property)
+
+    assert_no_difference 'Property.count' do
+      post "/properties", params: { property: property.attributes, include: [:accounts] }, as: :json
+    end
+
+    assert_response :bad_request
+  end
+
+  test "Controller#update with an invalid include" do
+    property = create(:property, {name: "A"})
+    patch "/properties/#{property.id}", params: { property: {name: "B"}, include: [:accounts] }, as: :json
+
+    assert_response :bad_request
+    assert_equal 'A', property.reload.name
+  end
+
+  # test "Controller#destroy with an invalid include" do
+  #   No body is returned on a destroy so includes are used
+  # end
+
+  test "Controller#create_resource with an invalid include" do
+    property = create(:property, photos: [])
+    photo = build(:photo)
+
+    post "/properties/#{property.id}/photos", params: { photo: photo.attributes, include: [:camera] }, as: :json
+    assert_equal 0, property.reload.photos.count
+    assert_response :bad_request
+  end
+
+  # This test passes because includes are not used, response is a HEAD response
+  # and no includes are used.
+  test "Controller#add_resource with an invalid include" do
+    property = create(:property, photos: [])
+    photo = create(:photo)
+
+    post "/properties/#{property.id}/photos/#{photo.id}", params: { include: [:camera] }, as: :json
+    assert_equal 1, property.reload.photos.count
+    assert_response :created
+  end
+  
+  # This test passes because includes are not used, response is a HEAD response
+  # and no includes are used.
+  test "Controller#remove_resource with an invalid include" do
+    photo = create(:photo)
+    property = create(:property, photos: [photo])
+
+    delete "/properties/#{property.id}/photos/#{photo.id}", params: { include: [:camera] }, as: :json
+    assert_equal 0, property.reload.photos.count
+    assert_response :no_content
+  end
+
+end

data/test/standard_api/controller/subresource_test.rb

@@ -0,0 +1,157 @@
+require 'standard_api/test_helper'
+
+class ControllerSubresourceTest < ActionDispatch::IntegrationTest
+  
+  # add_resource
+  test 'Controller#add_resource with has_many' do
+    property = create(:property, photos: [])
+    photo = create(:photo)
+
+    post "/properties/#{property.id}/photos/#{photo.id}"
+    assert_equal property.photos.reload.map(&:id), [photo.id]
+    assert_response :created
+
+    assert_raises ActiveRecord::RecordNotFound do
+      post "/properties/#{property.id}/photos/9999999"
+    end
+  end
+
+  test 'Controller#add_resource with has_and_belongs_to_many' do
+    photo1 = create(:photo)
+    photo2 = create(:photo)
+    property = create(:property, photos: [photo1])
+
+    post "/properties/#{property.id}/photos/#{photo2.id}"
+    assert_equal property.photos.reload.map(&:id), [photo1.id, photo2.id]
+    assert_response :created
+
+    assert_raises ActiveRecord::RecordNotFound do
+      post "/properties/#{property.id}/photos/9999999"
+    end
+  end
+
+  test 'Controller#add_resource with belongs_to' do
+    photo = create(:photo)
+    account = create(:account)
+
+    post "/photos/#{photo.id}/account/#{account.id}"
+    assert_equal photo.reload.account_id, account.id
+    assert_response :created
+  end
+
+  test 'Controller#add_resource with has_one' do
+    photo = create(:document)
+    property = create(:property)
+    post "/properties/#{property.id}/document/#{photo.id}"
+    assert_equal property.reload.document, photo
+    assert_response :created
+  end
+  
+  test 'Controller#add_resource that is already there' do
+    photo = create(:photo)
+    property = create(:property, photos: [photo])
+
+    post "/properties/#{property.id}/photos/#{photo.id}"
+    assert_response :bad_request
+    assert_equal JSON(response.body), {
+      "errors" => [
+        "Relationship between Property and Photo violates unique constraints"
+      ]
+    }
+
+    assert_raises ActiveRecord::RecordNotFound do
+      post "/properties/#{property.id}/photos/9999999"
+    end
+  end
+
+  # create_resource
+  test 'Controller#create_resource with has_many' do
+    property = create(:property, photos: [])
+    photo = build(:photo)
+
+    post "/properties/#{property.id}/photos", params: { photo: photo.attributes }, as: :json
+    assert_equal property.photos.reload.map(&:id), [JSON.parse(response.body)['id']]
+    assert_equal property.photos.count, 1
+    assert_response :created
+  end
+
+  test 'Controller#create_resource with has_and_belongs_to_many' do
+    photo1 = create(:photo)
+    photo2 = build(:photo)
+    property = create(:property, photos: [photo1])
+
+    post "/properties/#{property.id}/photos", params: { photo: photo2.attributes }, as: :json
+    assert_equal property.photos.reload.map(&:id).sort, [photo1.id, JSON.parse(response.body)['id']].sort
+    assert_equal property.photos.count, 2
+    assert_response :created
+  end
+
+  test 'Controller#create_resource with belongs_to' do
+    photo = create(:photo)
+    account = build(:account)
+
+    post "/photos/#{photo.id}/account", params: { account: account.attributes }, as: :json
+    assert_equal photo.reload.account_id, JSON.parse(response.body)['id']
+    assert_response :created
+  end
+
+  test 'Controller#create_resource with has_one' do
+    account = build(:account)
+    property = create(:property)
+    post "/properties/#{property.id}/landlord", params: { landlord: account.attributes }, as: :json
+    assert_equal property.reload.landlord.id, JSON.parse(response.body)['id']
+    assert_response :created
+  end
+
+  # remove_resource
+  test 'Controller#remove_resource' do
+    photo = create(:photo)
+    property = create(:property, photos: [photo])
+    assert_equal property.photos.reload, [photo]
+    delete "/properties/#{property.id}/photos/#{photo.id}"
+    assert_equal property.photos.reload, []
+    assert_response :no_content
+
+    assert_raises ActiveRecord::RecordNotFound do
+      delete "/properties/#{property.id}/photos/9999999"
+    end
+  end
+
+  test 'Controller#remove_resource with has_one' do
+    photo = create(:document)
+    property = create(:property, document: photo)
+    assert_equal property.document, photo
+    delete "/properties/#{property.id}/document/#{photo.id}"
+    assert_nil property.reload.document
+    assert_response :no_content
+  end
+
+  test 'Controller#remove_resource with belongs_to' do
+    account = create(:account)
+    photo = create(:photo, account: account)
+
+    delete "/photos/#{photo.id}/account/#{account.id}"
+    assert_nil photo.reload.account_id
+    assert_response :no_content
+  end
+
+  test 'Controller#remove_resource with belongs_to unless not match' do
+    account1 = create(:account)
+    account2 = create(:account)
+    photo = create(:photo, account: account1)
+
+    delete "/photos/#{photo.id}/account/#{account2.id}"
+    assert_equal photo.reload.account_id, account1.id
+    assert_response :not_found
+  end
+
+  test 'Controller#remove_resource with belongs_to unless not match and is nil' do
+    account = create(:account)
+    photo = create(:photo)
+
+    delete "/photos/#{photo.id}/account/#{account.id}"
+    assert_nil photo.reload.account_id
+    assert_response :not_found
+  end
+
+end