shipping_connector 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98c92bddd04b8f92e6630534b66d4e169583db1264fd56ae0ae664aed41e2ebf
-  data.tar.gz: 48e528d536d25680d36127600bb785ac267ce11b9a082b0b4c2df94ff8ad5b60
+  metadata.gz: b5dc5dd88edc69471c3d50e15f9e84e59cc604fbd4a7a33f6f37310a67e7060e
+  data.tar.gz: 86629918a4474ab6abb378ddd6f8b3c9500eaa86a7f8d343de498edc97cf23e1
 SHA512:
-  metadata.gz: be449f20f233c15e90b0a2679d878eac4dfefaddf95645f62eaf474888db9a79369a2ebc2fb2c2c76e81a4a6e95064c2a4de35459749d317bddcb6cf7e5a0e9c
-  data.tar.gz: b48be38a98eb8cc2f341d0177b491b2eb23859a098d782f8b358b117828dd6268fbcc4f3b04fe33360cca592ac5a643b0270cc38f935d793bbc9e1660df27dc2
+  metadata.gz: 6b591b23947cd52b0783bd376e3137fcadc996ba59e85cc76b3af86fa34b416f988fe3547eb790bdf67c71f24cb9f9b9c118f46407107b08b4f7b4be59bae4be
+  data.tar.gz: '094dbffaabfc78dfd8086614e1c40e4274f0c317cde2467ddaccf9e372b15c7b4cb1b30675473c18347678f699c1427fe669ec5c97145cc3dacfb3e21bec9963'

data/lib/shipping_connector/carrier/dao.rb

@@ -8,13 +8,12 @@ module ShippingConnector
     # @overload initialize(customer_id, password)
     #   @param customer_id [Integer] login details for the API user
     #   @param password [String] login details for the API user
-    #
     def initialize(options = {})
       require! options, :customer_id, :password
       super
     end
 
-    # Returns a list of service points or a single service point
+    # Returns a list of service points or a single service point. The returned distance is as the crow flies.
     # @overload service_points(scope, zip_code, address, limit = 10)
     #   @param scope [Symbol] the scope: `:list` for listing nearest service points
     #   @param zip_code [Integer, String] zip code for address to search from

data/lib/shipping_connector/carrier/postnord.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module ShippingConnector
+  class Postnord < Carrier
+    self.url = 'api2.postnord.com'
+
+    # Initializes a new carrier object for Postnord
+    # @overload initialize(api_key)
+    #   @param api_key [String] authentication details
+    def initialize(options = {})
+      require! options, :api_key
+      super
+    end
+
+    # Returns a list of service points or a single service point. The returned distance is based on driving route.
+    # @overload service_points(scope, zip_code, city, address, country, limit = 10)
+    #   @param scope [Symbol] :list or :list_address to find by address
+    #   @param zip_code [String] this or city is required
+    #   @param city [String] this or zip_code is required
+    #   @param address [String] street address to search from
+    #   @param limit [String] amount of service points to be returned
+    #   @return [Array<ServicePoint>] the nearest service points ordered by distance
+    # @overload service_points(scope, latitude, longitude, limit = 10)
+    #   @param scope [Symbol] :list_coordinates to find by coordinates
+    #   @param latitude [String] required
+    #   @param longitude [String] required
+    #   @param limit [String] amount of service points to be returned
+    #   @return [Array<ServicePoint>] the nearest service points ordered by distance
+    # @overload service_points(id)
+    #   @param id [Integer] the id of the service_point to be returned
+    #   @return [ServicePoint] the service point for the given id
+    def service_points(*arguments)
+      scope   = arguments.slice!(0)
+      options = arguments.slice!(0) || {}
+
+      case scope
+      when :list, :list_address
+        require!(options, :country)
+        list_service_points(options)
+      when :list_coordinates
+        require!(options, :country, :latitude, :longitude)
+        list_by_coordinates(options)
+      else
+        require!(options, :country)
+        find_service_point(scope, options)
+      end
+    end
+
+    private
+
+    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
+    rescue Faraday::ClientError => e
+      body = JSON.parse e.response[:body]
+      raise StandardError, "Postnord error: #{body['message']}"
+    end
+
+    def find_service_point(id, arguments)
+      service_point = get('/rest/businesslocation/v5/servicepoints/ids',
+                          {
+                            ids: id, countryCode: arguments[:country]
+                          })['servicePointInformationResponse']['servicePoints'].first
+
+      ServicePoint.new(
+        id: service_point['servicePointId'], zip_code: service_point['visitingAddress']['postalCode'],
+        name: service_point['name'], city: service_point['visitingAddress']['city'],
+        address: "#{service_point['visitingAddress']['streetName']} #{service_point['visitingAddress']['streetName']}",
+        opening_hours: opening_hours(service_point['openingHours'])
+      )
+    end
+
+    def list_service_points(options)
+      unless options.key?(:city) || options.key?(:zip_code)
+        raise ArgumentError, 'At least one of :city or :zip_code is required'
+      end
+
+      params = { countryCode: options[:country] }
+
+      params[:city] = options[:city] if options[:city]
+      params[:postalCode] = options[:postalCode] if options[:zip_code]
+      params[:streetName] = options[:address] if options[:address]
+      params[:numberOfServicePoints] = options[:limit] || 10
+
+      array = get('/rest/businesslocation/v5/servicepoints/nearest/byaddress',
+                  params)['servicePointInformationResponse']['servicePoints']
+
+      generate_service_points array
+    end
+
+    def list_by_coordinates(options)
+      array = get('/rest/businesslocation/v5/servicepoints/nearest/bycoordinates',
+                  {
+                    countryCode: options[:country],
+                    northing: options[:latitude],
+                    easting: options[:longitude],
+                    numberOfServicePoints: options[:limit] || 10
+                  })['servicePointInformationResponse']['servicePoints']
+
+      generate_service_points array
+    end
+
+    def generate_service_points(array)
+      result = []
+      array.each do |service_point|
+        result << ServicePoint.new(
+          id: service_point['servicePointId'], zip_code: service_point['visitingAddress']['postalCode'],
+          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
+
+    def opening_hours(args)
+      hash = {}
+
+      args['postalServices'].each do |h|
+        hash[h['openDay'].downcase.to_s] = "#{h['openTime']} - #{h['closeTime']}"
+      end
+
+      ServicePoint::OpeningHours.new(hash)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipping_connector
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Simon Thyregod Kristensen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-24 00:00:00.000000000 Z
+date: 2021-10-25 00:00:00.000000000 Z
 dependencies: []
 description: |2
       ShippingConnector is an abstraction library that makes connecting to various shipping
@@ -22,6 +22,7 @@ files:
 - lib/shipping_connector.rb
 - lib/shipping_connector/carrier.rb
 - lib/shipping_connector/carrier/dao.rb
+- lib/shipping_connector/carrier/postnord.rb
 - lib/shipping_connector/carriers.rb
 - lib/shipping_connector/service_point.rb
 homepage: https://github.com/sthyregod/shipping_connector