newgistics 2.1.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 531b711f00ce955b4cd22a6b2e9e9f33faa50506
-  data.tar.gz: 611c887de7ba5cdb4989857218b7bfbfdbf82a01
+  metadata.gz: a7102bd462733a83d1d2feb94572a2e21923b6ba
+  data.tar.gz: 2cc9355b5df9e998f7bf45925de7fe1c5951831b
 SHA512:
-  metadata.gz: 566e377c9306a88b8dd218afc100ccfadaa64d4cb4bb467c0c5e12f927dc815764c9786af3393e8bc916e6cb23e128b169835a3d8586dc10768160858280baf7
-  data.tar.gz: 7e131edb758105bae9051d639c52bf56d84011b7da67f0765522d03ad0dd98dd0e755e8cbc59ceb39207ded8e946e7e8e30caf16f169b760842ab616f75b2e60
+  metadata.gz: 0b4882f4bfab7b5233f739c3a031b9a7e29ffdaed5af1f095b0e42041ceeacc2817743e59af3c0f8bd0676d6f3b23137d3bd28219ded0d0af5edf6ba6fd1a38c
+  data.tar.gz: 0cd0c053dbbb127cbe95d6ae16b58af81e7593285bf6a240392c3d487c41dc53e18f1846dfa8b555ce0ff3f44b416ebdd56df25ae3e44ec267d8fb0086c15442

data/README.md

@@ -1,5 +1,5 @@
-[![Code Climate](https://codeclimate.com/repos/5991e52637216b02640002d4/badges/9e19d346f6da0db0783c/gpa.svg)](https://codeclimate.com/repos/5991e52637216b02640002d4/feed)
-[![Test Coverage](https://codeclimate.com/repos/5991e52637216b02640002d4/badges/9e19d346f6da0db0783c/coverage.svg)](https://codeclimate.com/repos/5991e52637216b02640002d4/coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ed9b1c5905ae5547414e/maintainability)](https://codeclimate.com/github/rocketsofawesome/newgistics-ruby/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ed9b1c5905ae5547414e/test_coverage)](https://codeclimate.com/github/rocketsofawesome/newgistics-ruby/test_coverage)
 [ ![Codeship Status for rocketsofawesome/newgistics-ruby](https://app.codeship.com/projects/63cb9a70-68b6-0135-a28b-5ec5668067cc/status?branch=master)](https://app.codeship.com/projects/241459)
 # Newgistics
 
@@ -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

@@ -15,6 +15,8 @@ require "newgistics/model"
 require "newgistics/customer"
 require "newgistics/item"
 require "newgistics/order"
+require "newgistics/package_item"
+require "newgistics/package"
 require "newgistics/product"
 require "newgistics/return"
 require "newgistics/inbound_return"
@@ -23,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"
@@ -31,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/item.rb

@@ -5,6 +5,9 @@ module Newgistics
     attribute :id, String
 
     attribute :sku, String
+    attribute :upc, String
+    attribute :description, String
+    attribute :lot, String
     attribute :qty, Integer
     attribute :is_gift_wrapped, Boolean
     attribute :custom_fields, Hash

data/lib/newgistics/order.rb

@@ -18,6 +18,8 @@ module Newgistics
     attribute :custom_fields, Hash
     attribute :allow_duplicate, Boolean
     attribute :items, Array[Item]
+    attribute :reference_1, String
+    attribute :reference_2, String
 
     attribute :errors, Array[String], default: []
     attribute :warnings, Array[String], default: []

data/lib/newgistics/package.rb

@@ -0,0 +1,13 @@
+module Newgistics
+  class Package
+    include Newgistics::Model
+
+    attribute :tracking_number, String
+    attribute :weight, Float
+    attribute :billable_weight, Float
+    attribute :height, Float
+    attribute :width, Float
+    attribute :depth, Float
+    attribute :items, Array[PackageItem]
+  end
+end

data/lib/newgistics/package_item.rb

@@ -0,0 +1,12 @@
+module Newgistics
+  class PackageItem
+    include Newgistics::Model
+
+    attribute :sku, String
+    attribute :qty, Integer
+
+    def self.element_selector
+      'Item'
+    end
+  end
+end

data/lib/newgistics/requests/post_shipment.rb

@@ -54,6 +54,8 @@ module Newgistics
           xml.GiftMessage order.gift_message
           xml.HoldForAllInventory order.hold_for_all_inventory
           xml.AllowDuplicate order.allow_duplicate
+          xml.Reference1 order.reference_1
+          xml.Reference2 order.reference_2
 
           order_date_xml(order, xml)
           customer_xml(order.customer, xml)

data/lib/newgistics/requests/update_shipment_address.rb

@@ -0,0 +1,74 @@
+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_field(xml, 'FirstName', :first_name)
+          xml_field(xml, 'LastName', :last_name)
+          xml_field(xml, 'Company', :company)
+          xml_field(xml, 'Address1', :address1)
+          xml_field(xml, 'Address2', :address2)
+          xml_field(xml, 'City', :city)
+          xml_field(xml, 'State', :state)
+          xml_field(xml, 'PostalCode', :postal_code)
+          xml_field(xml, 'Country', :country)
+          xml_field(xml, 'Email', :email)
+          xml_field(xml, 'Phone', :phone)
+          xml_field(xml, 'Fax', :fax)
+          xml_field(xml, 'IsResidential', :is_residential)
+          xml_field(xml, 'Status', :status)
+          xml_field(xml, 'StatusNotes', :status_notes)
+          xml_field(xml, 'ShipMethod', :ship_method)
+        end
+      end
+
+      def xml_field(xml, xml_node, attribute_name)
+        value = shipment_address_update.send(attribute_name)
+        xml.send(xml_node, value) unless value.nil?
+      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.rb

@@ -35,6 +35,7 @@ module Newgistics
     attribute :weight, Float
     attribute :postage, Float
     attribute :fees, Array[Fee]
+    attribute :packages, Array[Package]
 
     def backordered?
       shipment_status == 'BACKORDER'

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.1.0"
+  VERSION = "2.5.0".freeze
 end

data/newgistics.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov", "~> 0.17.1"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "vcr", "~> 3.0.3"
   spec.add_development_dependency "timecop", "~> 0.9"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newgistics
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Manuel Martinez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-25 00:00:00.000000000 Z
+date: 2020-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -127,16 +127,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +216,8 @@ files:
 - lib/newgistics/manifest_slip.rb
 - lib/newgistics/model.rb
 - lib/newgistics/order.rb
+- lib/newgistics/package.rb
+- lib/newgistics/package_item.rb
 - lib/newgistics/product.rb
 - lib/newgistics/query.rb
 - lib/newgistics/requests/cancel_manifest.rb
@@ -224,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
@@ -232,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