hermes_api 0.4.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a6253995c5e13c6cc4c920b3825dff5563bef6a7f9ffc69aaafcb7e918378c6
-  data.tar.gz: 0cda194a1f1464eebb3c98634fdd31fcf9b8347e2c05028ca0fbd1998bae387b
+  metadata.gz: e46834a6a9ce66e5a73e5a352ebe1384e53cadb20933d4e51cbcf93bfa1fc9e8
+  data.tar.gz: cc774117acd165f1a01ed476ea88b65eeb68b0a4b37b2122e199bfcdd55be7d8
 SHA512:
-  metadata.gz: 626e0a3607ea22c200fa724f6ed5bd09cea386c8563a8d918d5a05fd14b1ae05fa47f8787f94500ca20b9ddbf5cd09b27c5160c0eac6bf702b5afbf67dac0b18
-  data.tar.gz: fca544bc66a51feea9ca45e9a84245c2e5da4db47d96853c5dd026f990b103e9e0e55d338da8f6a84663e1180d6f9593e2ac22a52f5ce2efb884efbab9533131
+  metadata.gz: 05c7e2f756c0c68c8dfa535cbb8cbf064582352146f346bca765bfd31c146b94e4045b0f2f49170e97d2561ca2f5ba4012161632e110afdcd12e149e34aeb56c
+  data.tar.gz: 1df67df9cd32108bbf3de5da31b1b25b3f646f4394fc5fd4cd390d303065b3f3f16de0532b30ed6ac1f2434db9d55cb7a0d7e611ed32b256d5064bf9a904dbc3

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    hermes_api (0.4.0)
+    hermes_api (0.5.2)
       activeresource (>= 4.1.0, < 6.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
     activemodel-serializers-xml (1.0.2)
       activemodel (> 5.x)
       activesupport (> 5.x)
@@ -17,7 +17,7 @@ GEM
       activemodel (>= 5.0, < 7)
       activemodel-serializers-xml (~> 1.0)
       activesupport (>= 5.0, < 7)
-    activesupport (6.1.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/bin/console

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require "pry"
 require "bundler/setup"
 require "dotenv/load"
 require "dev/zeitwerk_loader"
@@ -11,5 +12,4 @@ require "hermes_api"
 set_config
 
 # (If you use this, don't forget to add pry to your Gemfile!)
-require "pry"
 Pry.start

data/lib/dev/config.rb

@@ -2,12 +2,9 @@ require "dotenv/load"
 
 def set_config
   HermesAPI.configure do |config|
-    config.user = ENV["HERMES_API_USER"]
-    config.password = ENV["HERMES_API_PASSWORD"]
     config.env = :test
+    # Set to production when testing HermesAPI::TrackingEvent resource
+    # config.env = :production
     config.proxy = ENV["HERMES_API_PROXY"]
-    config.auth_id = ENV["HERMES_API_AUTH_ID"]
-    config.auth_secret = ENV["HERMES_API_AUTH_SECRET"]
-    config.api_key = ENV["HERMES_API_KEY"]
   end
 end

data/lib/hermes_api/bearer_auth.rb

@@ -0,0 +1,40 @@
+module HermesAPI
+  module BearerAuth
+    def with_oauth_session(api_key, client_id, client_secret)
+      existing_apikey = headers["apikey"]
+      existing_bearer_token = connection.bearer_token
+      headers["apikey"] = api_key
+      connection.bearer_token = fetch_token(client_id, client_secret)
+      response = yield
+      headers["apikey"] = existing_apikey
+      connection.bearer_token = existing_bearer_token
+      response
+    rescue ActiveResource::UnauthorizedAccess => e
+      clear_token_cache(client_id, client_secret)
+      raise e
+    end
+
+    def oauth_audience
+      prefix.match(/^\/?([^\/]*)/).captures.first
+    end
+
+    def clear_token_cache(client_id, client_secret)
+      cache_key = "HermesAPI/#{client_id}/#{client_secret}/#{oauth_audience}/oauth_token"
+      HermesAPI.cache.delete(cache_key)
+    end
+
+    def fetch_token(client_id, client_secret)
+      cache_key = "HermesAPI/#{client_id}/#{client_secret}/#{oauth_audience}/oauth_token"
+      cached_token = HermesAPI.cache.read(cache_key)
+      return cached_token if cached_token
+
+      response = OAuth.create(audience: oauth_audience, client_id: client_id, client_secret: client_secret)
+      HermesAPI.cache.write(
+        cache_key,
+        response.access_token,
+        expires_in: response.expires_in - 15 # clear cache earlier
+      )
+      response.access_token
+    end
+  end
+end

data/lib/hermes_api/cache.rb

@@ -1,10 +1,5 @@
 module HermesAPI
   mattr_accessor :cache
 
-  self.cache = if defined?(Rails) && Rails.respond_to?(:cache) &&
-                  Rails.cache.is_a?(ActiveSupport::Cache::Store)
-    Rails.cache
-  else
-    ActiveSupport::Cache::MemoryStore.new
-  end
-end
+  self.cache = ActiveSupport::Cache::MemoryStore.new
+end

data/lib/hermes_api/configuration.rb

@@ -1,6 +1,6 @@
 module HermesAPI
   class Configuration
-    attr_accessor :proxy, :env, :user, :password, :auth_id, :auth_secret, :api_key
+    attr_accessor :proxy, :env
   end
 
   PRODUCTION_SITE = "https://www.hermes-europe.co.uk"
@@ -10,9 +10,9 @@ module HermesAPI
   OAUTH_TESTING_SITE = "https://hermes-client-integration-pre.eu.auth0.com"
 
   JSON_PRODUCTION_SITE = "https://api.hermesworld.co.uk"
-  JSON_TESTING_SITE = "https://api.hermesworld.co.uk"
   # temporarily disabled until it is fixed
   # JSON_TESTING_SITE = "https://hermeslive-pre-prod.apigee.net"
+  JSON_TESTING_SITE = JSON_PRODUCTION_SITE
 
   class << self
     def config
@@ -22,13 +22,13 @@ module HermesAPI
     def after_configure
       HermesAPI::Base.site = config.env.to_s == "production" ? PRODUCTION_SITE : TESTING_SITE
       HermesAPI::Base.proxy = config.proxy
-      HermesAPI::Base.user = config.user
-      HermesAPI::Base.password = config.password
 
       HermesAPI::JsonBase.site = config.env.to_s == "production" ? JSON_PRODUCTION_SITE : JSON_TESTING_SITE
       HermesAPI::OAuth.site = config.env.to_s == "production" ? OAUTH_PRODUCTION_SITE : OAUTH_TESTING_SITE
 
-      HermesAPI::JsonBase.headers["apikey"] = config.api_key
+      if defined?(Rails) && Rails.respond_to?(:cache) && Rails.cache.is_a?(ActiveSupport::Cache::Store)
+        HermesAPI.cache = Rails.cache
+      end
     end
 
     def configure

data/lib/hermes_api/creation_error.rb

@@ -4,18 +4,50 @@ module HermesAPI
       ActiveResource::Formats::XmlFormat.decode(@response.body)
     end
 
-    def to_s
-      response = ActiveResource::Formats::XmlFormat.decode(@response.body)
-      entries = response.dig("routingResponseEntries", "routingResponseEntry")
+    def code
+      if entries.is_a? Array
+        entries.map do |entry|
+          entry.dig("errorMessages", "errorCode")
+        end
+      else
+        entries.dig("errorMessages", "errorCode")
+      end
+    end
+
+    alias_method :codes, :code
+
+    def description
+      unless entries.is_a? Array
+        entries.dig("errorMessages", "errorDescription")
+      end
+    end
+
+    def code_with_descriptions
       if entries.is_a? Array
         entries.map do |entry|
-          error = entry.dig("errorMessages")
-          "Something went wrong, Error Code: #{error["errorCode"]}, Error Description: #{error["errorDescription"]}."
-        end.to_s
+          code = entry.dig("errorMessages", "errorCode")
+          description = entry.dig("errorMessages", "errorDescription")
+          "#{code}: #{description}"
+        end
+      end
+    end
+
+    def to_s
+      if entries.is_a? Array
+        "#{code_with_descriptions.join(", ")}."
       else
-        error = entries.dig("errorMessages")
-        "Something went wrong. Error Code: #{error["errorCode"]} Error Description: #{error["errorDescription"]}"
+        "#{code}: #{description}."
       end
     end
+
+    private
+
+    def decoded_response
+      ActiveResource::Formats::XmlFormat.decode(@response.body)
+    end
+
+    def entries
+      decoded_response.dig("routingResponseEntries", "routingResponseEntry")
+    end
   end
 end

data/lib/hermes_api/resources/base.rb

@@ -29,8 +29,13 @@ module HermesAPI
       super
     end
 
+    def load(attributes, remove_root = false, persisted = false)
+      attributes.deep_transform_keys! { |k| k.to_s.underscore }
+      super
+    end
+
     def to_xml(options = {})
-      super({root: self.class.root}.merge(options))
+      super({root: self.class.root, camelize: :lower}.merge(options))
     end
   end
 end

data/lib/hermes_api/resources/drop_off_return_label.rb

@@ -0,0 +1,166 @@
+module HermesAPI
+  class DropOffReturnLabel < Base
+        # Create return label(s) wheredrop off at ParcelShops.
+    # HermesUK doc: https://drive.google.com/file/d/1lVuHd2o4nDWrGkacG0GrvNm7LYVL_bFd/view?usp=sharing
+    # You can choose to create a batch of return labels by passing in multiple collectionRoutingRequestEntry.
+    # Example:
+    # HermesAPI::Base.with_session("username", "password") do
+    # request_body = {client_id: "1234",
+    #                 client_name: "Leggings",
+    #                 child_client_id: "",
+    #                 child_client_name: "",
+    #                 source_of_request: "CLIENTWS",
+    #                 collection_routing_request_entries: [{ # collectionRoutingRequestEntry
+    #                   customer: {
+    #                     address: {
+    #                       first_name: "Leonie", lastame: "E", houseName: "2", streetName: "Street",
+    #                       addressLine1: "2 Street", addressLine2: "Fulham", postCode: "SW6 6EL",
+    #                       city: "London", region: "", countryCode: "GB"
+    #                     },
+    #                     mobilePhoneNo: "+447884571522",
+    #                     email: "leonie@london.com",
+    #                     customerReference1: "8284"
+    #                   },
+    #                   countryOfOrigin: "GB"
+    #                 }]}
+    # @order = HermesAPI::DropOffReturnLabel.new(request_body)
+    # @order.save
+
+    #   # Request for a single print in store QR code by wrapping in an oauth session block, only work with 1 label.
+    #   # To request a batch of QR codes, use the HermesAPI::PrintInStoreQrCode#create directly.
+
+    #   HermesAPI::PrintInStoreQrCode.with_oauth_session("api_key", "client_id/auth_id", "client_secret/auth_secret") do
+    #     @order.request_print_in_store_qr_code(
+    #       delivery_address: {
+    #         name: "Andy",
+    #         address_line1: "7 Street",
+    #         address_line2: "Fulham",
+    #         country_code: "GB",
+    #         postcode: "SW6 6EL"
+    #       },
+    #       dimensions: {
+    #         depth: 15,
+    #         length: 20,
+    #         width: 15,
+    #         weight: 1
+    #       },
+    #       value: {
+    #         currency: "GBP",
+    #         amount: 10
+    #       }
+    #     )
+    #   end
+    # end
+
+    include ReturnLabelHelper
+
+    self.prefix = "/routing/service/rest/v4/createReturnBarcodeAndLabel"
+    self.element_name = ""
+
+    DEFAULT_ATTRS = {
+      client_id: "",
+      client_name: "",
+      child_client_id: "",
+      child_client_name: "",
+      source_of_request: "",
+      collection_routing_request_entries: [{
+        customer: {
+          address: {
+            first_name: "",
+            last_name: "",
+            house_name: "",
+            street_name: "",
+            address_line1: "",
+            post_code: "",
+            city: "",
+            region: "",
+            country_code: ""
+          },
+          mobile_phone_no: "",
+          email: "",
+          customer_reference1: ""
+        },
+        country_of_origin: ""
+      }]
+    }
+
+    def request_print_in_store_qr_code(**attrs)
+      if missing_required_qr_code_attributes?(attrs)
+        raise ArgumentError, request_print_in_store_qr_code_error_message
+      end
+
+      return nil if attributes["routing_response_entries"].blank?
+
+      entries = routing_response_entries.routing_response_entry
+      entry = entries.is_a?(Array) ? entries[0] : entries
+      carrier = entry.inbound_carriers.carrier1
+      barcode = carrier.barcode1
+      customer = collection_routing_request_entries[0].customer
+      address = customer.address
+
+      self.print_in_store_qr_code = PrintInStoreQrCode.create(
+        customer: {
+          customer_reference1: customer.customer_reference1
+        },
+        label_type: "RETURN",
+        barcode: {
+          barcode: barcode.barcode_number,
+          barcode_display: barcode.barcode_display
+        },
+        client: {
+          client_id: client_id,
+          client_name: client_name
+        },
+        routing: {
+          delivery_method: {
+            delivery_method_id: carrier.delivery_method_code,
+            delivery_method_description: carrier.delivery_method_desc
+          },
+          sort_levels: {
+            sort_level1: carrier.sort_level1.strip,
+            sort_level2: carrier.sort_level2
+          }
+        },
+        service_offers: [],
+        **attrs
+      )
+    end
+
+    private
+
+    def missing_required_qr_code_attributes?(attrs)
+      ([:dimensions, :value, :delivery_address] - attrs.keys).length > 0
+    end
+
+    def request_print_in_store_qr_code_error_message
+      <<~ERR_MESSAGE
+        Missing required attributes
+        Example:
+
+        label = HermesAPI::DropOffReturnLabel.new(...)
+
+        if label.save
+          label.request_print_in_store_qr_code(
+            dimensions: {
+              depth: 15,
+              length: 20,
+              width: 15,
+              weight: 1
+            },
+            value: {
+              currency: 'GBP',
+              amount: 10
+            },
+            delivery_address: {
+              name: 'Don Joe',
+              address_line1: 'Real Logic',
+              address_line2: '4-4 Ridings Park, Eastern Way',
+              country_code: 'GB',
+              postcode: 'WS117FJ'
+            }
+          )
+        end
+      ERR_MESSAGE
+    end
+  end
+end

data/lib/hermes_api/resources/json_base.rb

@@ -2,5 +2,19 @@ module HermesAPI
   class JsonBase < ActiveResource::Base
     self.include_format_in_path = false
     self.auth_type = :bearer
+
+    def self.inherited(subclass)
+      subclass.extend(BearerAuth)
+    end
+
+    def load(attributes, remove_root = false, persisted = false)
+      attributes.deep_transform_keys! { |k| k.to_s.underscore }
+      super
+    end
+
+    def to_json(options = {})
+      attributes.as_json.deep_transform_keys { |k| k.to_s.camelize(:lower) }
+        .to_json(include_root_in_json ? {root: self.class.element_name}.merge(options) : options)
+    end
   end
 end

data/lib/hermes_api/resources/o_auth.rb

@@ -1,17 +1,15 @@
 module HermesAPI
   class OAuth < ActiveResource::Base
     self.include_format_in_path = false
-    self.element_name=""
-    self.prefix="/oauth/token"
+    self.element_name = ""
+    self.prefix = "/oauth/token"
 
     def initialize(attributes = {}, persisted = false)
       attributes = {
         grant_type: "client_credentials",
-        client_id: HermesAPI.config.auth_id,
-        client_secret: HermesAPI.config.auth_secret,
         **attributes
       }
       super
     end
   end
-end
+end

data/lib/hermes_api/resources/pickup_return_label.rb

@@ -0,0 +1,85 @@
+module HermesAPI
+  class PickupReturnLabel < Base
+    # Create return label(s) with courier pickup request.
+    # HermesUK doc: https://drive.google.com/file/d/1lVuHd2o4nDWrGkacG0GrvNm7LYVL_bFd/view?usp=sharing
+    # You can choose to create a batch of return labels by passing in multiple collectionRoutingRequestEntry.
+    # Example:
+    # HermesAPI::Base.with_session("username", "password") do
+    #   request_body = {clientId: "249",
+    #                   clientName: "Leggings",
+    #                   childClientId: "",
+    #                   childClientName: "",
+    #                   sourceOfRequest: "CLIENTWS",
+    #                   routingStartDate: Time.now.tomorrow.strftime("%Y-%m-%dT%H:%M:%S"),
+    #                   collectionRoutingRequestEntries: [{ # collectionRoutingRequestEntry
+    #                     customer: {
+    #                       address: {
+    #                         firstName: "Leonie", lastName: "E", houseName: "2", streetName: "Street",
+    #                         addressLine1: "2 Street", addressLine2: "Fulham", postCode: "SW6 6EL",
+    #                         city: "London", region: "", countryCode: "GB"
+    #                       },
+    #                       mobilePhoneNo: "+447884571522",
+    #                       email: "leonie@london.com",
+    #                       customerReference1: "8284"
+    #                     },
+    #                     parcel: {
+    #                       weight: 1,
+    #                       length: 10,
+    #                       width: 10,
+    #                       depth: 10,
+    #                       girth: 0,
+    #                       combinedDimension: 0,
+    #                       volume: 0,
+    #                       value: 10,
+    #                       description: "Parcel"
+    #                     },
+    #                     countryOfOrigin: "GB"
+    #                   }]}
+    #   @order = HermesAPI::PickupReturnLabel.new(request_body)
+    #   @order.save
+    # end
+
+    include ReturnLabelHelper
+
+    self.prefix = "/routing/service/rest/v4/routeCollectionCreatePreadviceReturnBarcodeAndLabel"
+    self.element_name = ""
+
+    DEFAULT_ATTRS = {
+      client_id: "",
+      client_name: "",
+      child_client_id: "",
+      child_client_name: "",
+      source_of_request: "",
+      collection_routing_request_entries: [{
+        customer: {
+          address: {
+            first_name: "",
+            last_name: "",
+            house_name: "",
+            street_name: "",
+            address_line1: "",
+            post_code: "",
+            city: "",
+            region: "",
+            country_code: ""
+          },
+          parcel: {
+            weight: 1,
+            length: 10,
+            width: 10,
+            depth: 10,
+            girth: 0,
+            combined_dimension: 0,
+            volume: 0,
+            value: 10,
+            description: "Parcel"
+          },
+          mobile_phone_no: "",
+          email: "",
+          customer_reference1: ""
+        },
+        country_of_origin: ""
+      }]
+    }
+  end
+end

data/lib/hermes_api/resources/print_in_store_qr_code.rb

@@ -1,7 +1,5 @@
 module HermesAPI
   class PrintInStoreQrCode < JsonBase
-    extend HermesAPI::BearerTokenSetup
-
     self.element_name = ""
     self.prefix = "/client-print-in-store-api/v1/references"
 
@@ -11,8 +9,8 @@ module HermesAPI
       super
     end
 
-    def qr_code
-      base64_data = as_json.dig("qrCode", "base64EncodedBytes")
+    def qr_code_image
+      base64_data = as_json.dig("qr_code", "base64_encoded_bytes")
       Base64.decode64(base64_data) if base64_data
     end
   end

data/lib/hermes_api/resources/tracking_event.rb

@@ -1,7 +1,11 @@
 module HermesAPI
   class TrackingEvent < JsonBase
-    extend HermesAPI::BearerTokenSetup
-
+    # # Retrieve TrackingEvents by wrapping in an oauth session block
+    #
+    # HermesAPI::TrackingEvent.with_oauth_session("api_key", "client_id/auth_id", "client_secret/auth_secret") do
+    #   HermesAPI::TrackingEvent.where(barcode: "123456789")
+    # end
+    #
     self.element_name = ""
     self.prefix = "/client-tracking-api/v1/events"
 

data/lib/hermes_api/resources/web_tracking.rb

@@ -1,5 +1,9 @@
 module HermesAPI
   class WebTracking < ActiveResource::Base
+    # # Retrieve TrackingEvents from web site: https://www.myhermes.co.uk/track
+  
+    # HermesAPI::WebTracking.find("1234512345")
+    
     self.element_name = ""
     self.site = "https://api.hermesworld.co.uk"
     self.prefix = "/enterprise-tracking-api/v1/parcels"
@@ -18,11 +22,14 @@ module HermesAPI
 
     def load(attributes, remove_root = false, persisted = false)
       attributes = attributes.dig("results", 0)
-      super(attributes)
+      attributes.deep_transform_keys! { |k| k.to_s.underscore }
+      super
     end
 
     def self.find(barcode)
       uniqueId = format.decode(connection.get("#{prefix}/search/#{barcode}", headers).body).first
+      return nil if uniqueId.nil?
+
       find_single("", params: {uniqueIds: uniqueId})
     end
   end

data/lib/hermes_api/shared/return_label_helper.rb

@@ -0,0 +1,41 @@
+module HermesAPI
+  module ReturnLabelHelper
+    module ClassMethods
+      def root
+        :collectionRoutingRequest
+      end
+    end
+
+    def self.included(base_klass)
+      base_klass.extend(ClassMethods)
+    end
+
+    def labels
+      entries = routing_response_entries.routing_response_entry
+      if entries.is_a?(Array)
+        entries.map do |entry|
+          Base64.decode64(entry.inbound_carriers.label_image)
+        end
+      else
+        Base64.decode64(entries.inbound_carriers.label_image)
+      end
+    rescue NameError
+    end
+
+    alias_method :label, :labels
+
+    def tracking_numbers
+      entries = routing_response_entries.routing_response_entry
+      if entries.is_a?(Array)
+        entries.map do |entry|
+          entry.inbound_carriers.carrier1.barcode1.barcode_number
+        end
+      else
+        entries.inbound_carriers.carrier1.barcode1.barcode_number
+      end
+    rescue NameError
+    end
+
+    alias_method :tracking_number, :tracking_numbers
+  end
+end

data/lib/hermes_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HermesAPI
-  VERSION = "0.4.1"
+  VERSION = "0.7.0"
 end

data/lib/hermes_api.rb

@@ -4,17 +4,19 @@ require_relative "hermes_api/version"
 require "active_resource"
 
 module HermesAPI
+  require "hermes_api/bearer_auth"
   require "hermes_api/cache"
-  require "hermes_api/bearer_token_setup"
   require "hermes_api/configuration"
-  require "hermes_api/creation_error"
   require "hermes_api/connection"
+  require "hermes_api/creation_error"
 
-  require "hermes_api/resources/base"
-  require "hermes_api/resources/return_label"
+  require "hermes_api/shared/return_label_helper"
 
-  require "hermes_api/resources/o_auth"
+  require "hermes_api/resources/base"
+  require "hermes_api/resources/drop_off_return_label"
   require "hermes_api/resources/json_base"
+  require "hermes_api/resources/o_auth"
+  require "hermes_api/resources/pickup_return_label"
   require "hermes_api/resources/print_in_store_qr_code"
   require "hermes_api/resources/tracking_event"
   require "hermes_api/resources/web_tracking"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -151,18 +151,20 @@ files:
 - lib/dev/config.rb
 - lib/dev/zeitwerk_loader.rb
 - lib/hermes_api.rb
-- lib/hermes_api/bearer_token_setup.rb
+- lib/hermes_api/bearer_auth.rb
 - lib/hermes_api/cache.rb
 - lib/hermes_api/configuration.rb
 - lib/hermes_api/connection.rb
 - lib/hermes_api/creation_error.rb
 - lib/hermes_api/resources/base.rb
+- lib/hermes_api/resources/drop_off_return_label.rb
 - lib/hermes_api/resources/json_base.rb
 - lib/hermes_api/resources/o_auth.rb
+- lib/hermes_api/resources/pickup_return_label.rb
 - lib/hermes_api/resources/print_in_store_qr_code.rb
-- lib/hermes_api/resources/return_label.rb
 - lib/hermes_api/resources/tracking_event.rb
 - lib/hermes_api/resources/web_tracking.rb
+- lib/hermes_api/shared/return_label_helper.rb
 - lib/hermes_api/version.rb
 homepage: https://github.com/PostCo/hermes_api
 licenses:

data/lib/hermes_api/bearer_token_setup.rb

@@ -1,23 +0,0 @@
-module HermesAPI
-  module BearerTokenSetup
-    def connection(refresh = false)
-      connection = super
-      connection.bearer_token = fetch_token
-      connection
-    end
-
-    def fetch_token
-      oauth_audience = prefix.match(/^\/?([^\/]*)/).captures.first
-      cached_token = HermesAPI.cache.read("#{oauth_audience}/oauth_token")
-      return cached_token if cached_token
-
-      response = OAuth.create(audience: oauth_audience)
-      HermesAPI.cache.write(
-        "#{oauth_audience}/oauth_token",
-        response.access_token,
-        expires_in: response.expires_in - 15 # clear cache earlier
-      )
-      response.access_token
-    end
-  end
-end

data/lib/hermes_api/resources/return_label.rb

@@ -1,139 +0,0 @@
-"
-Create return label(s).
-You can choose to create a batch of return labels by passing in multiple collectionRoutingRequestEntry.
-"
-module HermesAPI
-  class ReturnLabel < Base
-    self.prefix = "/routing/service/rest/v4/createReturnBarcodeAndLabel"
-    self.element_name = ""
-
-    DEFAULT_ATTRS = {
-      clientId: "",
-      clientName: "",
-      childClientId: "",
-      childClientName: "",
-      sourceOfRequest: "",
-      collectionRoutingRequestEntries: [{
-        customer: {
-          address: {
-            firstName: "",
-            lastName: "",
-            houseName: "",
-            streetName: "",
-            addressLine1: "",
-            postCode: "",
-            city: "",
-            region: "",
-            countryCode: ""
-          },
-          mobilePhoneNo: "",
-          email: "",
-          customerReference1: ""
-        },
-        countryOfOrigin: ""
-      }]
-    }
-
-    def self.root
-      :collectionRoutingRequest
-    end
-
-    def labels
-      entries = routingResponseEntries.routingResponseEntry
-      if entries.is_a?(Array)
-        entries.map do |entry|
-          Base64.decode64(entry.inboundCarriers.labelImage)
-        end
-      else
-        Base64.decode64(entries.inboundCarriers.labelImage)
-      end
-    rescue NameError
-    end
-
-    alias_method :label, :labels
-
-    def tracking_numbers
-      entries = routingResponseEntries.routingResponseEntry
-      if entries.is_a?(Array)
-        entries.map do |entry|
-          entry.inboundCarriers.carrier1.barcode1.barcodeNumber
-        end
-      else
-        entries.inboundCarriers.carrier1.barcode1.barcodeNumber
-      end
-    rescue NameError
-    end
-
-    alias_method :tracking_number, :tracking_numbers
-
-    def request_print_in_store_qr_code(**attrs)
-      if ([:dimensions, :value, :deliveryAddress] - attrs.keys).length > 0
-        raise ArgumentError, request_print_in_store_qr_code_error_message
-      end
-
-      return nil if attributes["routingResponseEntries"].blank?
-
-      entries = routingResponseEntries.routingResponseEntry
-      entry = entries.is_a?(Array) ? entries[0] : entries
-      carrier = entry.inboundCarriers.carrier1
-      barcode = carrier.barcode1
-      customer = collectionRoutingRequestEntries[0].customer
-      address = customer.address
-
-      self.print_in_store_qr_code = PrintInStoreQrCode.create(
-        customer: {
-          customerReference1: customer.customerReference1
-        },
-        labelType: "RETURN",
-        barcode: {
-          barcode: barcode.barcodeNumber,
-          barcodeDisplay: barcode.barcodeDisplay
-        },
-        client: {
-          clientId: clientId,
-          clientName: clientName
-        },
-        routing: {
-          deliveryMethod: {
-            deliveryMethodId: carrier.deliveryMethodCode,
-            deliveryMethodDescription: carrier.deliveryMethodDesc
-          },
-          sortLevels: {
-            sortLevel1: carrier.sortLevel1.strip,
-            sortLevel2: carrier.sortLevel2
-          }
-        },
-        serviceOffers: [],
-        **attrs
-      )
-    end
-
-    private
-
-    def request_print_in_store_qr_code_error_message
-      <<~HEREDOC
-      Missing attributes
-      Example:
-      HermesAPI::ReturnLabel#request_print_in_store_qr_code(
-        dimensions: {
-          depth: 15,
-          length: 20,
-          width: 15,
-          weight: 1
-        },
-        value: {
-          currency: 'GBP',
-          amount: 10
-        },
-        deliveryAddress: {
-          name: 'Don Joe',
-          addressLine1: 'Real Logic',
-          addressLine2: '4-4 Ridings Park, Eastern Way',
-          countryCode: 'GB',
-          postcode: 'WS117FJ'
-        }
-      )
-      HEREDOC
-    end
-  end
-end