hermes_api 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a6253995c5e13c6cc4c920b3825dff5563bef6a7f9ffc69aaafcb7e918378c6
-  data.tar.gz: 0cda194a1f1464eebb3c98634fdd31fcf9b8347e2c05028ca0fbd1998bae387b
+  metadata.gz: b071e3f67cee6a1475d31ef398886a256a6caa74af59f57a4cd94b35982298e0
+  data.tar.gz: 0501c14dc98e8de9e9c1d3bdb703e19f69d41f55a048249ade0ab1cb102793ed
 SHA512:
-  metadata.gz: 626e0a3607ea22c200fa724f6ed5bd09cea386c8563a8d918d5a05fd14b1ae05fa47f8787f94500ca20b9ddbf5cd09b27c5160c0eac6bf702b5afbf67dac0b18
-  data.tar.gz: fca544bc66a51feea9ca45e9a84245c2e5da4db47d96853c5dd026f990b103e9e0e55d338da8f6a84663e1180d6f9593e2ac22a52f5ce2efb884efbab9533131
+  metadata.gz: 7dd454207d4bcb9eea759890d4243b9486fbf704c29117614e51d1654621bbcde2c458916a0e89e6b1bd884cc65d40f41d113dcbe460c0f654b7a445e114a1bc
+  data.tar.gz: c6f727e2435134d77e00b856c61bd08467c374dd6cb95a58b9c517871fe325d50f2e468aad228a5f09b78958e507cff404216a32c206670763c18215138548b5

data/Gemfile.lock

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

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

@@ -2,5 +2,9 @@ module HermesAPI
   class JsonBase < ActiveResource::Base
     self.include_format_in_path = false
     self.auth_type = :bearer
+
+    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_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"
 

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 = ""
 
@@ -79,7 +126,6 @@ module HermesAPI
       barcode = carrier.barcode1
       customer = collectionRoutingRequestEntries[0].customer
       address = customer.address
-
       self.print_in_store_qr_code = PrintInStoreQrCode.create(
         customer: {
           customerReference1: customer.customerReference1
@@ -112,27 +158,27 @@ module HermesAPI
 
     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'
-        }
-      )
+        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

data/lib/hermes_api/resources/tracking_event.rb

@@ -1,6 +1,10 @@
 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/version.rb

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

data/lib/hermes_api.rb

@@ -5,7 +5,7 @@ require "active_resource"
 
 module HermesAPI
   require "hermes_api/cache"
-  require "hermes_api/bearer_token_setup"
+  require "hermes_api/bearer_auth"
   require "hermes_api/configuration"
   require "hermes_api/creation_error"
   require "hermes_api/connection"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -151,7 +151,7 @@ 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

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