little_finger 0.0.0 → 0.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmI2OTgwMTAwNjFlMzg3NWVkYTI4YmFlOTEyYTMwY2I2NDhjZDk3Mg==
+    MmYzZTlkNGNjY2Q4YWQ5ZTM0OTc1NDMzZjJkYzA4YmRiYmY3ZGUxYQ==
   data.tar.gz: !binary |-
-    Yzk2MjhiY2FlMDU5ZjA1YjYyNDdmMTI3ZTVmMmZjMGQ1MTFjM2RjZQ==
+    OGIwNWI1YmIyZGZkNDY0N2Q5OTJlZWJmZjI0ZTgxODJkNTRmMWVjYg==
 SHA512:
   metadata.gz: !binary |-
-    MjdlNzdlM2JhNTkxY2VkYzQ4NDMzMGM5ODBiMmU2MTgyZWEwZGRlYjQ0NWQy
-    ZjhmMTViZDFkOWNkYTZiZDhkYWJhOGQ0M2JiMThhMzlmYWViY2RjZTUzOGE4
-    ZjlmODIwMGI0NjFhYjc2MTYyNGJjMzM3NjhjNzYzNjNiYjVmNmM=
+    ZGExYTM4NTUwZmE1NTEzNjUwMmM2NjRmMGQwN2EyYTZlYmFlMjVhODRiNGJj
+    NjI2YzNmMDkyYWI3ZmI0MTUzNzYwMThlMzQ3YjU1MGE4NjUyNTNkMzNlZmM2
+    NWU1YWI2OWFiMmQ1YTc2NDJhNWUwMzNjNjY2N2FkZTUxNmE5NjY=
   data.tar.gz: !binary |-
-    NzExYzQxOTljOGZiNjBlYjNhYTczOWVjYzc4NjNhNTk2NTg2NzU1YWVhYzYw
-    OWU1MzY1Y2QyMWRiMTZiNTYzY2I4ZmNkODJjYWU5OWUwMDlkYWI0MjAxMGJi
-    MTJlN2JlMzI1YjBmOWNiMDZjYmJhZjNmNWE1MjUwNTgxZTFlYjQ=
+    ZjhkYWFiZjI3MTgyNzIyMWQ3YWM0YWU3NjJlZTkzOWUxYjZlMDBkNTA4MDdl
+    ODkyNjUwODQzZWE2ZGUxZDlmNTYyZTA0NzMxMDZjNWJmYTk2NWEzYzI4YmQ4
+    ODdlZjcxZTRjMmU5N2NhNmVmNGQwNzg1MzA4NjYyMTIzMjE5Yzg=

data/README.md

@@ -0,0 +1,45 @@
+little_finger
+============
+[![Build Status](https://travis-ci.org/honest/little_finger.svg?branch=master)](https://travis-ci.org/honest/little_finger)
+[![Gem Version](https://badge.fury.io/rb/little_finger.svg)](http://badge.fury.io/rb/little_finger)
+
+Little Finger is an AvaTax REST API wrapper plus backup tax calculation.
+
+Please visit the AvaTax [developer site](http://developer.avalara.com/) for more information on their REST API.
+
+Dependencies
+-----------
+TBD
+
+Requirements
+----------
+- Ruby 1.9.3 or later
+
+Getting Started
+----------
+- Add the `little_finger` gem to your Gemfile with `gem 'little_finger'`
+- Run `bundle install` to retrieve `little_finger` and all its dependencies
+- Authentication requires an valid **Account Number** and **License Key**. If you do not have an AvaTax account, a free trial account can be acquired through the [developer site](http://developer.avalara.com/api-get-started)
+- Specify your authentication credentials in the YAML file (see `little_finger.yml.example`) and place it in your config folder
+
+Usage
+----------
+```
+To get the connection status to AvaTax:
+LittleFinger::Avatax.new.status
+
+To get a tax estimate via geographic coordinates:
+LittleFinger::Avatax.new.estimate(coordinates, sale_amount)
+
+To validate an address:
+LittleFinger::Avatax.new.validate(address)
+
+To get the tax and optionally create or update a transaction in AvaTax:
+LittleFinger::Avatax.new.get(payload)
+
+To cancel an existing transaction:
+LittleFinger::Avatax.new.cancel(cancel_code, lookup_opts)
+
+Backup: TBD
+
+```

data/lib/little_finger.rb

@@ -1,6 +1,14 @@
-class LittleFinger
-  def self.hi
-    puts 'Hello world'
+require "active_support/all"
+require "awesome_print"
+require "yaml"
+require "hashie"
+require_relative "little_finger/configuration"
+
+module LittleFinger
+
+  def self.yolo
+    "#yolo"
   end
-  
+
 end
+require_relative "little_finger/avatax"

data/lib/little_finger/avatax.rb

@@ -0,0 +1,96 @@
+require "json"
+require "base64"
+require "rest-client"
+require_relative "configuration"
+
+class LittleFinger::Avatax
+  attr_accessor :company_code, :account_number, :license_key, :credentials, :tax_service_url, :address_service_url
+
+  def initialize()
+    @company_code = LittleFinger::Configuration.configuration[:avatax][:company_code]
+    @account_number = LittleFinger::Configuration.configuration[:avatax][:account_number]
+    @license_key = LittleFinger::Configuration.configuration[:avatax][:license_key]
+    @credentials = ["Basic ",Base64.encode64(@account_number + ":"+ @license_key)].join
+    @tax_service_url = [LittleFinger::Configuration.configuration[:avatax][:service_url], LittleFinger::Configuration.configuration[:avatax][:tax_service_path]].join
+    @address_service_url = [LittleFinger::Configuration.configuration[:avatax][:service_url], LittleFinger::Configuration.configuration[:avatax][:address_service_path]].join
+  end
+
+  # Since the REST API does not provide an explicit ping function, the estimate method can also be used to test connectivity to the service.
+  # @return [Fixnum] response code
+  def status
+    coordinates = { latitude: "34.030291", longitude: "-118.468925"}
+    uri = [@tax_service_url,coordinates[:latitude].to_s,",",coordinates[:longitude].to_s,"/get?saleamount=",0].join
+    response = send_request(:get, uri)
+    response.code
+  end
+
+  # Calculates taxes on a document such as a sales order, sales invoice, purchase order, purchase invoice, or credit memo.
+  # http://developer.avalara.com/api-docs/api-reference/rest-curl/gettax
+  # @param [Hash] payload
+  def get(payload)
+    uri = [@tax_service_url,"get"].join
+    response = send_request(:post, uri, payload)
+    JSON.parse(response.body)
+  end
+
+  # Voids or deletes and existing transaction record from the AvaTax system.
+  # http://developer.avalara.com/api-docs/api-reference/rest-curl/canceltax
+  # http://developer.avalara.com/api-docs/rest/tax/cancel
+  # @param [String] cancel_code The reason for cancelling the tax record: Unspecified, PostFailed, DocDeleted, DocVoided, AdjustmentCancelled
+  # @param [Hash] lookup_opts options to identify Avatax transactions by DocId or by the set of values CompanyCode, DocCode, and DocType.
+  # @option lookup_opts [String] DocId Avatax-assigned unique Document Id
+  # @option lookup_opts [String] CompanyCode Client application company reference code
+  # @option lookup_opts [String] DocCode Client application identifier describing this tax transaction (i.e. invoice number, sales order number, etc.)
+  # @option lookup_opts [String] DocType The reason for cancelling the tax record.
+  # @return [Hash] JSON parsed response body
+  def cancel(cancel_code, lookup_opts = {})
+    payload = lookup_opts.merge({CancelCode: cancel_code})
+    uri = [@tax_service_url, "cancel"].join
+    response = send_request(:post, uri, payload)
+    JSON.parse(response.body).try(:[],"CancelTaxResult")
+  end
+
+  # Retrieves tax rate details for the supplied geographic coordinates and sale amount.
+  # http://developer.avalara.com/api-docs/api-reference/rest-curl/estimatetax
+  # @param [Hash] coordinates geographic coordinates
+  # @option coordinates [String] latitude
+  # @option coordinates [String] longitude
+  # @param [Float] sale_amount
+  # @return [Hash] JSON parsed response body
+  def estimate(coordinates, sale_amount = 0)
+    return unless coordinates.present? && coordinates.has_key?(:latitude) && coordinates.has_key?(:longitude)
+    uri = [@tax_service_url,coordinates[:latitude].to_s,",",coordinates[:longitude].to_s,"/get?saleamount=",sale_amount.to_s].join
+    response = send_request(:get, uri)
+    JSON.parse(response.body)
+  end
+
+  # Normalizes a single US or Canadian address, providing a non-ambiguous address match.
+  # http://developer.avalara.com/api-docs/api-reference/rest-curl/validate
+  # @param [Hash] address physical shipping address to validate
+  # @option address [String] :Line1
+  # @option address [String] :Line2
+  # @option address [String] :Line3
+  # @option address [String] :City
+  # @option address [String] :Region
+  # @option address [String] :PostalCode
+  # @option address [String] :Country
+  # @return [Hash] JSON parsed response body
+  def validate(address)
+    uri = [@address_service_url, "validate?", address.to_query].join
+    response = send_request(:get, uri)
+    JSON.parse(response.body)
+  end
+
+private
+
+  # Forms and sends the request
+  # @param [Symbol] method request method
+  # @param [String] uri Avatax service endpoint
+  # @param optional [Hash] payload
+  # @param optional [Hash] custom_headers
+  def send_request(method, uri, payload = {}, custom_headers = {})
+    headers = {authorization: @credentials, content_type: "application/json"}.merge(custom_headers)
+    RestClient::Request.execute(method: method.to_sym, url: uri, payload: JSON.generate(payload), headers: headers){|response, request, result| response }
+  end
+
+end

data/lib/little_finger/configuration.rb

@@ -0,0 +1,31 @@
+module LittleFinger
+  module Configuration
+    @@conf = nil
+
+    def self.configure_with(environment_name, yaml_file = nil)
+      @@yaml_file = yaml_file.nil? ? "config/little_finger.yml" : yaml_file
+      @@all_conf = Hashie::Mash.new(YAML.load_file(@@yaml_file) )
+      @@conf = @@all_conf[environment_name]
+      self
+    end
+
+    def self.configuration
+      self.configure_with(self.environment) if @@conf.nil?
+      @@conf
+    end
+
+    def self.environment
+      val = ENV["RAILS_ENV"] || ENV["RACK_ENV"]
+      val = if val.present?
+              val.to_sym
+            else
+              if defined?(Rails)
+                Rails.env
+              else
+                raise "No environment can be found for configuration!"
+              end
+            end
+    end
+
+  end
+end

data/spec/config.yml

@@ -0,0 +1,8 @@
+test:
+  enabled: true
+  avatax:
+    account_number: "1234567890"
+    license_key: "A1B2C3D4E5F6G7H8"
+    service_url: "https://development.avalara.net"
+    tax_service_path: "/1.0/tax/"
+    address_service_path: "/1.0/address/"

data/spec/little_finger_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+describe LittleFinger do
+
+  describe "#yolo" do
+    subject { LittleFinger.yolo }
+
+    it { expect(subject).to eq("#yolo") }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require "little_finger"
+ENV["RAILS_ENV"] ||= "test"
+require "timecop"
+require "factory_girl"
+require_relative "support/helpers/avatax_helper"
+
+FactoryGirl.definition_file_paths = [File.expand_path("../factories", __FILE__)]
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end
+
+LittleFinger::Configuration.configure_with("test", File.expand_path("../config.yml", __FILE__))

data/spec/support/helpers/avatax_helper.rb

@@ -0,0 +1,24 @@
+module AvataxHelper
+
+  def error_messages(messages)
+    messages.map{|m| m["Summary"] }
+  end
+
+  def simple_calculation(tax_lines)
+    # given no tax amount overrides
+    tax_sum = 0
+    tax_lines.each do |line|
+      tax_sum += line["Taxable"].to_f * line["Rate"].to_f
+    end
+    tax_sum.round(2)
+  end
+
+  def sum_taxes(tax_lines)
+    tax_sum = 0
+    tax_lines.each do |line|
+      tax_sum += line["Tax"].to_f
+    end
+    tax_sum.round(2)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: little_finger
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Michelle Yung
@@ -9,14 +9,161 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2014-12-04 00:00:00.000000000 Z
-dependencies: []
-description: Avatax REST API wrapper plus backup tax calculation
-email: michelle@thehonestcompany.com
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: airbrake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+description: AvaTax REST API wrapper plus backup tax calculation
+email: michelle@honest.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/little_finger.rb
+- lib/little_finger/avatax.rb
+- lib/little_finger/configuration.rb
+- spec/config.yml
+- spec/little_finger_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers/avatax_helper.rb
 homepage: https://github.com/honest/little_finger
 licenses:
 - MIT
@@ -40,6 +187,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Avatax with backup tax calculation
+summary: AvaTax with backup tax calculation
 test_files: []
 has_rdoc: