vertex_client 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11ed8d014744d39407ca7e188da269f509f4f24daa20860fe18811f589909f64
+  data.tar.gz: 20daf898b1aadeb787068d7d313145df258720b8168dde5772f5c9be63b2f86b
+SHA512:
+  metadata.gz: b6732453d5d31302dfad3e8a67c2911d55e28f44a8f5b675eccb8634576f2fa649dcf54fccf5c41113618e0e8832016d53cc9c03ee491a7c8d0cc639ed2f38bc
+  data.tar.gz: 75eb538e6aa4d3587ce7d19976fd0fbc7d8f1652e46aff650fe529aec196a62ccf2296b575e0d927efc8af97a239cb63ac849aec1796504139405314b2f3d49f

data/.env

@@ -0,0 +1,2 @@
+VERTEX_TRUSTED_ID=secret
+VERTEX_SOAP_API=https://connect.vertexsmb.com/vertex-ws/services/

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+.env.*
+.ruby-version
+.byebug_history

data/.travis.yml

@@ -0,0 +1,24 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+ - 2.1.10
+ - 2.2.4
+ - 2.4.1
+ - 2.5.3
+if: branch = master OR type = pull_request
+env:
+  global:
+    - CC_TEST_REPORTER_ID=88a7fd75659a6698f28c8c4c6b60c20f902e26733691b2fe449a65474f22b618
+    - CI=true
+before_install:
+  - bin/setup
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bin/test
+after_success:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Brewfile

@@ -0,0 +1,2 @@
+# Add homebrew-based depencencies here
+tap 'github/bootstrap'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at amaas@customink.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in vertex_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Custom Ink
+
+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/README.md

@@ -0,0 +1,195 @@
+# VertexClient
+
+[![Build Status](https://travis-ci.org/customink/vertex_client.svg?branch=master)](https://travis-ci.org/customink/vertex_client) [![Maintainability](https://api.codeclimate.com/v1/badges/5f18a48fa18ddfb942f4/maintainability)](https://codeclimate.com/github/customink/vertex_client/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/5f18a48fa18ddfb942f4/test_coverage)](https://codeclimate.com/github/customink/vertex_client/test_coverage)
+
+The Vertex Client Ruby Gem provides an interface to integrate with _Vertex SMB_ which is also known as [Vertex Cloud Indirect Tax](https://www.vertexinc.com/solutions/products/vertex-cloud-indirect-tax).
+
+## Usage
+
+### Quotation
+
+```ruby
+response = VertexClient.quotation(
+  # The top level transaction date for all line items.
+  date: '2018-11-15',
+  # The top level customer for all line items.
+  customer: {
+    code: "inky@customink.com",
+    address_1: "11 Wall Street",
+    address_2: "#300",
+    city: "New York",
+    state: "NY",
+    postal_code: '10005',
+    # Optional tax_exempt status for customer
+    is_tax_exempt: true
+
+    # Optional tax_area_id for customer location
+    tax_area_id: '330612010'
+  },
+  # The top level seller for all line items.
+  seller: {
+    company: "CustomInk"
+  },
+  line_items: [
+    {
+      # Internal product ID or code
+      product_code: "4600",
+      # Mapped product class, or "commodity code", in Vertex Cloud
+      product_class: "123456"
+      quantity: 7,
+      # Total price of this line item
+      price: "35.50",
+    },
+    {
+      product_code: "5200",
+      product_class: "123456"
+      quantity: 4,
+      price: "25.40",
+      # Optional transaction date override for a line item.
+      date: '2018-11-14',
+      # Optional seller override for a line item.
+      seller: {
+        company: "CustomInkStores"
+      },
+      # Optional customer override for a line item.
+      customer: {
+        code: "prez@customink.com",
+        address_1: "1600 Pennsylvania Ave NW",
+        city: "Washington",
+        state: "DC",
+        postal_code: '20500'
+      }
+    }
+  ]
+)
+
+response.total_tax #=> Total tax amount
+response.total     #=> Total price plus total tax
+response.subtotal  #=> Total price before tax
+```
+
+### Invoice
+
+Invoice is the same payload as quotation, but with one added identifier.
+
+```ruby
+VertexClient.invoice(
+  # Vertex's Document Number is a unique referencial identifier for this invoice.
+  document_number: "unique-identifier-1a43b",
+
+  # ... All of the of the payload from quotation here ...
+)
+
+```
+
+### Distribute Tax
+
+Distribute Tax is the same payload as Invoice, but you pass `total_tax` on each line item. The `product_code` and `quantity` are optional.
+
+```ruby
+VertexClient.distribute_tax(
+
+  # ...
+
+  line_items: [
+    {
+      price: "100.00",
+      total_tax: "6.00",
+    }
+  ]
+
+)
+```
+
+### Tax Area
+Look up the internal Vertex location identifier for a given address. Including  `tax_area_id` as part of the customer information in calls to `invoice` and `quotation` should improve performance, especially in situations where there are many destination addresses.
+
+```ruby
+response = VertexClient.tax_area(
+  address_1: "11 Wall Street",
+  address_2: "#300",
+  city: "New York",
+  state: "NY",
+  postal_code: '10005'
+)
+response.tax_area_id # => '330612010'
+```
+
+### Adjustment Allocator
+
+Allocates a given monetary adjustment, such as a service charge or a discount, across a given array of weights, such as line items. The `adjustment` parameter must be passed in as a positive or negative numeric dollar amount, such as `-0.56`, `7.00` or `12.34`, and the `weights` parameter must be passed in as an array of non-negative numeric values, such as `[1.23, 4.56, 7.89]` or `[1, 2, 3, 4]`, which can represent prices or ratios.
+
+```ruby
+VertexClient::Utils::AdjustmentAllocator.new(1234.56, [310.00, 350.00, 200.00, 140.00]).allocate
+#=> [#<BigDecimal:7fa6bba053c0,'0.38271E3',18(36)>,
+     #<BigDecimal:7fa6bba0fcd0,'0.4321E3',18(36)>,
+     #<BigDecimal:7fa6bba0dfc0,'0.24691E3',18(36)>,
+     #<BigDecimal:7fa6bba17b88,'0.17284E3',18(36)>]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vertex_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vertex_client
+
+## Configuration
+
+Configure the client's connection to Vertex using environment variables or an initializer.
+
+### Environment Variables
+The following environment variables are used to configure the client.
+
+```
+VERTEX_TRUSTED_ID=your-trusted-id
+VERTEX_SOAP_API=https://connect.vertexsmb.com/vertex-ws/services/
+```
+### Initializer
+
+If you are using Rails, take advantage of the included generator:
+
+    $ bundle exec rails g vertex_client:install
+
+Otherwise reference our [initializer template](https://github.com/customink/vertex_client/blob/master/lib/generators/install/templates/initializer.rb.erb)
+
+
+## Development
+
+This project follows Github's [Scripts to rule them all conventions][scripts-to-rule-them-all]. After cloning the app,
+run the following:
+
+    bin/bootstrap
+    bin/setup
+    bin/test
+
+After pulling down changes, run the following:
+
+    bin/update
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/customink/vertex_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the VertexClient project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/customink/vertex_client/blob/master/CODE_OF_CONDUCT.md).
+
+[scripts-to-rule-them-all]: https://github.com/github/scripts-to-rule-them-all

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require 'wwtd/tasks'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/bootstrap

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+# script/bootstrap: Resolve all dependencies that the application requires to
+# run.
+
+set -e
+
+cd "$(dirname "$0")/.."
+
+if [ -f "Brewfile" ] && [ "$(uname -s)" = "Darwin" ]; then
+  brew bundle check || {
+    echo "==> Installing Homebrew dependencies..."
+    brew bundle
+  }
+fi
+
+RUBIES=(2.1.10 2.2.4 2.4.1 2.5.3)
+for VERSION in "${RUBIES[@]}"
+do
+  echo "Setting up ruby version $VERSION..."
+  echo $VERSION > .ruby-version
+  brew bootstrap-rbenv-ruby
+done

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dotenv/load"
+require "vertex_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -e
+cd "$(dirname "$0")/.."
+
+if [[ -z "$CI" ]]; then
+  # Bundle each ruby version
+  rm -rf Gemfile.lock
+  wwtd --only-bundle
+else
+  bundle --quiet
+fi

data/bin/test

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# This script is a starting point to run the entire test suite.
+# Add necessary setup steps to this file.
+
+# Uncomment when `rake db:setup` doesn't setup the test database in bin/setup
+# puts '==> Prepping test db'
+# system('RAILS_ENV=test bin/rails db:setup')
+
+puts '== Running tests =='
+command = ENV['CI'] ? 'bundle exec rake' : 'wwtd'
+system("#{command}") || abort

data/bin/update

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -e
+./bin/bootstrap
+./bin/setup