fulfil_api 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc3d42e014ce01e2bca045883fcbe4b43a2f701fafd6c4252c7b06c1a9314acf
-  data.tar.gz: e6e79edf8b831515f3a706358c5884384b1f925b150443b1627ae33905ead5c6
+  metadata.gz: 31bfb876f7d82e4d803cbacf7b3628f5acb66c086188e1c56c50a37dfe6cb6f4
+  data.tar.gz: db1418268779073af449b43f71ccc47a8a4ad1db92c3261b7d22d9821f5155e0
 SHA512:
-  metadata.gz: 8694733643edbf5caa327f42fb5121b4557869358afaf916c4cdfe30e2a7854ba70b189b24d8f1886b41054f1eb36aa6ffc1bafbc4c378e0b2276fa4513aaebc
-  data.tar.gz: ef3818c50ac4a8e09660a690a7d3a97e0775111ccbd1f35825969ab66ee1cb4003e5c2aec2f2b26ef5902a0e1ad07a5fb90bda99ad4b6c94b7bff4a8b57dbcc3
+  metadata.gz: 5cdefd3a083ef390084db3a04276c49c02243b0cf39b52f9c6146657f712f68251e3087f636d789978536f106d1a59f1b3c18f014ebc2c6330501654cc94a08a
+  data.tar.gz: 0522da7f4f12ebf1753df8512a716a7c496c11d9f0740ea599ecbfc742b7ef026ca4324769d6bba5f2d37ee16ee4cb963baa5d318d46ea9020538c390fe98e02

data/lib/fulfil_api/configuration.rb

@@ -16,8 +16,6 @@ module FulfilApi
     # @param options [Hash, nil] An optional list of configuration options.
     #   Each key in the hash should correspond to a configuration attribute.
     def initialize(options = {})
-      @mutex = Mutex.new
-
       # Assigns the optional configuration options
       options.each_pair do |key, value|
         send(:"#{key}=", value) if respond_to?(:"#{key}=")
@@ -27,25 +25,6 @@ module FulfilApi
       set_default_options
     end
 
-    # Provides thread-safe access to missing methods, allowing dynamic handling of configuration options.
-    #
-    # @param method [Symbol] The method name.
-    # @param args [Array] The arguments passed to the method.
-    # @param block [Proc] An optional block passed to the method.
-    # @return [void]
-    def method_missing(method, *args, &block)
-      @mutex.synchronize { super }
-    end
-
-    # Ensures that the object responds correctly to methods handled by method_missing.
-    #
-    # @param method [Symbol] The method name.
-    # @param include_private [Boolean] Whether to include private methods.
-    # @return [Boolean] Whether the object responds to the method.
-    def respond_to_missing?(method, include_private = false)
-      @mutex.synchronize { super }
-    end
-
     private
 
     # Sets the default options for the gem configuration.
@@ -61,13 +40,12 @@ module FulfilApi
   end
 
   @configuration = Configuration.new
-  @configuration_mutex = Mutex.new
 
   # Provides thread-safe access to the gem's configuration.
   #
   # @return [Fulfil::Configuration] The current configuration object.
   def self.configuration
-    @configuration_mutex.synchronize { @configuration }
+    Thread.current[:fulfil_api_configuration] ||= Configuration.new
   end
 
   # Allows the configuration of the gem in a thread-safe manner.
@@ -75,23 +53,25 @@ module FulfilApi
   # @yieldparam [Fulfil::Configuration] config The current configuration object.
   # @return [void]
   def self.configure
-    @configuration_mutex.synchronize { yield(@configuration) }
+    yield(configuration)
   end
 
   # Overwrites the configuration with the newly provided configuration options.
   #
   # @param options [Hash, Fulfil::Configuration] A list of configuration options for the gem.
   # @return [Fulfil::Configuration] The updated configuration object.
-  def self.configuration=(options_or_configuration)
-    @configuration_mutex.synchronize do
-      if options_or_configuration.is_a?(Hash)
-        options_or_configuration.each_pair do |key, value|
-          @configuration.send(:"#{key}=", value) if @configuration.respond_to?(:"#{key}=")
-        end
-      elsif options_or_configuration.is_a?(Configuration)
-        @configuration = options_or_configuration
+  def self.configuration=(options_or_configuration) # rubocop:disable Metrics/MethodLength
+    Thread.current[:fulfil_api_configuration] =
+      case options_or_configuration
+      when Hash
+        config = Configuration.new
+        options_or_configuration.each { |key, value| config.send(:"#{key}=", value) }
+        config
+      when Configuration
+        options_or_configuration
+      else
+        raise ArgumentError, "Expected Hash or Configuration, got #{options_or_configuration.class} instead"
       end
-    end
   end
 
   # Temporarily applies the provided configuration options within a block,
@@ -107,6 +87,6 @@ module FulfilApi
     yield
   ensure
     # Revert to the original configuration
-    self.configuration = original_configuration
+    Thread.current[:fulfil_api_configuration] = original_configuration
   end
 end

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.1"
 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.1
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2025-04-16 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