hermes_api 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1313c32c78bfdd9fb7a8256298157ca5a13f8a92a5074edeb1671969cb5f43
-  data.tar.gz: 14a9dbfd88d46e2c0dce1e49baf0fd8d992332ac5051a60e24b7dc9af083c9a4
+  metadata.gz: b071e3f67cee6a1475d31ef398886a256a6caa74af59f57a4cd94b35982298e0
+  data.tar.gz: 0501c14dc98e8de9e9c1d3bdb703e19f69d41f55a048249ade0ab1cb102793ed
 SHA512:
-  metadata.gz: 8bab7f7db1681634318f832ce9e2aacd1d059025f2745dfddc6a115581dfaad5de7baa552ceb23116e31fa3dae7cbdc16f9200ddad8ad61b7a828156a3fd925b
-  data.tar.gz: 31f1ea2846b709e074a7a280b8ee7fa84820db2622370c2b011fe53d69d1bcd3ff536b921a8aaa20bfe2a6aad66d3098d1f81bea283866b74e9d5eb555e3cdff
+  metadata.gz: 7dd454207d4bcb9eea759890d4243b9486fbf704c29117614e51d1654621bbcde2c458916a0e89e6b1bd884cc65d40f41d113dcbe460c0f654b7a445e114a1bc
+  data.tar.gz: c6f727e2435134d77e00b856c61bd08467c374dd6cb95a58b9c517871fe325d50f2e468aad228a5f09b78958e507cff404216a32c206670763c18215138548b5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hermes_api (0.2.1)
+    hermes_api (0.4.1)
       activeresource (>= 4.1.0, < 6.0.0)
 
 GEM

data/bin/console

@@ -6,7 +6,6 @@ require "dotenv/load"
 require "dev/zeitwerk_loader"
 require "dev/config"
 require "hermes_api"
-
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 set_config

data/hermes_api.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |spec|
   spec.name = "hermes_api"
   spec.version = HermesAPI::VERSION
   spec.authors = ["Andy Chong"]
-  spec.email = ["andygg1996personal@gmail.com"]
+  spec.email = ["andy@postco.co"]
 
   spec.summary = "Unofficial Ruby object based Hermes UK API wrapper."
   spec.description = "Unofficial Ruby object based Hermes UK API wrapper."

data/lib/dev/config.rb

@@ -2,12 +2,7 @@ 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
     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,38 @@
+module HermesAPI
+  module BearerAuth
+    def with_oauth_session(api_key, client_id, client_secret)
+      headers["apikey"] = api_key
+      connection.bearer_token = fetch_token(client_id, client_secret)
+      response = yield
+      connection.bearer_token = nil
+      headers["apikey"] = nil
+      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/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,9 @@ 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
     end
 
     def configure

data/lib/hermes_api/resources/json_base.rb

@@ -3,24 +3,8 @@ module HermesAPI
     self.include_format_in_path = false
     self.auth_type = :bearer
 
-    OAUTH_AUDIENCE = nil
-
-    def save
-      token = HermesAPI.cache.read("#{self.class.name}/oauth_token") || fetch_token
-      connection.bearer_token = token
-      super
-    end
-
-    private
-
-    def fetch_token
-      response = OAuth.create(audience: self.class::OAUTH_AUDIENCE)
-      HermesAPI.cache.write(
-        "#{self.class.name}/oauth_token",
-        response.access_token,
-        expires_in: response.expires_in - 15 # clear cache earlier
-      )
-      response.access_token
+    def self.inherited(subclass)
+      subclass.extend(BearerAuth)
     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/{print_in_store_qr.rb → print_in_store_qr_code.rb}

@@ -1,14 +1,17 @@
 module HermesAPI
-  class PrintInStoreQr < JsonBase
+  class PrintInStoreQrCode < JsonBase
     self.element_name = ""
     self.prefix = "/client-print-in-store-api/v1/references"
 
-    OAUTH_AUDIENCE = "client-print-in-store-api"
-
     def load(attributes, remove_root = false, persisted = false)
       # remove the outer array before parsing the response body
       attributes = attributes[0] if attributes.is_a?(Array) && attributes.length == 1
       super
     end
+
+    def qr_code
+      base64_data = as_json.dig("qrCode", "base64EncodedBytes")
+      Base64.decode64(base64_data) if base64_data
+    end
   end
 end

data/lib/hermes_api/resources/return_label.rb

@@ -1,9 +1,56 @@
-"
-Create return label(s).
-You can choose to create a batch of return labels by passing in multiple collectionRoutingRequestEntry.
-"
 module HermesAPI
   class ReturnLabel < Base
+    # Create return label(s).
+    # 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: "1234",
+    #                   clientName: "Life",
+    #                   childClientId: "",
+    #                   childClientName: "",
+    #                   sourceOfRequest: "CLIENTWS",
+    #                   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"
+    #                     },
+    #                     countryOfOrigin: "GB"
+    #                   }]}
+    #   @order = HermesAPI::ReturnLabel.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(
+    #       deliveryAddress: {
+    #         name: "Andy",
+    #         addressLine1: "7 Street",
+    #         addressLine2: "Fulham",
+    #         countryCode: "GB",
+    #         postcode: "SW6 6EL"
+    #       },
+    #       dimensions: {
+    #         depth: 15,
+    #         length: 20,
+    #         width: 15,
+    #         weight: 1
+    #       },
+    #       value: {
+    #         currency: "GBP",
+    #         amount: 10
+    #       }
+    #     )
+    #   end
+    # end
+    #
     self.prefix = "/routing/service/rest/v4/createReturnBarcodeAndLabel"
     self.element_name = ""
 
@@ -66,18 +113,11 @@ module HermesAPI
 
     alias_method :tracking_number, :tracking_numbers
 
-    def request_print_in_store_qr_code(attrs = {
-      dimensions: {
-        depth: 15,
-        length: 20,
-        width: 15,
-        weight: 1
-      },
-      value: {
-        currency: "GBP",
-        amount: 10
-      }
-    })
+    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
@@ -86,17 +126,10 @@ module HermesAPI
       barcode = carrier.barcode1
       customer = collectionRoutingRequestEntries[0].customer
       address = customer.address
-
-      self.print_in_store_qr_code = PrintInStoreQr.create(
+      self.print_in_store_qr_code = PrintInStoreQrCode.create(
         customer: {
           customerReference1: customer.customerReference1
         },
-        deliveryAddress: {
-          name: "#{address.firstName} #{address.lastName}",
-          addressLine1: address.addressLine1,
-          countryCode: address.countryCode,
-          postcode: address.postCode
-        },
         labelType: "RETURN",
         barcode: {
           barcode: barcode.barcodeNumber,
@@ -121,8 +154,32 @@ module HermesAPI
       )
     end
 
-    def base64_print_in_store_qr_code
-      as_json.dig("print_in_store_qr_code", "qrCode", "base64EncodedBytes")
+    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

data/lib/hermes_api/resources/tracking_event.rb

@@ -0,0 +1,16 @@
+module HermesAPI
+  class TrackingEvent < JsonBase
+    #   # 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"
+
+    def self.where(barcode:)
+      super(barcode: barcode, descriptionType: "CLIENT")
+    end
+  end
+end

data/lib/hermes_api/resources/web_tracking.rb

@@ -0,0 +1,29 @@
+module HermesAPI
+  class WebTracking < ActiveResource::Base
+    self.element_name = ""
+    self.site = "https://api.hermesworld.co.uk"
+    self.prefix = "/enterprise-tracking-api/v1/parcels"
+    self.include_format_in_path = false
+    headers["apiKey"] = ENV["HERMES_WEB_TRACKING_API_KEY"]
+
+    MAPPING = {
+      "715" => "pending_drop_off",
+      "708" => "dropped_off",
+      "690" => "dropped_off",
+      "710" => "collected_by_courier",
+      "688" => "collected_by_courier",
+      "689" => "collected_by_courier",
+      "711" => "collected_by_courier"
+    }
+
+    def load(attributes, remove_root = false, persisted = false)
+      attributes = attributes.dig("results", 0)
+      super(attributes)
+    end
+
+    def self.find(barcode)
+      uniqueId = format.decode(connection.get("#{prefix}/search/#{barcode}", headers).body).first
+      find_single("", params: {uniqueIds: uniqueId})
+    end
+  end
+end

data/lib/hermes_api/version.rb

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

data/lib/hermes_api.rb

@@ -5,15 +5,17 @@ require "active_resource"
 
 module HermesAPI
   require "hermes_api/cache"
+  require "hermes_api/bearer_auth"
   require "hermes_api/configuration"
   require "hermes_api/creation_error"
   require "hermes_api/connection"
 
   require "hermes_api/resources/base"
   require "hermes_api/resources/return_label"
-  
+
   require "hermes_api/resources/o_auth"
   require "hermes_api/resources/json_base"
-  require "hermes_api/resources/print_in_store_qr"
-
+  require "hermes_api/resources/print_in_store_qr_code"
+  require "hermes_api/resources/tracking_event"
+  require "hermes_api/resources/web_tracking"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -130,7 +130,7 @@ dependencies:
         version: '0'
 description: Unofficial Ruby object based Hermes UK API wrapper.
 email:
-- andygg1996personal@gmail.com
+- andy@postco.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -151,6 +151,7 @@ files:
 - lib/dev/config.rb
 - lib/dev/zeitwerk_loader.rb
 - lib/hermes_api.rb
+- lib/hermes_api/bearer_auth.rb
 - lib/hermes_api/cache.rb
 - lib/hermes_api/configuration.rb
 - lib/hermes_api/connection.rb
@@ -158,8 +159,10 @@ files:
 - lib/hermes_api/resources/base.rb
 - lib/hermes_api/resources/json_base.rb
 - lib/hermes_api/resources/o_auth.rb
-- lib/hermes_api/resources/print_in_store_qr.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/version.rb
 homepage: https://github.com/PostCo/hermes_api
 licenses: