avatax-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8cd145141172657e1cff1479fffb4ca51ed0724f
+  data.tar.gz: afa91da4845f340b0cbc00596f2fee25fcc22ad5
+SHA512:
+  metadata.gz: 8bd160627ebd839166ef0e8aad8f9777f8517baaf27f88898df3fb856d8eae7e2a7a1f99cafb50d58de8b9a46f15ded001b32ce7dfeb688daa60e64a9beff013
+  data.tar.gz: 6c6baa7cd30609171adfe276f901e13a14e10bfa322b48951749d8a3daaa14f34ec107249aa9e1f0a8bf5bfd38cb7592e1fa24bed15c7f08a028477a40252346

data/.gitignore

@@ -0,0 +1,11 @@
+example.rb
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/env.yml

data/.rubocop.yml

@@ -0,0 +1,248 @@
+AllCops:
+  Exclude:
+    - 'Rakefile'
+    - 'Gemfile'
+    - 'bin/**/*'
+    - 'avatax.gemspec'
+    - 'example.rb'
+    - 'vendor/**/*'
+
+# Block length was set to 25, we currently don't have a rule for this
+BlockLength:
+  Enabled: false
+
+# Changing this was causing the route not found error in specs
+HttpPositionalArguments:
+  Enabled: false
+
+# We are going to use .html_safe for the time being
+Rails/OutputSafety:
+  Enabled: false
+
+# Disabling this until we remove all references to it in all our code bases
+Rails/HasAndBelongsToMany:
+  Enabled: false
+
+# Don't require Ruby 2.3 "frozen_string_literal" pragma comment, for now.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# We use class vars and will have to continue doing so for compatability
+Style/ClassVars:
+  Enabled: false
+
+# We need these names for backwards compatability
+Style/PredicateName:
+  Enabled: false
+
+Style/AccessorMethodName:
+  Enabled: false
+
+# This has been used for customization
+Style/MutableConstant:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Performance/Count:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/OpMethod:
+  Enabled: false
+
+# We can use good judgement here
+Style/RegexpLiteral:
+  Enabled: false
+
+# Unicode comments are useful
+Style/AsciiComments:
+  Enabled: false
+
+Lint/EndAlignment:
+  Enabled: false
+
+Style/ElseAlignment:
+  Enabled: false
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/AlignParameters:
+  Enabled: false
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  Enabled: false
+
+Style/IndentArray:
+  Enabled: false
+
+Style/IndentHash:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: false
+
+# From http://relaxed.ruby.style/
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylealias
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleblockdelimiters
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledocumentation
+
+Style/DotPosition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylesinglelinemethods
+
+Lint/RescueException:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespacebeforeblockbraces
+
+Style/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylestringliterals
+
+Style/SymbolProc:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: http://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+avatax

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in avatax.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Taylor Scott
+
+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,157 @@
+# Avatax
+[![CircleCI](https://circleci.com/gh/skukx/avatax.svg?style=shield)](https://circleci.com/gh/skukx/avatax)
+
+This gem is a work in progress for providing a ruby client for Avatax REST api v2.
+See: http://developer.avalara.com/avatax/api-reference/tax/v2/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'avatax-ruby', git: 'git@github.com:skukx/avatax.git', require: 'avatax'
+```
+
+Or
+
+```ruby
+gem 'avatax-ruby', require: 'avatax'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Setting Up the client
+```ruby
+client = Avatax::Client.new(
+    username: 'avatax_user',
+    password: 'avatax_password',
+    env: :sandbox
+)
+```
+The `env` can be set to `:sandbox` or `:production`.
+
+### Estimating Taxes
+```ruby
+##
+# Estimate by address
+# @see http://developer.avalara.com/avatax/api-reference/tax/v2/TaxRates/#ApiV2TaxratesByaddressGet
+#
+params = {
+    line1: '350 State St.',
+    city: 'Salt Lake City',
+    region: 'CA',
+    postalCode: '84111',
+    country: 'US'
+}
+resp = client.tax_rates.get(:by_address, params)
+
+##
+# Estimate by postal code
+# @see http://developer.avalara.com/avatax/api-reference/tax/v2/TaxRates/#ApiV2TaxratesBypostalcodeGet
+#
+params = { country: 'US', postalCode: '84111' }
+resp = client.tax_rates.get(:by_postal_code, params)
+
+resp.success? # => true
+```
+
+### Transactions
+
+#### Get all transactions within a company.
+```ruby
+client.transactions.all('my_company')
+```
+
+#### Find a transaction by code
+```ruby
+client.transactions.find_by_code('my_company', 'transaction_code')
+```
+
+#### Find a transaction by avatax id.
+```ruby
+client.transactions.find_by_id('my_company', '123')
+```
+
+#### Adjust an existing transaction.
+```ruby
+params = {
+  adjustmentReason: 8,
+  adjustmentDescription: 'New line item.',
+  new_transaction: { ... }
+}
+
+client.transactions.adjust('my_company', 'my_code', params)
+```
+
+#### Change a transaction code
+```ruby
+params = { newCode: 'my_new_code' }
+client.transactions.change_code('my_company', 'my_code', params)
+```
+
+#### Commit a transaction
+By default, if not present, the post request will contain the body `{ commit: true }`
+
+```ruby
+client.transactions.commit('my_company', 'my_code')
+```
+
+#### Settle a transaction
+This call can perform multiple actions on a transaction. See [avatax docs](https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#SettleTransaction) for more information.
+```ruby
+params = { ... }
+client.transactions.settle('my_company', 'my_code', params)
+```
+
+#### Void a transaction.
+```ruby
+client.transactions.void('my_company', 'my_code')
+```
+
+#### Create a transaction
+```ruby
+params = {
+  code: 'my_code',
+  type: 'SalesInvoice',
+  companyCode: 'my_company',
+  date: Date.current.to_s,
+  customerCode: 1,
+  discount: 0.00,
+  addresses: {
+    ShipTo: {
+      line1: '50 Main street',
+      city: 'Salt Lake City',
+      region: 'UT',
+      country: 'US',
+      postalCode: '84144'
+    }
+  },
+  lines: [
+    {
+      amount: 9.99,
+      quantity: 1
+    }
+  ]
+}
+
+client.transactions.create(params)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/avatax.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).