avatax-ruby 0.0.1

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task :default => :spec

data/avatax.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'avatax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "avatax-ruby"
+  spec.version       = Avatax::VERSION
+  spec.authors       = ["Taylor Scott"]
+  spec.email         = ["tscott@deseretbook.com"]
+
+  spec.summary       = %q{Ruby client for Avatax}
+  spec.description   = %q{Ruby client for Avatax}
+  spec.homepage      = "https://github.com/skukx/avatax"
+  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"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'faraday_middleware'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "avatax"
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,6 @@
+dependencies:
+  pre:
+    - gem install bundler
+test:
+  pre:
+    - bundle exec rubocop

data/lib/avatax.rb

@@ -0,0 +1,30 @@
+require 'active_support/all'
+require 'faraday'
+require 'faraday_middleware'
+
+require 'avatax/version'
+require 'avatax/code'
+require 'avatax/response'
+
+require 'avatax/api/base'
+require 'avatax/api/accounts'
+require 'avatax/api/addresses'
+require 'avatax/api/batches'
+require 'avatax/api/companies'
+require 'avatax/api/contacts'
+require 'avatax/api/definitions'
+require 'avatax/api/items'
+require 'avatax/api/locations'
+require 'avatax/api/nexus'
+require 'avatax/api/settings'
+require 'avatax/api/subscriptions'
+require 'avatax/api/tax_codes'
+require 'avatax/api/tax_rates'
+require 'avatax/api/tax_rules'
+require 'avatax/api/transactions'
+require 'avatax/api/upcs'
+require 'avatax/api/users'
+require 'avatax/api/utilities'
+
+require 'avatax/configuration'
+require 'avatax/client'

data/lib/avatax/api/accounts.rb

@@ -0,0 +1,86 @@
+module Avatax
+  module Api
+    ##
+    # Accounts Client
+    # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/
+    #
+    class Accounts < Base
+      ##
+      # Activate an account
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#ActivateAccount
+      #
+      # @param account_id [String, Integer] The ID of the account to activate.
+      # @param args [Hash]  The arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def activate(account_id, args = {})
+        post_for(:activate, account_id, args)
+      end
+
+      ##
+      # Get configuration for an account
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#GetAccountConfiguration
+      #
+      # @param account_id [String, Integer] The ID of the account to activate.
+      # @param args [Hash]  The arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def configuration(account_id, args = {})
+        get_for(:configuration, account_id, args)
+      end
+
+      ##
+      # Update configuration for an account
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#SetAccountConfiguration
+      #
+      # @param account_id [String, Integer] The ID of the account to activate.
+      # @param args [Hash]  The arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def update_configuration(account_id, args = {})
+        post_for(:configuration, account_id, args)
+      end
+
+      ##
+      # Reset the license key for an account.
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#AccountResetLicenseKey
+      #
+      # @param account_id [String, Integer] The ID of the account to activate.
+      # @param args [Hash]  The arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def reset_license_key(account_id, args = {})
+        post_for(:resetlicensekey, account_id, args)
+      end
+
+      ##
+      # Get an account.
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Accounts/#GetAccount
+      #
+      # @param account_id [String, Integer] The ID of the account to activate.
+      # @param args [Hash]  The arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def get(account_id, args = {})
+        get_for(nil, account_id, args)
+      end
+
+      private
+
+      def get_for(endpoint, account_id, args)
+        request_for(:get, endpoint, account_id, args)
+      end
+
+      def post_for(endpoint, account_id, args)
+        request_for(:post, endpoint, account_id, args)
+      end
+
+      def request_for(method, endpoint, account_id, args)
+        raise ArgumentError, 'account_id is required' if account_id.blank?
+
+        resp = connection.send method, "/api/v2/accounts/#{account_id}/#{endpoint}", args
+        handle_response(resp)
+      end
+    end
+  end
+end

data/lib/avatax/api/addresses.rb

@@ -0,0 +1,14 @@
+module Avatax
+  module Api
+    class Addresses < Base
+      ##
+      # Validate an address
+      # @see http://developer.avalara.com/avatax/api-reference/tax/v2/Addresses/#ApiV2AddressesResolvePost
+      #
+      def validate(args = {})
+        resp = connection.post '/api/v2/addresses/resolve', args
+        handle_response(resp)
+      end
+    end
+  end
+end

data/lib/avatax/api/base.rb

@@ -0,0 +1,18 @@
+module Avatax
+  module Api
+    class Base
+      attr_reader :connection
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      protected
+
+      def handle_response(response)
+        # Wrap in our own response class
+        Avatax::Response.new response
+      end
+    end
+  end
+end

data/lib/avatax/api/batches.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Batches < Base
+    end
+  end
+end

data/lib/avatax/api/companies.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Companies < Base
+    end
+  end
+end

data/lib/avatax/api/contacts.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Contacts < Base
+    end
+  end
+end

data/lib/avatax/api/definitions.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Definitions < Base
+    end
+  end
+end

data/lib/avatax/api/items.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Items < Base
+    end
+  end
+end

data/lib/avatax/api/locations.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Locations < Base
+    end
+  end
+end

data/lib/avatax/api/nexus.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Nexus < Base
+    end
+  end
+end

data/lib/avatax/api/settings.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Settings < Base
+    end
+  end
+end

data/lib/avatax/api/subscriptions.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class Subscriptions < Base
+    end
+  end
+end

data/lib/avatax/api/tax_codes.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class TaxCodes < Base
+    end
+  end
+end

data/lib/avatax/api/tax_rates.rb

@@ -0,0 +1,28 @@
+module Avatax
+  module Api
+    class TaxRates < Base
+      BY_ADDRESS_METHOD = :by_address
+      BY_POSTAL_CODE_METHOD = :by_postal_code
+
+      VALID_METHODS = [BY_ADDRESS_METHOD, BY_POSTAL_CODE_METHOD]
+
+      def get(method, args = {})
+        unless VALID_METHODS.include?(method.to_sym)
+          raise ArgumentError, 'method must be one of :bt_address or :by_postal_code'
+        end
+
+        handle_response(send("get_#{method}", args))
+      end
+
+      private
+
+      def get_by_address(args)
+        connection.get '/api/v2/taxrates/byaddress', args
+      end
+
+      def get_by_postal_code(args)
+        connection.get '/api/v2/taxrates/bypostalcode', args
+      end
+    end
+  end
+end

data/lib/avatax/api/tax_rules.rb

@@ -0,0 +1,6 @@
+module Avatax
+  module Api
+    class TaxRules < Base
+    end
+  end
+end

data/lib/avatax/api/transactions.rb

@@ -0,0 +1,171 @@
+module Avatax
+  module Api
+    ##
+    # Transactions client
+    # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/
+    #
+    class Transactions < Base
+      ##
+      # Get all transactions within a company.
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsGet
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def all(company_code, args = {})
+        raise ArgumentError, 'company_code is required' if company_code.blank?
+
+        resp = connection.get "/api/v2/companies/#{company_code}/transactions/", args
+        handle_response(resp)
+      end
+
+      ##
+      # Get a transaction by code
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsByTransactionCodeGet
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The avatax transaction code.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def find_by_code(company_code, transaction_code, args = {})
+        raise ArgumentError, 'company_code is required' if company_code.blank?
+        raise ArgumentError, 'transaction_code is required' if transaction_code.blank?
+
+        resp = connection.get "/api/v2/companies/#{company_code}/transactions/#{transaction_code}", args
+        handle_response(resp)
+      end
+
+      ##
+      # Get a transaction by code
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2TransactionsByIdGet
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The avatax transaction ID.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def find_by_id(transaction_id, args = {})
+        raise ArgumentError, 'transaction_id is required' if transaction_id.blank?
+
+        resp = connection.get "/api/v2/transactions/#{transaction_id}", args
+        handle_response(resp)
+      end
+
+      ##
+      # Adjust a transaction
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsByTransactionCodeAdjustPost
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The avatax transaction code.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def adjust(company_code, transaction_code, args = {})
+        post_for(:adjust, company_code, transaction_code, args)
+      end
+
+      ##
+      # Change a transaction code
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsByTransactionCodeChangecodePost
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The current avatax transaction code.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def change_code(company_code, transaction_code, args = {})
+        post_for(:changecode, company_code, transaction_code, args)
+      end
+
+      ##
+      # Commit a transaction
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsByTransactionCodeCommitPost
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The current avatax transaction code.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def commit(company_code, transaction_code, args = {})
+        args.reverse_merge(commit: true)
+        post_for(:commit, company_code, transaction_code, args)
+      end
+
+      ##
+      # Settle a transaction
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsByTransactionCodeSettlePost
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The current avatax transaction code.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def settle(company_code, transaction_code, args = {})
+        post_for(:settle, company_code, transaction_code, args)
+      end
+
+      ##
+      # Verify a transaction
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsByTransactionCodeVerifyPost
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The current avatax transaction code.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def verify(company_code, transaction_code, args = {})
+        post_for(:verify, company_code, transaction_code, args)
+      end
+
+      ##
+      # Void a transaction
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2CompaniesByCompanyCodeTransactionsByTransactionCodeVoidPost
+      #
+      # @param company_code [String] The company_code in avatax.
+      # @param transaction_code [String] The current avatax transaction code.
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def void(company_code, transaction_code, args = {})
+        args.reverse_merge!(code: Avatax::Code::DOC_VOIDED)
+        post_for(:void, company_code, transaction_code, args)
+      end
+
+      ##
+      # Create a transaction
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#ApiV2TransactionsCreatePost
+      #
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def create(args = {})
+        resp = connection.post '/api/v2/transactions/create', args
+        handle_response(resp)
+      end
+
+      ##
+      # Create or Adjust a transaction if transaction already exists.
+      # @see https://developer.avalara.com/avatax/api-reference/tax/v2/Transactions/#CreateOrAdjustTransaction
+      #
+      # @param args [Hash] Arguments for avatax.
+      # @return [Avatax::Response]
+      #
+      def create_or_adjust(args = {})
+        resp = connection.post '/api/v2/transactions/createoradjust', args
+        handle_response(resp)
+      end
+
+      private
+
+      def post_for(endpoint, company_code, transaction_code, args)
+        raise ArgumentError, 'company_code is required' if company_code.blank?
+        raise ArgumentError, 'transaction_code is required' if transaction_code.blank?
+
+        resp = connection.post "/api/v2/companies/#{company_code}/transactions/#{transaction_code}/#{endpoint}", args
+        handle_response(resp)
+      end
+    end
+  end
+end