huginn_bigcommerce_order_agent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37b3f2f6cb0a72462c5ac574ceca9c2c43dc62f73141c36d4f9fded17baa91e9
+  data.tar.gz: d366ade42a3d0eba1cc01f164dc6a2b88f5d9a61f2ee4537706e5fc716179202
+SHA512:
+  metadata.gz: deaa0ce3da5b2ffe1acf67b1fdd722016905d2f0382ab01a9a5302518552e20c63d17bb512619242b02695313e237dc39a61ffc61fecefc4bb7acecc1a588d7e
+  data.tar.gz: 9c500ed4653260221828b4ea07557cfbf04e4ed1868ec3763a23f44bd11363e7d7f1c1f75ad9f2fb36171f19ab084c2e072b721c92bfa02e8befa822a8bec2ba

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2021 5 Stones
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/client/abstract_client.rb

@@ -0,0 +1,65 @@
+
+module BigcommerceOrderAgent
+    module Client
+        class AbstractClient
+            @client = nil
+            @uri_base = ''
+
+            def initialize(store_hash, client_id, access_token)
+                @endpoint = 'https://api.bigcommerce.com'
+                @headers = {
+                    'X-Auth-Client' => client_id,
+                    'X-Auth-Token' => access_token,
+                    'Content-Type' => 'application/json',
+                    'Accept' => 'application/json'
+                }
+                @store_hash = store_hash
+            end
+
+            def self.uri_base
+                @uri_base
+            end
+
+            def uri_base
+                self.class.uri_base
+            end
+
+            def client
+                if !@client
+                    @client = Faraday.new({ url: @endpoint, headers: @headers }) do |conn|
+                        conn.use Faraday::Response::RaiseError
+                        conn.response :logger, nil, { headers: true, bodies: true }
+                        conn.response :json, :content_type => 'application/json'
+                        conn.adapter Faraday.default_adapter
+                    end
+                end
+
+                return @client
+            end
+
+            def uri(params = {}, path = nil)
+                params[:api_version] = 'v2' unless params[:api_version].present?
+                u = "/stores/#{@store_hash}/#{uri_base}"
+
+                if path
+                  u = u + "/#{path}"
+                end
+
+                params.each do |key,val|
+                  u = u.gsub(":#{key.to_s}", val.to_s)
+                end
+
+                # remove params that weren't provided
+                u = u.gsub(/(\/\:[^\/]+)/, '')
+
+                return u
+            end
+
+            def index(params = {})
+                response = client.get(uri, params)
+                return response.body['data']
+            end
+
+        end
+    end
+end

data/lib/client/customer.rb

@@ -0,0 +1,22 @@
+module BigcommerceOrderAgent
+  module Client
+    class Customer < AbstractClient
+      @uri_base = 'v3/customers'
+
+      # The v3 customer endpoint only returns a customer array. In the context of
+      # this agent, however, we only want one customer, so we intentionally return
+      # data[0]
+      def get(id, params = {})
+        begin
+          response = client.get(uri, { 'id:in' => id, 'include' => 'attributes,formfields' })
+          return response.body['data'][0]
+        rescue Faraday::Error::ClientError => e
+          raise BigcommerceApiError.new(
+            'get order', "Failed to get order #{id}", { order_id: id }, e
+          )
+        end
+      end
+
+    end
+  end
+end

data/lib/client/order.rb

@@ -0,0 +1,83 @@
+module BigcommerceOrderAgent
+  module Client
+    class Order < AbstractClient
+      @uri_base = ':api_version/orders/:order_id'
+
+      def get(id, params = {})
+        order = nil
+
+        begin
+          response = client.get(uri({ order_id: id }), params)
+          order = response.body
+        rescue Faraday::Error => e
+          raise BigcommerceApiError.new('get order', { order_id: id }, e)
+        end
+
+        if order.present?
+          order[:products] = get_products(id)
+          order[:coupons] = get_coupons(id)
+          order[:shipping_addresses] = get_shipping_addresses(id)
+          order[:transactions] = get_transactions(id)
+          order[:shipments] = get_shipments(id)
+
+          transactions = get_transactions(id)
+        end
+
+        return order
+      end
+
+      #----------  Sub Record Queries  ----------#
+
+      # Returns the order's line items
+      def get_products(order_id, params = {})
+        begin
+          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)
+        end
+      end
+
+      # Returns an array of shipping addresses attached to the order
+      def get_shipping_addresses(order_id, params = {})
+        begin
+          response = client.get(uri({ order_id: order_id }, 'shipping_addresses'), params)
+          return response.body
+        rescue Faraday::Error => e
+          raise BigcommerceApiError.new('get order shipping address', { order_id: order_id }, e)
+        end
+      end
+
+      # Returns order shipments
+      def get_shipments(order_id, params = {})
+        begin
+          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)
+        end
+      end
+
+      # Returns order-level promotions
+      def get_coupons(order_id, params = {})
+        begin
+          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
+          )
+        end
+      end
+
+      # Returns order transactions. NOTE:
+      def get_transactions(order_id, params = {})
+        begin
+          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)
+        end
+      end
+    end
+  end
+end

data/lib/errors/bigcommerce_api_error.rb

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

data/lib/huginn_bigcommerce_order_agent.rb

@@ -0,0 +1,12 @@
+require 'huginn_agent'
+require 'json'
+
+# load clients
+HuginnAgent.load 'client/abstract_client'
+HuginnAgent.load 'client/customer'
+HuginnAgent.load 'client/order'
+
+# load errors
+HuginnAgent.load 'errors/bigcommerce_api_error'
+
+HuginnAgent.register 'huginn_bigcommerce_order_agent/bigcommerce_order_agent'

data/lib/huginn_bigcommerce_order_agent/bigcommerce_order_agent.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Agents
+  class BigcommerceOrderAgent < Agent
+    include WebRequestConcern
+
+    can_dry_run!
+    default_schedule 'never'
+
+    # TODO:   Provide a more detailed agent description. Including details of
+    # each option and how that option is used
+    description <<-MD
+      Used to fetch order data from the BigCommerce API.
+
+      The BigCommerce API does not provide a way to quickly fetch the full product
+      record in a single request. The `PostAgent` provided by Huginn will do the
+      trick, but it requires 6 agents just to _fetch_ the data, and formatters to
+      ensure the `body` data in the payload is not lost on each subsequent request.
+
+      This agent is designed to consolidate that process into a single, no-frills
+      execution. We fetch the data, and return it as is in a single JSON object.
+      It's up to the end user to decide what to do next.
+
+
+      ### **Data Structures:**
+
+      *  [Orders](https://developer.bigcommerce.com/api-reference/store-management/orders/orders/getanorder#responses)
+      *  [Customers](https://developer.bigcommerce.com/api-reference/store-management/customers-v3/customers/customersget#responses)
+      *  [Order Products](https://developer.bigcommerce.com/api-reference/store-management/orders/order-products/getallorderproducts#responses)
+      *  [Shipping Addresses](https://developer.bigcommerce.com/api-reference/store-management/orders/order-shipping-addresses/getallshippingaddresses#responses)
+      *  [Order Shipments](https://developer.bigcommerce.com/api-reference/store-management/orders/order-shipments/getallordershipments#responses)
+      *  [Order Coupons](https://developer.bigcommerce.com/api-reference/store-management/orders/order-coupons/getallordercoupons#responses)
+      *  [Transactions](https://developer.bigcommerce.com/api-reference/store-management/order-transactions/transactions/gettransactions#responses)
+
+      ### **Options:**
+      *  store_hash   - required
+      *  client_id    - required
+      *  access_token - required
+      *  order_id     - required
+      *  output_mode  - not required ('clean' or 'merge', defaults to 'clean')
+
+
+      ### **Agent Payloads:**
+
+      **Success Payload:**
+
+      ```
+      {
+        order: {
+          [...],
+          customer: { ... },
+          products: { ... },
+          coupons: { ... },
+          shipping_addresses: { ... },
+          transactions: { ... }
+        },
+        status: 200,
+      }
+      ```
+
+      **Error Payload:**
+
+      ```
+      {
+        status: 5XX | 4XX,
+        scope: string,
+        response_body: {
+          status: number,
+          code: number,
+          title: string,
+          type: url,
+          errors: { ... }
+        },
+        request_data: { ... },
+      }
+      ```
+    MD
+
+    def default_options
+      {
+        'store_hash' => '',
+        'client_id' => '',
+        'access_token' => '',
+        'output_mode' => 'clean',
+        'order_id' => '',
+      }
+    end
+
+    def validate_options
+        unless options['store_hash'].present?
+          errors.add(:base, 'store_hash is a required field')
+        end
+
+        unless options['client_id'].present?
+          errors.add(:base, 'client_id is a required field')
+        end
+
+        unless options['access_token'].present?
+          errors.add(:base, 'access_token is a required field')
+        end
+
+        unless options['order_id'].present?
+          errors.add(:base, 'order_id is a required field')
+        end
+
+        if options['output_mode'].present? && !options['output_mode'].to_s.include?('{') && !%[clean merge].include?(options['output_mode'].to_s)
+          errors.add(:base, "if provided, output_mode must be 'clean' or 'merge'")
+        end
+    end
+
+    def working?
+      received_event_without_error?
+    end
+
+    def check
+      initialize_clients
+      handle interpolated['payload'].presence || {}
+    end
+
+    def receive(incoming_events)
+      initialize_clients
+      incoming_events.each do |event|
+        handle(event)
+      end
+    end
+
+    def handle(event)
+      data = event.payload
+      order_id = data['id']
+      new_event = interpolated['output_mode'].to_s == 'merge' ? data.dup : {}
+
+      if (order_id.blank?)
+        create_event payload: new_event.merge(
+          status: 500,
+          message: "'#{order_id}' is not a valid order id",
+        )
+      end
+
+      begin
+        order = @order_client.get(order_id)
+        order[:customer] = @customer_client.get(order['customer_id'])
+
+        create_event payload: new_event.merge(
+          order: order,
+          status: 200,
+        )
+
+      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,
+        )
+      end
+
+    end
+
+    private
+
+    def initialize_clients
+        @order_client = initialize_client(:Order)
+        @customer_client = initialize_client(:Customer)
+    end
+
+    def initialize_client(class_name)
+        klass = ::BigcommerceOrderAgent::Client.const_get(class_name.to_sym)
+        return klass.new(
+            interpolated['store_hash'],
+            interpolated['client_id'],
+            interpolated['access_token']
+        )
+    end
+
+  end
+end

data/spec/bigcommerce_order_agent_spec.rb

@@ -0,0 +1,13 @@
+# require 'rails_helper'
+# require 'huginn_agent/spec_helper'
+#
+# describe Agents::BigcommerceOrderAgent do
+#   before(:each) do
+#     @valid_options = Agents::BigcommerceOrderAgent.new.default_options
+#     @checker = Agents::BigcommerceOrderAgent.new(:name => "BigcommerceOrderAgent", :options => @valid_options)
+#     @checker.user = users(:bob)
+#     @checker.save!
+#   end
+#
+#   pending "add specs here"
+# end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: huginn_bigcommerce_order_agent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- 5 Stones
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: huginn_agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A no-frills agent to consolidate API requests and return BigCommerce
+  Order data as a single JSON object.
+email:
+- it@weare5stones.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/client/abstract_client.rb
+- lib/client/customer.rb
+- lib/client/order.rb
+- lib/errors/bigcommerce_api_error.rb
+- lib/huginn_bigcommerce_order_agent.rb
+- lib/huginn_bigcommerce_order_agent/bigcommerce_order_agent.rb
+- spec/bigcommerce_order_agent_spec.rb
+homepage: https://github.com/5-stones/huginn_bigcommerce_order_agent
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Agent that fetches order data from BigCommerce.
+test_files:
+- spec/bigcommerce_order_agent_spec.rb