vertex_client 0.6.1

data/lib/vertex_client/rates.rb

@@ -0,0 +1,55 @@
+module VertexClient
+  RATES = {
+    'AL' => '0.11',
+    'AK' => '0.0',
+    'AZ' => '0.0',
+    'AR' => '0.0',
+    'CA' => '0.0',
+    'CO' => '0.112',
+    'CT' => '0.0635',
+    'DE' => '0.0',
+    'FL' => '0.0',
+    'GA' => '0.089',
+    'HI' => '0.045',
+    'ID' => '0.09',
+    'IL' => '0.11',
+    'IN' => '0.07',
+    'IA' => '0.07',
+    'KS' => '0.0',
+    'KY' => '0.06',
+    'LA' => '0.122',
+    'ME' => '0.055',
+    'MD' => '0.06',
+    'MA' => '0.0625',
+    'MI' => '0.06',
+    'MN' => '0.0888',
+    'MS' => '0.07',
+    'MO' => '0.0',
+    'MT' => '0.0',
+    'NE' => '0.075',
+    'NV' => '0.0827',
+    'NH' => '0.0',
+    'NJ' => '0.0863',
+    'NM' => '0.0',
+    'NY' => '0.0',
+    'NC' => '0.075',
+    'ND' => '0.085',
+    'OH' => '0.08',
+    'OK' => '0.115',
+    'OR' => '0.0',
+    'PA' => '0.08',
+    'RI' => '0.7',
+    'SC' => '0.09',
+    'SD' => '0.075',
+    'TN' => '0.0',
+    'TX' => '0.0825',
+    'UT' => '0.086',
+    'VT' => '0.07',
+    'VA' => '0.07',
+    'WA' => '0.104',
+    'WV' => '0.07',
+    'WI' => '0.0675',
+    'WY' => '0.08',
+    'DC' => '0.0'
+  }.freeze
+end

data/lib/vertex_client/resources/base.rb

@@ -0,0 +1,41 @@
+require 'active_support'
+module VertexClient
+  module Resource
+    class Base
+
+      def initialize(params)
+        @payload = payload_type.new(params)
+      end
+
+      def result
+        @result ||= (response ? formatted_response : fallback_response)
+      end
+
+      private
+
+      def response
+        @response ||= connection.request(@payload.transform)
+      end
+
+      def connection
+        @connection ||= Connection.new(self.class::ENDPOINT)
+      end
+
+      def formatted_response
+        response_type.new(response)
+      end
+
+      def payload_type
+        Kernel.const_get("VertexClient::Payload::#{demodulized_class_name}")
+      end
+
+      def response_type
+        Kernel.const_get("VertexClient::Response::#{demodulized_class_name}")
+      end
+
+      def demodulized_class_name
+        self.class.name.demodulize
+      end
+    end
+  end
+end

data/lib/vertex_client/resources/distribute_tax.rb

@@ -0,0 +1,6 @@
+module VertexClient
+  module Resource
+    class DistributeTax < Invoice
+    end
+  end
+end

data/lib/vertex_client/resources/invoice.rb

@@ -0,0 +1,12 @@
+module VertexClient
+  module Resource
+    class Invoice < Base
+      ENDPOINT = 'CalculateTax70'.freeze
+      ERROR_MESSAGE = 'The Vertex API returned an error or is unavailable'.freeze
+
+      def fallback_response
+        raise ServerError, ERROR_MESSAGE
+      end
+    end
+  end
+end

data/lib/vertex_client/resources/quotation.rb

@@ -0,0 +1,12 @@
+module VertexClient
+  module Resource
+    class Quotation < Base
+      ENDPOINT = 'CalculateTax70'.freeze
+
+      def fallback_response
+        fallback_payload = Payload::QuotationFallback.new(@payload.params)
+        Response::QuotationFallback.new(fallback_payload)
+      end
+    end
+  end
+end

data/lib/vertex_client/resources/tax_area.rb

@@ -0,0 +1,10 @@
+module VertexClient
+  module Resource
+    class TaxArea < Base
+      ENDPOINT = 'LookupTaxAreas70'.freeze
+      def fallback_response
+        Response::TaxAreaFallback.new
+      end
+    end
+  end
+end

data/lib/vertex_client/responses/base.rb

@@ -0,0 +1,17 @@
+require 'active_support'
+module VertexClient
+  module Response
+    class Base
+
+      def initialize(vertex_response)
+        @body = vertex_response.body[:vertex_envelope][response_key].with_indifferent_access
+      end
+
+      private
+
+      def response_key
+        :"#{self.class.name.demodulize.underscore}_response"
+      end
+    end
+  end
+end

data/lib/vertex_client/responses/distribute_tax.rb

@@ -0,0 +1,17 @@
+module VertexClient
+  module Response
+    class DistributeTax < Base
+      def subtotal
+        @subtotal ||= BigDecimal.new(@body[:sub_total])
+      end
+
+      def total_tax
+        @total_tax ||= BigDecimal.new(@body[:total_tax])
+      end
+
+      def total
+        @total ||= BigDecimal.new(@body[:total])
+      end
+    end
+  end
+end

data/lib/vertex_client/responses/invoice.rb

@@ -0,0 +1,6 @@
+module VertexClient
+  module Response
+    class Invoice < Quotation
+    end
+  end
+end

data/lib/vertex_client/responses/line_item.rb

@@ -0,0 +1,15 @@
+module VertexClient
+  module Response
+    class LineItem
+
+      attr_reader :total_tax, :product, :quantity, :price
+
+      def initialize(params={})
+        @product        = params[:product]
+        @quantity       = params[:quantity] ? params[:quantity].to_i : 0
+        @price          = BigDecimal.new(params[:price] || 0)
+        @total_tax      = BigDecimal.new(params[:total_tax] || 0)
+      end
+    end
+  end
+end

data/lib/vertex_client/responses/quotation.rb

@@ -0,0 +1,39 @@
+module VertexClient
+  module Response
+    class Quotation < Base
+
+      def subtotal
+        @subtotal ||= BigDecimal.new(@body[:sub_total])
+      end
+
+      def total_tax
+        @total_tax ||= BigDecimal.new(@body[:total_tax])
+      end
+
+      def total
+        @total ||= BigDecimal.new(@body[:total])
+      end
+
+      def line_items
+        @line_items ||= @body[:line_item].flatten.map do |line_item|
+          LineItem.new(
+            product:        product_for_line_item(line_item),
+            quantity:       line_item[:quantity],
+            price:          line_item[:extended_price],
+            total_tax:      tax_for_line_item(line_item)
+          )
+        end
+      end
+
+      private
+
+      def tax_for_line_item(line_item)
+        line_item[:total_tax]
+      end
+
+      def product_for_line_item(line_item)
+        line_item[:product]
+      end
+    end
+  end
+end

data/lib/vertex_client/responses/quotation_fallback.rb

@@ -0,0 +1,42 @@
+module VertexClient
+  module Response
+    class QuotationFallback < Quotation
+
+      def initialize(payload)
+        @body = payload.body
+      end
+
+      def subtotal
+        @subtotal || line_items.sum(&:price)
+      end
+
+      def total_tax
+        @total_tax ||= line_items.sum(&:total_tax).floor(2)
+      end
+
+      def total
+        @total ||= subtotal + total_tax
+      end
+
+      private
+
+      def tax_amount(price, state)
+        if RATES.has_key?(state)
+          price * BigDecimal.new(RATES[state])
+        else
+          BigDecimal.new("0.0")
+        end
+      end
+
+      def tax_for_line_item(line_item)
+        price = BigDecimal.new(line_item[:extended_price].to_s)
+        state = line_item[:customer][:destination][:main_division]
+        tax_amount(price, state)
+      end
+
+      def product_for_line_item(line_item)
+        line_item[:product][:content!]
+      end
+    end
+  end
+end

data/lib/vertex_client/responses/tax_area.rb

@@ -0,0 +1,9 @@
+module VertexClient
+  module Response
+    class TaxArea < Base
+      def tax_area_id
+        @tax_area_id ||= @body[:tax_area_result][:@tax_area_id]
+      end
+    end
+  end
+end

data/lib/vertex_client/responses/tax_area_fallback.rb

@@ -0,0 +1,9 @@
+module VertexClient
+  module Response
+    class TaxAreaFallback
+      def tax_area_id
+        nil
+      end
+    end
+  end
+end

data/lib/vertex_client/utils/adjustment_allocator.rb

@@ -0,0 +1,61 @@
+module VertexClient
+  module Utils
+    class AdjustmentAllocator
+      def initialize(adjustment, weights)
+        @adjustment = adjustment
+        @weights    = weights
+      end
+
+      def allocate
+        return [] if weights.empty? && @adjustment.zero?
+        validate!
+        allocations, remainders = allocations_with_remainders.transpose
+        remaining_adjustment    = adjustment_in_cents - allocations.sum
+        deserving_indices       = remainders.each_with_index.sort_by { |remainder, i| [remainder, i] }.map { |_r, i| i }.last(remaining_adjustment)
+        allocations.each_with_index.map { |allocation, i| deserving_indices.include?(i) ? cents_to_dollars(allocation + 1) : cents_to_dollars(allocation) }
+      end
+
+      private
+
+      ADJUSTMENT_ERROR = 'adjustment must not be more precise than two decimal places (eg: 2.14 or 0.05)'.freeze
+      WEIGHTS_ERROR    = 'all weights must be a non-negative number, and must not total zero'.freeze
+
+      def adjustment_format_valid?
+        adjustment.is_a?(Numeric) && (dollars_to_cents(adjustment) == adjustment * 100)
+      end
+
+      def adjustment_in_cents
+        dollars_to_cents(adjustment)
+      end
+
+      def allocations_with_remainders
+        weights.map do |weight|
+          (adjustment_in_cents * weight).divmod(weights_total)
+        end
+      end
+
+      def cents_to_dollars(cents)
+        cents / 100.to_d
+      end
+
+      def dollars_to_cents(dollars)
+        (dollars * 100).to_i
+      end
+
+      def validate!
+        raise VertexClient::ValidationError.new(ADJUSTMENT_ERROR) unless adjustment_format_valid?
+        raise VertexClient::ValidationError.new(WEIGHTS_ERROR) unless weights_format_valid?
+      end
+
+      def weights_format_valid?
+        weights.all? { |weight| weight.is_a?(Numeric) && weight >= 0 } && !weights_total.zero?
+      end
+
+      def weights_total
+        weights.sum
+      end
+
+      attr_reader :adjustment, :weights
+    end
+  end
+end

data/lib/vertex_client/version.rb

@@ -0,0 +1,3 @@
+module VertexClient
+  VERSION = "0.6.1"
+end

data/vertex_client.gemspec

@@ -0,0 +1,54 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vertex_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "vertex_client"
+  spec.version       = VertexClient::VERSION
+  spec.authors       = ["Custom Ink"]
+  spec.email         = ["technology@customink.com"]
+  spec.required_ruby_version = '>= 2.1'
+  spec.summary       = %q{A Ruby Gem to integrate with the Vertex Cloud API}
+  spec.description   = %q{The Vertex Client Ruby Gem provides an interface to integrate with Vertex Cloud's SOAP API.}
+  spec.homepage      = "https://github.com/customink/vertex_client"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/customink/vertex_client"
+    spec.metadata["changelog_uri"] = "https://github.com/customink/vertex_client/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "savon", ">= 2.11"
+  spec.add_development_dependency "circuitbox"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "wwtd"
+
+end

metadata

@@ -0,0 +1,288 @@
+--- !ruby/object:Gem::Specification
+name: vertex_client
+version: !ruby/object:Gem::Version
+  version: 0.6.1
+platform: ruby
+authors:
+- Custom Ink
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: circuitbox
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !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: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  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: The Vertex Client Ruby Gem provides an interface to integrate with Vertex
+  Cloud's SOAP API.
+email:
+- technology@customink.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".gitignore"
+- ".travis.yml"
+- Brewfile
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bootstrap
+- bin/console
+- bin/setup
+- bin/test
+- bin/update
+- lib/generators/install/install_generator.rb
+- lib/generators/install/templates/initializer.rb.erb
+- lib/vertex_client.rb
+- lib/vertex_client/configuration.rb
+- lib/vertex_client/connection.rb
+- lib/vertex_client/payloads/base.rb
+- lib/vertex_client/payloads/distribute_tax.rb
+- lib/vertex_client/payloads/invoice.rb
+- lib/vertex_client/payloads/quotation.rb
+- lib/vertex_client/payloads/quotation_fallback.rb
+- lib/vertex_client/payloads/tax_area.rb
+- lib/vertex_client/railtie.rb
+- lib/vertex_client/rates.rb
+- lib/vertex_client/resources/base.rb
+- lib/vertex_client/resources/distribute_tax.rb
+- lib/vertex_client/resources/invoice.rb
+- lib/vertex_client/resources/quotation.rb
+- lib/vertex_client/resources/tax_area.rb
+- lib/vertex_client/responses/base.rb
+- lib/vertex_client/responses/distribute_tax.rb
+- lib/vertex_client/responses/invoice.rb
+- lib/vertex_client/responses/line_item.rb
+- lib/vertex_client/responses/quotation.rb
+- lib/vertex_client/responses/quotation_fallback.rb
+- lib/vertex_client/responses/tax_area.rb
+- lib/vertex_client/responses/tax_area_fallback.rb
+- lib/vertex_client/utils/adjustment_allocator.rb
+- lib/vertex_client/version.rb
+- vertex_client.gemspec
+homepage: https://github.com/customink/vertex_client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/customink/vertex_client
+  source_code_uri: https://github.com/customink/vertex_client
+  changelog_uri: https://github.com/customink/vertex_client/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A Ruby Gem to integrate with the Vertex Cloud API
+test_files: []