pack_api 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f59a0e96b77d27b0c274c7bfbd3d02d58bf10139079f7e8f65f0f141700657a
-  data.tar.gz: 48f2caa082efe138a25ce949383e04959b07f2cc6e383fc277059b19c7edb489
+  metadata.gz: 91807c3325db138316580a060e86626a03f7ebc9a4025d673a8144d9faf768e8
+  data.tar.gz: 22f935038e02720fd46351e96d7c379f40b25c4c930594e3f848b1440769cf8b
 SHA512:
-  metadata.gz: 4b81ed5a8dd8536b534c18774efbdd21eb3d8799a9b00aa96afa015d5fed12ff626e48c5035983a7b28760f6a0a40c06b205d55bc2e93f82c67b29381360ec27
-  data.tar.gz: 7a7bda196011de7a10e1a8c8b98961c530dee455bc4d908f1d0c9b5c726c7df47bdeef29906a9f8faa0a65a169dfdfbadb8e1eb8c0cbb15dff35b3086c3abd42
+  metadata.gz: 9c268b476a6c26f6832cb365ac01084309d4644f75a82cccde62223b70a19feda093971266bf620d20d97744e5e28ead4a9e72a778182c55c86b51dfb77f41d1
+  data.tar.gz: 8d4376d38175ed100ed4aee1ed432f6812ecca77da984e202a91b7dd465d85c5f7bdcd5156830a9ce5510cf45417cab006aa3f84a6685a16ee472f413ada94f5

data/lib/pack_api/frozen_empty.rb

@@ -0,0 +1,4 @@
+class PackAPI::FrozenEmpty
+  ARRAY = [].freeze
+  HASH = {}.freeze
+end

data/lib/pack_api/mapping/abstract_transformer.rb

@@ -10,7 +10,7 @@ module PackAPI::Mapping
       @api_type = config[:api_type]
       @model_type = config[:model_type]
       @transform_value = config[:transform_value]
-      @options = {}
+      @options = PackAPI::FrozenEmpty::HASH
     end
 
     ###
@@ -20,7 +20,7 @@ module PackAPI::Mapping
     end
 
     def options=(value)
-      @options = value.presence || {}
+      @options = value.presence || PackAPI::FrozenEmpty::HASH
     end
 
     protected
@@ -30,8 +30,10 @@ module PackAPI::Mapping
     end
 
     def model_attribute(api_attribute)
+      # support _destroy and other special attributes used by Rails
       return api_attribute if api_attribute.start_with?('_')
 
+      # prevent api_attributes from being used unless they are in the public type definition
       unless mappings.key?(api_attribute)
         raise ActiveModel::UnknownAttributeError.new(@model_type.name, api_attribute)
       end

data/lib/pack_api/mapping/api_to_model_attributes_transformer.rb

@@ -5,23 +5,16 @@ module PackAPI::Mapping
   # Specialized attribute transformer allowing API attributes be converted to the attribute names needed to
   # creating/updating an ActiveRecord model.
   class APIToModelAttributesTransformer < AbstractTransformer
-
     def execute
       result = {}
       attribute_names = NormalizedAPIAttribute.new(api_attribute_names)
       data_source.each do |api_attribute, api_value|
         normalized_api_attribute = attribute_names.normalize(api_attribute)
         model_attribute = model_attribute(normalized_api_attribute)
-        model_value = model_value(normalized_api_attribute, api_value)
-        result.deep_merge!({ model_attribute => model_value })
+        model_value = transform_value(normalized_api_attribute, api_value)
+        result[model_attribute] = model_value
       end
       result
     end
-
-    private
-
-    def model_value(api_attribute, api_value)
-      transform_value(api_attribute, api_value)
-    end
   end
 end

data/lib/pack_api/mapping/attribute_hash_transformer.rb

@@ -9,7 +9,6 @@ module PackAPI::Mapping
   # Converts model attributes to API attributes
   # Converts API attributes to model attributes
   class AttributeHashTransformer < AbstractTransformer
-
     def execute
       options.fetch(:contains_model_attributes, true) ?
         model_attributes_to_api_attributes :

data/lib/pack_api/mapping/attribute_map.rb

@@ -26,8 +26,6 @@
 #       associate the error with the "user_id" attribute (not the "user" attribute).
 module PackAPI::Mapping
   class AttributeMap
-    FROZEN_EMPTY_HASH = {}.freeze
-
     attr_reader :config, :options
 
     class << self
@@ -225,25 +223,36 @@ module PackAPI::Mapping
       end
 
       def call(attribute_map, attribute_value)
-        proc ?
-          attribute_map.instance_exec(attribute_value, **@kwargs, &proc) :
-          attribute_map.send(instance_method.name, attribute_value, **@kwargs)
+        if @kwargs
+          proc ?
+            attribute_map.instance_exec(attribute_value, **@kwargs, &proc) :
+            attribute_map.send(instance_method.name, attribute_value, **@kwargs)
+        else
+          proc ?
+            attribute_map.instance_exec(attribute_value, &proc) :
+            attribute_map.send(instance_method.name, attribute_value)
+        end
       end
 
       def kwargs=(new_kwargs)
-        @kwargs = supported_kwargs(new_kwargs)
+        @kwargs = new_kwargs == DEFAULT_OPTIONS || new_kwargs.blank? ?
+                    nil :
+                  supported_kwargs(new_kwargs)
       end
 
       private
 
       def supported_kwargs(kwargs)
-        return FROZEN_EMPTY_HASH if kwargs.blank?
+        return if parameters.empty?
+
+        overlap = parameters.any? { |p| kwargs.key?(p) }
+        return unless overlap
 
-        kwargs.select { |kwarg| parameters.any? { |parameter| parameter.last == kwarg } }
+        kwargs.slice(*parameters)
       end
 
       def parameters
-        @parameters ||= (proc || instance_method).parameters
+        @parameters ||= (proc || instance_method).parameters.map(&:last)
       end
     end
 

data/lib/pack_api/mapping/filter_map.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
 module PackAPI::Mapping
-  FROZEN_EMPTY_ARRAY = [].freeze
-  FROZEN_EMPTY_HASH = {}.freeze
-
   ##
   # This class is responsible for transforming API filter names into model filters. It also produces filter definitions
   # in API terms for those filters that are supported by the model.
@@ -43,7 +40,7 @@ module PackAPI::Mapping
 
     def api_attribute_filter_names
       @api_attribute_filter_names ||= attribute_map_class.nil? ?
-                                        FROZEN_EMPTY_ARRAY :
+                                        PackAPI::FrozenEmpty::ARRAY :
                                         attribute_map_class.api_type.filterable_attributes.keys
     end
 
@@ -51,7 +48,7 @@ module PackAPI::Mapping
     # Map from a backend filter name to an API filter name for default attribute filters.
     def api_attribute_filter_name_map
       return @api_attribute_filter_name_map if defined?(@api_attribute_filter_name_map)
-      return FROZEN_EMPTY_HASH if attribute_map_class.nil?
+      return PackAPI::FrozenEmpty::HASH if attribute_map_class.nil?
 
       names = {}
       api_attribute_filter_names.each { |name| names[name] = name }

data/lib/pack_api/mapping/model_to_api_attributes_transformer.rb

@@ -5,7 +5,6 @@ module PackAPI::Mapping
   # Specialized attribute transformer converting an ActiveRecord model attributes to the attribute names needed
   # to create a ValueObject in the public API.
   class ModelToAPIAttributesTransformer < AbstractTransformer
-
     def options=(options)
       super
       @optional_attributes_to_include = nil
@@ -17,15 +16,17 @@ module PackAPI::Mapping
         model_attribute = model_attribute(api_attribute)
         next unless include_model_attribute?(model_attribute)
 
-        value = unless optional_api_attribute?(api_attribute) && !include_api_attribute?(api_attribute)
-                  api_value(api_attribute, model_value(model_attribute))
-                end
-        result[api_attribute] = value
+        api_value = transform_value(api_attribute, model_value(model_attribute)) if include_api_attribute?(api_attribute)
+        result[api_attribute] = api_value
       end
     end
 
     protected
 
+    def include_api_attribute?(api_attribute)
+      !optional_api_attribute?(api_attribute) || include_optional_api_attribute?(api_attribute)
+    end
+
     def model_attributes_of_interest
       @model_attributes_of_interest ||= options[:model_attributes_of_interest]
     end
@@ -38,7 +39,7 @@ module PackAPI::Mapping
       api_type_optional_attributes.include?(api_attribute_name)
     end
 
-    def include_api_attribute?(api_attribute_name)
+    def include_optional_api_attribute?(api_attribute_name)
       return false if optional_attributes_to_include.nil?
       return false if optional_attributes_to_include.respond_to?(:exclude?) &&
                       optional_attributes_to_include.exclude?(api_attribute_name)
@@ -53,15 +54,11 @@ module PackAPI::Mapping
     end
 
     def api_type_optional_attributes
-      @api_type_optional_attributes ||= api_type.optional_attributes || []
+      @api_type_optional_attributes ||= api_type.optional_attributes || PackAPI::FrozenEmpty::ARRAY
     end
 
     def model_value(model_attribute)
       data_source.public_send(model_attribute)
     end
-
-    def api_value(api_attribute, model_value)
-      transform_value(api_attribute, model_value)
-    end
   end
 end

data/lib/pack_api/mapping/value_object_factory.rb

@@ -2,7 +2,6 @@
 
 module PackAPI::Mapping
   class ValueObjectFactory
-
     class << self
       attr_reader :attribute_map_registry, :value_object_attributes
 

data/lib/pack_api/querying/collection_query.rb

@@ -109,11 +109,21 @@ module PackAPI::Querying
     end
 
     def apply_filters(filters:)
-      filtered_query = ComposableQuery.new(@query)
-      filter_factory.create_filters(filters).each { |filter| filter.apply_to(filtered_query) }
+      filter_objects = filter_factory.create_filters(filters)
+      validate_filters(filter_objects)
+      filtered_query = filter_objects.each_with_object(ComposableQuery.new(@query)) do |filter, composable_query|
+        filter.apply_to(composable_query)
+      end
       @query = filtered_query.build
     end
 
+    def validate_filters(filter_objects)
+      errors = filter_objects.select { |filter| filter.respond_to?(:valid?) && !filter.valid? }
+                             .map { |invalid_filter| { invalid_filter.filter_name => invalid_filter.errors.messages } }
+                             .reduce({}, :merge)
+      raise PackAPI::InternalError.new(object: errors) if errors.present?
+    end
+
     def stable_sort(sort)
       return sort if sort.is_a?(Arel::Nodes::SqlLiteral)
 

data/lib/pack_api/querying/dynamic_enum_filter.rb

@@ -2,8 +2,6 @@
 
 module PackAPI::Querying
   module DynamicEnumFilter
-    FROZEN_EMPTY_ARRAY = [].freeze
-
     extend ActiveSupport::Concern
     class_methods do
       def type = :dynamic_enum
@@ -14,7 +12,7 @@ module PackAPI::Querying
 
       private
 
-      def filter_options(**) = FROZEN_EMPTY_ARRAY
+      def filter_options(**) = PackAPI::FrozenEmpty::ARRAY
     end
   end
 end

data/lib/pack_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PackAPI
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

data/lib/pack_api.rb

@@ -9,6 +9,7 @@ require_relative "types"
 require_relative "pack_api/version"
 
 module PackAPI
+  autoload :FrozenEmpty, "pack_api/frozen_empty"
   autoload :InternalError, "pack_api/internal_error"
   autoload :ValuesInBatches, "pack_api/values_in_batches"
   autoload :ValuesInBackgroundBatches, "pack_api/values_in_background_batches"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pack_api
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Flytedesk
@@ -199,6 +199,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/pack_api.rb
+- lib/pack_api/frozen_empty.rb
 - lib/pack_api/internal_error.rb
 - lib/pack_api/mapping/abstract_transformer.rb
 - lib/pack_api/mapping/api_to_model_attributes_transformer.rb