newgistics 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64dcab77c965fb14c316ac1c00dc5ac9fac14824
-  data.tar.gz: 6dc6b36a937c9cb77c8cb62b564d5600ae3f6e28
+  metadata.gz: 531b711f00ce955b4cd22a6b2e9e9f33faa50506
+  data.tar.gz: 611c887de7ba5cdb4989857218b7bfbfdbf82a01
 SHA512:
-  metadata.gz: 4aed4d616111d0261f497d74f0f9d1edc3f333069670b896c60ff1afaf0d4b9a74172fedb335af6676fd8617529c7c087fa6d9abb39f32dde00ba2a8004b946c
-  data.tar.gz: a4480045ea1b18c1915e929996e39df8c3b485d85ef376f8bb53db0c4e49d682590e82a073186e0f9f2e6f7c5d1ea16dd59c1c8faa0f9293f2c54821f5c781fa
+  metadata.gz: 566e377c9306a88b8dd218afc100ccfadaa64d4cb4bb467c0c5e12f927dc815764c9786af3393e8bc916e6cb23e128b169835a3d8586dc10768160858280baf7
+  data.tar.gz: 7e131edb758105bae9051d639c52bf56d84011b7da67f0765522d03ad0dd98dd0e755e8cbc59ceb39207ded8e946e7e8e30caf16f169b760842ab616f75b2e60

data/README.md

@@ -179,7 +179,16 @@ manifest.save
 
 `manifest_attributes` is a `Hash` containing all the attributes for the manifest, the attributes should map one-to-one to the Newgistics API spec.
 
-`manifest.save` will return `true` if the manifest is placed successfully and `false` otherwise, any errors or warnings generated when creating the manifest are available under `manifest.errors` and `manifest.warnings` respectively
+`manifest.save` will return `true` if the manifest is placed successfully and `false` otherwise, any errors or warnings generated when creating the manifest are available under `manifest.errors` and `manifest.warnings` respectively.
+
+#### Canceling an existing Manifest in Newgistics
+
+```ruby
+manifest = Newgistics::Manifest.new(id: '123456')
+manifest.cancel
+```
+
+`manifest.cancel` will return `true` if the manifest is canceled successfully and `false` otherwise, any errors or warnings generated when cancelling the manifest are available under `manifest.errors` and `manifest.warnings` respectively. The cancel operation only requires the manifest to have an `id`, while other attributes can be set on the `manifest` object, they aren't required for cancelling it.
 
 
 ## Development

data/lib/newgistics.rb

@@ -30,6 +30,7 @@ require "newgistics/requests/post_shipment"
 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_contents"
 require "newgistics/response_handlers/cancel_shipment"
 require "newgistics/response_handlers/post_shipment"
@@ -38,6 +39,7 @@ require "newgistics/response_handlers/post_errors"
 require "newgistics/response_handlers/search"
 require "newgistics/response_handlers/update_shipment_contents"
 require "newgistics/response_handlers/post_manifest"
+require "newgistics/response_handlers/cancel_manifest"
 require "newgistics/manifest_item"
 require "newgistics/manifest_slip"
 require "newgistics/manifest"

data/lib/newgistics/manifest.rb

@@ -9,12 +9,19 @@ module Newgistics
     attribute :warnings, Array[String], default: []
 
     def id
-      manifest_slip&.manifest_id
+      read_slip_attribute(:manifest_id)
     end
 
     def id=(id)
-      self.manifest_slip ||= ManifestSlip.new
-      manifest_slip.manifest_id = id
+      write_slip_attribute(:manifest_id, id)
+    end
+
+    def status
+      read_slip_attribute(:status)
+    end
+
+    def status=(status)
+      write_slip_attribute(:status, status)
     end
 
     def save
@@ -22,6 +29,11 @@ module Newgistics
       errors.empty?
     end
 
+    def cancel
+      Requests::CancelManifest.new(self).perform
+      errors.empty?
+    end
+
     def self.where(conditions)
       Query.build(
         endpoint: '/manifests.aspx',
@@ -32,5 +44,16 @@ module Newgistics
     def self.element_selector
       'manifest'
     end
+
+    private
+
+    def read_slip_attribute(attribute)
+      manifest_slip&.send(attribute)
+    end
+
+    def write_slip_attribute(attribute, value)
+      self.manifest_slip ||= ManifestSlip.new
+      manifest_slip.send("#{attribute}=", value)
+    end
   end
 end

data/lib/newgistics/requests/cancel_manifest.rb

@@ -0,0 +1,30 @@
+module Newgistics
+  module Requests
+    class CancelManifest
+      attr_reader :manifest
+
+      def initialize(manifest, response_handler: nil)
+        @manifest = manifest
+        @response_handler = response_handler || default_response_handler
+      end
+
+      def path
+        '/cancel_manifest.aspx'
+      end
+
+      def body
+        { manifestId: manifest.id, key: Newgistics.configuration.api_key }
+      end
+
+      def perform
+        Newgistics.api.get(self, @response_handler)
+      end
+
+      private
+
+      def default_response_handler
+        ResponseHandlers::CancelManifest.new(manifest)
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/cancel_manifest.rb

@@ -0,0 +1,16 @@
+module Newgistics
+  module ResponseHandlers
+    class CancelManifest
+      attr_reader :manifest
+
+      def initialize(manifest)
+        @manifest = manifest
+      end
+
+      def handle(response)
+        PostErrors.new(manifest).handle(response)
+        manifest.status = 'CANCELED' if manifest.errors.empty?
+      end
+    end
+  end
+end

data/lib/newgistics/version.rb

@@ -1,3 +1,3 @@
 module Newgistics
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newgistics
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Manuel Martinez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -218,12 +218,14 @@ files:
 - lib/newgistics/order.rb
 - lib/newgistics/product.rb
 - lib/newgistics/query.rb
+- lib/newgistics/requests/cancel_manifest.rb
 - lib/newgistics/requests/cancel_shipment.rb
 - lib/newgistics/requests/post_inbound_return.rb
 - lib/newgistics/requests/post_manifest.rb
 - lib/newgistics/requests/post_shipment.rb
 - lib/newgistics/requests/search.rb
 - lib/newgistics/requests/update_shipment_contents.rb
+- lib/newgistics/response_handlers/cancel_manifest.rb
 - lib/newgistics/response_handlers/cancel_shipment.rb
 - lib/newgistics/response_handlers/post_errors.rb
 - lib/newgistics/response_handlers/post_inbound_return.rb