Avatax_AddressService 1.0.9 → 1.0.10

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGEwYzJmYWVhMzM0NmYwNTY3ZTVhMWE3M2I0ZWEwM2IxYzljZWJmZA==
+    ZDE0YjRhNzgxMDVmY2M2MDQ1YTRmYjdhOTFhZTMzNjM0ODdlZTAwYw==
   data.tar.gz: !binary |-
-    YWYxNjI5NGE3NTg1N2MwOWNiNjQzY2IzZDdhMTBiNjNkNDRmNmRkOQ==
+    ZjkyYmJjYjc0YjJlYzVjMzAwMmEwNjZjMmIxNzZmYTYyNDQ0YjczYg==
 SHA512:
   metadata.gz: !binary |-
-    MmM5NjliYjk2ODAyYWFlN2VmZDE5ZjEyZDhmNzIyMTY4MzBlNTdhYTdkZDM5
-    MmI1ZTQwNjM0NzVkMjg5MzNkNTVjZTdlMzBjYWJkOTYxMWExZmY1ZjVlNmMz
-    ZDI1YmEzOTM5YTQ3MjFjYzAyNjljMjgyNjZiZGIxYTJhZThiNmM=
+    ZWI4NjkyOGFkMzJjMGNmYmJjNWVhYjVkMmE3ZjBhNDRhZmRjZjM0MjI3OTA0
+    MDFkNmYwYzVkNDc5MGYzZTczM2Y2YmE4MjJjM2FlYmQ0NWVjMWUwYjU0MjBl
+    MGUyOGUzYmU3ZjNiMzY3NzE2MWFlZmY0MWU3MWNjZjRhYWFjM2I=
   data.tar.gz: !binary |-
-    OWY3MGE2YTdlN2RkODIyNmEyZjMwZTg3OTQ2NWRhZTBmZTU1M2JlMGI5NGM0
-    ZGJmYTA5MzlkZTQxNDhjNDJkZThlODI1YzZkYWZiMjc2YjBiMmM1NThkNDUx
-    N2I5NTFjMDFiMjJjYWI1NzdjNmQxNDNjMGFkYmZmMGM3MjQ0NzA=
+    NmUzODk2NWE3NWYwOGNiYTU4MGMyNmNhNTVhMWFmYTdlYzU1NTVkMzU5OGNl
+    NmY1MTkwNDNlMGY1NDNmNmQxMWRhODM0YWIzZjdiYmNhMmQwYjc5ZTQ5ZWM1
+    NjlhNTY2OWMwMTFlMzVhYjdlMzAzN2ZmZTg0ZWJkOGM1MjA1YTk=

data/Avatax_AddressService.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "Avatax_AddressService"
-  s.version = "1.0.9"
+  s.version = "1.0.10"
   s.date = "2012-12-16"
   s.author = "Graham S Wilson"
   s.email = "support@Avalara.com"
@@ -10,10 +10,11 @@ Gem::Specification.new do |s|
   s.description = "Ruby SDK provides means of communication with Avatax Web Services."
   s.files = ["lib/address_log.txt", "lib/addressservice_dev.wsdl", "lib/addressservice_prd.wsdl", "lib/avatax_addressservice.rb",
              "lib/template_validate.erb","lib/template_ping.erb","lib/template_isauthorized.erb",
-             "Avatax_AddressService.gemspec", "Avatax Ruby SDK Guide.docx", "LICENSE.txt"]
+             "samples/credentials.yml", "samples/Ping.rb","samples/Validate.rb",
+             "spec/addressservice_spec.rb","spec/isauthorized_spec.rb","spec/ping_spec.rb","spec/spec_helper.rb","spec/validate_spec.rb",
+             "Avatax_AddressService.gemspec","Avatax Ruby SDK Guide.docx","LICENSE.txt"]
   # s.add_dependency "nokogiri", ">= 1.4.0", "< 1.6"
   s.add_dependency "savon", ">= 2.3.0"
   s.required_ruby_version = '>=1.9.1'
   s.post_install_message = 'Thanks for installing the Avalara AddressService Ruby SDK. Refer to "Avatax Ruby SDK User Guide.docx" to get started.'
-end
-  
+end

data/samples/Ping.rb

@@ -0,0 +1,23 @@
+require 'Avatax_AddressService'
+require 'yaml'
+#Note that the ping function exists in both the AddressSvc and TaxSvc classes - it works the same way in both.
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::AddressService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+
+  #Call the service
+result = svc.ping
+#print result
+
+#Display the result
+puts "Ping ResultCode: "+result[:result_code]
+
+#If we encountered an error
+if result[:result_code] != "Success"
+  #Print the first error message returned
+  puts result[:details]
+end

data/samples/Validate.rb

@@ -0,0 +1,37 @@
+require 'Avatax_AddressService'
+require 'yaml'
+
+#Create an instance of the service class
+credentials = YAML::load(File.open('credentials.yml'))
+svc = AvaTax::AddressService.new(:username => credentials['username'], 
+      :password => credentials['password'],  
+      :clientname => credentials['clientname'],
+      :use_production_url => credentials['production']) 
+  
+  # Create the request
+input = {
+  :line1 => "General Delivery", #Required
+  :line2 => "Suite 100",        #Optional
+  :line3 => "Attn: Accounts Payable", #Optional
+  :city =>"Seattle",            #Required, if PostalCode is not specified
+  :region=>"WA",                #Required, if PostalCode is not specified
+  :postalcode =>"98101",        #Required, if City and Region are not specified
+  :country => "US"              #Optional
+}
+#Call the service
+result = svc.validate(input)
+#Display the result
+#print result
+
+#If we encountered an error
+if result[:result_code] != "Success"
+  #puts the first error message returned
+  puts "Address Validation ResultCode: "+result[:result_code]
+  puts result[:details]
+else
+  puts "Validated Address: "
+  result[:valid_addresses][:valid_address].each do |key, value|
+    puts key.to_s + ": " + value.to_s if not value.nil?
+  end
+  
+end

data/samples/credentials.yml

@@ -0,0 +1,5 @@
+username: username
+password: password
+clientname: AvaTaxCalcSOAP Ruby Sample
+production: false
+companycode: APITrialCompany

data/spec/addressservice_spec.rb

@@ -0,0 +1,42 @@
+require "spec_helper"
+
+describe "AddressService" 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']}
+  end
+
+  describe "does not allow instantiation with" do
+    it "no values" do
+      lambda { AvaTax::AddressService.new }.should raise_exception
+    end
+    it "optional values only" do
+      lambda { AvaTax::AddressService.new(
+      :clientname => @creds[:clientname],
+      :adapter => "AvaTaxCalcRuby",
+      :machine => "MyComputer",
+      :use_production_account => @creds[:use_production_url] ) }.should raise_exception
+    end
+  end
+  describe "allows instantiation with" do
+    it "required values only" do
+      lambda { AvaTax::AddressService.new(
+      :username => @creds[:username], 
+      :password => @creds[:password],  
+      :clientname => @creds[:clientname]) }.should_not raise_exception
+    end
+    it "required and optional values" do
+      lambda { AvaTax::AddressService.new(
+      :username => @creds[:username], 
+      :password => @creds[:password],  
+      :clientname => @creds[:clientname],
+      :adapter => "AvaTaxCalcRuby",
+      :machine => "MyComputer",
+      :use_production_account => false ) }.should_not raise_exception
+    end
+  end
+
+end

data/spec/isauthorized_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe "IsAuthorized" 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']}
+  end
+  
+  describe "returns a meaningful" do
+    it "error when URL is missing" do
+      @creds[:use_production_url] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.isauthorized[:result_code].should eql "Success"
+    end
+    it "success when URL is specified" do
+      @creds[:use_production_url] = false
+      @service = AvaTax::AddressService.new(@creds)
+      @service.isauthorized[:result_code].should eql "Success"
+    end
+    it "error when username is missing" do
+      @creds[:username] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.isauthorized[:result_code].should eql "Error"
+    end
+    it "error when password is omitted" do
+      @creds[:password] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.isauthorized[:result_code].should eql "Error"
+    end
+    it "success when clientname is omitted" do
+      @creds[:clientname] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.isauthorized[:result_code].should eql "Success"
+    end     
+  end
+  
+  describe "has consistent formatting for" do
+    it "internal logic errors" do
+      @service = AvaTax::AddressService.new(@creds)
+      lambda { @service.isauthorized("param1","param2") }.should raise_exception
+    end
+    it "server-side errors" do
+      @creds[:password] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @result = @service.isauthorized
+      @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::AddressService.new(@creds)
+      @result = @service.isauthorized
+      @result[:result_code].should eql "Success" and @result[:expires].should_not be_nil
+    end
+  end  
+  describe "requests with" do
+    it "missing required parameters fail" do
+      true #there are no required parameters for isauthorized
+    end
+    it "invalid parameters fail" do
+      @service = AvaTax::AddressService.new(@creds)
+      lambda { @service.isauthorized("param1","param2") }.should raise_exception
+    end
+    it "missing optional parameters succeed" do
+      @service = AvaTax::AddressService.new(@creds)
+      @service.isauthorized[:result_code].should eql "Success"
+    end
+    it "all parameters succeed" do
+      @service = AvaTax::AddressService.new(@creds)
+      @service.isauthorized("Message")[:result_code].should eql "Success"
+    end
+  end
+  
+end

data/spec/ping_spec.rb

@@ -0,0 +1,75 @@
+require "spec_helper"
+
+describe "Ping" 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']}
+  end
+  
+  describe "returns a meaningful" do
+    it "error when URL is missing" do
+      @creds[:use_production_url] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.ping[:result_code].should eql "Success"
+    end
+    it "success when URL is specified" do
+      @creds[:use_production_url] = false
+      @service = AvaTax::AddressService.new(@creds)
+      @service.ping[:result_code].should eql "Success"
+    end
+    it "error when username is missing" do
+      @creds[:username] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.ping[:result_code].should eql "Error"
+    end
+    it "error when password is omitted" do
+      @creds[:password] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.ping[:result_code].should eql "Error"
+    end
+    it "success when clientname is omitted" do
+      @creds[:clientname] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.ping[:result_code].should eql "Success"
+    end     
+  end
+  
+  describe "has consistent formatting for" do
+    it "internal logic errors" do
+      @service = AvaTax::AddressService.new(@creds)
+      lambda { @service.ping("param1","param2") }.should raise_exception
+    end
+    it "server-side errors" do
+      @creds[:password] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @result = @service.ping
+      @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::AddressService.new(@creds)
+      @result = @service.ping
+      @result[:result_code].should eql "Success" and @result[:version].should_not be_nil
+    end
+  end  
+  describe "requests with" do
+    it "missing required parameters fail" do
+      true #there are no required parameters for ping
+    end
+    it "invalid parameters fail" do
+      @service = AvaTax::AddressService.new(@creds)
+      lambda { @service.ping("param1","param2") }.should raise_exception
+    end
+    it "missing optional parameters succeed" do
+      @service = AvaTax::AddressService.new(@creds)
+      @service.ping[:result_code].should eql "Success"
+    end
+    it "all parameters succeed" do
+      @service = AvaTax::AddressService.new(@creds)
+      @service.ping("Message")[:result_code].should eql "Success"
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# spec/awesome_gem/awesome.rb
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+$: << File.join(APP_ROOT, 'lib') # so rspec knows where your file could be
+require 'avatax_addressservice.rb' # this loads the class you want to test
+require 'yaml'
+
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end

data/spec/validate_spec.rb

@@ -0,0 +1,83 @@
+require "spec_helper"
+
+describe "Validate" do
+  before :each do
+    @address_req = {:line1 => "100 Ravine Lane NE", :postalcode => "98110"}
+    @address_opt = {    
+      :addresscode => "02",
+      :line2 => "Attn: Avalara",
+      :line3 => "Suite 200",
+      :city => "Bainbridge Island",
+      :region => "WA",
+      :country => "US",
+      :taxregionid => "234",
+      :latitude => "47.624935",
+      :longitude => "-122.515068",
+      :textcase => "Upper",
+      :coordinates => "true",
+      :taxability => "true"}
+      credentials = YAML::load(File.open('credentials.yml'))
+      @creds = {:username => credentials['username'], 
+            :password => credentials['password'],  
+            :clientname => credentials['clientname'],
+            :use_production_url => credentials['production']}
+    @svc = AvaTax::AddressService.new(@creds)      
+  end
+  
+  describe "returns a meaningful" do
+    it "error when URL is missing" do
+      @creds[:use_production_url] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.validate(@address_req)[:result_code].should eql "Success"
+    end
+    it "success when URL is specified" do
+      @creds[:use_production_url] = false
+      @service = AvaTax::AddressService.new(@creds)
+      @service.validate(@address_req)[:result_code].should eql "Success"
+    end
+    it "error when username is missing" do
+      @creds[:username] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.validate(@address_req)[:result_code].should eql "Error"
+    end
+    it "error when password is omitted" do
+      @creds[:password] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.validate(@address_req)[:result_code].should eql "Error"
+    end
+    it "success when clientname is omitted" do
+      @creds[:clientname] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @service.validate(@address_req)[:result_code].should eql "Success"
+    end   
+  end
+  
+  describe "has consistent formatting for" do
+    it "internal logic errors" do
+      lambda { @svc.validate(@address_req, @address_req) }.should raise_exception
+    end
+    it "server-side errors" do
+      @creds[:password] = nil
+      @service = AvaTax::AddressService.new(@creds)
+      @result = @service.validate(@address_req)
+      @result[:result_code].should eql "Error" and @result[:details].should eql "The user or account could not be authenticated."
+    end
+    it "successful results" do
+      @result = @svc.validate(@address_req)
+      @result[:result_code].should eql "Success" and @result[:valid_addresses].should_not be_nil
+    end
+  end  
+  describe "requests with" do
+    it "missing required parameters fail" do
+      @address_req[:line1] = nil
+      @svc.validate(@address_req)[:result_code].should eql "Error"
+    end
+    it "missing optional parameters succeed" do
+      @svc.validate(@address_req)[:result_code].should eql "Success"
+    end
+    it "all parameters succeed" do
+      @address_full = @address_req.merge(@address_opt)
+      @svc.validate(@address_full)[:result_code].should eql "Success"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Avatax_AddressService
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Graham S Wilson
@@ -37,6 +37,14 @@ files:
 - lib/template_validate.erb
 - lib/template_ping.erb
 - lib/template_isauthorized.erb
+- samples/credentials.yml
+- samples/Ping.rb
+- samples/Validate.rb
+- spec/addressservice_spec.rb
+- spec/isauthorized_spec.rb
+- spec/ping_spec.rb
+- spec/spec_helper.rb
+- spec/validate_spec.rb
 - Avatax_AddressService.gemspec
 - Avatax Ruby SDK Guide.docx
 - LICENSE.txt