hermes_api 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d101377a4a226bc69ba37a0d644c196f23c35536812fda7bef716682dc01de05
-  data.tar.gz: 022f6ac19dfc202bad3df1a1d4b99753c49979dc35161893be38e17fe40bde5c
+  metadata.gz: cfeafd10d08ea6ffa236a36b66d94dc11f3b7883931aade9995a93488d9a17e9
+  data.tar.gz: 3d4fb22d7d6f794988fedbefc1d79c384b744a13085fb9b9e6073fed00bd7638
 SHA512:
-  metadata.gz: c08cfed50575d2a1e68d79d0dc06e51537aefe570c2af67c5eb04dacb189a71d374698a4f62c89d3dd4190b94890c1bd2fd83050dcd05e0160a66f4a470f4a92
-  data.tar.gz: 6b7c038decbcc7b330f5f666bd997bfe11d7e5d52a589c4068f98c490d8c27157f7767e1780ae29a0b8668f9a2fd47bf2a1d6b222762ad3b9b69ad7bbe8aeacb
+  metadata.gz: 4fc203dac84c6484c990dcca4d2c070c083d8f0c588d465daa6c3de2eb0a02a0c2523376d9d30e9d37e2dc518c20b57b76c63c80070c5c45dc90404e6a5b46c8
+  data.tar.gz: 59160916b4fe767ead70309ef93f7c67c0392c577159ccde3f6d8fb8bded452194401db92781636cce250be07b614723461729d61fc9144fac4b153659051c45

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hermes_api (0.3.0)
+    hermes_api (0.3.1)
       activeresource (>= 4.1.0, < 6.0.0)
 
 GEM
@@ -49,15 +49,11 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    image_processing (1.12.1)
-      mini_magick (>= 4.9.5, < 5)
-      ruby-vips (>= 2.0.17, < 3)
     listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    mini_magick (4.11.0)
     minitest (5.14.4)
     nenv (0.3.0)
     notiffany (0.1.3)
@@ -66,10 +62,6 @@ GEM
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
-    pdf-core (0.9.0)
-    prawn (2.4.0)
-      pdf-core (~> 0.9.0)
-      ttfunk (~> 1.7)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -111,14 +103,11 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
-    ruby-vips (2.1.2)
-      ffi (~> 1.12)
     shellany (0.0.1)
     standard (1.1.3)
       rubocop (= 1.18.1)
       rubocop-performance (= 1.11.2)
     thor (1.1.0)
-    ttfunk (1.7.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
@@ -132,8 +121,6 @@ DEPENDENCIES
   gem-release
   guard-rspec
   hermes_api!
-  image_processing
-  prawn
   pry
   pry-byebug
   rake (~> 13.0)

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/hermes_api.rb

@@ -11,9 +11,10 @@ module HermesAPI
 
   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/resources/json_base.rb

@@ -2,25 +2,5 @@ module HermesAPI
   class JsonBase < ActiveResource::Base
     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
-    end
   end
 end

data/lib/hermes_api/resources/print_in_store_qr_code.rb

@@ -1,10 +1,10 @@
 module HermesAPI
   class PrintInStoreQrCode < JsonBase
+    extend BearerTokenSetup
+
     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

data/lib/hermes_api/resources/return_label.rb

@@ -66,18 +66,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
@@ -91,12 +84,6 @@ module HermesAPI
         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,
@@ -120,5 +107,33 @@ module HermesAPI
         **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.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hermes_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2021-08-11 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_token_setup.rb
 - lib/hermes_api/cache.rb
 - lib/hermes_api/configuration.rb
 - lib/hermes_api/connection.rb
@@ -160,6 +161,8 @@ files:
 - 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: