fulfil_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a26b32a0feab8bd7e697b27db519ac3945fefcd00159aa714742c40ac5abffe
-  data.tar.gz: e8e5c494d57360d1cacbbea096c6c4cac3d70d504d04f4478a5f5508db658a63
+  metadata.gz: 68821bbca5de486309740ca1fec47352555b874dc0a2428dd9dc3663df7db063
+  data.tar.gz: 3b44214cf2330b643fbe50cb2d060e8e0cdfc3f0a7720bef47d2152955199407
 SHA512:
-  metadata.gz: 1d4b7f5ca1a4bc4e8449cc3b235fd9f3b467e7977d76feaa52fa11dac18a6a34ba1ab6b4a8280183e798e45f4ddfda00e0e2d27534ca467110a3cdec203adc49
-  data.tar.gz: 63ce6d7793de383098af74f7ca3c81ef8730351d7483390f8256f2dcd5cecc5cb3385ff46e9046fe7ed51f62e66f183b3b4abbf7b11f92a8322abe1ef44eeec9
+  metadata.gz: 881c1beb39b7ccefcc45b41755f858345eaf28433d06f91249d4d221f7f82f09ff5b99cff6aef56d834a5a0bec18a2ac77aea4935ea0f4978cf4e3d0405a348d
+  data.tar.gz: 3a9645874ddc1394fbbc864c3da07432542a370e47a1a25e7117b9f0e6167d41609e61285933497c1640549b6ba0a8dd1efdf01fb1085d6d4174573444d16db2

data/lib/fulfil_api/customer_shipment.rb

@@ -10,20 +10,17 @@ module FulfilApi
       # Sets the fulfillment status of the customer shipment on hold
       #
       # @param id_or_ids [String, Integer, Array[String], Array[Integer]] The ID(s) of the customer shipment(s) to hold.
-      # @param note [String] A note to define the reason for holding. (Optional)
-      # @param hold_reason [String] An hold reason ID. (Optional)
+      # @param note [String] A note to define the reason for holding.
       # @return [Boolean] Returns true if hold successfully.
       # @raise [FulfilApi::Error] If an error occurs during holding the customer shipment.
       #
       # @example Hold a customer shipment
-      #   FulfilApi::CustomerShipment.hold(123, note: "Double booking", hold_reason: hold_reason_id)
+      #   FulfilApi::CustomerShipment.hold(123, note: "Double booking")
       #
       # @example Hold multipe customer shipments
-      #   FulfilApi::CustomerShipment.hold([123, 456], note: "Double booking", hold_reason: hold_reason_id)
-      def hold!(id_or_ids, note: nil, hold_reason: nil)
-        FulfilApi.client.put("/model/#{MODEL_NAME}/hold",
-                             body: [[*id_or_ids].flatten, { note: note, hold_reason: hold_reason }.compact_blank])
-
+      #   FulfilApi::CustomerShipment.hold([123, 456], note: "Double booking")
+      def hold!(id_or_ids, note:)
+        FulfilApi.client.put("/model/#{MODEL_NAME}/hold", body: [[*id_or_ids].flatten, note])
         true
       end
 
@@ -40,25 +37,23 @@ module FulfilApi
       #
       # @example Unhold a customer shipment
       #   FulfilApi::CustomerShipment.unhold([123, 456], note: "All clear")
-      def unhold!(id_or_ids, note: nil)
-        FulfilApi.client.put("/model/#{MODEL_NAME}/unhold", body: [[*id_or_ids].flatten, { note: note }.compact_blank])
-
+      def unhold!(id_or_ids, note:)
+        FulfilApi.client.put("/model/#{MODEL_NAME}/unhold", body: [[*id_or_ids].flatten, note])
         true
       end
     end
 
     # Sets the current customer shipment on hold, rescuing any errors that occur and handling them based on error type.
     #
-    # @param note [String] A note to define the reason for holding. (Optional)
-    # @param hold_reason [String] An hold reason ID. (Optional)
+    # @param note [String] A note to define the reason for holding.
     # @return [Boolean] Returns true if hold successfully, otherwise false.
     #
     # @example Holds a customer_shipment
-    #   customer_shipment.hold(note: "Double booking", hold_reason: hold_reason_id)
-    def hold(note: nil, hold_reason: nil)
-      self.class.hold!(id, note: note, hold_reason: hold_reason)
+    #   customer_shipment.hold("Holding the shipment for 30 minutes to allow edits to the order")
+    def hold(note)
+      self.class.hold!(id, note: note)
     rescue FulfilApi::Error => e
-      handle_error(e)
+      handle_exception(e)
       false
     end
 
@@ -68,18 +63,12 @@ module FulfilApi
     # @return [Boolean] Returns true if unhold successfully, otherwise false.
     #
     # @example Unholds a customer_shipment
-    #   customer_shipment.unhold(note: "Double booking")
-    def unhold(note: nil)
+    #   customer_shipment.unhold("Ship out these items to the customer")
+    def unhold(note)
       self.class.unhold!(id, note: note)
     rescue FulfilApi::Error => e
-      handle_error(e)
+      handle_exception(e)
       false
     end
-
-    private
-
-    def handle_error(err)
-      errors.add(code: err.details[:response_status], type: :system, message: err.details[:response_body])
-    end
   end
 end

data/lib/fulfil_api/resource/persistable.rb

@@ -52,14 +52,7 @@ module FulfilApi
       def save
         save!
       rescue FulfilApi::Error => e
-        case (error = JSON.parse(e.details[:response_body]).deep_symbolize_keys!)
-        in { type: "UserError" }
-          errors.add(code: error[:code], type: :user, message: error[:message])
-        in { code: Integer, name: String, description: String }
-          errors.add(code: error[:code], type: :authorization, message: error[:description])
-        end
-
-        self
+        handle_exception(e)
       end
 
       # Saves the current resource, raising an error if it cannot be saved.

data/lib/fulfil_api/resource.rb

@@ -72,5 +72,18 @@ module FulfilApi
     private
 
     attr_reader :model_name
+
+    def handle_exception(exception) # rubocop:disable Metrics/AbcSize
+      case (error = JSON.parse(exception.details[:response_body]).deep_symbolize_keys!)
+      in { type: "UserError" }
+        errors.add(code: error[:code], type: :user, message: error[:message])
+      in { code: Integer, name: String, description: String }
+        errors.add(code: error[:code], type: :authorization, message: error[:description])
+      else
+        errors.add(code: exception.details[:response_status], type: :system, message: exception.details[:response_body])
+      end
+
+      self
+    end
   end
 end

data/lib/fulfil_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fulfil_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stefan Vermaas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport