friendly_shipping 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0116dbbecf450a2d319054657287b93b5df9f19
-  data.tar.gz: 9a0f816797149b9995e85f3b6b74eba010b6fd3b
+  metadata.gz: 6474cdfc41f6c366bbc23ec531346f569a820250
+  data.tar.gz: f54265c3fac066e54892c1430f6b28d7f65d027a
 SHA512:
-  metadata.gz: 42c0b1c6e67c8467ff3a92f3804239d038a080c8c8bacfde0994fef9c7d23a4c9f77a6c570db7e3424cdf4691bdb6f08f817554891ad0923e0e1a91f42d6dc65
-  data.tar.gz: 3b87784060938c7b0968565c8ade8d5733f326bfe764c300545e9fdee5ecbbe120365c405e99d9c2496c578a1ada0898a41a18173bcc366de4eb82411b8c3871
+  metadata.gz: bbc3d24cf5f1c690f13e33b5bfd3fc0857f071fb8d4ee79bea1fa08df8f93eab900b6cd233c4627022c9e1c6dcae7056ba0a3140e99882be038c6f192a46eea7
+  data.tar.gz: bf83d0948e27ad4dc2c8cbf45643d70bd7d7563986901a0bc782cc119cd3c8aac7ac3f1aec19edf86fd37541b7bf36e6467edf971fb3dd193752c9552d7d3ebf

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.6] - 2019-11-28
+
+### Changed
+- UPS Service: Add Support for voiding labels
+
 ## [0.4.5] - 2019-11-27
 
 ### Changed

data/lib/friendly_shipping/services/ups.rb

@@ -8,12 +8,14 @@ require 'friendly_shipping/services/ups/serialize_address_validation_request'
 require 'friendly_shipping/services/ups/serialize_rating_service_selection_request'
 require 'friendly_shipping/services/ups/serialize_shipment_accept_request'
 require 'friendly_shipping/services/ups/serialize_shipment_confirm_request'
+require 'friendly_shipping/services/ups/serialize_void_shipment_request'
 require 'friendly_shipping/services/ups/parse_address_validation_response'
 require 'friendly_shipping/services/ups/parse_address_classification_response'
 require 'friendly_shipping/services/ups/parse_city_state_lookup_response'
 require 'friendly_shipping/services/ups/parse_rate_response'
 require 'friendly_shipping/services/ups/parse_shipment_confirm_response'
 require 'friendly_shipping/services/ups/parse_shipment_accept_response'
+require 'friendly_shipping/services/ups/parse_void_shipment_response'
 require 'friendly_shipping/services/ups/shipping_methods'
 require 'friendly_shipping/services/ups/label_options'
 
@@ -40,6 +42,7 @@ module FriendlyShipping
         rates: '/ups.app/xml/Rate',
         ship_confirm: '/ups.app/xml/ShipConfirm',
         ship_accept: '/ups.app/xml/ShipAccept',
+        void: '/ups.app/xml/Void',
       }.freeze
 
       def initialize(key:, login:, password:, test: true, client: HttpClient.new)
@@ -165,6 +168,19 @@ module FriendlyShipping
         end
       end
 
+      def void(label, debug: false)
+        url = base_url + RESOURCES[:void]
+        void_request_xml = SerializeVoidShipmentRequest.call(label: label)
+        request = FriendlyShipping::Request.new(
+          url: url,
+          body: access_request_xml + void_request_xml,
+          debug: debug
+        )
+        client.post(request).bind do |response|
+          ParseVoidShipmentResponse.call(request: request, response: response)
+        end
+      end
+
       private
 
       def access_request_xml

data/lib/friendly_shipping/services/ups/parse_void_shipment_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'dry/monads/result'
+
+module FriendlyShipping
+  module Services
+    class Ups
+      class ParseVoidShipmentResponse
+        def self.call(request:, response:)
+          parsing_result = ParseXMLResponse.call(response.body, 'VoidShipmentResponse')
+          parsing_result.fmap do |xml|
+            FriendlyShipping::ApiResult.new(
+              xml.root.at('ResponseStatusDescription').text,
+              original_request: request,
+              original_response: response
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/services/ups/serialize_void_shipment_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module FriendlyShipping
+  module Services
+    class Ups
+      class SerializeVoidShipmentRequest
+        def self.call(label:)
+          xml_builder = Nokogiri::XML::Builder.new do |xml|
+            xml.VoidShipmentRequest do
+              xml.Request do
+                xml.RequestAction('Void')
+              end
+              xml.ShipmentIdentificationNumber(label.tracking_number)
+            end
+          end
+          xml_builder.to_xml
+        end
+      end
+    end
+  end
+end

data/lib/friendly_shipping/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FriendlyShipping
-  VERSION = "0.4.5"
+  VERSION = "0.4.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: friendly_shipping
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - Martin Meyerhoff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-28 00:00:00.000000000 Z
+date: 2019-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_uri
@@ -194,6 +194,7 @@ files:
 - lib/friendly_shipping/services/ups/parse_rate_response.rb
 - lib/friendly_shipping/services/ups/parse_shipment_accept_response.rb
 - lib/friendly_shipping/services/ups/parse_shipment_confirm_response.rb
+- lib/friendly_shipping/services/ups/parse_void_shipment_response.rb
 - lib/friendly_shipping/services/ups/parse_xml_response.rb
 - lib/friendly_shipping/services/ups/serialize_access_request.rb
 - lib/friendly_shipping/services/ups/serialize_address_snippet.rb
@@ -204,6 +205,7 @@ files:
 - lib/friendly_shipping/services/ups/serialize_shipment_accept_request.rb
 - lib/friendly_shipping/services/ups/serialize_shipment_address_snippet.rb
 - lib/friendly_shipping/services/ups/serialize_shipment_confirm_request.rb
+- lib/friendly_shipping/services/ups/serialize_void_shipment_request.rb
 - lib/friendly_shipping/services/ups/shipping_methods.rb
 - lib/friendly_shipping/services/ups_freight.rb
 - lib/friendly_shipping/services/ups_freight/generate_commodity_information.rb