hermes_api 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: decb2c7f0da4ef7dfa95e137bb613f325005f58441d8cb1f9d661ac1ad0a043f
-  data.tar.gz: 3168e91a8a8e03076d00b299e91b52fd784bf8be90b031376e713d5cad093280
+  metadata.gz: cfeafd10d08ea6ffa236a36b66d94dc11f3b7883931aade9995a93488d9a17e9
+  data.tar.gz: 3d4fb22d7d6f794988fedbefc1d79c384b744a13085fb9b9e6073fed00bd7638
 SHA512:
-  metadata.gz: '082600bc6adb445edd65488dac82b68a5d35f69676502e18f2cc26969156bfb4a1acc23e6b3bde7d61779a7019ebd113fce122ce9843f644201e4134480ae315'
-  data.tar.gz: 6bfc6e4202d609471d541196bea1081876ebfd9ccdb3c94cba1f15f7b3e6ca5a2cb2ef95290ca98d8a09efa44ff9c06456ddbb3f9014f756b3314de775b67762
+  metadata.gz: 4fc203dac84c6484c990dcca4d2c070c083d8f0c588d465daa6c3de2eb0a02a0c2523376d9d30e9d37e2dc518c20b57b76c63c80070c5c45dc90404e6a5b46c8
+  data.tar.gz: 59160916b4fe767ead70309ef93f7c67c0392c577159ccde3f6d8fb8bded452194401db92781636cce250be07b614723461729d61fc9144fac4b153659051c45

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hermes_api (0.1.0)
+    hermes_api (0.3.1)
       activeresource (>= 4.1.0, < 6.0.0)
 
 GEM
@@ -32,6 +32,7 @@ GEM
     dotenv (2.7.6)
     ffi (1.15.3)
     formatador (0.3.0)
+    gem-release (2.2.2)
     guard (2.17.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -117,6 +118,7 @@ PLATFORMS
 
 DEPENDENCIES
   dotenv
+  gem-release
   guard-rspec
   hermes_api!
   pry
@@ -127,4 +129,4 @@ DEPENDENCIES
   standard
 
 BUNDLED WITH
-   2.2.15
+   2.2.24

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

@@ -3,15 +3,15 @@
 require_relative "lib/hermes_api/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "hermes_api"
-  spec.version       = HermesAPI::VERSION
-  spec.authors       = ["Andy Chong"]
-  spec.email         = ["andygg1996personal@gmail.com"]
-
-  spec.summary       = "Unofficial Ruby object based Hermes UK API wrapper."
-  spec.description   = "Unofficial Ruby object based Hermes UK API wrapper."
-  spec.homepage      = "https://github.com/PostCo/hermes_api"
-  spec.license       = "MIT"
+  spec.name = "hermes_api"
+  spec.version = HermesAPI::VERSION
+  spec.authors = ["Andy Chong"]
+  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."
+  spec.homepage = "https://github.com/PostCo/hermes_api"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org/"
@@ -25,11 +25,11 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activeresource", ">= 4.1.0", "< 6.0.0" 
+  spec.add_dependency "activeresource", ">= 4.1.0", "< 6.0.0"
 
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "dotenv"
@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "guard-rspec"
   spec.add_development_dependency "standard"
+  spec.add_development_dependency "gem-release"
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"

data/lib/dev/config.rb

@@ -2,9 +2,12 @@ require "dotenv/load"
 
 def set_config
   HermesAPI.configure do |config|
-    config.user = ENV["HERMES_API_USER"] 
+    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 
+end

data/lib/dev/zeitwerk_loader.rb

@@ -8,6 +8,7 @@ loader.inflector.inflect(
 loader.push_dir("./lib")
 loader.collapse("./lib/hermes_api/resources")
 loader.ignore("#{__dir__}/config.rb")
+loader.ignore("./lib/hermes_api/cache.rb")
 loader.enable_reloading
 # loader.log!
 loader.setup

data/lib/hermes_api.rb

@@ -4,10 +4,17 @@ require_relative "hermes_api/version"
 require "active_resource"
 
 module HermesAPI
+  require "hermes_api/cache"
   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_code"
+  require "hermes_api/resources/tracking_event"
+  require "hermes_api/resources/web_tracking"
 end

data/lib/hermes_api/bearer_token_setup.rb

@@ -0,0 +1,23 @@
+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/cache.rb

@@ -0,0 +1,10 @@
+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

data/lib/hermes_api/configuration.rb

@@ -1,11 +1,19 @@
 module HermesAPI
   class Configuration
-    attr_accessor :proxy, :env, :user, :password
+    attr_accessor :proxy, :env, :user, :password, :auth_id, :auth_secret, :api_key
   end
 
   PRODUCTION_SITE = "https://www.hermes-europe.co.uk"
   TESTING_SITE = "https://sit.hermes-europe.co.uk"
 
+  OAUTH_PRODUCTION_SITE = "https://hermes-client-integration-prod.eu.auth0.com"
+  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"
+
   class << self
     def config
       @config ||= Configuration.new
@@ -16,6 +24,11 @@ module HermesAPI
       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

@@ -0,0 +1,6 @@
+module HermesAPI
+  class JsonBase < ActiveResource::Base
+    self.include_format_in_path = false
+    self.auth_type = :bearer
+  end
+end

data/lib/hermes_api/resources/o_auth.rb

@@ -0,0 +1,17 @@
+module HermesAPI
+  class OAuth < ActiveResource::Base
+    self.include_format_in_path = false
+    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

data/lib/hermes_api/resources/print_in_store_qr_code.rb

@@ -0,0 +1,19 @@
+module HermesAPI
+  class PrintInStoreQrCode < JsonBase
+    extend BearerTokenSetup
+
+    self.element_name = ""
+    self.prefix = "/client-print-in-store-api/v1/references"
+
+    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

@@ -23,8 +23,8 @@ module HermesAPI
             addressLine1: "",
             postCode: "",
             city: "",
-            region: ""
-            countryCode: "",
+            region: "",
+            countryCode: ""
           },
           mobilePhoneNo: "",
           email: "",
@@ -50,6 +50,8 @@ module HermesAPI
     rescue NameError
     end
 
+    alias_method :label, :labels
+
     def tracking_numbers
       entries = routingResponseEntries.routingResponseEntry
       if entries.is_a?(Array)
@@ -62,7 +64,76 @@ module HermesAPI
     rescue NameError
     end
 
-    alias_method :label, :labels
     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

data/lib/hermes_api/resources/tracking_event.rb

@@ -0,0 +1,12 @@
+module HermesAPI
+  class TrackingEvent < JsonBase
+    extend BearerTokenSetup
+
+    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.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-06 00:00:00.000000000 Z
+date: 2021-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -114,9 +114,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Unofficial Ruby object based Hermes UK API wrapper.
 email:
-- andygg1996personal@gmail.com
+- andy@postco.co
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -137,11 +151,18 @@ files:
 - lib/dev/config.rb
 - lib/dev/zeitwerk_loader.rb
 - lib/hermes_api.rb
+- lib/hermes_api/bearer_token_setup.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/json_base.rb
+- lib/hermes_api/resources/o_auth.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:
@@ -166,7 +187,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Unofficial Ruby object based Hermes UK API wrapper.