newgistics 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e4beb6b736d1470b531b46cac3356b06405e5bd
-  data.tar.gz: c6743453796386f18b6a7f1b35472e67f491190f
+  metadata.gz: 71568ff5b6f4a81cfe913095bc14707e6e76867e
+  data.tar.gz: 003a16e6b4cbc982e1bf366db97590237c0f0448
 SHA512:
-  metadata.gz: 6991c8ec582649313e5c5575a2644d16ea4df560208cbaec6b01218513fea8273b79c22032af7fc85156c96eba0ae98b188776f6d6e87fbebeea0a9746d2ef7e
-  data.tar.gz: 472593db28710abbafceb6bd491f38de105919eedd6e27c05586e0bce7618a775d9f9dc9cd13abb12f042bfc7ed86c08509f49d86732649cfdaca4807125ab2f
+  metadata.gz: 45ff8b1f9cf39885b897d198bedd54a526ca81f960ef7ee4ebe7dbfab527c71f68dbbcee36510a2ba325dc3eeadb742a30db9b9c10c908cc0f263e1fa93a1ab4
+  data.tar.gz: 90c502e5be3d5458dc1687752c84085f46ece2a4f729535bbc6ef85386debae1b4707986729fff9a871424d800e422983739cfcccc77b5936308ed1bcccc91dd

data/.codeclimate.yml

@@ -1,13 +1,6 @@
 engines:
   rubocop:
     enabled: true
-    checks:
-      Rubocop/Style/Documentation:
-        enabled: false
-      Rubocop/Style/FrozenStringLiteralComment:
-        enabled: false
-      Rubocop/Style/StringLiterals:
-        enabled: false
   duplication:
     enabled: true
     config:

data/.rubocop.yml

@@ -0,0 +1,14 @@
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing

data/lib/newgistics/customer.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Customer
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :company, String
     attribute :first_name, String

data/lib/newgistics/fee.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Fee
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :type, String
     attribute :amount, Float

data/lib/newgistics/inbound_return.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class InboundReturn
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :id, String
     attribute :shipment_id, String
@@ -15,7 +15,6 @@ module Newgistics
     def self.where(conditions)
       Query.build(
         endpoint: '/inbound_returns.aspx',
-        element_selector: 'InboundReturns InboundReturn',
         model_class: self
       ).where(conditions)
     end

data/lib/newgistics/inventory.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Inventory
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :manifest_id, String
     attribute :manifest_po, String
@@ -14,9 +14,12 @@ module Newgistics
     def self.where(conditions)
       Query.build(
         endpoint: '/inventory_details.aspx',
-        element_selector: 'inventories inventory',
         model_class: self
       ).where(conditions)
     end
+
+    def self.element_selector
+      'inventory'
+    end
   end
 end

data/lib/newgistics/item.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Item
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :id, String
 

data/lib/newgistics/manifest.rb

@@ -1,29 +1,36 @@
 module Newgistics
   class Manifest
-    include Virtus.model
+    include Newgistics::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 :manifest_slip, ManifestSlip
     attribute :contents, Array[ManifestItem], default: []
 
     attribute :errors, Array[String], default: []
     attribute :warnings, Array[String], default: []
 
+    def id
+      manifest_slip&.manifest_id
+    end
+
+    def id=(id)
+      self.manifest_slip ||= ManifestSlip.new
+      manifest_slip.manifest_id = id
+    end
+
     def save
       Requests::PostManifest.new(self).perform
       errors.empty?
     end
+
+    def self.where(conditions)
+      Query.build(
+        endpoint: '/manifests.aspx',
+        model_class: self
+      ).where(conditions)
+    end
+
+    def self.element_selector
+      'manifest'
+    end
   end
 end

data/lib/newgistics/manifest_item.rb

@@ -1,10 +1,17 @@
 module Newgistics
   class ManifestItem
-    include Virtus.model
+    include Newgistics::Model
 
-    attribute :sku, String
+    attribute :damaged_qty, Integer
     attribute :description, String
     attribute :original_qty, Integer
     attribute :received_qty, Integer
+    attribute :sku, String
+    attribute :upc, String
+    attribute :variance, Integer
+
+    def self.element_selector
+      "item"
+    end
   end
 end

data/lib/newgistics/manifest_slip.rb

@@ -0,0 +1,49 @@
+module Newgistics
+  class ManifestSlip
+    include Newgistics::Model
+
+    attribute :actual_arrival_date, Timestamp
+    attribute :actual_received_date, Timestamp
+    attribute :carton_count, Integer
+    attribute :created_date, Timestamp
+    attribute :estimated_arrival_date, Date
+    attribute :manifest_id, String
+    attribute :manifest_name, String
+    attribute :manifest_po, String
+    attribute :notes, String
+    attribute :pallet_count, Integer
+    attribute :ship_date, Timestamp
+    attribute :shipped_via, String
+    attribute :status, String
+    attribute :total_weight, Float
+    attribute :tracking_no, String
+    attribute :warehouse_id, String
+    attribute :weight, Float
+
+    alias_method :no_pallets, :pallet_count
+    alias_method :no_pallets=, :pallet_count=
+    alias_method :no_cartons, :carton_count
+    alias_method :no_cartons=, :carton_count=
+    alias_method :shipped_date, :ship_date
+    alias_method :shipped_date=, :ship_date=
+    alias_method :total_weight, :weight
+    alias_method :total_weight=, :weight=
+
+    def estimated_arrival_date=(date)
+      date = parse_date(date) if should_parse_date?(date)
+      super(date)
+    end
+
+    private
+
+    def should_parse_date?(date)
+      date.is_a?(String) && date =~ %r{[01]\d/[0123]\d/\d{4}}
+    end
+
+    def parse_date(date)
+      Date.strptime(date, '%m/%d/%Y')
+    rescue ArgumentError
+      date
+    end
+  end
+end

data/lib/newgistics/model.rb

@@ -0,0 +1,14 @@
+module Newgistics
+  module Model
+    def self.included(base)
+      base.include(Virtus.model)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def element_selector
+        name.split('::').last
+      end
+    end
+  end
+end

data/lib/newgistics/order.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Order
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :id, String
     attribute :warehouse_id, String

data/lib/newgistics/product.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Product
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :id, String
     attribute :sku, String
@@ -22,9 +22,12 @@ module Newgistics
     def self.where(conditions)
       Query.build(
         endpoint: '/inventory.aspx',
-        element_selector: 'products product',
         model_class: self
       ).where(conditions)
     end
+
+    def self.element_selector
+      'product'
+    end
   end
 end

data/lib/newgistics/query.rb

@@ -10,12 +10,9 @@ module Newgistics
       @conditions = {}
     end
 
-    def self.build(endpoint:, element_selector:, model_class:)
+    def self.build(endpoint:, model_class:)
       request = Requests::Search.new(endpoint)
-      response_handler = ResponseHandlers::Search.new(
-        element_selector: element_selector,
-        model_class: model_class
-      )
+      response_handler = ResponseHandlers::Search.new(model_class: model_class)
 
       new(request, response_handler)
     end

data/lib/newgistics/requests/cancel_shipment.rb

@@ -44,7 +44,7 @@ module Newgistics
       end
 
       def mandatory_params
-         {
+        {
           apiKey: api_key,
           shipmentID: shipment_cancellation.shipment_id,
           orderID: shipment_cancellation.order_id

data/lib/newgistics/requests/post_manifest.rb

@@ -46,25 +46,27 @@ module Newgistics
       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
+        manifest_slip = manifest.manifest_slip || ManifestSlip.new
 
-          date_xml(xml, :ship_date)
-          date_xml(xml, :estimated_arrival_date)
+        xml.manifest_slip do
+          xml.manifest_po manifest_slip.manifest_po
+          xml.manifest_name manifest_slip.manifest_name
+          xml.warehouse_id manifest_slip.warehouse_id
+          xml.status manifest_slip.status
+          xml.tracking_no manifest_slip.tracking_no
+          xml.pallet_count manifest_slip.pallet_count
+          xml.carton_count manifest_slip.carton_count
+          xml.weight manifest_slip.weight
+          xml.notes manifest_slip.notes
+          xml.ship_date format_date(manifest_slip.ship_date)
+          xml.estimated_arrival_date format_date(
+            manifest_slip.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?
+      def format_date(date)
+        date.strftime("%m/%d/%Y") if date.respond_to?(:strftime)
       end
 
       def contents_xml(xml)

data/lib/newgistics/requests/search.rb

@@ -13,7 +13,7 @@ module Newgistics
 
       def body
         params.
-          map { |k,v| [StringHelper.camelize(k, upcase_first: false), v] }.
+          map { |k, v| [StringHelper.camelize(k, upcase_first: false), v] }.
           to_h
       end
     end

data/lib/newgistics/response_handlers/search.rb

@@ -1,10 +1,9 @@
 module Newgistics
   module ResponseHandlers
     class Search
-      attr_reader :element_selector, :model_class
+      attr_reader :model_class
 
-      def initialize(element_selector:, model_class:)
-        @element_selector = element_selector
+      def initialize(model_class:)
         @model_class = model_class
       end
 
@@ -34,7 +33,7 @@ module Newgistics
       end
 
       def build_models(xml)
-        xml.css(element_selector).map do |model_xml|
+        xml.css(model_class.element_selector).map do |model_xml|
           build_model(model_xml)
         end
       end
@@ -50,7 +49,7 @@ module Newgistics
       end
 
       def raise_error(message)
-        raise QueryError.new(message)
+        raise QueryError, message
       end
     end
   end

data/lib/newgistics/return.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Return
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :warehouse_id, String
     attribute :shipment_id, String
@@ -32,7 +32,6 @@ module Newgistics
     def self.where(conditions)
       Query.build(
         endpoint: '/returns.aspx',
-        element_selector: 'Returns Return',
         model_class: self
       ).where(conditions)
     end

data/lib/newgistics/shipment.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Shipment
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :id, String
     attribute :client_name, String
@@ -71,7 +71,6 @@ module Newgistics
     def self.where(conditions)
       Query.build(
         endpoint: '/shipments.aspx',
-        element_selector: 'Shipments Shipment',
         model_class: self
       ).where(conditions)
     end

data/lib/newgistics/shipment_cancellation.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class ShipmentCancellation
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :shipment_id, String
     attribute :order_id, String

data/lib/newgistics/shipment_update.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class ShipmentUpdate
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :id, String
     attribute :order_id, String

data/lib/newgistics/string_helper.rb

@@ -1,13 +1,21 @@
 module Newgistics
   class StringHelper
+    CAMEL_CASED_STRING_REGEX = /([a-z])([A-Z])/
+    UNDERSCORED_STRING_REGEX = /([A-Za-z\d]+)(_|\z)/
+    CAPITALIZED_STRING_REGEX = /\A[A-Z]/
+
     def self.camelize(string, upcase_first: true)
-      result = string.to_s.gsub(/([a-z\d]+)(_|\z)/) { $1.capitalize }
-      result = result.gsub(/\A[A-Z]/) { $&.downcase } unless upcase_first
-      result
+      string.dup.to_s.tap do |s|
+        s.gsub!(UNDERSCORED_STRING_REGEX) { $1.capitalize! || $1 }
+        s.gsub!(CAPITALIZED_STRING_REGEX) { $&.downcase! } unless upcase_first
+      end
     end
 
     def self.underscore(string)
-      string.to_s.gsub(/([a-z])([A-Z])/) { "#{$1}_#{$2}" }.downcase
+      string.dup.to_s.tap do |s|
+        s.gsub!(CAMEL_CASED_STRING_REGEX) { "#{$1}_#{$2}" }
+        s.downcase!
+      end
     end
   end
 end

data/lib/newgistics/version.rb

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

data/lib/newgistics/warehouse.rb

@@ -1,6 +1,6 @@
 module Newgistics
   class Warehouse
-    include Virtus.model
+    include Newgistics::Model
 
     attribute :id, String
 

data/lib/newgistics/xml_marshaller.rb

@@ -37,8 +37,7 @@ module Newgistics
     end
 
     def build_list(item_class, element)
-      item_selector = get_list_item_selector(item_class)
-      element.css(item_selector).map do |child|
+      element.css(item_class.element_selector).map do |child|
         build_object(item_class, child)
       end
     end
@@ -49,10 +48,6 @@ module Newgistics
       end
     end
 
-    def get_list_item_selector(item_class)
-      item_class.to_s.split('::').last
-    end
-
     def assign_simple_attribute(object, element)
       attribute = attribute_name(element)
       assign_attribute(object, attribute, element.text)

data/lib/newgistics.rb

@@ -8,6 +8,7 @@ require "newgistics/default_logger"
 require "newgistics/configuration"
 require "newgistics/time_zone"
 require "newgistics/timestamp"
+require "newgistics/model"
 require "newgistics/customer"
 require "newgistics/item"
 require "newgistics/order"
@@ -35,6 +36,7 @@ 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_slip"
 require "newgistics/manifest"
 require "newgistics/fee"
 require "newgistics/shipment"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newgistics
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Manuel Martinez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -191,6 +191,7 @@ files:
 - ".env.sample"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".simplecov"
 - CODE_OF_CONDUCT.md
@@ -212,6 +213,8 @@ files:
 - lib/newgistics/item.rb
 - lib/newgistics/manifest.rb
 - lib/newgistics/manifest_item.rb
+- lib/newgistics/manifest_slip.rb
+- lib/newgistics/model.rb
 - lib/newgistics/order.rb
 - lib/newgistics/product.rb
 - lib/newgistics/query.rb