vertex_client 0.6.1

data/lib/generators/install/install_generator.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'rails/generators'
+module VertexClient
+  class InstallGenerator < Rails::Generators::Base
+    desc 'Installs the vertex_client gem with base configuration'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_intitializer
+      template 'initializer.rb.erb', 'config/initializers/vertex_client.rb'
+    end
+  end
+end

data/lib/generators/install/templates/initializer.rb.erb

@@ -0,0 +1,27 @@
+# Uncomment the next line if you want to use circuitbox with VertexClient.
+# require "circuitbox"
+VertexClient.configure do |config|
+  config.trusted_id = ENV.fetch('VERTEX_TRUSTED_ID')
+  config.soap_api = ENV.fetch('VERTEX_SOAP_API')
+
+  # Circuitbox configuration.
+  # https://github.com/yammer/circuitbox#per-circuit-configuration
+  # config.circuit_config = {
+  #   sleep_window: 300,
+  #   time_window: 60,
+  #   error_threshold: 50,
+  #   logger: Rails.logger,
+  #   exceptions: [
+  #     VertexClient::ServerError
+  #   ]
+  # }
+
+  # Optional circuitbox store configuration:
+  #   config.circuit_config[:cache] can be set to any moneta-backed store:
+  # see: https://github.com/minad/moneta fore more information.
+  #
+  # Example - Using your Rails.cache's configured dalli store:
+  # backend = Rails.cache.instance_variable_get(:@data)
+  # config.circuit_config[:cache] = Moneta::Adapters::MemcachedDalli.new backend: backend
+
+end

data/lib/vertex_client.rb

@@ -0,0 +1,89 @@
+require 'vertex_client/version'
+require 'vertex_client/railtie' if defined?(Rails)
+require 'active_support/all'
+require 'savon'
+
+module VertexClient
+
+  autoload :Configuration,        'vertex_client/configuration'
+  autoload :Connection,           'vertex_client/connection'
+  autoload :RATES,                'vertex_client/rates'
+
+  module Utils
+    autoload :AdjustmentAllocator, 'vertex_client/utils/adjustment_allocator'
+  end
+
+  module Payload
+    autoload :Base,                 'vertex_client/payloads/base'
+    autoload :DistributeTax,        'vertex_client/payloads/distribute_tax'
+    autoload :Invoice,              'vertex_client/payloads/invoice'
+    autoload :Quotation,            'vertex_client/payloads/quotation'
+    autoload :QuotationFallback,    'vertex_client/payloads/quotation_fallback'
+    autoload :TaxArea,              'vertex_client/payloads/tax_area'
+  end
+
+  module Resource
+    autoload :Base,                 'vertex_client/resources/base'
+    autoload :DistributeTax,        'vertex_client/resources/distribute_tax'
+    autoload :Invoice,              'vertex_client/resources/invoice'
+    autoload :Quotation,            'vertex_client/resources/quotation'
+    autoload :TaxArea,              'vertex_client/resources/tax_area'
+  end
+
+  module Response
+    autoload :Base,                 'vertex_client/responses/base'
+    autoload :DistributeTax,        'vertex_client/responses/distribute_tax'
+    autoload :Invoice,              'vertex_client/responses/invoice'
+    autoload :LineItem,             'vertex_client/responses/line_item'
+    autoload :Quotation,            'vertex_client/responses/quotation'
+    autoload :QuotationFallback,    'vertex_client/responses/quotation_fallback'
+    autoload :TaxArea,              'vertex_client/responses/tax_area'
+    autoload :TaxAreaFallback,      'vertex_client/responses/tax_area_fallback'
+  end
+
+  class << self
+
+    attr_accessor :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reconfigure!
+      @configuration = Configuration.new
+      yield(@configuration) if block_given?
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def quotation(payload)
+      Resource::Quotation.new(payload).result
+    end
+
+    def invoice(payload)
+      Resource::Invoice.new(payload).result
+    end
+
+    def distribute_tax(payload)
+      Resource::DistributeTax.new(payload).result
+    end
+
+    def tax_area(payload)
+      Resource::TaxArea.new(payload).result
+    end
+
+    def circuit
+      return unless configuration.circuit_config && defined?(Circuitbox)
+      Circuitbox.circuit(
+        Configuration::CIRCUIT_NAME,
+        configuration.circuit_config
+      )
+    end
+  end
+
+  class Error < StandardError; end
+  class ValidationError < Error; end
+  class ServerError < Error; end
+end

data/lib/vertex_client/configuration.rb

@@ -0,0 +1,35 @@
+module VertexClient
+  class Configuration
+
+    CIRCUIT_NAME = 'vertex_client'.freeze
+    CIRCUIT_CONFIG = {
+      sleep_window:     300,
+      volume_threshold: 10,
+      error_threshold:  50,
+      time_window:      60,
+      logger: Logger.new(STDOUT),
+      exceptions: [
+        Savon::Error
+      ]
+    }.freeze
+
+    attr_accessor :trusted_id, :soap_api, :circuit_config
+
+    def initialize
+      @trusted_id = ENV['VERTEX_TRUSTED_ID']
+      @soap_api   = ENV['VERTEX_SOAP_API']
+    end
+
+    def circuit_config
+      CIRCUIT_CONFIG.merge(@circuit_config) if @circuit_config
+    end
+
+    def soap_api
+      @soap_api.gsub(/\/+$/ ,'') + '/'
+    end
+
+    def fallback_rates
+      RATES
+    end
+  end
+end

data/lib/vertex_client/connection.rb

@@ -0,0 +1,58 @@
+module VertexClient
+  class Connection
+
+    VERTEX_NAMESPACE = "urn:vertexinc:o-series:tps:7:0".freeze
+    ERROR_MESSAGE = 'The Vertex API returned an error or is unavailable'.freeze
+
+    def initialize(endpoint)
+      @endpoint = endpoint
+    end
+
+    def request(payload)
+      call_with_circuit_if_available do
+        client.call(
+          :vertex_envelope,
+          message: shell_with_auth.merge(payload)
+        )
+      end
+    end
+
+    def client
+      @client ||= Savon.client do |globals|
+        globals.endpoint clean_endpoint
+        globals.namespace VERTEX_NAMESPACE
+        globals.convert_request_keys_to :camelcase
+        globals.env_namespace :soapenv
+        globals.namespace_identifier :urn
+      end
+    end
+
+    def config
+      @config ||= VertexClient.configuration
+    end
+
+    private
+
+    def call_with_circuit_if_available
+      if VertexClient.circuit
+        VertexClient.circuit.run { yield }
+      else
+        begin
+          yield
+        rescue => _e
+          nil
+        end
+      end
+    end
+
+    def shell_with_auth
+      {
+        login: { trusted_id: @config.trusted_id }
+      }
+    end
+
+    def clean_endpoint
+      URI.join(config.soap_api, @endpoint).to_s
+    end
+  end
+end

data/lib/vertex_client/payloads/base.rb

@@ -0,0 +1,44 @@
+require 'active_support'
+module VertexClient
+  module Payload
+    class Base
+
+      attr_reader :params
+
+      def initialize(params)
+        @params = params.with_indifferent_access
+        validate!
+      end
+
+      def transform
+        {
+          request_key => body
+        }
+      end
+
+      private
+
+      def request_key
+        :"#{self.class.name.demodulize.underscore}_request"
+      end
+
+      def transform_customer(customer)
+        remove_nils({
+          :@isTaxExempt =>  customer[:is_tax_exempt],
+          destination: remove_nils({
+            street_address_1: customer[:address_1],
+            street_address_2: customer[:address_2],
+            city:             customer[:city],
+            main_division:    customer[:state],
+            postal_code:      customer[:postal_code],
+            country:          customer[:country]
+          })
+        })
+      end
+
+      def remove_nils(hash)
+        hash.select {|_key, value| value.present? }
+      end
+    end
+  end
+end

data/lib/vertex_client/payloads/distribute_tax.rb

@@ -0,0 +1,20 @@
+module VertexClient
+  module Payload
+    class DistributeTax < Invoice
+      def validate!
+        super
+        raise VertexClient::ValidationError.new('total_tax must be specified for all line items') unless all_line_items_have_tax?
+      end
+
+      def all_line_items_have_tax?
+        params[:line_items].all?{ |item| item[:total_tax].present? }
+      end
+
+      def transform_line_item(line_item, number, defaults)
+        remove_nils(super(line_item, number, defaults).merge(
+          input_total_tax: line_item[:total_tax]
+        ))
+      end
+    end
+  end
+end

data/lib/vertex_client/payloads/invoice.rb

@@ -0,0 +1,29 @@
+module VertexClient
+  module Payload
+    class Invoice < Quotation
+
+      DOCUMENT_NUMBER_LIMIT = 40
+
+      def validate!
+        super
+        raise VertexClient::ValidationError.new('document_number is required for invoice') if document_number_missing?
+        raise VertexClient::ValidationError.new("document_number must be less than or equal to #{DOCUMENT_NUMBER_LIMIT} characters") if document_number_too_long?
+      end
+
+      def body
+        super.merge({
+           :'@documentNumber' => params[:document_number],
+           :'@documentDate'   => params[:date]
+         })
+      end
+
+      def document_number_missing?
+        params[:document_number].to_s.empty?
+      end
+
+      def document_number_too_long?
+        params[:document_number].to_s.length > DOCUMENT_NUMBER_LIMIT
+      end
+    end
+  end
+end

data/lib/vertex_client/payloads/quotation.rb

@@ -0,0 +1,69 @@
+module VertexClient
+  module Payload
+    class Quotation < Base
+
+      SALE_TRANSACTION_TYPE = 'SALE'.freeze
+
+      def validate!
+        raise VertexClient::ValidationError.new('customer requires a state or postal_code') if customer_missing_location?
+      end
+
+      def body
+        {
+          :'@transactionType' => SALE_TRANSACTION_TYPE,
+          line_item: params[:line_items].map.with_index do |line_item, index|
+            transform_line_item(line_item, index, params)
+          end
+        }
+      end
+
+      private
+
+      def customer_missing_location?
+        !customer_lines(params).all? { |customer| customer_destination_present?(customer) }
+      end
+
+      def transform_customer(customer_params)
+        super(customer_params).tap do |customer|
+          if customer_params[:tax_area_id].present?
+            customer[:destination] = { :@taxAreaId => customer_params[:tax_area_id]}
+          end
+        end
+      end
+
+      def customer_lines(params)
+        [params[:customer], params[:line_items].map { |li| li[:customer]}].flatten.compact
+      end
+
+      def customer_destination_present?(customer)
+        customer[:state].present? && customer[:postal_code].present?
+      end
+
+      def transform_line_item(line_item, number, defaults)
+        remove_nils({
+          :'@lineItemNumber' => number+1,
+          :'@taxDate' =>  line_item[:date] || defaults[:date],
+          :'@locationCode' => line_item[:location_code] || defaults[:location_code],
+          customer:       transform_customer(line_item[:customer] || defaults[:customer]),
+          seller:         transform_seller(line_item[:seller] || defaults[:seller]),
+          product:        transform_product(line_item),
+          quantity:       line_item[:quantity],
+          extended_price: line_item[:price],
+        })
+      end
+
+      def transform_seller(seller)
+        {
+          company: seller[:company]
+        }
+      end
+
+      def transform_product(line_item)
+        {
+          :'@productClass' => line_item[:product_class],
+          :content! => line_item[:product_code]
+        }
+      end
+    end
+  end
+end

data/lib/vertex_client/payloads/quotation_fallback.rb

@@ -0,0 +1,14 @@
+module VertexClient
+  module Payload
+    class QuotationFallback < Quotation
+
+      private
+
+      def transform_customer(customer_params)
+        customer_without_tax_area = customer_params.dup
+        customer_without_tax_area.delete(:tax_area_id) if customer_without_tax_area[:tax_area_id].present?
+        super(customer_without_tax_area)
+      end
+    end
+  end
+end

data/lib/vertex_client/payloads/tax_area.rb

@@ -0,0 +1,22 @@
+module VertexClient
+  module Payload
+    class TaxArea < Base
+
+      def validate!
+        raise VertexClient::ValidationError.new('At least give a value') if values_empty?
+      end
+
+      def body
+        {
+          tax_area_lookup: {
+            postal_address: transform_customer(params)[:destination]
+          }
+        }
+      end
+
+      def values_empty?
+        params.values.all?(&:empty?)
+      end
+    end
+  end
+end

data/lib/vertex_client/railtie.rb

@@ -0,0 +1,7 @@
+module VertexClient
+  class Railtie < Rails::Railtie
+    generators do
+      require 'generators/install/install_generator'
+    end
+  end
+end