newgistics 1.0.0

data/lib/newgistics/requests/search.rb

@@ -0,0 +1,21 @@
+module Newgistics
+  module Requests
+    class Search
+      attr_reader :path, :params
+
+      def initialize(path)
+        @path = path
+      end
+
+      def params=(params)
+        @params = params.merge(key: Newgistics.configuration.api_key)
+      end
+
+      def body
+        params.
+          map { |k,v| [StringHelper.camelize(k, upcase_first: false), v] }.
+          to_h
+      end
+    end
+  end
+end

data/lib/newgistics/requests/update_shipment_contents.rb

@@ -0,0 +1,74 @@
+module Newgistics
+  module Requests
+    class UpdateShipmentContents
+      attr_reader :shipment_update, :response_handler
+
+      def initialize(shipment_update, response_handler: nil)
+        @shipment_update = shipment_update
+        @response_handler = response_handler || default_response_handler
+      end
+
+      def path
+        '/update_shipment_contents.aspx'
+      end
+
+      def body
+        xml_builder.to_xml
+      end
+
+      def perform
+        Newgistics.api.post(self, response_handler)
+      end
+
+      private
+
+      def default_response_handler
+        ResponseHandlers::UpdateShipmentContents.new(shipment_update)
+      end
+
+      def xml_builder
+        Nokogiri::XML::Builder.new do |xml|
+          shipment_update_xml(xml)
+        end
+      end
+
+      def shipment_update_xml(xml)
+        xml.Shipment(shipment_update_attributes) do
+          add_items_xml(shipment_update.add_items, xml)
+          remove_items_xml(shipment_update.remove_items, xml)
+        end
+      end
+
+      def api_key
+        Newgistics.configuration.api_key
+      end
+
+      def shipment_update_attributes
+        {
+          apiKey: api_key,
+          id: shipment_update.id,
+          orderID: shipment_update.order_id
+        }.reject { |_k, v| v.nil? || v.empty? }
+      end
+
+      def add_items_xml(items, xml)
+        xml.AddItems do
+          items.each { |item| item_xml(item, xml) }
+        end
+      end
+
+      def remove_items_xml(items, xml)
+        xml.RemoveItems do
+          items.each { |item| item_xml(item, xml) }
+        end
+      end
+
+      def item_xml(item, xml)
+        xml.Item do
+          xml.SKU item.sku
+          xml.Qty item.qty
+        end
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/cancel_shipment.rb

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

data/lib/newgistics/response_handlers/post_errors.rb

@@ -0,0 +1,40 @@
+module Newgistics
+  module ResponseHandlers
+    class PostErrors
+      attr_reader :model
+
+      def initialize(model)
+        @model = model
+      end
+
+      def handle(response)
+        if response.success?
+          handle_successful_response(response)
+        else
+          handle_failed_response(response)
+        end
+      end
+
+      private
+
+      def handle_successful_response(response)
+        xml = Nokogiri::XML(response.body)
+        model.errors = error_nodes(xml).map(&:text)
+        model.warnings = warning_nodes(xml).map(&:text)
+      end
+
+      def handle_failed_response(response)
+        message = "API Error: #{response.status}"
+        model.errors << message
+      end
+
+      def error_nodes(xml)
+        xml.css('errors error') + xml.css('Errors Error')
+      end
+
+      def warning_nodes(xml)
+        xml.css('warnings warning') + xml.css('Warnings warning')
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/post_inbound_return.rb

@@ -0,0 +1,25 @@
+module Newgistics
+  module ResponseHandlers
+    class PostInboundReturn
+      attr_reader :inbound_return
+
+      def initialize(inbound_return)
+        @inbound_return = inbound_return
+      end
+
+      def handle(response)
+        PostErrors.new(inbound_return).handle(response)
+        if inbound_return.errors.empty?
+          handle_successful_response(response)
+        end
+      end
+
+      private
+
+      def handle_successful_response(response)
+        xml = Nokogiri::XML(response.body)
+        inbound_return.id = xml.css('Return').first['ID']
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/post_shipment.rb

@@ -0,0 +1,25 @@
+module Newgistics
+  module ResponseHandlers
+    class PostShipment
+      attr_reader :order
+
+      def initialize(order)
+        @order = order
+      end
+
+      def handle(response)
+        PostErrors.new(order).handle(response)
+        if order.errors.empty?
+          handle_successful_response(response)
+        end
+      end
+
+      private
+
+      def handle_successful_response(response)
+        xml = Nokogiri::XML(response.body)
+        order.shipment_id = xml.css('shipment').first['id']
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/search.rb

@@ -0,0 +1,57 @@
+module Newgistics
+  module ResponseHandlers
+    class Search
+      attr_reader :element_selector, :model_class
+
+      def initialize(element_selector:, model_class:)
+        @element_selector = element_selector
+        @model_class = model_class
+      end
+
+      def handle(response)
+        if response.success?
+          handle_successful_response(response)
+        else
+          handle_failed_response(response)
+        end
+      end
+
+      private
+
+      def handle_successful_response(response)
+        xml = Nokogiri::XML(response.body)
+        errors = error_nodes(xml).map(&:text)
+
+        if errors.empty?
+          build_models(xml)
+        else
+          raise_error(errors.join(', '))
+        end
+      end
+
+      def error_nodes(xml)
+        xml.css('errors error') + xml.css('Errors Error')
+      end
+
+      def build_models(xml)
+        xml.css(element_selector).map do |model_xml|
+          build_model(model_xml)
+        end
+      end
+
+      def build_model(model_xml)
+        model_class.new.tap do |model|
+          XmlMarshaller.new.assign_attributes(model, model_xml)
+        end
+      end
+
+      def handle_failed_response(response)
+        raise_error "API Error: #{response.status}"
+      end
+
+      def raise_error(message)
+        raise QueryError.new(message)
+      end
+    end
+  end
+end

data/lib/newgistics/response_handlers/update_shipment_contents.rb

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

data/lib/newgistics/return.rb

@@ -0,0 +1,40 @@
+module Newgistics
+  class Return
+    include Virtus.model
+
+    attribute :warehouse_id, String
+    attribute :shipment_id, String
+    attribute :order_id, String
+
+    attribute :status, String
+    attribute :name, String
+    attribute :company, 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 :carrier, String
+    attribute :tracking_number, String
+    attribute :postage_due, Float
+    attribute :rma_present, Boolean
+    attribute :rma_number, String
+    attribute :reason, String
+    attribute :condition, String
+    attribute :notes, String
+    attribute :is_archived, Boolean
+    attribute :timestamp, Timestamp
+    attribute :items, Array[Item]
+
+    def self.where(conditions)
+      Query.build(
+        endpoint: '/returns.aspx',
+        element_selector: 'Returns Return',
+        model_class: self
+      ).where(conditions)
+    end
+  end
+end

data/lib/newgistics/shipment.rb

@@ -0,0 +1,79 @@
+module Newgistics
+  class Shipment
+    include Virtus.model
+
+    attribute :id, String
+    attribute :client_name, String
+    attribute :order_id, String
+    attribute :purchase_order, String
+    attribute :name, String
+    attribute :last_name, String
+    attribute :first_name, String
+    attribute :company, 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 :order_timestamp, Timestamp
+    attribute :received_timestamp, Timestamp
+    attribute :shipment_status, String
+    attribute :order_type, String
+    attribute :shipped_date, Timestamp
+    attribute :expected_delivery_date, Timestamp
+    attribute :delivered_timestamp, Timestamp
+    attribute :warehouse, Warehouse
+    attribute :ship_method, String
+    attribute :ship_method_code, String
+    attribute :tracking, String
+    attribute :tracking_url, String
+    attribute :items, Array[Item]
+    attribute :custom_fields, Hash
+    attribute :weight, Float
+    attribute :postage, Float
+    attribute :fees, Array[Fee]
+
+    def backordered?
+      shipment_status == 'BACKORDER'
+    end
+
+    def canceled?
+      shipment_status == 'CANCELED'
+    end
+
+    def on_hold?
+      %w(ONHOLD BADSKUHOLD BADADDRESS CNFHOLD INVHOLD).include? shipment_status
+    end
+
+    def received?
+      shipment_status == 'RECEIVED'
+    end
+
+    def printed?
+      shipment_status == 'PRINTED'
+    end
+
+    def shipped?
+      shipment_status == 'SHIPPED'
+    end
+
+    def returned?
+      shipment_status == 'RETURNED'
+    end
+
+    def verified?
+      shipment_status == 'VERIFIED'
+    end
+
+    def self.where(conditions)
+      Query.build(
+        endpoint: '/shipments.aspx',
+        element_selector: 'Shipments Shipment',
+        model_class: self
+      ).where(conditions)
+    end
+  end
+end

data/lib/newgistics/shipment_cancellation.rb

@@ -0,0 +1,24 @@
+module Newgistics
+  class ShipmentCancellation
+    include Virtus.model
+
+    attribute :shipment_id, String
+    attribute :order_id, String
+    attribute :cancel_if_in_process, Boolean
+    attribute :cancel_if_backorder, Boolean
+    attribute :success, Boolean
+
+    attribute :errors, Array[String], default: []
+    attribute :warnings, Array[String], default: []
+
+    def success?
+      !!success
+    end
+
+    def save
+      Requests::CancelShipment.new(self).perform
+
+      errors.empty? && success?
+    end
+  end
+end