shipping_connector 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5dc5dd88edc69471c3d50e15f9e84e59cc604fbd4a7a33f6f37310a67e7060e
-  data.tar.gz: 86629918a4474ab6abb378ddd6f8b3c9500eaa86a7f8d343de498edc97cf23e1
+  metadata.gz: 513d12edb9b1d0272c2881b3e026b5a33e8f389f99596a8421b89c898e77d07c
+  data.tar.gz: 15f454b5b931284bb24671cf92e40dca5215ccc4a27a72e5034b2933042c0e2a
 SHA512:
-  metadata.gz: 6b591b23947cd52b0783bd376e3137fcadc996ba59e85cc76b3af86fa34b416f988fe3547eb790bdf67c71f24cb9f9b9c118f46407107b08b4f7b4be59bae4be
-  data.tar.gz: '094dbffaabfc78dfd8086614e1c40e4274f0c317cde2467ddaccf9e372b15c7b4cb1b30675473c18347678f699c1427fe669ec5c97145cc3dacfb3e21bec9963'
+  metadata.gz: 870b5d463ebaf3877f5461736278b922869311e7617a1b2b5ce1c099a7a3f39f16c48403c54bf0ec0d3af50fd1106fba74f96aa687f4a29dbae7dc0bfd2180d5
+  data.tar.gz: 4521d98d28d6699082f1e85fd6963cb73254469f944c5669a005d3843f1c6bfa19017502ddaa74fd5bc12f2af0ba581612e3e5b717ec0da2a9a904aee7fb4336

data/lib/shipping_connector/carrier/postnord.rb

@@ -46,25 +46,56 @@ module ShippingConnector
       end
     end
 
+    # Returns a shipment with a list of events
+    # @param id [String] the shipment id
+    # @param locale [Symbol] two-letter language code, e.g. :da or :en
+    # @return [Shipment] the shipment for the given id
+    def shipment(id, locale: :en)
+      # Ugh... Why is Postnord not consistent in their API...
+      data = get('/rest/shipment/v5/trackandtrace/ids.json',
+                 { id: id, locale: locale })
+
+      shipment = data['shipments'].first { |s| s['shipmentId'] == id.to_s }
+      raise "Shipment with ID #{id} not found" unless shipment
+
+      item = shipment['items'].first { |i| i['itemId'] == id.to_s }
+      raise "The shipment returned no items with ID #{id}" unless item
+
+      generate_shipment(shipment['status'], item)
+    end
+
     private
 
+    def generate_shipment(status, item)
+      events = generate_events(item['events'])
+      Shipment.new(
+        id: item['itemId'],
+        events: events, status: convert_status(status),
+        status_description: item['statusText']['header']
+      )
+    end
+
     def auth_params
       { apikey: @options[:api_key], returnType: 'json' }
     end
 
     def get(path, params)
       response = super(path, params.merge(auth_params))
-      JSON.parse response.body
+      body = JSON.parse(response.body)
+      return body.values.first if body.keys.first =~ /Response$/
+
+      body
     rescue Faraday::ClientError => e
       body = JSON.parse e.response[:body]
-      raise StandardError, "Postnord error: #{body['message']}"
+      message = body.values.first['compositeFault']['faults'][0]
+      raise StandardError, "Postnord error #{message['faultCode']}: #{message['explanationText']}"
     end
 
     def find_service_point(id, arguments)
       service_point = get('/rest/businesslocation/v5/servicepoints/ids',
                           {
                             ids: id, countryCode: arguments[:country]
-                          })['servicePointInformationResponse']['servicePoints'].first
+                          })['servicePoints'].first
 
       ServicePoint.new(
         id: service_point['servicePointId'], zip_code: service_point['visitingAddress']['postalCode'],
@@ -87,7 +118,7 @@ module ShippingConnector
       params[:numberOfServicePoints] = options[:limit] || 10
 
       array = get('/rest/businesslocation/v5/servicepoints/nearest/byaddress',
-                  params)['servicePointInformationResponse']['servicePoints']
+                  params)['servicePoints']
 
       generate_service_points array
     end
@@ -99,7 +130,7 @@ module ShippingConnector
                     northing: options[:latitude],
                     easting: options[:longitude],
                     numberOfServicePoints: options[:limit] || 10
-                  })['servicePointInformationResponse']['servicePoints']
+                  })['servicePoints']
 
       generate_service_points array
     end
@@ -112,7 +143,7 @@ module ShippingConnector
           name: service_point['name'], city: service_point['visitingAddress']['city'],
           address: "#{service_point['visitingAddress']['streetName']} #{service_point['visitingAddress']['streetName']}",
           distance: service_point['routeDistance'], opening_hours: opening_hours(service_point['openingHours'])
-)
+        )
       end
       result
     end
@@ -126,5 +157,35 @@ module ShippingConnector
 
       ServicePoint::OpeningHours.new(hash)
     end
+
+    def generate_events(events)
+      array = []
+      events.each do |event|
+        array << Shipment::Event.new(
+          type: convert_status(event['status']),
+          time: convert_time(event['eventTime']),
+          description: event['eventDescription'],
+          location: event['location']['displayName']
+        )
+      end
+      array
+    end
+
+    def convert_status(status)
+      # FIXME: Find a good status category for 'OTHER'
+      hash = {
+        'DELIVERED' => :delivered,
+        'EN_ROUTE' => :en_route,
+        'AVAILABLE_FOR_DELIVERY' => :available_for_delivery
+      }
+      return hash[status] if hash[status]
+
+      warn "Unknown status: #{status}"
+      :unknown
+    end
+
+    def convert_time(time_string)
+      TZInfo::Timezone.get('Europe/Copenhagen').to_local(Time.parse(time_string))
+    end
   end
 end

data/lib/shipping_connector/shipment.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ShippingConnector
+  class Shipment
+    attr_reader :id, :receiver, :sender, :events, :status, :status_description
+
+    def initialize(params = {})
+      params.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    class Event
+      attr_reader :type, :time, :description, :location
+
+      def initialize(params = {})
+        params.each { |key, value| instance_variable_set("@#{key}", value) }
+      end
+    end
+  end
+end

data/lib/shipping_connector.rb

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require 'faraday'
-require 'json'
-require 'active_support/core_ext/class/attribute'
-
 require 'shipping_connector/carrier'
 require 'shipping_connector/carriers'
 require 'shipping_connector/service_point'
+require 'shipping_connector/shipment'

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: shipping_connector
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Thyregod Kristensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-25 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo-data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: |2
       ShippingConnector is an abstraction library that makes connecting to various shipping
       carriers' APIs easier. As with everything Ruby, the goal is to make writing code that
@@ -25,6 +95,7 @@ files:
 - lib/shipping_connector/carrier/postnord.rb
 - lib/shipping_connector/carriers.rb
 - lib/shipping_connector/service_point.rb
+- lib/shipping_connector/shipment.rb
 homepage: https://github.com/sthyregod/shipping_connector
 licenses:
 - MIT