huginn_bigcommerce_order_agent 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37b3f2f6cb0a72462c5ac574ceca9c2c43dc62f73141c36d4f9fded17baa91e9
-  data.tar.gz: d366ade42a3d0eba1cc01f164dc6a2b88f5d9a61f2ee4537706e5fc716179202
+  metadata.gz: cabec8912614fcbefdb3f4b24312d2f5fba6efb291a35aba2cc42056d1652975
+  data.tar.gz: a45e78bf2dc55451a236bda4eca4e25d27316964661990576d1654e751878441
 SHA512:
-  metadata.gz: deaa0ce3da5b2ffe1acf67b1fdd722016905d2f0382ab01a9a5302518552e20c63d17bb512619242b02695313e237dc39a61ffc61fecefc4bb7acecc1a588d7e
-  data.tar.gz: 9c500ed4653260221828b4ea07557cfbf04e4ed1868ec3763a23f44bd11363e7d7f1c1f75ad9f2fb36171f19ab084c2e072b721c92bfa02e8befa822a8bec2ba
+  metadata.gz: 31af98d99c56f1e923bb55d1fd6022b5d408988169929faa3526fcb8265375d90ed93477ee08d84fbfaa2eab93ca638109a33717fc0b3f2a86b1dce09de65aa7
+  data.tar.gz: 50f36319afbefee1f094a3ed7c3a7d1a39ef6abb082e5e83b690a80bc4e866c2db7ac47059f33b3529d5b0bf694e1b8407c55eea427df29f8aee3ada6e213583

data/lib/client/customer.rb

@@ -12,7 +12,14 @@ module BigcommerceOrderAgent
           return response.body['data'][0]
         rescue Faraday::Error::ClientError => e
           raise BigcommerceApiError.new(
-            'get order', "Failed to get order #{id}", { order_id: id }, e
+            e.response[:status],
+            'get order customer',
+            "Failed to get order customer #{id}",
+            id,
+            {
+              errors: JSON.parse(e.response[:body])['errors']
+            },
+            e
           )
         end
       end

data/lib/client/order.rb

@@ -1,6 +1,10 @@
+require 'carmen'
+
 module BigcommerceOrderAgent
   module Client
     class Order < AbstractClient
+      include Carmen
+
       @uri_base = ':api_version/orders/:order_id'
 
       def get(id, params = {})
@@ -10,7 +14,16 @@ module BigcommerceOrderAgent
           response = client.get(uri({ order_id: id }), params)
           order = response.body
         rescue Faraday::Error => e
-          raise BigcommerceApiError.new('get order', { order_id: id }, e)
+          raise BigcommerceApiError.new(
+            e.response[:status],
+            'get order',
+            "Failed to get order #{id}",
+            id,
+            {
+              errors: JSON.parse(e.response[:body])['errors']
+            },
+            e
+          )
         end
 
         if order.present?
@@ -20,6 +33,8 @@ module BigcommerceOrderAgent
           order[:transactions] = get_transactions(id)
           order[:shipments] = get_shipments(id)
 
+          order['billing_address']['state_code'] = get_region_code(order['billing_address'])
+
           transactions = get_transactions(id)
         end
 
@@ -34,7 +49,16 @@ module BigcommerceOrderAgent
           response = client.get(uri({ order_id: order_id }, 'products'), params)
           return response.body
         rescue Faraday::Error => e
-          raise BigcommerceApiError.new('get order products', { order_id: order_id }, e)
+          raise BigcommerceApiError.new(
+            e.response[:status],
+            'get order products',
+            "Failed to get order products #{order_id}",
+            order_id,
+            {
+              errors: JSON.parse(e.response[:body])['errors']
+            },
+            e
+          )
         end
       end
 
@@ -42,9 +66,25 @@ module BigcommerceOrderAgent
       def get_shipping_addresses(order_id, params = {})
         begin
           response = client.get(uri({ order_id: order_id }, 'shipping_addresses'), params)
-          return response.body
+
+          addresses = response.body
+
+          addresses.each do |addr|
+            addr['state_code'] = get_region_code(addr)
+          end
+
+          return addresses
         rescue Faraday::Error => e
-          raise BigcommerceApiError.new('get order shipping address', { order_id: order_id }, e)
+          raise BigcommerceApiError.new(
+            e.response[:status],
+            'get order shipping address',
+            "Failed to get order shipping address #{order_id}",
+            order_id,
+            {
+              errors: JSON.parse(e.response[:body])['errors']
+            },
+            e
+          )
         end
       end
 
@@ -54,7 +94,16 @@ module BigcommerceOrderAgent
           response = client.get(uri({ order_id: order_id }, 'shipments'), params)
           return response.body
         rescue Faraday::Error => e
-          raise BigcommerceApiError.new('get order shipments', { order_id: order_id }, e)
+          raise BigcommerceApiError.new(
+            e.response[:status],
+            'get order shipments',
+            "Failed to get order shipments #{order_id}",
+            order_id,
+            {
+              errors: JSON.parse(e.response[:body])['errors']
+            },
+            e
+          )
         end
       end
 
@@ -64,7 +113,15 @@ module BigcommerceOrderAgent
           response = client.get(uri({ order_id: order_id }, 'coupons'), params)
           return response.body
         rescue Faraday::Error => e
-          raise BigcommerceApiError.new('get order coupons', { order_id: order_id }, e
+          raise BigcommerceApiError.new(
+            e.response[:status],
+            'get order coupons',
+            "Failed to get order coupons #{order_id}",
+            order_id,
+            {
+              errors: JSON.parse(e.response[:body])['errors']
+            },
+            e
           )
         end
       end
@@ -75,9 +132,26 @@ module BigcommerceOrderAgent
           response = client.get(uri({ api_version: 'v3', order_id: order_id }, 'transactions'), params)
           return response.body['data']
         rescue Faraday::Error => e
-          raise BigcommerceApiError.new('get order transactions', { order_id: order_id }, e)
+          raise BigcommerceApiError.new(
+            e.response[:status],
+            'get order transactions',
+            "Failed to get order transactions #{order_id}",
+            order_id,
+            {
+              errors: JSON.parse(e.response[:body])['errors']
+            },
+            e
+          )
         end
       end
+
+      # Returns the region (state) code for the provided address
+      def get_region_code(address)
+        country = Country.named(address['country'])
+        state = country.subregions.named(address['state'])
+
+        return state.code
+      end
     end
   end
 end

data/lib/errors/bigcommerce_api_error.rb

@@ -1,10 +1,13 @@
 class BigcommerceApiError < StandardError
-  attr_reader :scope, :data, :original_error
+  attr_reader :status, :scope, :identifier, :data, :original_error
 
-  def initialize(scope, data, original_error)
+  def initialize(status, scope, message, identifier, data, original_error)
+    @status = status
     @scope = scope
+    @identifier = identifier
     @data = data
     @original_error = original_error
-    super(original_error.message)
+
+    super(message)
   end
 end

data/lib/huginn_bigcommerce_order_agent/bigcommerce_order_agent.rb

@@ -148,14 +148,16 @@ module Agents
         )
 
       rescue BigcommerceApiError => e
-        faraday_error = e.original_error
-
-        create_event payload: new_event.merge(
-          status: faraday_error.response[:status],
-          scope: e.scope,
-          response: faraday_error.response[:body],
-          request_data: e.data,
-        )
+        emit_error(e)
+      rescue => e
+        emit_error(BigcommerceApiError.new(
+          500,
+          'get order by id',
+          e.message,
+          order_id,
+          { order_id: order_id },
+          e
+        ))
       end
 
     end
@@ -176,5 +178,22 @@ module Agents
         )
     end
 
+    #  Takes a BigCommerceProductError and emits the underlying data as an error payload
+    #  to assist with error reporting. It is recommended that these errors be consolidated
+    #  with a Digest Agent and reported as a summary.
+    def emit_error(error)
+      payload = {
+        status: error.status,
+        message: error.message,
+        scope: error.scope,
+        identifier: error.identifier,
+        data: error.data,
+      }
+      Rails.logger.debug({
+        error: payload,
+        trace: error.backtrace
+      })
+      create_event({ payload: payload })
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huginn_bigcommerce_order_agent
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - 5 Stones
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-24 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler