suretax 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 090d466426a8ed2734e208ca3e310afa0fca041c
+  data.tar.gz: 890130d8629a6ff1ca5d959202a6d640753397b6
+SHA512:
+  metadata.gz: 0509fea19ea7ce6a32f96a2888b8c1b170f028a9c0cdf5be786f221c9cf7f177498675795c27517c07ecd1cb6157203fb4e3b78d1f929eeddbf234446d342db5
+  data.tar.gz: 0daa94af83c1320f63869a7607528a45de24d8da108d7ff2e86718e4bff66f55061331d6b7317f262f804a0fe4f9cdfe5d0740095a8833ffdd36709042825c7a

data/.gitignore

@@ -0,0 +1,27 @@
+._*
+.bundle
+.DS_Store
+.rvmrc
+.ruby-version
+.ruby-gemset
+.pow*
+
+*.gem
+*.swp
+database.yml
+application.yml
+
+tmp/*
+log/*
+coverage/*
+vendor/bundle
+
+spec/dummy/log/*
+spec/dummy/tmp/*
+spec/dummy/vendor/bundle/*
+spec/dummy/coverage
+
+!spec/dummy/config/database.yml
+
+.env
+dump.rdb

data/.travis.yml

@@ -0,0 +1,14 @@
+env:
+  - SURETAX_VALIDATION_KEY="xxxxxxxxxx" SURETAX_CLIENT_NUMBER="000000000"
+gemfile:
+  - Gemfile.travis
+language: ruby
+script:
+  - bundle exec rspec
+rvm:
+  - 1.9.3
+  - 2.1.0
+  - jruby-19mode
+  - rbx-2.2
+notifications:
+  email: false

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    suretax (0.1.0)
+      faraday
+      monetize
+      money
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    awesome_print (1.2.0)
+    coderay (1.1.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    dotenv (0.9.0)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    i18n (0.7.0.beta1)
+    method_source (0.8.2)
+    monetize (0.4.1)
+      money (~> 6.2.1)
+    money (6.2.1)
+      i18n (>= 0.6.4, <= 0.7.0.dev)
+    multi_json (1.8.4)
+    multipart-post (2.0.0)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-its (1.0.1)
+      rspec-core (>= 2.99.0.beta1)
+      rspec-expectations (>= 2.99.0.beta1)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+    safe_yaml (1.0.1)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    webmock (1.17.3)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler (~> 1.3)
+  dotenv
+  pry
+  rake
+  rspec (~> 3.0.0)
+  rspec-its (~> 1.0)
+  simplecov
+  suretax!
+  webmock

data/Gemfile.travis

@@ -0,0 +1,12 @@
+# Special Travis Gemfile for Rubinius
+source 'https://rubygems.org'
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubysl-openssl', '~> 2.1.0'
+  gem 'psych'
+  gem 'rubinius-coverage'
+  gem 'json', '~> 1.8'
+end
+
+eval_gemfile File.expand_path('../Gemfile', __FILE__)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Damon Davison
+
+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/NOTES.md

@@ -0,0 +1,3 @@
+# Suretax gem notes
+
+- Deal with post failures and parse errors in Response.

data/README.md

@@ -0,0 +1,58 @@
+[![Code Climate](https://codeclimate.com/github/bqsoft/suretax.png)](https://codeclimate.com/github/bqsoft/suretax)
+[![TravisCI](https://api.travis-ci.org/bqsoft/suretax.png)](https://travis-ci.org/bqsoft/suretax)
+# Suretax
+
+
+## Synopsis
+
+```ruby
+Suretax.configure do |c|
+  c.validation_key  = ENV['SURETAX_VALIDATION_KEY']
+  c.base_url        = ENV['SURETAX_BASE_URL']
+  c.client_number   = ENV['SURETAX_CLIENT_NUMBER']
+  c.request_version = ENV['SURETAX_REQUEST_VERSION']
+  c.cancel_version  = ENV['SURETAX_CANCEL_VERSION']
+end
+
+request = Suretax::Api::Request.new({ initial: data })
+request.items = [ Suretax::Api::RequestItem.new({ initial: data }) ]
+connection = Suretax::Connection.new
+
+if request.valid?
+  response = connection.post(body: request.params)
+  response.params
+end
+```
+
+The configuration object is used to provide default values for
+Suretax transactions.  The validation_key, client_number, and
+base_url may be overridden by supplying the key when instantiating
+a Suretax::Api::Request object.
+
+
+If not supplied, the base_url will default to the Suretax test 
+host (https://testapi.taxrating.net) and the request version
+and cancel version will default to the latest versions available
+(currently V03 and V01 respectively).
+
+
+You can peek inside the tests for more examples and to see what data
+methods are available.
+
+
+## Development Environment
+
+Suretax uses [dotenv] to easily switch between development/test environments
+and production.
+
+You will need to set the following environment variables for the gem to work:
+
+- `SURETAX_VALIDATION_KEY` (You can get this from [SureTax][suretax].)
+- `SURETAX_BASE_URL` (This is usually `https://testapi.taxrating.net` for testing.)
+
+You can do this by creating a .env file in the root of the Suretax gem
+repository (gitignored by default). For more information, please see
+the [dotenv documentation][dotenv]
+
+[dotenv]: https://github.com/bkeepers/dotenv
+[suretax]: http://suretax.com

data/Rakefile

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

data/circle.yml

@@ -0,0 +1,7 @@
+machine:
+  environment:
+    SURETAX_BASE_URL: "https://testapi.taxrating.net"
+    SURETAX_VALIDATION_KEY: "xxxxxxxxxx"
+    SURETAX_CLIENT_NUMBER: "000000000"
+    SURETAX_POST_PATH: "/Services/V01/SureTax.asmx/PostRequest"
+    SURETAX_CANCEL_PATH: "/Services/V01/SureTax.asmx/CancelPostRequest"

data/lib/suretax.rb

@@ -0,0 +1,24 @@
+require "suretax/version"
+
+require "suretax/concerns"
+
+require "suretax/configuration"
+require "suretax/connection"
+require "suretax/response"
+require "suretax/constants"
+require "suretax/api"
+
+require "money"
+
+module Suretax
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  self.configuration ||= Configuration.instance
+end

data/lib/suretax/api.rb

@@ -0,0 +1,7 @@
+require 'suretax/api/response'
+require 'suretax/api/request'
+require 'suretax/api/request_item'
+require 'suretax/api/cancel_request'
+require 'suretax/api/group'
+require 'suretax/api/tax'
+require 'suretax/api/tax_amount'

data/lib/suretax/api/cancel_request.rb

@@ -0,0 +1,64 @@
+module Suretax
+  module Api
+    #
+    # Given a transaction ID, sends a request to cancel
+    # that transaction to Suretax.
+    #
+    class CancelRequest
+      attr_accessor :client_number, :validation_key, :transaction,
+                    :client_tracking
+
+      attr_reader   :response
+
+      def initialize(options = {})
+        self.client_number  = options.fetch(:client_number,
+                                            configuration.client_number)
+        self.validation_key = options.fetch(:validation_key,
+                                            configuration.validation_key)
+
+        options.each_pair do |key, value|
+          send("#{key.to_s}=", value.to_s)
+        end
+      end
+
+      def submit
+        log_request
+        suretax_response = connection.cancel(params)
+
+        log_response(suretax_response)
+        @response = Suretax::Api::Response.new(suretax_response.body)
+      end
+
+      def params
+        {
+          'ClientNumber'   => client_number,
+          'ClientTracking' => client_tracking,
+          'TransId'        => transaction,
+          'ValidationKey'  => validation_key
+        }
+      end
+
+      private
+
+      def log_request
+        logger.info "\nSureTax Cancellation sent:\n#{params.inspect}" if logger
+      end
+
+      def log_response(response)
+        logger.info("\nSureTax Cancellation resp:\n#{response.inspect}") if logger
+      end
+
+      def logger
+        configuration.logger
+      end
+
+      def configuration
+        Suretax.configuration
+      end
+
+      def connection
+        @connection ||= Connection.new
+      end
+    end
+  end
+end

data/lib/suretax/api/group.rb

@@ -0,0 +1,16 @@
+module Suretax
+  module Api
+    class Group
+      attr_reader :state, :customer, :invoice, :taxes, :line
+
+      def initialize(response_params)
+        @state = response_params.fetch('StateCode')
+        @invoice = response_params.fetch('InvoiceNumber')
+        @line = response_params['LineNumber']
+        @customer = response_params.fetch('CustomerNumber')
+        @taxes = response_params.fetch('TaxList').map { |tax| Tax.new(tax) }
+      end
+
+    end
+  end
+end

data/lib/suretax/api/item_message.rb

@@ -0,0 +1,13 @@
+module Suretax
+  module Api
+    class ItemMessage
+      attr_reader :line_number, :response_code, :message
+
+      def initialize(response_params)
+        @line_number = response_params.fetch('LineNumber')
+        @response_code = response_params.fetch('ResponseCode')
+        @message = response_params.fetch('Message')
+      end
+    end
+  end
+end

data/lib/suretax/api/request.rb

@@ -0,0 +1,133 @@
+module Suretax
+  module Api
+    class ValidationError < StandardError; end
+
+    class Request
+      include Suretax::Concerns::Validatable
+
+      attr_accessor :business_unit,
+                    :client_number,
+                    :client_tracking,
+                    :data_month,
+                    :data_year,
+                    :industry_exemption,
+                    :response_group,
+                    :response_type,
+                    :return_file_code,
+                    :total_revenue,
+                    :validation_key,
+                    :items
+
+      attr_reader   :response
+
+      validate :client_number,
+               :business_unit,
+               :validation_key,
+               :data_year,
+               :data_month,
+               :total_revenue,
+               :return_file_code,
+               :client_tracking,
+               :response_group,
+               :response_type,
+               :items
+
+      def initialize(options = {})
+        self.return_file_code = '0'
+        self.client_number    = options.delete(:client_number)  || configuration.client_number
+        self.validation_key   = options.delete(:validation_key) || configuration.validation_key
+
+        default_data_date(options)
+
+        options.each_pair do |key,value|
+          self.send("#{key.to_s}=", value.to_s)
+        end
+
+        initialize_items(options)
+
+        validate!
+      end
+
+      def submit
+        if valid?
+          log_request
+          suretax_response = connection.post(params)
+          @response = Suretax::Api::Response.new(suretax_response.body)
+        else
+          raise(ValidationError, errors.messages.join(", "))
+        end
+      end
+
+      def valid?
+        !errors.any?
+      end
+
+      def rollback
+        if response
+          CancelRequest.new(transaction: response.transaction, 
+            client_number: client_number, validation_key: validation_key,
+            client_tracking: client_tracking).submit
+        end
+      end
+
+      def params
+        {
+          "ClientNumber"             => client_number,
+          "BusinessUnit"             => business_unit || '',
+          "ValidationKey"            => validation_key,
+          "DataYear"                 => data_year,
+          "DataMonth"                => data_month,
+          "TotalRevenue"             => total_revenue.to_f,
+          "ReturnFileCode"           => return_file_code,
+          "ClientTracking"           => client_tracking || '',
+          "IndustryExemption"        => industry_exemption,
+          "ResponseType"             => response_type,
+          "ResponseGroup"            => response_group,
+          "ItemList"                 => items.map { |item| item.params }
+        }
+      end
+
+      private
+
+        def default_data_date(options)
+          max_date = configuration.test? ? Date.today.prev_month : Date.today
+
+          requested_date = begin
+                             Date.new(options[:data_year].to_i, options[:data_month].to_i, 1)
+                           rescue
+                             max_date
+                           end
+
+          data_date = [requested_date, max_date].min
+
+          self.data_month = data_date.strftime('%m')
+          self.data_year  = data_date.strftime('%Y')
+        end
+
+        def initialize_items(options)
+          self.items = []
+          if options[:items].respond_to?(:each)
+            options[:items].each do |item_args|
+              self.items << RequestItem.new(item_args)
+            end
+          end
+        end
+
+        def log_request
+          logger.info "\nSureTax Request sent:\n#{params.inspect}" if logger
+        end
+
+        def logger
+          configuration.logger
+        end
+
+        def configuration
+          Suretax.configuration
+        end
+
+        def connection
+          @connection ||= Connection.new
+        end
+    end
+  end
+end