fulfil_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc3d42e014ce01e2bca045883fcbe4b43a2f701fafd6c4252c7b06c1a9314acf
-  data.tar.gz: e6e79edf8b831515f3a706358c5884384b1f925b150443b1627ae33905ead5c6
+  metadata.gz: e0460289a73e01bd52c8b06a997b9fc62396113cd981dc9a09e87ca900f5c9a6
+  data.tar.gz: abc95e2905c9a95482dbbba457e2e088a3fd9f02043f89846f2bf60a9bad7b62
 SHA512:
-  metadata.gz: 8694733643edbf5caa327f42fb5121b4557869358afaf916c4cdfe30e2a7854ba70b189b24d8f1886b41054f1eb36aa6ffc1bafbc4c378e0b2276fa4513aaebc
-  data.tar.gz: ef3818c50ac4a8e09660a690a7d3a97e0775111ccbd1f35825969ab66ee1cb4003e5c2aec2f2b26ef5902a0e1ad07a5fb90bda99ad4b6c94b7bff4a8b57dbcc3
+  metadata.gz: 80682546344bb1ead394205e822881b499188a8d924984acf62c564f5b37527926039b7d6b6bc771a6cf18217396ffbdc7e1483bda04f6a4b2d4fe801c358ea9
+  data.tar.gz: a7b246c3a4a3addebcfa72ba38bb0e1fe5ccb689e92b3f076beb5686b258c18300ed56481f2aaba8cf367bc98a946a0677e8ecc5cb0884e04092e80c23e188ba

data/lib/fulfil_api/resource/attribute_assignable.rb

@@ -22,11 +22,31 @@ module FulfilApi
       # @param name [String, Symbol] The attribute name
       # @param value [Any] The attribute value
       # @return [Hash] The resource attributes
-      def assign_attribute(name, value)
+      def assign_attribute(name, value) # rubocop:disable Metrics/MethodLength
         attribute = build_attribute(name, value)
         attribute.deep_stringify_keys!
 
-        @attributes = @attributes.deep_merge(attribute)
+        # NOTE: Fulfil will assign the ID of a nested resource to its own namespace.
+        #   This leads to conflicts when we're trying to parse the returned fields
+        #   from the API.
+        #
+        # To address this problem, we're manually handling these cases. We're dealing
+        #   with a nested relation when one of the values is an integer and the other
+        #   is an hash.
+        #
+        # @example a nested relation
+        #
+        #   $ resource.assign_attributes({ "warehouse.name" => "Toronto", "warehouse" => 10 })
+        #   => <FulfilApi::Resource @attributes={"warehouse" => { "id" => 10, "name" => "Toronto" }} />
+        @attributes = @attributes.deep_merge(attribute) do |_key, current_value, other_value|
+          if current_value.is_a?(Integer) && other_value.is_a?(Hash)
+            { "id" => current_value }.deep_merge(other_value)
+          elsif current_value.is_a?(Hash) && other_value.is_a?(Integer)
+            current_value.deep_merge({ "id" => other_value })
+          else
+            other_value
+          end
+        end
       end
 
       private

data/lib/fulfil_api/resource/comparable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  class Resource
+    module Comparable
+      def ==(other)
+        other.is_a?(FulfilApi::Resource) &&
+          other.hash == hash
+      end
+
+      def eql?(other)
+        self == other
+      end
+
+      def hash
+        @attributes.hash
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource/serializable.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module FulfilApi
+  class Resource
+    module Serializable
+      extend ActiveSupport::Concern
+
+      class_methods do
+        # Turns a JSON string into a {FulfilApi::Resource}.
+        #
+        # @note it's required to include the name of the model as part of the JSON
+        #   string too. Otherwise, you will encounter a naming error when attempting
+        #   to turn the JSON into a {FulfilApi::Resource}
+        #
+        # @param json [String] The JSONified data
+        # @param root_included [true, false] When using Rails, one can include
+        # @return [FulfilApi::Resource]
+        def from_json(json, root_included: false)
+          attributes = JSON.parse(json)
+          attributes = attributes.values.first if root_included
+
+          new(attributes)
+        end
+      end
+
+      # Overwrites the default {#as_json} method because {ActiveModel} will nest
+      #   the attributes when the model is transformed to JSON.
+      #
+      # @param options [Hash, nil] An optional list of options
+      # @return [Hash] A set of attributes available to be JSONified.
+      def as_json(options = nil)
+        # NOTE: We're including the model name by default. Otherwise, we can't use
+        #   the {.from_json} method to parse it when reading from JSON.
+        hash = to_h.merge("model_name" => @model_name)
+
+        case options
+        in { root: }
+          { root => hash }
+        else
+          hash
+        end
+      end
+
+      # Turns the {Resource} into a JSON object.
+      #
+      # @param options [Hash, nil] An optional list of options
+      # @return [String] The JSONified resource data
+      def to_json(options = nil)
+        as_json(options).to_json
+      end
+    end
+  end
+end

data/lib/fulfil_api/resource.rb

@@ -5,7 +5,9 @@ module FulfilApi
   #   endpoints of Fulfil.
   class Resource
     include AttributeAssignable
+    include Comparable
     include Persistable
+    include Serializable
 
     # The model name is required to be able to build the API endpoint to
     #   perform the search/read/count HTTP requests.

data/lib/fulfil_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FulfilApi
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fulfil_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2024-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -95,8 +95,10 @@ files:
 - lib/fulfil_api/resource.rb
 - lib/fulfil_api/resource/attribute_assignable.rb
 - lib/fulfil_api/resource/attribute_type.rb
+- lib/fulfil_api/resource/comparable.rb
 - lib/fulfil_api/resource/errors.rb
 - lib/fulfil_api/resource/persistable.rb
+- lib/fulfil_api/resource/serializable.rb
 - lib/fulfil_api/test_helper.rb
 - lib/fulfil_api/version.rb
 - sig/fulfil_api.rbs