newgistics 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4bcf5101a15db9de29e852df07c6561d08858ae
-  data.tar.gz: 7f608f2476a8d3cf2bd9ee34122cfb5ea1c1f757
+  metadata.gz: 9e4beb6b736d1470b531b46cac3356b06405e5bd
+  data.tar.gz: c6743453796386f18b6a7f1b35472e67f491190f
 SHA512:
-  metadata.gz: e7b56a167e8451fdf7c0cb5b5a631f8c62d485fc83c9036e07826c9d8a411531db8f80ff43db72ed4aeba07357ce0cf58c34b511467ee5e3b74530a8e1ea7556
-  data.tar.gz: df095043057ee1c87513bd1e14e15604ef04f8553356beb1035b3a0e46e858c4c9626f2b234540000add8cafbceb17c9b2ceb005b22fad4f9bbfb726c9ca3455
+  metadata.gz: 6991c8ec582649313e5c5575a2644d16ea4df560208cbaec6b01218513fea8273b79c22032af7fc85156c96eba0ae98b188776f6d6e87fbebeea0a9746d2ef7e
+  data.tar.gz: 472593db28710abbafceb6bd491f38de105919eedd6e27c05586e0bce7618a775d9f9dc9cd13abb12f042bfc7ed86c08509f49d86732649cfdaca4807125ab2f

data/README.md

@@ -11,7 +11,7 @@ This Ruby gem allows you to interact with the Newgistics Fulfillment API.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'newgistics', github: 'rocketsofawesome/newgistics-ruby'
+gem 'newgistics'
 ```
 
 And then execute:
@@ -168,6 +168,20 @@ Newgistics::Inventory.
 You can use the `where` method to specify the parameters for the Search. Parameter keys will be automatically camelized when sent to
 Newgistics, for a full list of the available parameters refer to the Newgistics API documentation.
 
+### Manifests
+
+#### Creating a new Manifest in Newgistics
+
+```ruby
+manifest = Newgistics::Manifest.new(manifest_attributes)
+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
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/newgistics.rb

@@ -25,6 +25,7 @@ require "newgistics/requests/cancel_shipment"
 require "newgistics/requests/post_shipment"
 require "newgistics/requests/post_inbound_return"
 require "newgistics/requests/search"
+require "newgistics/requests/post_manifest"
 require "newgistics/requests/update_shipment_contents"
 require "newgistics/response_handlers/cancel_shipment"
 require "newgistics/response_handlers/post_shipment"
@@ -32,6 +33,9 @@ require "newgistics/response_handlers/post_inbound_return"
 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/manifest_item"
+require "newgistics/manifest"
 require "newgistics/fee"
 require "newgistics/shipment"
 require "newgistics/version"

data/lib/newgistics/manifest.rb

@@ -0,0 +1,29 @@
+module Newgistics
+  class Manifest
+    include Virtus.model
+
+    attribute :id, String
+    attribute :manifest_po, String
+    attribute :manifest_name, String
+    attribute :warehouse_id, String
+    attribute :status, String
+    attribute :ship_date, Date
+    attribute :shipped_via, String
+    attribute :tracking_no, String
+    attribute :created_date, Timestamp
+    attribute :estimated_arrival_date, Date
+    attribute :pallet_count, Integer
+    attribute :carton_count, Integer
+    attribute :weight, Float
+    attribute :notes, String
+    attribute :contents, Array[ManifestItem], default: []
+
+    attribute :errors, Array[String], default: []
+    attribute :warnings, Array[String], default: []
+
+    def save
+      Requests::PostManifest.new(self).perform
+      errors.empty?
+    end
+  end
+end

data/lib/newgistics/manifest_item.rb

@@ -0,0 +1,10 @@
+module Newgistics
+  class ManifestItem
+    include Virtus.model
+
+    attribute :sku, String
+    attribute :description, String
+    attribute :original_qty, Integer
+    attribute :received_qty, Integer
+  end
+end

data/lib/newgistics/requests/post_manifest.rb

@@ -0,0 +1,90 @@
+module Newgistics
+  module Requests
+    class PostManifest
+      attr_reader :manifest, :response_handler
+
+      def initialize(manifest, response_handler: nil)
+        @manifest = manifest
+        @response_handler = response_handler || default_response_handler
+      end
+
+      def path
+        '/post_manifests.aspx'
+      end
+
+      def body
+        xml_builder.to_xml
+      end
+
+      def perform
+        Newgistics.api.post(self, response_handler)
+      end
+
+      private
+
+      def api_key
+        Newgistics.configuration.api_key
+      end
+
+      def xml_builder
+        Nokogiri::XML::Builder.new do |xml|
+          manifests_xml(xml)
+        end
+      end
+
+      def manifests_xml(xml)
+        xml.manifests(apiKey: api_key) do
+          manifest_xml(xml)
+        end
+      end
+
+      def manifest_xml(xml)
+        xml.manifest do
+          manifest_slip_xml(xml)
+          contents_xml(xml)
+        end
+      end
+
+      def manifest_slip_xml(xml)
+        xml.manifest_slip do
+          xml.manifest_po manifest.manifest_po
+          xml.manifest_name manifest.manifest_name
+          xml.warehouse_id manifest.warehouse_id
+          xml.status manifest.status
+          xml.tracking_no manifest.tracking_no
+          xml.pallet_count manifest.pallet_count
+          xml.carton_count manifest.carton_count
+          xml.weight manifest.weight
+          xml.notes manifest.notes
+
+          date_xml(xml, :ship_date)
+          date_xml(xml, :estimated_arrival_date)
+        end
+      end
+
+      def date_xml(xml, attribute)
+        date = manifest.send(attribute)
+        xml.send(attribute, date.strftime("%m/%d/%Y")) unless date.nil?
+      end
+
+      def contents_xml(xml)
+        xml.contents do
+          manifest.contents.each { |item| item_xml(item, xml) }
+        end
+      end
+
+      def item_xml(item, xml)
+        xml.item do
+          xml.sku item.sku
+          xml.description item.description
+          xml.original_qty item.original_qty
+          xml.received_qty item.received_qty
+        end
+      end
+
+      def default_response_handler
+        ResponseHandlers::PostManifest.new(manifest)
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/post_manifest.rb

@@ -0,0 +1,23 @@
+module Newgistics
+  module ResponseHandlers
+    class PostManifest
+      attr_reader :manifest
+
+      def initialize(manifest)
+        @manifest = manifest
+      end
+
+      def handle(response)
+        PostErrors.new(manifest).handle(response)
+        handle_successful_response(response) if manifest.errors.empty?
+      end
+
+      private
+
+      def handle_successful_response(response)
+        xml = Nokogiri::XML(response.body)
+        manifest.id = xml.at_css('manifest')['id']
+      end
+    end
+  end
+end

data/lib/newgistics/version.rb

@@ -1,3 +1,3 @@
 module Newgistics
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newgistics
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Manuel Martinez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -193,7 +193,6 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".simplecov"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -211,17 +210,21 @@ files:
 - lib/newgistics/inbound_return.rb
 - lib/newgistics/inventory.rb
 - lib/newgistics/item.rb
+- lib/newgistics/manifest.rb
+- lib/newgistics/manifest_item.rb
 - lib/newgistics/order.rb
 - lib/newgistics/product.rb
 - lib/newgistics/query.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_shipment.rb
 - lib/newgistics/response_handlers/post_errors.rb
 - lib/newgistics/response_handlers/post_inbound_return.rb
+- 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_contents.rb

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.1
-before_install: gem install bundler -v 1.15.3