suretax 0.1.0

data/spec/support/cancellation_helper.rb

@@ -0,0 +1,31 @@
+module CancellationSpecHelper
+
+  def cancel_response_body
+    {
+      "Successful" => "Y",
+      "ResponseCode" => "9999",
+      "HeaderMessage" => "Success",
+      "ClientTracking" => "test",
+      "TransId" => 0
+    }
+  end
+
+  def cancel_request_body
+    {
+      "ClientNumber" => suretax_client_number,
+      "ClientTracking" => "test",
+      "TransId" => "999",
+      "ValidationKey" => suretax_key
+    }
+  end
+
+  def cancel_failed_response_body
+    {
+      "Successful" => "N",
+      "ResponseCode" => nil,
+      "HeaderMessage" => nil,
+      "ClientTracking" => nil,
+      "TransId" => 0
+    }
+  end
+end

data/spec/support/connection_shared_examples.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+shared_examples_for 'API connection' do
+  context 'with a valid request' do
+    before do
+      stub_request(:post, "#{suretax_url}#{api_path}").to_return(
+        status: 200,
+        body: response_body
+      )
+    end
+
+    it 'should be successful' do
+      expect(response).to be_success
+    end
+
+    it 'should have a urlencode header' do
+      expect(connection.headers['Content-Type']).to include('application/x-www-form-urlencoded')
+    end
+  end
+
+  context 'with an invalid request' do
+
+    let(:request_body) { {} }
+
+    before do
+      stub_request(:post, "#{suretax_url}#{api_path}").to_return(
+        status: 500,
+        body: invalid_response_body
+      )
+    end
+
+    it 'should not be successful' do
+      expect(response).to_not be_success
+    end
+  end
+end
+

data/spec/support/request_helper.rb

@@ -0,0 +1,309 @@
+# encoding: utf-8
+
+module RequestSpecHelper
+
+  def valid_encoded_test_request_body
+    {
+      "ClientNumber"             => suretax_client_number,
+      "BusinessUnit"             => "testing",
+      "ValidationKey"            => suretax_key,
+      "ClientTracking"           => "track",
+      "DataMonth"                => "7",
+      "DataYear"                 => "2013",
+      "ResponseGroup"            => "03",
+      "ResponseType"             => "D6",
+      "ReturnFileCode"           => "0",
+      "TotalRevenue"             => 40.0,
+      "IndustryExemption"        => "",
+      "ItemList"                 => [
+        {
+          "LineNumber"           => "1",
+          "InvoiceNumber"        => "1",
+          "CustomerNumber"       => "000000007",
+          "OrigNumber"           => "8585260000",
+          "TermNumber"           => "8585260000",
+          "BillToNumber"         => "8585260000",
+          "Zipcode"              => "",
+          "Plus4"                => "",
+          "P2PZipcode"           => "",
+          "P2PPlus4"             => "",
+          "TransDate"            => "2013-12-01T00:00:00",
+          "Revenue"              => 40.0,
+          "Units"                => 1,
+          "UnitType"             => "00",
+          "Seconds"              => 55,
+          "TaxIncludedCode"      => "0",
+          "TaxSitusRule"         => "01",
+          "TransTypeCode"        => "010101",
+          "SalesTypeCode"        => "R",
+          "RegulatoryCode"       => "99",
+          "TaxExemptionCodeList" => [
+            "00",
+            "00"
+          ]
+        }
+      ]
+    }
+  end
+
+  def valid_test_response_body
+    {
+      "Successful"     => "Y",
+      "ResponseCode"   => "9999",
+      "HeaderMessage"  => "Success",
+      "ItemMessages"   => [],
+      "ClientTracking" => "track",
+      "TotalTax"       => "1.394490",
+      "TransId"        => 2664495,
+      "GroupList"      => [
+        {
+          "StateCode"      => "CA",
+          "InvoiceNumber"  => "1",
+          "CustomerNumber" => "000000007",
+          "TaxList"        => [
+            {
+              "TaxTypeCode" => "106",
+              "TaxTypeDesc" => "CA EMERG TEL. USERS SURCHARGE",
+              "TaxAmount"   => "0.200760"
+            },
+            {
+              "TaxTypeCode" => "108",
+              "TaxTypeDesc" => "CA P.U.C. FEE",
+              "TaxAmount"   => "0.072130"
+            },
+            {
+              "TaxTypeCode" => "109",
+              "TaxTypeDesc" => "CA TELECOM RELAY SYSTEMS SURCHARGE",
+              "TaxAmount"   => "0.080000"
+            },
+            {
+              "TaxTypeCode" => "117",
+              "TaxTypeDesc" => "CA HIGH COST FUND(B) SURCHARGE",
+              "TaxAmount"   => "0.120000"
+            },
+            {
+              "TaxTypeCode" => "118",
+              "TaxTypeDesc" => "CA TELECONNECT FUND",
+              "TaxAmount"   => "0.236000"
+            },
+            {
+              "TaxTypeCode" => "119",
+              "TaxTypeDesc" => "CA HIGH COST FUND(A) SURCHARGE",
+              "TaxAmount"   => "0.160000"
+            },
+            {
+              "TaxTypeCode" => "120",
+              "TaxTypeDesc" => "CA ADVANCED SERV FUND SURCH",
+              "TaxAmount"   => "0.065600"
+            },
+            {
+              "TaxTypeCode" => "122",
+              "TaxTypeDesc" => "CA UNIVERSAL LIFELINE  SURCHARGE",
+              "TaxAmount"   => "0.460000"
+            }
+          ]
+        }
+      ]
+    }
+  end
+
+  def valid_v03_response_body
+    {
+      "Successful" => "Y",
+      "ResponseCode" => "9999",
+      "HeaderMessage" => "Success",
+      "ItemMessages" => [],
+      "ClientTracking" => "track",
+      "TotalTax" => "1.394490",
+      "TransId" => 2872159,
+      "GroupList" => [
+        {
+        "LineNumber" => "1",
+        "StateCode" => "CA",
+        "InvoiceNumber" => "1",
+        "CustomerNumber" => "000000007",
+        "TaxList" => [
+          {
+            "TaxTypeCode" => "106",
+            "TaxTypeDesc" => "CA EMERG TEL. USERS SURCHARGE",
+            "TaxAmount" => "0.200760",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.005,
+            "PercentTaxable" => 1.0
+          },
+          {
+            "TaxTypeCode" => "108",
+            "TaxTypeDesc" => "CA P.U.C. FEE",
+            "TaxAmount" => "0.072130",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.0018,
+            "PercentTaxable" => 1.0
+          },
+          {
+            "TaxTypeCode" => "109",
+            "TaxTypeDesc" => "CA TELECOM RELAY SYSTEMS SURCHARGE",
+            "TaxAmount" => "0.080000",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.002,
+            "PercentTaxable" => 1.0
+          },
+          {
+            "TaxTypeCode" => "117",
+            "TaxTypeDesc" => "CA HIGH COST FUND(B) SURCHARGE",
+            "TaxAmount" => "0.120000",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.003,
+            "PercentTaxable" => 1.0
+          },
+          {
+            "TaxTypeCode" => "118",
+            "TaxTypeDesc" => "CA TELECONNECT FUND",
+            "TaxAmount" => "0.236000",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.0059,
+            "PercentTaxable" => 1.0
+          },
+          {
+            "TaxTypeCode" => "119",
+            "TaxTypeDesc" => "CA HIGH COST FUND(A) SURCHARGE",
+            "TaxAmount" => "0.160000",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.004,
+            "PercentTaxable" => 1.0
+          },
+          {
+            "TaxTypeCode" => "120",
+            "TaxTypeDesc" => "CA ADVANCED SERV FUND SURCH",
+            "TaxAmount" => "0.065600",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.00164,
+            "PercentTaxable" => 1.0
+          },
+          {
+            "TaxTypeCode" => "122",
+            "TaxTypeDesc" => "CA UNIVERSAL LIFELINE  SURCHARGE",
+            "TaxAmount" => "0.460000",
+            "Revenue" => "40",
+            "CountyName" => "SAN DIEGO",
+            "CityName" => "SAN DIEGO",
+            "TaxRate" => 0.0115,
+            "PercentTaxable" => 1.0
+          }]
+        }
+      ]
+    }
+  end
+
+  def post_failed_response_body
+    {
+      "Successful"=>"N",
+      "ResponseCode"=>"1101",
+      "HeaderMessage"=>"Failure - Error parsing request",
+      "ItemMessages"=>[],
+      "ClientTracking"=>nil,
+      "TotalTax"=>nil,
+      "TransId"=>2667859,
+      "GroupList"=>[]
+    }
+  end
+
+  def success_with_item_errors
+    {
+      "Successful"       => "Y",
+      "ResponseCode"     => "9001",
+      "HeaderMessage"    => "Success with Item errors",
+      "ItemMessages"     => [
+        {
+          "LineNumber"   => "1",
+          "ResponseCode" => "9220",
+          "Message"      => "Invalid Unit Type – Must be 00"
+        }
+      ],
+      "ClientTracking"   => "7310",
+      "TotalTax"         => "26.53",
+      "TransId"          => 4366,
+      "GroupList"        => [
+        {
+          "CustomerNumber" => "00123",
+          "InvoiceNumber"  => "12345678",
+          "StateCode"      => "CA",
+          "TaxList"        => [
+            {
+              "TaxAmount"   => "10.45",
+              "TaxTypeCode" => "316",
+              "TaxTypeDesc" => "LOCAL UTILITY USERS TAX"
+            },
+            {
+              "TaxAmount"   => "15.50",
+              "TaxTypeCode" => "035",
+              "TaxTypeDesc" => "FEDERAL UNIVERSAL SERVICE FUND"
+            },
+            {
+              "TaxAmount"   => "0.58",
+              "TaxTypeCode" => "060",
+              "TaxTypeDesc" => "FEDERAL TRS FUND"
+            }
+          ]
+        }
+      ]
+    }
+  end
+
+  def suretax_valid_request_params
+    {
+       business_unit: "testing",
+       client_number: suretax_client_number,
+       client_tracking: "track",
+       data_month: "7",
+       data_year: "2013",
+       industry_exemption: "",
+       response_group: "03",
+       response_type: "D6",
+       return_file_code: "0",
+       total_revenue: "40",
+       validation_key: suretax_key,
+       items: [ suretax_valid_request_item_params ]
+    }
+  end
+
+  def suretax_valid_request_item_params
+    {
+      bill_to_number: "8585260000",
+      customer_number: "000000007",
+      invoice_number: "1",
+      line_number: "1",
+      orig_number: "8585260000",
+      p_to_p_plus_four: "",
+      p_to_p_zipcode: "",
+      plus_four: "",
+      regulatory_code: "99",
+      revenue: "40",
+      sales_type_code: "R",
+      seconds: "55",
+      tax_included_code: "0",
+      tax_situs_rule: "01",
+      term_number: "8585260000",
+      trans_date: "2013-12-01T00:00:00",
+      trans_type_code: "010101",
+      unit_type: "00",
+      units: "1",
+      zipcode: "",
+      tax_exemption_codes: [ "00", "00" ]
+    }
+  end
+
+end

data/spec/support/suretax_helper.rb

@@ -0,0 +1,27 @@
+module SuretaxSpecHelper
+
+  def suretax_key
+    ENV['SURETAX_VALIDATION_KEY']
+  end
+
+  def suretax_url
+    Suretax.configuration.base_url
+  end
+
+  def suretax_client_number
+    ENV['SURETAX_CLIENT_NUMBER']
+  end
+
+  def suretax_post_path
+    Suretax.configuration.request_path
+  end
+
+  def suretax_cancel_path
+    Suretax.configuration.cancel_path
+  end
+
+  def suretax_wrap_response(json_string)
+    "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<string xmlns=\"http://tempuri.org/\">" + json_string + "</string>"
+  end
+
+end

data/spec/support/validations_shared_examples.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+shared_examples_for 'optional phone number' do
+  it 'can be blank' do
+    request_item.send("#{subject}=",nil)
+
+    expect(request_item.errors.any?).to eq false
+  end
+
+  it 'must be numeric' do
+    request_item.send("#{subject}=",'abcdefghij')
+
+    expect(request_item.errors.any?).to eq true
+    expect(request_item.errors.messages).to eq [%Q{Invalid #{subject}: abcdefghij}]
+  end
+
+  it 'must ten digits' do
+    request_item.send("#{subject}=",'1' * 11)
+
+    expect(request_item.errors.any?).to eq true
+    expect(request_item.errors.messages).to eq [%Q{Invalid #{subject}: #{'1' * 11}}]
+
+    request_item.send("#{subject}=",'1' * 9)
+
+    expect(request_item.errors.any?).to eq true
+    expect(request_item.errors.messages).to eq [%Q{Invalid #{subject}: #{'1' * 9}}]
+  end
+end

data/suretax.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'suretax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "suretax"
+  spec.version       = Suretax::VERSION
+  spec.authors       = ["Damon Davison"]
+  spec.email         = ["damon@allolex.net"]
+  spec.description   = %q{A wrapper library for the SureTax communications tax API}
+  spec.summary       = %q{This gem will allow Ruby developers to easily integrate SureTax into their apps.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "money"
+  spec.add_dependency "monetize"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.0.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.0'
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
+end