newgistics 1.0.0

data/lib/newgistics/api.rb

@@ -0,0 +1,26 @@
+module Newgistics
+  class Api
+    def get(request, response_handler)
+      response = connection.get(request.path, request.body)
+      response_handler.handle(response)
+    end
+
+    def post(request, response_handler)
+      response = connection.post(request.path, request.body)
+      response_handler.handle(response)
+    end
+
+    private
+
+    def connection
+      @connection ||= Faraday.new(url: api_base_url) do |faraday|
+        faraday.response :logger, Newgistics.logger, bodies: true
+        faraday.adapter Faraday.default_adapter
+      end
+    end
+
+    def api_base_url
+      Newgistics.configuration.api_base_url
+    end
+  end
+end

data/lib/newgistics/configuration.rb

@@ -0,0 +1,23 @@
+module Newgistics
+  class Configuration
+    attr_reader :time_zone, :local_time_zone
+    attr_accessor :api_key, :api_base_url
+
+    def initialize
+      self.time_zone = "America/Denver"
+      self.local_time_zone = "UTC"
+    end
+
+    def api_base_url
+      @api_base_url ||= "https://apistaging.newgisticsfulfillment.com"
+    end
+
+    def time_zone=(name)
+      @time_zone = TimeZone.new(name)
+    end
+
+    def local_time_zone=(name)
+      @local_time_zone = TimeZone.new(name)
+    end
+  end
+end

data/lib/newgistics/customer.rb

@@ -0,0 +1,20 @@
+module Newgistics
+  class Customer
+    include Virtus.model
+
+    attribute :company, String
+    attribute :first_name, String
+    attribute :last_name, String
+    attribute :email, String
+
+    attribute :address1, String
+    attribute :address2, String
+    attribute :city, String
+    attribute :state, String
+    attribute :country, String
+    attribute :phone, String
+    attribute :fax, String
+    attribute :zip, String
+    attribute :is_residential, Boolean
+  end
+end

data/lib/newgistics/default_logger.rb

@@ -0,0 +1,11 @@
+require 'logger'
+
+module Newgistics
+  class DefaultLogger
+    def self.build
+      Logger.new(STDOUT).tap do |logger|
+        logger.level = Logger::INFO
+      end
+    end
+  end
+end

data/lib/newgistics/errors.rb

@@ -0,0 +1,4 @@
+module Newgistics
+  class QueryError < StandardError
+  end
+end

data/lib/newgistics/fee.rb

@@ -0,0 +1,9 @@
+module Newgistics
+  class Fee
+    include Virtus.model
+
+    attribute :type, String
+    attribute :amount, Float
+    attribute :notes, String
+  end
+end

data/lib/newgistics/inbound_return.rb

@@ -0,0 +1,29 @@
+module Newgistics
+  class InboundReturn
+    include Virtus.model
+
+    attribute :id, String
+    attribute :shipment_id, String
+    attribute :order_id, String
+    attribute :rma, String
+    attribute :comments, String
+    attribute :items, Array[Item]
+
+    attribute :errors, Array[String], default: []
+    attribute :warnings, Array[String], default: []
+
+    def self.where(conditions)
+      Query.build(
+        endpoint: '/inbound_returns.aspx',
+        element_selector: 'InboundReturns InboundReturn',
+        model_class: self
+      ).where(conditions)
+    end
+
+    def save
+      Requests::PostInboundReturn.new(self).perform
+
+      errors.empty?
+    end
+  end
+end

data/lib/newgistics/inventory.rb

@@ -0,0 +1,22 @@
+module Newgistics
+  class Inventory
+    include Virtus.model
+
+    attribute :manifest_id, String
+    attribute :manifest_po, String
+    attribute :shipment_id, String
+    attribute :order_id, String
+    attribute :timestamp, Timestamp
+    attribute :sku, String
+    attribute :quantity, Integer
+    attribute :notes, String
+
+    def self.where(conditions)
+      Query.build(
+        endpoint: '/inventory_details.aspx',
+        element_selector: 'inventories inventory',
+        model_class: self
+      ).where(conditions)
+    end
+  end
+end

data/lib/newgistics/item.rb

@@ -0,0 +1,19 @@
+module Newgistics
+  class Item
+    include Virtus.model
+
+    attribute :id, String
+
+    attribute :sku, String
+    attribute :qty, Integer
+    attribute :is_gift_wrapped, Boolean
+    attribute :custom_fields, Hash
+
+    attribute :qty_returned, Integer
+    attribute :return_reason, String
+    attribute :qty_returned_to_stock, Integer
+    attribute :return_timestamp, Timestamp
+
+    attribute :reason, String
+  end
+end

data/lib/newgistics/order.rb

@@ -0,0 +1,32 @@
+module Newgistics
+  class Order
+    include Virtus.model
+
+    attribute :id, String
+    attribute :warehouse_id, String
+    attribute :customer, Customer
+    attribute :drop_ship_info, Hash
+    attribute :order_date, Date
+    attribute :ship_method, String
+    attribute :info_line, String
+    attribute :requires_signature, Boolean
+    attribute :is_insured, Boolean
+    attribute :insured_value, Float
+    attribute :add_gift_wrap, Boolean
+    attribute :gift_message, String
+    attribute :hold_for_all_inventory, Boolean
+    attribute :custom_fields, Hash
+    attribute :allow_duplicate, Boolean
+    attribute :items, Array[Item]
+
+    attribute :errors, Array[String], default: []
+    attribute :warnings, Array[String], default: []
+    attribute :shipment_id, String
+
+    def save
+      Requests::PostShipment.new(self).perform
+
+      errors.empty?
+    end
+  end
+end

data/lib/newgistics/product.rb

@@ -0,0 +1,30 @@
+module Newgistics
+  class Product
+    include Virtus.model
+
+    attribute :id, String
+    attribute :sku, String
+
+    attribute :putaway_quantity, Integer
+    attribute :quarantine_quantity, Integer
+    attribute :damaged_quantity, Integer
+    attribute :expired_quantity, Integer
+    attribute :recalled_quantity, Integer
+    attribute :current_quantity, Integer
+    attribute :kitting_quantity, Integer
+    attribute :pending_quantity, Integer
+    attribute :available_quantity, Integer
+
+    def self.all
+      where({}).all
+    end
+
+    def self.where(conditions)
+      Query.build(
+        endpoint: '/inventory.aspx',
+        element_selector: 'products product',
+        model_class: self
+      ).where(conditions)
+    end
+  end
+end

data/lib/newgistics/query.rb

@@ -0,0 +1,43 @@
+module Newgistics
+  class Query
+    include Enumerable
+
+    attr_reader :request, :response_handler, :conditions
+
+    def initialize(request, response_handler)
+      @request = request
+      @response_handler = response_handler
+      @conditions = {}
+    end
+
+    def self.build(endpoint:, element_selector:, model_class:)
+      request = Requests::Search.new(endpoint)
+      response_handler = ResponseHandlers::Search.new(
+        element_selector: element_selector,
+        model_class: model_class
+      )
+
+      new(request, response_handler)
+    end
+
+    def where(conditions)
+      @conditions.merge!(conditions)
+      self
+    end
+
+    def all
+      results.to_a
+    end
+
+    def each
+      results.each { |result| yield(result) }
+    end
+
+    private
+
+    def results
+      request.params = conditions
+      Newgistics.api.get(request, response_handler)
+    end
+  end
+end

data/lib/newgistics/requests/cancel_shipment.rb

@@ -0,0 +1,70 @@
+module Newgistics
+  module Requests
+    class CancelShipment
+      attr_reader :shipment_cancellation, :response_handler
+
+      def initialize(shipment_cancellation, response_handler: nil)
+        @shipment_cancellation = shipment_cancellation
+        @response_handler = response_handler || default_response_handler
+      end
+
+      def path
+        "/cancel_shipment.aspx?#{URI.encode_www_form(mandatory_params.merge(optional_params))}"
+      end
+
+      def body
+        xml_builder.to_xml
+      end
+
+      def perform
+        Newgistics.api.post(self, response_handler)
+      end
+
+      private
+
+      def default_response_handler
+        ResponseHandlers::CancelShipment.new(shipment_cancellation)
+      end
+
+      def xml_builder
+        Nokogiri::XML::Builder.new do |xml|
+          shipment_cancellation_xml(xml)
+        end
+      end
+
+      def shipment_cancellation_xml(xml)
+        xml.cancelShipment(mandatory_params) do
+          cancel_if_in_process(xml)
+          cancel_if_backorder(xml)
+        end
+      end
+
+      def api_key
+        Newgistics.configuration.api_key
+      end
+
+      def mandatory_params
+         {
+          apiKey: api_key,
+          shipmentID: shipment_cancellation.shipment_id,
+          orderID: shipment_cancellation.order_id
+        }.reject { |_k, v| v.nil? || v.empty? }
+      end
+
+      def cancel_if_in_process(xml)
+        xml.cancelIfInProcess shipment_cancellation.cancel_if_in_process
+      end
+
+      def cancel_if_backorder(xml)
+        xml.cancelIfBackorder shipment_cancellation.cancel_if_backorder
+      end
+
+      def optional_params
+        {
+          cancelIfInProcess: shipment_cancellation.cancel_if_in_process,
+          cancelIfBackorder: shipment_cancellation.cancel_if_backorder
+        }.reject { |_k, v| v.nil? }
+      end
+    end
+  end
+end

data/lib/newgistics/requests/post_inbound_return.rb

@@ -0,0 +1,76 @@
+module Newgistics
+  module Requests
+    class PostInboundReturn
+      attr_reader :inbound_return, :response_handler
+
+      def initialize(inbound_return, response_handler: nil)
+        @inbound_return = inbound_return
+        @response_handler = response_handler || default_response_handler
+      end
+
+      def path
+        '/post_inbound_returns.aspx'
+      end
+
+      def body
+        xml_builder.to_xml
+      end
+
+      def perform
+        Newgistics.api.post(self, response_handler)
+      end
+
+      private
+
+      def default_response_handler
+        ResponseHandlers::PostInboundReturn.new(inbound_return)
+      end
+
+      def xml_builder
+        Nokogiri::XML::Builder.new do |xml|
+          returns_xml(xml)
+        end
+      end
+
+      def returns_xml(xml)
+        xml.Returns(apiKey: api_key) do
+          return_xml(inbound_return, xml)
+        end
+      end
+
+      def api_key
+        Newgistics.configuration.api_key
+      end
+
+      def return_xml(inbound_return, xml)
+        xml.Return(return_attributes(inbound_return)) do
+          xml.RMA inbound_return.rma
+          xml.Comments inbound_return.comments
+
+          items_xml(inbound_return.items, xml)
+        end
+      end
+
+      def return_attributes(inbound_return)
+        {
+          id: inbound_return.shipment_id,
+          orderID: inbound_return.order_id
+        }.reject { |_k, v| v.nil? || v.empty? }
+      end
+
+      def items_xml(items, xml)
+        xml.Items 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
+          xml.Reason item.reason
+        end
+      end
+    end
+  end
+end

data/lib/newgistics/requests/post_shipment.rb

@@ -0,0 +1,121 @@
+module Newgistics
+  module Requests
+    class PostShipment
+      attr_reader :order, :response_handler
+
+      def initialize(order, response_handler: nil)
+        @order = order
+        @response_handler = response_handler || default_response_handler
+      end
+
+      def path
+        '/post_shipments.aspx'
+      end
+
+      def body
+        xml_builder.to_xml
+      end
+
+      def perform
+        Newgistics.api.post(self, response_handler)
+      end
+
+      private
+
+      def default_response_handler
+        ResponseHandlers::PostShipment.new(order)
+      end
+
+      def xml_builder
+        Nokogiri::XML::Builder.new do |xml|
+          orders_xml(xml)
+        end
+      end
+
+      def orders_xml(xml)
+        xml.Orders(apiKey: api_key) do
+          order_xml(order, xml)
+        end
+      end
+
+      def api_key
+        Newgistics.configuration.api_key
+      end
+
+      def order_xml(order, xml)
+        xml.Order(orderID: order.id) do
+          xml.Warehouse(warehouseid: order.warehouse_id)
+          xml.ShipMethod order.ship_method
+          xml.InfoLine order.info_line
+          xml.RequiresSignature order.requires_signature
+          xml.IsInsured order.is_insured
+          xml.InsuredValue order.insured_value
+          xml.AddGiftWrap order.add_gift_wrap
+          xml.GiftMessage order.gift_message
+          xml.HoldForAllInventory order.hold_for_all_inventory
+          xml.AllowDuplicate order.allow_duplicate
+
+          order_date_xml(order, xml)
+          customer_xml(order.customer, xml)
+          drop_ship_info_xml(order, xml)
+          custom_fields_xml(order, xml)
+          items_xml(order.items, xml)
+        end
+      end
+
+      def order_date_xml(order, xml)
+        unless order.order_date.nil?
+          xml.OrderDate order.order_date.strftime('%m/%d/%Y')
+        end
+      end
+
+      def drop_ship_info_xml(object, xml)
+        xml.DropShipInfo do
+          object.drop_ship_info.each do |key, value|
+            xml.send StringHelper.camelize(key), value
+          end
+        end
+      end
+
+      def custom_fields_xml(object, xml)
+        xml.CustomFields do
+          object.custom_fields.each do |key, value|
+            xml.send StringHelper.camelize(key), value
+          end
+        end
+      end
+
+      def items_xml(items, xml)
+        xml.Items 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
+          xml.IsGiftWrapped item.is_gift_wrapped
+          custom_fields_xml(item, xml)
+        end
+      end
+
+      def customer_xml(customer, xml)
+        xml.CustomerInfo do
+          xml.Company customer.company
+          xml.FirstName customer.first_name
+          xml.LastName customer.last_name
+          xml.Address1 customer.address1
+          xml.Address2 customer.address2
+          xml.City customer.city
+          xml.State customer.state
+          xml.Zip customer.zip
+          xml.Country customer.country
+          xml.Email customer.email
+          xml.Phone customer.phone
+          xml.IsResidential customer.is_residential
+        end
+      end
+    end
+  end
+end