RubyGems - Avatax_TaxService - Versions diffs - 1.0.11 → 1.0.12 - Mend

Avatax_TaxService 1.0.11 → 1.0.12

Files changed (27) hide show

checksums.yaml +8 -8
data/Avatax_TaxService.gemspec +7 -4
data/lib/avatax_taxservice.rb +127 -225
data/lib/template_gettax.erb +2 -2
data/samples/CancelTax.rb +27 -0
data/samples/GetTax.rb +118 -0
data/samples/GetTaxHistory.rb +39 -0
data/samples/Ping.rb +24 -0
data/samples/PostTax.rb +34 -0
data/samples/Validate.rb +37 -0
data/samples/credentials.yml +5 -0
data/spec/adjusttax_spec.rb +235 -0
data/spec/canceltax_spec.rb +148 -0
data/spec/committax_spec.rb +145 -0
data/spec/gettax_spec.rb +281 -0
data/spec/gettaxhistory_spec.rb +120 -0
data/spec/isauthorized_spec.rb +75 -0
data/spec/ping_spec.rb +75 -0
data/spec/posttax_spec.rb +169 -0
data/spec/reconciletaxhistory_spec.rb +125 -0
data/spec/spec_helper.rb +16 -0
data/spec/taxservice_spec.rb +42 -0
metadata +20 -6
data/test/test_adjtax.rb +0 -127
data/test/test_gettax.rb +0 -150
data/test/test_gettaxhistory.rb +0 -55
data/test/test_reconciletaxhistory.rb +0 -63

data/spec/canceltax_spec.rb ADDED Viewed

@@ -0,0 +1,148 @@
+require "spec_helper"
+describe "CancelTax" do
+  before :each do
+    credentials = YAML::load(File.open('credentials.yml'))
+    @creds = {:username => credentials['username'],
+          :password => credentials['password'],
+          :clientname => credentials['clientname'],
+          :use_production_url => credentials['production']}
+      @svc =  AvaTax::TaxService.new(@creds)
+      @get_tax_request = {
+        :doctype => "SalesInvoice",
+        :commit => false,
+        :detaillevel => "Tax",
+        :docdate=>DateTime.now.strftime("%Y-%m-%d"),
+        :customercode => "CUST123",
+        :origincode => "456",
+        :destinationcode => "456",
+        :addresses=>[{
+          :addresscode=>"456",
+          :line1=>"7070 West Arlington Drive",
+          :postalcode=>"80123",
+          :country=>"US",
+          }],
+        :lines=>[{
+          :no=>"1",
+          :itemcode=>"Canoe",
+          :qty=>"1",
+          :amount=>"300.43",
+          :description=>"Blue canoe",
+          }]}
+      @get_tax_result = @svc.gettax(@get_tax_request)
+      @request_required = {
+        :companycode => @get_tax_result[:company_code],
+        :doctype => @get_tax_result[:doc_type],
+        :doccode => @get_tax_result[:doc_code],
+        :cancelcode => "DocVoided",
+      }
+      @request_optional = {
+        :docid => @get_tax_result[:doc_id]
+      }
+  end
+  describe "returns a meaningful" do
+    it "error when URL is missing" do
+      @creds[:use_production_url] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.canceltax(@request_required)[:result_code].should eql "Success"
+    end
+    it "success when URL is specified" do
+      @creds[:use_production_url] = false
+      @service = AvaTax::TaxService.new(@creds)
+      @service.canceltax(@request_required)[:result_code].should eql "Success"
+    end
+    it "error when username is missing" do
+      @creds[:username] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.canceltax(@request_required)[:result_code].should eql "Error"
+    end
+    it "error when password is omitted" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.canceltax(@request_required)[:result_code].should eql "Error"
+    end
+    it "success when clientname is omitted" do
+      @creds[:clientname] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.canceltax(@request_required)[:result_code].should eql "Success"
+    end
+  end
+  describe "has consistent formatting for" do
+    it "server-side errors" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.canceltax(@request_required)
+      @result[:result_code].should eql "Error" and @result[:details].should eql "The user or account could not be authenticated."
+    end
+    it "successful results" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.canceltax(@request_required)
+      @result[:result_code].should eql "Success" and @result[:transaction_id].should_not be_nil
+    end
+  end
+  describe "requests with" do
+    it "missing required parameters fail" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.canceltax(@request_optional)
+      @result[:result_code].should eql "Error"
+    end
+    it "invalid parameters ignore them" do
+      @service = AvaTax::TaxService.new(@creds)
+      @request_required[:bogus] = "data"
+      @result = @service.canceltax(@request_required)
+      @result[:result_code].should eql "Success"
+    end
+    it "missing optional parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.canceltax(@request_required)
+      @result[:result_code].should eql "Success"
+    end
+    it "all parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.canceltax(@request_required.merge(@request_optional))
+      @result[:result_code].should eql "Success"
+    end
+  end
+  describe "workflow" do
+    it "should not change the status when cancel code is unspecified" do
+      @request_required[:cancelcode] = "Unspecified"
+      @result = @svc.canceltax(@request_required)
+      @history_request = {
+        :doccode => @request_required[:doccode],
+        :companycode => @request_required[:companycode],
+        :doctype => @request_required[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Saved"
+    end
+    it "should void documents when cancel code is DocVoided" do
+      @request_required[:cancelcode] = "DocVoided"
+      @result = @svc.canceltax(@request_required)
+      @history_request = {
+        :doccode => @request_required[:doccode],
+        :companycode => @request_required[:companycode],
+        :doctype => @request_required[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Cancelled"
+    end
+    it "should delete uncommitted/voided documents when cancel code is DocDeleted" do\
+      @request_required[:cancelcode] = "DocDeleted"
+      @result = @svc.canceltax(@request_required)
+      @history_request = {
+        :doccode => @request_required[:doccode],
+        :companycode => @request_required[:companycode],
+        :doctype => @request_required[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:result_code].should eql "Error"
+    end
+  end
+end

data/spec/committax_spec.rb ADDED Viewed

@@ -0,0 +1,145 @@
+require "spec_helper"
+describe "CommitTax" do
+  before :each do
+    credentials = YAML::load(File.open('credentials.yml'))
+    @creds = {:username => credentials['username'],
+          :password => credentials['password'],
+          :clientname => credentials['clientname'],
+          :use_production_url => credentials['production']}
+    @svc =  AvaTax::TaxService.new(@creds)
+    @get_tax_request = {
+      :doctype => "SalesInvoice",
+      :commit => false,
+      :detaillevel => "Tax",
+      :docdate=>DateTime.now.strftime("%Y-%m-%d"),
+      :customercode => "CUST123",
+      :origincode => "456",
+      :destinationcode => "456",
+      :addresses=>[{
+        :addresscode=>"456",
+        :line1=>"7070 West Arlington Drive",
+        :postalcode=>"80123",
+        :country=>"US",
+        }],
+      :lines=>[{
+        :no=>"1",
+        :itemcode=>"Canoe",
+        :qty=>"1",
+        :amount=>"300.43",
+        :description=>"Blue canoe",
+        }]}
+    @get_tax_result = @svc.gettax(@get_tax_request)
+    @post_tax_request = {
+      :companycode => @get_tax_result[:company_code],
+      :doctype => @get_tax_result[:doc_type],
+      :doccode => @get_tax_result[:doc_code],
+      :commit => false,
+      :docdate => @get_tax_result[:doc_date],
+      :totalamount => @get_tax_result[:total_amount],
+      :totaltax => @get_tax_result[:total_tax],
+    }
+    @post_tax_result = @svc.posttax(@post_tax_request)
+    @request_required = {
+      :companycode => @get_tax_result[:company_code],
+      :doctype => @get_tax_result[:doc_type],
+      :doccode => @get_tax_result[:doc_code],
+    }
+    @request_optional = {
+      :docid => @get_tax_result[:doc_id],
+      :newdoccode => "new doc code: "+ @get_tax_result[:doc_code],
+    }
+  end
+  describe "returns a meaningful" do
+    it "error when URL is missing" do
+      @creds[:use_production_url] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.committax(@request_required)[:result_code].should eql "Success"
+    end
+    it "success when URL is specified" do
+      @creds[:use_production_url] = false
+      @service = AvaTax::TaxService.new(@creds)
+      @service.committax(@request_required)[:result_code].should eql "Success"
+    end
+    it "error when username is missing" do
+      @creds[:username] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.committax(@request_required)[:result_code].should eql "Error"
+    end
+    it "error when password is omitted" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.committax(@request_required)[:result_code].should eql "Error"
+    end
+    it "success when clientname is omitted" do
+      @creds[:clientname] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.committax(@request_required)[:result_code].should eql "Success"
+    end
+  end
+  describe "has consistent formatting for" do
+    it "server-side errors" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.committax(@request_required)
+      @result[:result_code].should eql "Error" and @result[:details].should eql "The user or account could not be authenticated."
+    end
+    it "successful results" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.committax(@request_required)
+      @result[:result_code].should eql "Success" and @result[:transaction_id].should_not be_nil
+    end
+  end
+  describe "requests with" do
+    it "missing required parameters fail" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.committax(@request_optional)
+      @result[:result_code].should eql "Error"
+    end
+    it "invalid parameters ignore them" do
+      @service = AvaTax::TaxService.new(@creds)
+      @request_required[:bogus] = "data"
+      @result = @service.committax(@request_required)
+      @result[:result_code].should eql "Success"
+    end
+    it "missing optional parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.committax(@request_required)
+      @result[:result_code].should eql "Success"
+    end
+    it "all parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.committax(@request_required.merge(@request_optional))
+      @result[:result_code].should eql "Success"
+    end
+  end
+  describe "workflow" do
+    it "should be able to commit posted transactions" do
+      @result = @svc.committax(@request_required)
+      @history_request = {
+        :doccode => @request_required[:doccode],
+        :companycode => @request_required[:companycode],
+        :doctype => @request_required[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Committed"
+    end
+    it "should be able to change the doccode" do
+      @result = @svc.committax(@request_required.merge(@request_optional))
+      @history_request = {
+        :doccode => @request_optional[:newdoccode],
+        :companycode => @request_required[:companycode],
+        :doctype => @request_required[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Committed"
+    end
+  end
+end

data/spec/gettax_spec.rb ADDED Viewed

@@ -0,0 +1,281 @@
+require "spec_helper"
+require "date"
+describe "GetTax" do
+  before :each do
+    credentials = YAML::load(File.open('credentials.yml'))
+    @creds = {:username => credentials['username'],
+          :password => credentials['password'],
+          :clientname => credentials['clientname'],
+          :use_production_url => credentials['production']}
+    @companycode = credentials['companycode']
+    @svc = AvaTax::TaxService.new(@creds)
+    @request_required = {
+      :doctype => "SalesOrder",
+      :docdate=>DateTime.now.strftime("%Y-%m-%d"),
+      :customercode => "CUST123",
+      :origincode => "456",
+      :destinationcode => "456",
+      :addresses=>[{
+        :addresscode=>"456",
+        :line1=>"7070 West Arlington Drive",
+        :postalcode=>"80123",
+        :country=>"US",
+        }],
+      :lines=>[{
+        :no=>"1",
+        :itemcode=>"Canoe",
+        :qty=>"1",
+        :amount=>"300.43",
+        :description=>"Blue canoe",
+        }]
+    }
+    @request_optional = {
+      :companycode => @companycode,
+      :salespersoncode => "Bill Sales",
+      :detaillevel => "Tax",
+      :customerusagetype => "L",
+      :discount => "10",
+      :purchaseorderno => "PO9823",
+      :exemptionno => "23423",
+      :referencecode => "ref1",
+      :locationcode => "001",
+      :commit => "false",
+      :batchcode => "",
+      :taxoverridetype => "TaxDate",
+      :taxamount => "0",
+      :taxdate => "1999-01-01",
+      :reason => "Override",
+      :currencycode => "USD",
+      :servicemode => "Remote",
+      :paymentdate => DateTime.now.strftime("%Y-%m-%d"),
+      :exchangerate => "0",
+      :exchangerateeffdate => "1900-01-01",
+      :poslanecode => "1",
+      :businessidentificationno => "2342",
+      :debug => false,
+      :validate => false,
+      :hashcode => "0",
+      :taxoverridetype=>"None",
+      :taxamount=>".0000",
+      :taxdate=>"1900-01-01",
+      :reason=>"",
+      :addresses=>[{
+        :addresscode=>"123",
+        :line1=>"100 ravine lane",
+        :line2=>"Suite 21",
+        :city=>"Bainbridge Island",
+        :region=>"WA",
+        :postalcode=>"98110",
+        :country=>"US",
+        :taxregionid=>"0",
+        :latitude=>"",
+        :longitude=>""
+        }, {
+        :addresscode=>"456",
+        :line1=> "Attn. Accounting",
+        :line3=>"7070 West Arlington Drive",
+        :postalcode=>"80123",
+        :country=>"US",
+        :taxregionid=>"0"
+        }],
+        :lines=>[{
+          :no=>"1",
+          :itemcode=>"Canoe",
+          :qty=>"1",
+          :amount=>"300.43",
+          :discounted=>"false",
+          :ref1=>"ref1",
+          :ref2=>"ref2",
+          :description=>"Blue canoe",
+            :taxoverridetypeline=>"TaxAmount",
+            :taxamountline=>"10",
+            :taxdateline=>"1900-01-01",
+            :reasonline=>"Tax credit",
+          :taxincluded=>"false"
+          }, {
+          :no=>"2",
+          :itemcode=>"Rowing boat",
+          :qty=>"1",
+          :destinationcodeline=>"123",
+          :amount=>"800.12",
+          :discounted=>"false",
+          :ref1=>"ref3",
+          :ref2=>"ref4",
+          :description=>"Red rowing boat",
+          :taxoverridetype=>"None",
+          :taxamount=>"0",
+          :taxdate=>"1900-01-01",
+          :taxincluded=>"true"
+          }]
+    }
+  end
+  describe "returns a meaningful" do
+    it "error when URL is missing" do
+      @creds[:use_production_url] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.gettax(@request_required)[:result_code].should eql "Success"
+    end
+    it "success when URL is specified" do
+      @creds[:use_production_url] = false
+      @service = AvaTax::TaxService.new(@creds)
+      @service.gettax(@request_required)[:result_code].should eql "Success"
+    end
+    it "error when username is missing" do
+      @creds[:username] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.gettax(@request_required)[:result_code].should eql "Error"
+    end
+    it "error when password is omitted" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.gettax(@request_required)[:result_code].should eql "Error"
+    end
+    it "success when clientname is omitted" do
+      @creds[:clientname] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @service.gettax(@request_required)[:result_code].should eql "Success"
+    end
+  end
+  describe "has consistent formatting for" do
+    it "server-side errors" do
+      @creds[:password] = nil
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.gettax(@request_required)
+      @result[:result_code].should eql "Error" and @result[:details].should eql "The user or account could not be authenticated."
+    end
+    it "successful results" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.gettax(@request_required)
+      if @result[:result_code] == "Error"
+        print @result
+      end
+      @result[:result_code].should eql "Success" and @result[:transaction_id].should_not be_nil
+    end
+  end
+  describe "requests with" do
+    it "missing required parameters fail" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.gettax(@request_optional)
+      @result[:result_code].should eql "Error"
+    end
+    it "invalid parameters ignore them" do
+      @service = AvaTax::TaxService.new(@creds)
+      @request_required[:bogus] = "data"
+      @result = @service.gettax(@request_required)
+      @result[:result_code].should eql "Success"
+    end
+    it "missing optional parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.gettax(@request_required)
+      @result[:result_code].should eql "Success"
+    end
+    it "all parameters succeed" do
+      @service = AvaTax::TaxService.new(@creds)
+      @result = @service.gettax(@request_required.merge(@request_optional))
+      @result[:result_code].should eql "Success"
+    end
+  end
+  describe "workflow" do
+    it "should calculate tax without recording a document" do
+      @request = @request_required
+      @request[:doctype] = "SalesOrder"
+      @request[:companycode] = @companycode
+      @result = @svc.gettax(@request)
+      @history_request = {
+        :doccode => @result[:doc_code],
+        :companycode => @request[:companycode],
+        :doctype => @request[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:result_code].should eql "Error" and
+      @history_result[:messages][:message][:summary].should eql "The tax document could not be found."
+    end
+    it "should record a document as uncommitted" do
+      @request = @request_required
+      @request[:doctype] = "SalesInvoice"
+      @request[:commit] = false
+      @request[:companycode] = @companycode
+      @result = @svc.gettax(@request)
+      @history_request = {
+        :doccode => @result[:doc_code],
+        :companycode => @request[:companycode],
+        :doctype => @request[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Saved"
+    end
+    it "should record a document as committed" do
+      @request = @request_required
+      @request[:doctype] = "SalesInvoice"
+      @request[:commit] = true
+      @request[:companycode] = @companycode
+      @result = @svc.gettax(@request)
+      @history_request = {
+        :doccode => @result[:doc_code],
+        :companycode => @request[:companycode],
+        :doctype => @request[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result[:result_code].should eql "Success" and
+      @history_result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Committed"
+    end
+    it "should update uncommitted documents" do
+      @request = @request_required
+      @request[:doctype] = "SalesInvoice"
+      @request[:commit] = false
+      @request[:companycode] = @companycode
+      @result_initial = @svc.gettax(@request)
+      @request[:customercode] = "NEWCUST"
+      @request[:doccode] = @result_initial[:doc_code]
+      @result = @svc.gettax(@request)
+      @history_request = {
+        :doccode => @result_initial[:doc_code],
+        :companycode => @request[:companycode],
+        :doctype => @request[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result_initial[:result_code].should eql "Success" and
+      @result[:result_code].should eql "Success" and
+      @history_result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Saved" and
+      @history_result[:get_tax_request][:customer_code].should eql @request[:customercode]
+    end
+    it "should not update committed documents" do
+      @request = @request_required
+      @old_customer_code = @request_required[:customercode]
+      @request[:doctype] = "SalesInvoice"
+      @request[:commit] = true
+      @request[:companycode] = @companycode
+      @result_initial = @svc.gettax(@request)
+      @request[:customercode] = "NEWCUST"
+      @request[:doccode] = @result_initial[:doc_code]
+      @result = @svc.gettax(@request)
+      @history_request = {
+        :doccode => @result_initial[:doc_code],
+        :companycode => @request[:companycode],
+        :doctype => @request[:doctype],
+      }
+      @history_result = @svc.gettaxhistory(@history_request)
+      @result_initial[:result_code].should eql "Success" and
+      @result[:result_code].should eql "Error" and
+      @history_result[:result_code].should eql "Success" and
+      @history_result[:get_tax_result][:doc_status].should eql "Committed" and
+      @history_result[:get_tax_request][:customer_code].should eql @old_customer_code
+    end
+  end
+end