newgistics 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c0335cf92de05483074262a2aa46718a9b233cd
-  data.tar.gz: 338ae379bbc0bad06091476890e6a8a80562f986
+  metadata.gz: b9c1f08cf89a001dd497f70997128e207d4fccc3
+  data.tar.gz: ffbf57d283b076a5fdfcd2b3859deb6e77260c48
 SHA512:
-  metadata.gz: b2e93ae697d6d3625c6f5f562e6502d1c18f78e65fd5045419bc2686acee06440ee3e7bd3f9870669e4173c0af98bd336e1a4de48a97d4b2c7c384f4c98584dc
-  data.tar.gz: 7c369439d2f000e045e38a683783490b7edf9d60f44134ed758fbae2d9a2a44a684f0b903b9954926ce16aa9029b32cc5b7b6e4a98955a749632ddb676f64e84
+  metadata.gz: ef9f20d382e4e78ffecadf41c99fd618a4c23cf9976b2b08b34c7b87fd5f27da0dc7b21b9a908a75c5737a17ca09752a9254defeb2df7bf7e3c9d152fa394ae5
+  data.tar.gz: b79656c7ab47c26c4ddb5401f8e67d5bda8fca6ddf6a2780f48e69190b4ab6ca3641d0794128c61ecadf6db22348e79149f0ca3e3e024c0533d25f05e4bc91c5

data/README.md

@@ -71,6 +71,16 @@ shipment_update.save
 
 `shipment_update.save` will return `true` if the order is updated successfully and `false` otherwise, any errors or warnings generated when updating the shipment are available under `shipment_update.errors` and `shipment_update.warnings` respectively. `shipment_update.success` or also `shipment_update.success?` will also be updated to the corresponding value.
 
+#### Updating a shipment's address in Newgistics
+```ruby
+address_update = Newgistics::ShipmentAddressUpdate.new(update_attributes)
+address_update.save
+```
+
+`update_attributes` is a `Hash` with the updates you want to perform on the shipment, for a list of available attributes you can look at the [Newgistics::ShipmentAddressUpdate model](lib/newgistics/shipment_address_update.rb)
+
+`address_update.save` will return `true` if the shipment is updated successfully and `false` otherwise, any errors or warnings generated when updating the shipment are available under `address_update.errors` and `address_update.warnings` respectively. `address_update.success` or also `address_update.success?` will also be updated to the corresponding value.
+
 #### Cancelling a shipment/order on Newgistics
 ```ruby
 shipment_cancellation = Newgistics::ShipmentCancellation.new(shipment_id: SHIPMENT_ID)

data/lib/newgistics.rb

@@ -25,6 +25,7 @@ require "newgistics/query"
 require "newgistics/errors"
 require "newgistics/string_helper"
 require "newgistics/shipment_cancellation"
+require "newgistics/shipment_address_update"
 require "newgistics/shipment_update"
 require "newgistics/warehouse"
 require "newgistics/requests/cancel_shipment"
@@ -33,12 +34,14 @@ require "newgistics/requests/post_inbound_return"
 require "newgistics/requests/search"
 require "newgistics/requests/post_manifest"
 require "newgistics/requests/cancel_manifest"
+require "newgistics/requests/update_shipment_address"
 require "newgistics/requests/update_shipment_contents"
 require "newgistics/response_handlers/cancel_shipment"
 require "newgistics/response_handlers/post_shipment"
 require "newgistics/response_handlers/post_inbound_return"
 require "newgistics/response_handlers/post_errors"
 require "newgistics/response_handlers/search"
+require "newgistics/response_handlers/update_shipment_address"
 require "newgistics/response_handlers/update_shipment_contents"
 require "newgistics/response_handlers/post_manifest"
 require "newgistics/response_handlers/cancel_manifest"

data/lib/newgistics/requests/update_shipment_address.rb

@@ -0,0 +1,69 @@
+module Newgistics
+  module Requests
+    class UpdateShipmentAddress
+      attr_reader :shipment_address_update, :response_handler
+
+      def initialize(shipment_address_update, response_handler: nil)
+        @shipment_address_update = shipment_address_update
+        @response_handler = response_handler || default_response_handler
+      end
+
+      def path
+        '/update_shipment_address.aspx'
+      end
+
+      def body
+        xml_builder.to_xml
+      end
+
+      def perform
+        Newgistics.api.post(self, response_handler)
+      end
+
+      private
+
+      def default_response_handler
+        ResponseHandlers::UpdateShipmentAddress.new(shipment_address_update)
+      end
+
+      def xml_builder
+        Nokogiri::XML::Builder.new do |xml|
+          shipment_address_update_xml(xml)
+        end
+      end
+
+      def shipment_address_update_xml(xml)
+        xml.updateShipment(shipment_address_update_attributes) do
+          xml.FirstName shipment_address_update.first_name
+          xml.LastName shipment_address_update.last_name
+          xml.Company shipment_address_update.company
+          xml.Address1 shipment_address_update.address1
+          xml.Address2 shipment_address_update.address2
+          xml.City shipment_address_update.city
+          xml.State shipment_address_update.state
+          xml.PostalCode shipment_address_update.postal_code
+          xml.Country shipment_address_update.country
+          xml.Email shipment_address_update.email
+          xml.Phone shipment_address_update.phone
+          xml.Fax shipment_address_update.fax
+          xml.IsResidential shipment_address_update.is_residential
+          xml.Status shipment_address_update.status
+          xml.StatusNotes shipment_address_update.status_notes
+          xml.ShipMethod shipment_address_update.ship_method
+        end
+      end
+
+      def api_key
+        Newgistics.configuration.api_key
+      end
+
+      def shipment_address_update_attributes
+        {
+          apiKey: api_key,
+          id: shipment_address_update.id,
+          orderID: shipment_address_update.order_id
+        }.reject { |_k, v| v.nil? || v.empty? }
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/update_shipment_address.rb

@@ -0,0 +1,25 @@
+module Newgistics
+  module ResponseHandlers
+    class UpdateShipmentAddress
+      attr_reader :shipment_address_update
+
+      def initialize(shipment_address_update)
+        @shipment_address_update = shipment_address_update
+      end
+
+      def handle(response)
+        PostErrors.new(shipment_address_update).handle(response)
+        if shipment_address_update.errors.empty?
+          handle_successful_response(response)
+        end
+      end
+
+      private
+
+      def handle_successful_response(response)
+        xml = Nokogiri::XML(response.body)
+        shipment_address_update.success = xml.at_css('success').text
+      end
+    end
+  end
+end

data/lib/newgistics/shipment_address_update.rb

@@ -0,0 +1,39 @@
+module Newgistics
+  class ShipmentAddressUpdate
+    include Newgistics::Model
+
+    attribute :id, String
+    attribute :order_id, String
+
+    attribute :company, String
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :address1, String
+    attribute :address2, String
+    attribute :city, String
+    attribute :state, String
+    attribute :postal_code, String
+    attribute :country, String
+    attribute :email, String
+    attribute :phone, String
+    attribute :fax, String
+    attribute :is_residential, Boolean
+
+    attribute :status, String
+    attribute :status_notes, String
+    attribute :ship_method, String
+
+    attribute :success, Boolean
+    attribute :errors, Array[String], default: []
+    attribute :warnings, Array[String], default: []
+
+    def success?
+      !!success
+    end
+
+    def save
+      Requests::UpdateShipmentAddress.new(self).perform
+      errors.empty? && success?
+    end
+  end
+end

data/lib/newgistics/version.rb

@@ -1,3 +1,3 @@
 module Newgistics
-  VERSION = "2.3.0"
+  VERSION = "2.4.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newgistics
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Manuel Martinez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-10 00:00:00.000000000 Z
+date: 2019-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -226,6 +226,7 @@ files:
 - lib/newgistics/requests/post_manifest.rb
 - lib/newgistics/requests/post_shipment.rb
 - lib/newgistics/requests/search.rb
+- lib/newgistics/requests/update_shipment_address.rb
 - lib/newgistics/requests/update_shipment_contents.rb
 - lib/newgistics/response_handlers/cancel_manifest.rb
 - lib/newgistics/response_handlers/cancel_shipment.rb
@@ -234,9 +235,11 @@ files:
 - lib/newgistics/response_handlers/post_manifest.rb
 - lib/newgistics/response_handlers/post_shipment.rb
 - lib/newgistics/response_handlers/search.rb
+- lib/newgistics/response_handlers/update_shipment_address.rb
 - lib/newgistics/response_handlers/update_shipment_contents.rb
 - lib/newgistics/return.rb
 - lib/newgistics/shipment.rb
+- lib/newgistics/shipment_address_update.rb
 - lib/newgistics/shipment_cancellation.rb
 - lib/newgistics/shipment_update.rb
 - lib/newgistics/string_helper.rb