taxjar-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a129c647b66e1054f0438dcd65485090e28b533
+  data.tar.gz: d5a63ab29627fb0c98deab4e59007712f934d726
+SHA512:
+  metadata.gz: 9e2f7ec935c28f4262da4555e1419d399ddf720d5a39f0f12dc370b3f78e0b3f452396ab555e0f5a69476c909af7b98154bd29d61a48b21c6f89e858c5e7b744
+  data.tar.gz: 5a13e3b0650ecc020f1d028d37aca79dd89af0ae16bad544ac9e3e12a01cbc578d1dbb90b3e6143d59732c3be44a964cc9afbdc108164b80352cecc122d83f58

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp
+*.swo
+vendor/bundle
+tester.rb
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'yard'
+
+group :test do
+  gem 'rspec', '~>3'
+  gem 'webmock', '~>1'
+
+end
+# Specify your gem's dependencies in taxjar-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tim Case
+
+MIT License
+
+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,173 @@
+# The Taxjar Ruby Gem
+[![Taxjar](http://www.taxjar.com/img/TJ_logo_color_office_png.png)](http://developers.taxjar.com)
+
+A Ruby interface to the Taxjar API. TaxJar makes sales tax filing easier for online sellers and merchants. 
+See local jurisdictional tax reports, get payment reminders, and more. You can use our API to access TaxJar API endpoints, 
+which can get information on sales tax rates, categories or upload transactions.
+
+* This wrapper supports 100% of the [Taxjar API Version 2](http://developers.taxjar.com/api/#introduction)
+* Data returned from API calls are mapped into Ruby objects
+
+
+## Gem Dependencies
+Installing this gem also installs the following gems:
+
+* [http](https://github.com/httprb/http.rb) http.rb: a fast Ruby HTTP client with a chainable API and full streaming support
+* [addressable](https://github.com/sporkmonger/addressable) Addressable is a replacement for the URI implementation that is part of Ruby's standard library. It more closely conforms to the relevant RFCs and adds support for IRIs and URI templates.
+* [memoizable](https://github.com/dkubb/memoizable) Memoize method return values
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+    gem 'taxjar-ruby', require: 'taxjar'
+```
+And then execute:
+```shell
+    $ bundle install
+```
+Or install it yourself as:
+```shell
+    $ gem install taxjar-ruby
+```
+## Quick Start Guide
+
+First, [get an api key from Taxar][https://app.taxjar.com/api_sign_up/plus/].
+
+Then copy and paste in your API keys:
+
+```ruby
+client = Taxjar::Client.new(api_key: "YOUR KEY")
+```
+
+
+You are ready to use Taxjar.
+
+## Usage
+
+### List all tax categories
+```ruby
+categories = client.categories
+
+```
+### List tax rates for a location (by zip/postal code)
+```ruby
+rates = client.rates_for_location('10001')
+```
+
+### Calculate Sales tax for an order
+```ruby
+      order = client.tax_for_order({
+                :to_country => 'US',
+                :to_zip => '90002',
+                :to_city => 'Los Angeles',
+                :from_country => 'US',
+                :from_zip => '92093',
+                :from_city => 'San Diego',                
+                :amount => 16.50,
+                :shipping => 1.5,
+                :line_items => [{:quantity => 1,
+                                 :product_identifier => '12-34243-9',
+                                 :unit_price => 15.0,
+                                 :product_tax_code => 31000}]
+      })
+```
+
+### Create order transaction
+```ruby
+      order = client.create_order({
+                :transaction_id => '123',
+                :transaction_date => '2015/05/14',
+                :to_country => 'US',
+                :to_zip => '90002',
+                :to_city => 'Los Angeles',
+                :to_street => '123 Palm Grove Ln',
+                :amount => 17.45,
+                :shipping => 1.5,
+                :sales_tax => 0.95,
+                :line_items => [{:quantity => 1,
+                                 :product_identifier => '12-34243-9',
+                                 :descriptiion => 'Fuzzy Widget',
+                                 :unit_price => 15.0,
+                                 :sales_tax => 0.95}]
+      })
+```
+
+### Update order transaction
+```ruby
+      order = client.update_order({
+                :transaction_id => '123',
+                :amount => 17.95,
+                :shipping => 2.0,
+                :line_items => [{:quantity => 1,
+                                 :product_identifier => '12-34243-0',
+                                 :descriptiion => 'Heavy  Widget',
+                                 :unit_price => 15.0,
+                                 :discount => 0.0,
+                                 :sales_tax => 0.95}]
+      })
+```
+
+### Create refund transaction
+```ruby
+      refund = client.create_refund({
+                :transaction_id => '321',
+                :transaction_date => '2015/05/14',
+                :transaction_reference_id => '123',
+                :to_country => 'US',
+                :to_zip => '90002',
+                :to_state => 'CA',
+                :to_city => 'Los Angeles',
+                :to_street => '123 Palm Grove Ln',
+                :amount => 17.45,
+                :shipping => 1.5,
+                :sales_tax => 0.95,
+                :line_items => [{:quantity => 1,
+                                 :product_identifier => '12-34243-9',
+                                 :descriptiion => 'Fuzzy Widget',
+                                 :unit_price => 15.0,
+                                 :sales_tax => 0.95}]
+      })
+```
+
+### Update refund transaction
+```ruby
+      refund = client.update_refund{
+                :transaction_id => '321',
+                :amount => 17.95,
+                :shipping => 2.0,
+                :sales_tax => 0.95,
+                :line_items => [{:quantity => 1,
+                                 :product_identifier => '12-34243-9',
+                                 :descriptiion => 'Heavy Widget',
+                                 :unit_price => 15.0,
+                                 :sales_tax => 0.95}]
+      })
+```
+## Tests
+An Rspec test suite is available to ensure API functionality:
+
+1. $ git clone git://github.com/taxjar/taxjar-ruby.git
+2. $ bundle install (installs rspec and other supporting gems, see
+   [GEMFILE](https://github.com/taxjar/taxjar-ruby/blob/master/Gemfile)
+   for complete listing)
+3. $ rspec
+
+## More Information
+More information can be found on the [Taxjar developer site](https://developers.taxjar.com).
+
+## License
+Taxjar is released under the [MIT
+License](https://github.com/taxjar/taxjar-ruby/blob/master/LICENSE.txt).
+
+## Support
+Bug reports and feature requests should be filed on the [github issue
+tracking page](https://github.com/taxjar/taxjar-ruby/issues). 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/taxjar.rb

@@ -0,0 +1,15 @@
+require "taxjar/base"
+require "taxjar/breakdown"
+require "taxjar/breakdown_line_item"
+require "taxjar/category"
+require "taxjar/client"
+require "taxjar/line_item"
+require "taxjar/order"
+require "taxjar/rate"
+require "taxjar/refund"
+require "taxjar/shipping"
+require "taxjar/tax"
+require "taxjar/version"
+
+module Taxjar
+end

data/lib/taxjar/api/api.rb

@@ -0,0 +1,37 @@
+require 'taxjar/api/utils'
+module Taxjar
+  module API
+    include Taxjar::API::Utils
+
+    def categories(options = {})
+      perform_get_with_objects("/v2/categories", 'categories', options, Taxjar::Category)
+    end
+
+    def rates_for_location(postal_code, options ={})
+      perform_get_with_object("/v2/rates/#{postal_code}", 'rate', options, Taxjar::Rate)
+    end
+
+    def tax_for_order(options = {})
+      perform_post_with_object("/v2/taxes", 'tax', options, Taxjar::Tax)
+    end
+
+    def create_order(options = {})
+      perform_post_with_object("/v2/transactions/orders", 'order', options, Taxjar::Order)
+    end
+
+    def update_order(options = {})
+      id = options.fetch(:transaction_id)
+      perform_put_with_object("/v2/transactions/orders/#{id}", 'order', options, Taxjar::Order)
+    end
+
+    def create_refund(options = {})
+      perform_post_with_object("/v2/transactions/refunds", 'refund', options, Taxjar::Refund)
+    end
+
+    def update_refund(options = {})
+      id = options.fetch(:transaction_id)
+      perform_put_with_object("/v2/transactions/refunds/#{id}", 'refund', options, Taxjar::Refund)
+    end
+
+  end
+end

data/lib/taxjar/api/request.rb

@@ -0,0 +1,70 @@
+require 'addressable/uri'
+require 'http'
+
+module Taxjar
+  module API
+    class Request
+      BASE_URL = 'https://api.taxjar.com'
+
+      attr_reader :client, :uri, :headers, :request_method, :path, :object_key, :options
+
+      # @param client [Taxjar::Client]
+      # @param request_method [String, Symbol]
+      # @param path [String]
+      # @param object_key [String]
+      def initialize(client, request_method, path, object_key, options = {})
+        @client = client
+        @request_method = request_method
+        @path = path
+        @uri = Addressable::URI.parse(BASE_URL + path)
+        set_request_headers
+        @object_key = object_key
+        @options = options
+      end
+
+      def perform
+        options_key = @request_method == :get ? :params : :json
+        response = HTTP.with(headers).public_send(request_method, uri.to_s, options_key =>  @options)
+        response_body = symbolize_keys!(response.parse)
+        fail_or_return_response_body(response.code, response_body)
+      end
+
+      private
+
+
+      def set_request_headers
+        @headers = {}
+        @headers[:user_agent] = client.user_agent
+        @headers[:authorization] = "Bearer #{client.api_key}"
+      end
+
+      def symbolize_keys!(object)
+        if object.is_a?(Array)
+          object.each_with_index do |val, index|
+            object[index] = symbolize_keys!(val)
+          end
+        elsif object.is_a?(Hash)
+          object.keys.each do |key|
+            object[key.to_sym] = symbolize_keys!(object.delete(key))
+          end
+        end
+        object
+      end
+
+      def fail_or_return_response_body(code, body)
+        e = extract_error(code, body)
+        fail(e) if e
+        body[object_key.to_sym]
+      end
+
+      def extract_error(code, body)
+        klass = Taxjar::Error::ERRORS[code]
+        if !klass.nil?
+          klass.from_response(body)
+        end
+      end
+
+
+    end
+  end
+end

data/lib/taxjar/api/utils.rb

@@ -0,0 +1,40 @@
+require 'taxjar/api/request'
+
+module Taxjar
+  module API
+    module Utils
+
+      def perform_request(request_method, path, object_key, options = {})
+        Taxjar::API::Request.new(self, request_method, path, object_key, options).perform
+      end
+
+      def perform_get_with_object(path, object_key, options, klass)
+        perform_request_with_object(:get, path, object_key, options, klass)
+      end
+
+      def perform_get_with_objects(path, object_key, options, klass)
+        perform_request_with_objects(:get, path, object_key, options, klass)
+      end
+
+      def perform_post_with_object(path, object_key, options, klass)
+        perform_request_with_object(:post, path, object_key, options, klass)
+      end
+
+      def perform_put_with_object(path, object_key, options, klass)
+        perform_request_with_object(:put, path, object_key, options, klass)
+      end
+
+      def perform_request_with_object(request_method, path, object_key, options, klass)
+        response = perform_request(request_method, path, object_key, options)
+        klass.new(response)
+      end
+
+      def perform_request_with_objects(request_method, path, object_key, options, klass)
+        response_array = perform_request(request_method, path, object_key, options) || []
+        response_array.collect do |element|
+          klass.new(element)
+        end
+      end
+    end
+  end
+end

data/lib/taxjar/base.rb

@@ -0,0 +1,88 @@
+require 'addressable/uri'
+require 'forwardable'
+require 'memoizable'
+
+module Taxjar
+  class Base
+    extend Forwardable
+    include Memoizable
+
+    attr_reader :attrs
+    alias_method :to_h, :attrs
+    alias_method :to_hash, :to_h
+
+    def map_collection(klass, key)
+      Array(@attrs[key.to_sym]).map do |entity|
+        klass.new(entity)
+      end
+    end
+
+    class << self
+
+      def attr_reader(*attrs)
+        attrs.each do |attr|
+          define_attribute_method(attr)
+          define_predicate_method(attr)
+        end
+      end
+
+      def object_attr_reader(klass, key1, key2 = nil)
+        define_attribute_method(key1, klass, key2)
+        define_predicate_method(key1)
+      end
+
+      def define_attribute_method(key1, klass = nil, key2 = nil)
+        define_method(key1) do
+          if attr_falsey_or_empty?(key1)
+          else
+            klass.nil? ? @attrs[key1] : klass.new(attrs_for_object(key1, key2))
+          end
+        end
+        memoize(key1)
+      end
+
+      def define_predicate_method(key1, key2 = key1)
+        define_method(:"#{key1}?") do
+          !attr_falsey_or_empty?(key2)
+        end
+        memoize(:"#{key1}?")
+      end
+    end
+
+    def initialize(attrs = {})
+      attrs = values_as_floats_where_possible(attrs)
+      @attrs = attrs || {}
+    end
+
+    def [](method)
+      warn "#{Kernel.caller.first}: [DEPRECATION] #[#{method.inspect}] is deprecated. Use ##{method} to fetch the value."
+      send(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+  private
+
+    def attr_falsey_or_empty?(key)
+      !@attrs[key] || @attrs[key].respond_to?(:empty?) && @attrs[key].empty?
+    end
+
+    def attrs_for_object(key1, key2 = nil)
+      if key2.nil?
+        @attrs[key1]
+      else
+        attrs = @attrs.dup
+        attrs.delete(key1).merge(key2 => attrs)
+      end
+    end
+
+    def values_as_floats_where_possible(attrs)
+      attrs.map{|k, v| [k, to_f_or_i_or_s(v)]}.to_h
+    end
+
+    def to_f_or_i_or_s(v)
+        ((float = Float(v)) && (float % 1.0 == 0) ? float.to_i : float) rescue v
+    end
+
+  end
+end