eshipper 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57b78cb7082d86f9669043760716042e72cfceff28c5480ce82da89417a21f6f
-  data.tar.gz: d268d104958c610d2d3f3fc86e97272514389fb79904b22e2247f9686c78d590
+  metadata.gz: ebd04fae554c9b5537c9d898c5ae5afdfa66e40937b7f03ef5f4f698a358dfdd
+  data.tar.gz: b310e67019d3e95e5dbeb6867d19d55e6ca46c4b278a2f5b9da12277778622dd
 SHA512:
-  metadata.gz: fba5257151a5f55e7f973950a8e6b987461ffe08d737993bf2366cecbc25f90eb6d3f4c98c07d3ac8c9de8814aa1f724302def293a205190d6236298563ac742
-  data.tar.gz: 7654f83d0b8e3ace3ebbf379748e6f046420beb003979bd5e7b6093789229c74a05cbea633fd835b20e0b24c898f70b8a4603d3e1508b98cd2e4f8eaa025a971
+  metadata.gz: fe4802cebcf82acc4c6900d091ac0f32bd96c431ca394843cdf193454b05fc35be61e91894fd51b1e27f8bf90a5be3746ac7390ac778e20a60e18047b13d3779
+  data.tar.gz: 43f25618f1c423a5afe4fdffbeecdaf5ec32013a75a5d993391980497d989ef79244ca7dc21847fe3f132f059f3ddc18ae8b73a90381d37bcc1b265120bf6c38

data/lib/eshipper/classes/order.rb

@@ -3,12 +3,59 @@
 module EShipper
   class Order < EShipperResponse
     def self.search(options = {})
-      orders = SearchReply.search(options).OrderSearchReply.Order
-      orders.is_a?(Array) ? orders : [orders]
+      orders = SearchReply.search(options).OrderSearchReply
+
+      if orders == "\n" # No results
+        []
+      elsif orders.Order.is_a?(Array) # Multiple results
+        orders.Order
+      else # Single result
+        [orders.Order]
+      end
+    end
+
+    def references
+      if !respond_to?(:References)
+        []
+      elsif self.References.Reference == "\n"
+        []
+      elsif self.References.Reference.is_a?(Array)
+        self.References.Reference
+      else
+        [self.References.Reference]
+      end
     end
 
     def fetch
-      OrderInformationReply.fetch(order_id: self.Id).OrderInformationReply
+      order_information_reply = OrderInformationReply.fetch(fetch_options)
+
+      if order_information_reply.respond_to?(:OrderInformationReply)
+        order_information_reply = order_information_reply.OrderInformationReply
+        if order_information_reply.Order.is_a?(Array)
+          # Sometimes there is a partial referenceCode match. In that case the API will return multiple Orders
+          # However, the way they format the Orders, the properties of all orders are siblings.
+          # In other words, the properties of an Order are NOT nested within the Order.
+          # So the way the parser works is that it gives us arrays for each property.
+          # TBD: Are properties of each Order ordered consistently?
+          # TBD: Does the API always return the better matching result first???
+          # Assume that the first result is the one we want!
+          this_index = order_information_reply.Order.each_with_index.find do |_, index|
+            order_information_reply.Order[index].id == self.Id
+          end[1]
+          order_information_reply.attributes.keys.each do |attribute_key|
+            order_information_reply.send("#{attribute_key}=", order_information_reply.attributes[attribute_key][this_index])
+          end
+          throw("id mismatch") if order_information_reply.Order.id != self.Id
+        end
+        order_information_reply
+      else
+        # TODO: error handling
+        throw(order_information_reply)
+      end
+    end
+
+    def fetch_options
+      { order_id: self.Id, referenceCode: references.first&.Code }
     end
   end
 end

data/lib/eshipper/requests/order_information_request.rb

@@ -2,18 +2,20 @@
 
 module EShipper
   class OrderInformationRequest < EShipper::Request
-    attr_reader :order_id
+    attr_reader :order_id, :referenceCode
 
-    def initialize(order_id:)
+    def initialize(order_id:, referenceCode: nil)
       @order_id = order_id
+      @referenceCode = referenceCode
       super()
     end
 
     def order_properties
       {
         orderId: @order_id,
+        referenceCode: referenceCode,
         detailed: "true",
-      }
+      }.compact
     end
 
     def request_body

data/lib/eshipper/requests/order_search_request.rb

@@ -21,7 +21,7 @@ module EShipper
       carrierTrackingNumber: nil, # [Optional]
       referenceValue: nil # [Optional]
     )
-      throw("Order date range should be within 3 month.") if toDate - 90 > fromDate
+      throw("Order date range should be within 3 month.") if fromDate + 90 > toDate
 
       @fromDate = fromDate
       @toDate = toDate

data/lib/eshipper/responses/eshipper_response.rb

@@ -1,16 +1,15 @@
 # frozen_string_literal: true
 
-class EShipperXMLFormatter
-  include ActiveResource::Formats::XmlFormat
-
-  def decode(xml)
-    ActiveResource::Formats::XmlFormat.decode(xml)
-  end
-end
-
 module EShipper
   class EShipperResponse < ::ActiveResource::Base
     self.site = EShipper::Client.instance.url
     self.format = :xml
+
+    def self.decode(xml)
+      # Remove raw & which are illegal
+      # https://stackoverflow.com/questions/17237334/illegal-character-in-raw-string-rexml-parsing
+      xml.gsub!(/&(?!(?:amp|lt|gt|quot|apos);)/, "&amp;")
+      format.decode(xml)
+    end
   end
 end

data/lib/eshipper/responses/order_information_reply.rb

@@ -2,11 +2,14 @@
 
 module EShipper
   class OrderInformationReply < EShipperResponse
-    self.format = :xml
-
     def self.fetch(options)
       request = EShipper::OrderInformationRequest.new(options)
-      new(format.decode(request.send_now))
+      response = decode(request.send_now)
+      if response["ErrorReply"]
+        throw(ErrorReply.new(response))
+      else
+        new(response)
+      end
     end
   end
 end

data/lib/eshipper/responses/search_reply.rb

@@ -2,11 +2,14 @@
 
 module EShipper
   class SearchReply < EShipperResponse
-    self.format = :xml
-
     def self.search(options)
       request = EShipper::OrderSearchRequest.new(options)
-      new(format.decode(request.send_now))
+      response = decode(request.send_now)
+      if response["ErrorReply"]
+        throw(ErrorReply.new(response))
+      else
+        new(response)
+      end
     end
   end
 end

data/lib/eshipper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EShipperRuby
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/readme.md

@@ -0,0 +1,14 @@
+# How to release
+
+1. Bump the version in ./lib/eshipper/version.rb
+2. Build: `$ gem build eshipper.gemspec`
+3. Install: `gem install ./eshipper-X.X.X.gem`
+4. Smoke test:
+```
+$ pry
+pry > require 'eshipper'
+pry > EShipper::Client.instance.username = "XXX"
+pry > EShipper::Client.instance.password = "XXX"
+pry > orders = EShipper::Order.search(carrierTrackingNumber: "XXX")
+```
+5. Push: `$ gem push eshipper-X.X.X.gem`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eshipper
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - "Marc \U0001F41D"
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-20 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -63,6 +63,7 @@ files:
 - lib/eshipper/responses/order_information_reply.rb
 - lib/eshipper/responses/search_reply.rb
 - lib/eshipper/version.rb
+- readme.md
 homepage: https://github.com/hrdwdmrbl/eshipper
 licenses:
 - MIT