caprese 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b539135a9520430f58f763ab6dec137d29b5de5
-  data.tar.gz: e0159857fd3adc9bfde3a247a59f495176042f47
+  metadata.gz: c285f46b32620d9d16fe5b6698098a385f5e163f
+  data.tar.gz: 559a81f42af6e01fac7cecec6b8a9b9c8134139b
 SHA512:
-  metadata.gz: 91542f3ccf9492a10ace8d7bc258d05573257b71b0258086950d6dd43e3da852dec063c1f637c41e9e6a10b428fcc8aa40892ac8397f1bfe8c53542eb2ecb576
-  data.tar.gz: 105f5f9d421d3e7e7015f919138fd0be80aefc32d5e3d493e321136a3a41e1d2ecf998e33c2c8cf902012cec20467b8f9df259519eb8ec2452a9e8d20032cbb2
+  metadata.gz: 346d727d18ae79c56606c0dc60e5badc09995e0430dff1fff2147a2f85a3cdeeef63a6e1ab0d4f0aea2bcb120ad1470de2d0b04fa60de347e93f11f819b9f53e
+  data.tar.gz: f7fe6949fb0241f3a4fec64ad91b3470a55bfffb3bc4131e0ac4690ec53829be8da23d69f11e0699aeb2f96f5e4943c9e2f18f4e5524b044700b6c876f2f3ddf

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.1.5
   - 2.2.2
+  - 2.3.1
 env:
-  - DB=sqlite
+  - "RAILS_VERSION=4.2.7"
+  - "RAILS_VERSION=5.0.1"
 script:
   - cd spec/dummy
   - RAILS_ENV=test bundle exec rake db:migrate --trace

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.3.0
+
+* Have children controllers inherit callbacks from their parent
+* Have child records without their own serializers inherit their type names from their parent
+* Enforce `Caprese::Record` on all records serialized
+* Allow editing of meta tag document
+* Modify `validates_associated` to propagate nested association errors to the record itself
+* Fail with `422 Unprocessable Entity` if any callbacks add an error to a record being persisted or updated

data/caprese.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.1'
 
-  spec.add_dependency 'active_model_serializers', '~> 0.10.0'
-  spec.add_dependency 'kaminari'
+  spec.add_dependency 'active_model_serializers', '0.10.2'
+  spec.add_dependency 'kaminari', '0.17.0'
   spec.add_dependency 'rails', '>= 4.2.0'
 
   spec.add_development_dependency 'bundler'

data/lib/caprese/adapter/json_api/resource_identifier.rb

@@ -3,20 +3,16 @@ module Caprese
     class JsonApi
       class ResourceIdentifier
         def self.type_for(class_name, serializer_type = nil, transform_options = {})
-          if serializer_type
-            raw_type = serializer_type
-          else
-            inflection =
-              if ActiveModelSerializers.config.jsonapi_resource_type == :singular
-                :singularize
-              else
-                :pluralize
-              end
-
-            raw_type = class_name.underscore
-            raw_type = ActiveSupport::Inflector.public_send(inflection, raw_type)
-            raw_type
-          end
+          inflection =
+            if ActiveModelSerializers.config.jsonapi_resource_type == :singular
+              :singularize
+            else
+              :pluralize
+            end
+
+          raw_type = serializer_type || class_name.underscore
+          raw_type = ActiveSupport::Inflector.public_send(inflection, raw_type)
+
           JsonApi.send(:transform_key_casing!, raw_type, transform_options)
         end
 
@@ -37,7 +33,7 @@ module Caprese
         private
 
         def type_for(serializer, transform_options)
-          self.class.type_for(serializer.object.class.name, serializer._type, transform_options)
+          self.class.type_for(serializer.object.class.name, serializer.json_key, transform_options)
         end
 
         def id_for(serializer)

data/lib/caprese/controller/concerns/callbacks.rb

@@ -49,10 +49,22 @@ module Caprese
         #
         # @param [Symbol,Array<Symbol>] callbacks the name(s) of callbacks to add to list of callbacks
         define_singleton_method method_name do |*callbacks|
-          unless (all_callbacks = self.instance_variable_get(instance_variable_name))
-            all_callbacks = self.instance_variable_set(instance_variable_name, [])
-          end
+          all_callbacks = self.instance_variable_get(instance_variable_name) || []
           all_callbacks.push *callbacks
+          self.instance_variable_set(instance_variable_name, all_callbacks)
+        end
+      end
+    end
+
+    module ClassMethods
+      # Is called when any controller class inherits from a parent controller, copying to the child controller
+      # all of the callbacks that have been stored in instance variables on the parent
+      #
+      # @param [Class] subclass the child class that is to inherit the callbacks
+      def inherited(subclass)
+        CALLBACKS.each do |method_name|
+          instance_variable_name = "@#{method_name}_callbacks"
+          subclass.instance_variable_set(instance_variable_name, instance_variable_get(instance_variable_name))
         end
       end
     end

data/lib/caprese/controller/concerns/persistence.rb

@@ -35,28 +35,19 @@ module Caprese
     #
     # @note For this action to succeed, the given controller must define `create_params`
     #   @see #create_params
-    #
-    # 1. Check that type of record to be created matches type that the given controller manages
-    # 2. Build the appropriate attributes/associations for the create action
-    # 3. Build a record with the attributes
-    # 4. Execute after_initialize callbacks
-    # 5. Execute before_create callbacks
-    # 6. Execute before_save callbacks
-    # 7. Create the record by saving it (or fail with RecordInvalid and render errors)
-    # 8. Execute after_create callbacks
-    # 9. Execute after_save callbacks
-    # 10. Return the created resource with 204 Created
-    #    @see #rescue_from ActiveRecord::RecordInvalid
     def create
       fail_on_type_mismatch(data_params[:type])
 
       record = queried_record_scope.build
       assign_record_attributes(record, permitted_params_for(:create), data_params)
+
       execute_after_initialize_callbacks(record)
 
       execute_before_create_callbacks(record)
       execute_before_save_callbacks(record)
 
+      fail RecordInvalidError.new(record) if record.errors.any?
+
       record.save!
 
       execute_after_create_callbacks(record)
@@ -74,22 +65,16 @@ module Caprese
     #
     # @note For this action to succeed, the given controller must define `update_params`
     #   @see #update_params
-    #
-    # 1. Check that type of record to be updated matches type that the given controller manages
-    # 2. Execute before_update callbacks
-    # 3. Execute before_save callbacks
-    # 4. Update the record (or fail with RecordInvalid and render errors)
-    # 5. Execute after_update callbacks
-    # 6. Execute after_save callbacks
-    # 7. Return the updated resource
-    #    @see #rescue_from ActiveRecord::RecordInvalid
     def update
       fail_on_type_mismatch(data_params[:type])
 
+      assign_record_attributes(queried_record, permitted_params_for(:update), data_params)
+
       execute_before_update_callbacks(queried_record)
       execute_before_save_callbacks(queried_record)
 
-      assign_record_attributes(queried_record, permitted_params_for(:update), data_params)
+      fail RecordInvalidError.new(queried_record) if queried_record.errors.any?
+
       queried_record.save!
 
       execute_after_update_callbacks(queried_record)
@@ -285,21 +270,29 @@ module Caprese
     # @param [Hash] resource_identifier the resource identifier for the resource
     # @return [ActiveRecord::Base] the found or built resource for the relationship
     def record_for_relationship(owner, relationship_name, resource_identifier)
-      record =
+      if resource_identifier[:type]
+        # { type: '...', id: '...' }
         if (id = resource_identifier[Caprese.config.resource_primary_key])
           get_record!(
             resource_identifier[:type],
             Caprese.config.resource_primary_key,
             id
           )
+
+        # { type: '...', attributes: { ... } }
         elsif contains_constructable_data?(resource_identifier)
           record_scope(resource_identifier[:type]).build
+
+        # { type: '...' }
         else
           owner.errors.add(relationship_name)
           nil
         end
-
-      record
+      else
+        # { id: '...' } && { attributes: { ... } }
+        owner.errors.add(relationship_name)
+        nil
+      end
     end
 
     # Assigns permitted attributes for a record in a relationship, for a given action

data/lib/caprese/controller/concerns/relationships.rb

@@ -58,12 +58,14 @@ module Caprese
       links = { self: request.original_url }
 
       if !target.respond_to?(:to_ary) &&
-        respond_to?(related_url = version_name("#{params[:relationship].singularize}_url"))
+        Rails.application.routes.url_helpers
+        .respond_to?(related_url = version_name("#{params[:relationship].singularize}_url"))
 
         links[:related] =
-          send(
+          Rails.application.routes.url_helpers.send(
             related_url,
-            target.read_attribute(self.config.resource_primary_key)
+            target.read_attribute(self.config.resource_primary_key),
+            host: caprese_default_url_options_host
           )
       end
 
@@ -110,8 +112,15 @@ module Caprese
       links = { self: request.original_url }
 
       # Add related link for this relationship if it exists
-      if respond_to?(related_path = "relationship_data_#{version_name(unversion(params[:controller]).singularize)}_url")
-        links[:related] = send(related_path, params[:id], params[:relationship])
+      if Rails.application.routes.url_helpers
+        .respond_to?(related_path = "relationship_data_#{version_name(unversion(params[:controller]).singularize)}_url")
+
+        links[:related] = Rails.application.routes.url_helpers.send(
+          related_path,
+          params[:id],
+          params[:relationship],
+          host: caprese_default_url_options_host
+        )
       end
 
       target = queried_association.reader
@@ -246,5 +255,13 @@ module Caprese
 
       @queried_association
     end
+
+    # Fetches the host from Caprese.config.default_url_options or fails if it is not set
+    # @note default_url_options[:host] is used to render the host in links that are serialized in the response
+    def caprese_default_url_options_host
+      Caprese.config.default_url_options.fetch(:host) do
+        fail 'Caprese requires that config.default_url_options[:host] be set when rendering links.'
+      end
+    end
   end
 end

data/lib/caprese/controller/concerns/rendering.rb

@@ -9,6 +9,7 @@ module Caprese
     # instead of requiring that they be explicity stated
     def render(options = {})
       options[:adapter] = Caprese::Adapter::JsonApi
+      options[:meta] = meta unless meta.empty?
 
       if options[:json].respond_to?(:to_ary)
         if options[:json].first.is_a?(Error)
@@ -27,6 +28,16 @@ module Caprese
       super
     end
 
+    # Allows for meta tags to be added in response document
+    #
+    # @example
+    #   meta[:redirect_url] = ...
+    #
+    # @return [Hash] the meta tag object
+    def meta
+      @caprese_meta ||= {}
+    end
+
     private
 
     # Finds a versioned serializer for a given resource
@@ -34,10 +45,15 @@ module Caprese
     # @example
     #   serializer_for(post) => API::V1::PostSerializer
     #
+    # @note The reason this method is a duplicate of Caprese::Serializer.serializer_for is
+    #   because the latter is only ever called from children of Caprese::Serializer, like those
+    #   in the API::V1:: scope. If we tried to use that method instead of this one, we end up
+    #   with Caprese::[record.class.name]Serializer instead of the proper versioned serializer
+    #
     # @param [ActiveRecord::Base] record the record to find a serializer for
     # @return [Serializer,Nil] the serializer for the given record
     def serializer_for(record)
-      version_module("#{record.class.name}Serializer").constantize
+      version_module("#{record.class.name}Serializer").constantize if Serializer.valid_for_serialization(record)
     end
   end
 end

data/lib/caprese/record/associated_validator.rb

@@ -0,0 +1,33 @@
+module Caprese
+  module Record
+    # Formats nested errors on associations in a more useful way than Rails alone
+    #
+    # @note BEFORE
+    # POST /posts (with invalid resources) =>
+    #   [
+    #     { "key"=>"invalid", "field"=>"attachment", "message"=>"Attachment is invalid." }
+    #   ]
+    #
+    # @note AFTER
+    # POST /posts (with invalid resources) =>
+    #   [
+    #     { "key"=>"not_found", "field"=>"attachment.file", "message"=>"Could not find a file at ..."}
+    #   ]
+    class AssociatedValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        Array(value).reject { |r| r.marked_for_destruction? || r.valid? }.each do |invalid_record|
+          invalid_record.errors.to_a.each do |error|
+            field_name = error.field ? "#{attribute}.#{error.field}" : attribute
+            record.errors.add(field_name, error.code, options.merge(value: invalid_record))
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def validates_associated(*attr_names)
+        validates_with AssociatedValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/caprese/record.rb

@@ -2,6 +2,7 @@ require 'active_model'
 require 'active_support/concern'
 require 'active_support/dependencies'
 require 'caprese/errors'
+require 'caprese/record/associated_validator'
 require 'caprese/record/errors'
 
 module Caprese

data/lib/caprese/serializer/concerns/links.rb

@@ -12,8 +12,14 @@ module Caprese
         #   object = Order<@token='asd27h'>
         #   links = { self: '/api/v1/orders/asd27hß' }
         link :self do
-          if respond_to?(url = serializer.version_name("#{object.class.name.underscore}_url"))
-            send(url, object.read_attribute(Caprese.config.resource_primary_key))
+          if Rails.application.routes.url_helpers
+            .respond_to?(url = serializer.version_name("#{object.class.name.underscore}_url"))
+
+            Rails.application.routes.url_helpers.send(
+              url,
+              object.read_attribute(Caprese.config.resource_primary_key),
+              host: serializer.send(:caprese_default_url_options_host)
+            )
           end
         end
       end
@@ -67,22 +73,24 @@ module Caprese
           Proc.new do |serializer|
             link :self do
               url = "relationship_definition_#{serializer.version_name("#{object.class.name.underscore}_url")}"
-              if respond_to? url
-                send(
+              if Rails.application.routes.url_helpers.respond_to? url
+                Rails.application.routes.url_helpers.send(
                   url,
                   primary_key => object.read_attribute(primary_key),
-                  relationship: reflection_name
+                  relationship: reflection_name,
+                  host: serializer.send(:caprese_default_url_options_host)
                 )
               end
             end
 
             link :related do
               url = "relationship_data_#{serializer.version_name("#{object.class.name.underscore}_url")}"
-              if respond_to? url
-                send(
+              if Rails.application.routes.url_helpers.respond_to? url
+                Rails.application.routes.url_helpers.send(
                   url,
                   primary_key => object.read_attribute(primary_key),
-                  relationship: reflection_name
+                  relationship: reflection_name,
+                  host: serializer.send(:caprese_default_url_options_host)
                 )
               end
             end
@@ -91,6 +99,16 @@ module Caprese
           end
         end
       end
+
+      private
+
+      # Fetches the host from Caprese.config.default_url_options or fails if it is not set
+      # @note default_url_options[:host] is used to render the host in links that are serialized in the response
+      def caprese_default_url_options_host
+        Caprese.config.default_url_options.fetch(:host) do
+          fail 'Caprese requires that config.default_url_options[:host] be set when rendering links.'
+        end
+      end
     end
   end
 end

data/lib/caprese/serializer/concerns/lookup.rb

@@ -14,7 +14,23 @@ module Caprese
         # @param [Hash] options options for `super` to use when getting the serializer
         # @return [Serializer,Nil] the serializer for the given record
         def serializer_for(record, options = {})
-          get_serializer_for(record.class) || super
+          return ActiveModel::Serializer::CollectionSerializer if record.respond_to?(:to_ary)
+
+          get_serializer_for(record.class) if valid_for_serialization(record)
+        end
+
+        # Indicates whether or not the record specified can be serialized by Caprese
+        #
+        # @note The only requirement right now is that the record model has Caprese::Record included
+        #
+        # @param [Object] record the record to check if is valid for serialization
+        # @return [True] this method either returns true, or fails - breaking control flow
+        def valid_for_serialization(record)
+          if record && !record.class.included_modules.include?(Caprese::Record)
+            fail 'All models managed by Caprese must include Caprese::Record'
+          end
+
+          true
         end
 
         private

data/lib/caprese/serializer.rb

@@ -9,5 +9,9 @@ module Caprese
     include Versioning
     include Links
     include Lookup
+
+    def json_key
+      unversion(self.class.name).gsub('Serializer', '').underscore
+    end
   end
 end

data/lib/caprese/version.rb

@@ -1,3 +1,3 @@
 module Caprese
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

data/lib/caprese.rb

@@ -23,7 +23,7 @@ module Caprese
   config.only_path_links ||= true
 
   # If true, relationship data will not be serialized unless it is in `include`
-  config.optimize_relationships ||= true
+  config.optimize_relationships ||= false
 
   # Defines the translation scope for model and controller errors
   config.i18n_scope ||= '' # 'api.v1.errors'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caprese
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Nick Landgrebe
@@ -10,36 +10,36 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2017-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.10.2
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -204,6 +204,7 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -233,6 +234,7 @@ files:
 - lib/caprese/error.rb
 - lib/caprese/errors.rb
 - lib/caprese/record.rb
+- lib/caprese/record/associated_validator.rb
 - lib/caprese/record/errors.rb
 - lib/caprese/routing/caprese_resources.rb
 - lib/caprese/serializer.rb