TaxCloud 1.0.0 → 1.0.1

data/lib/response/verify_address_result.rb

@@ -0,0 +1,21 @@
+module TaxCloud
+
+  class VerifyAddressResult
+
+    attr_accessor :address1, :address2, :city, :state, :zip5, :zip4, :err_number
+
+    def initialize(attrs = {})
+       attrs.each do |sym, val|
+        self.send "#{sym}=", val
+      end
+    end
+
+    def get_address
+      address = TaxCloud::Address.new(:address1 => @address1, :address2 => @address2, :city => @city, :state => @state, :zip5 => @zip5, :zip4 => @zip4)
+    end
+
+
+  end
+
+end
+

data/lib/service/authorized_service.rb

@@ -0,0 +1,40 @@
+module TaxCloud
+  require "service/base_service"
+  require "response/authorized_response"
+  require "response/authorized_with_capture_response"
+  require "response/captured_response"
+
+  class AuthorizedService < BaseService
+
+    def authorized_with_capture(api_id, api_key, customer_id, cart_id, order_id, date_authorized, date_captured)
+      response = client.request :authorized_with_capture do
+        soap.body = {:apiLoginID => api_id, :apiKey => api_key,
+                     'customerID' => customer_id, 'cartID' => cart_id, 'orderID' => order_id, 'dateAuthorized' => date_authorized, 'dateCaptured' => date_captured}
+
+      end
+
+      authorized_with_capture_rsp = TaxCloud::AuthorizedWithCaptureResponse.new(response.to_hash[:authorized_with_capture_response][:authorized_with_capture_result])
+    end
+
+    def authorized(api_id, api_key, customer_id, cart_id, order_id, date_authorized)
+      response = client.request :authorized do
+        soap.body = {:apiLoginID => api_id, :apiKey => api_key,
+                     'customerID' => customer_id, 'cartID' => cart_id, 'orderID' => order_id, 'dateAuthorized' => date_authorized}
+
+      end
+
+      authorized_response = TaxCloud::AuthorizedResponse.new(response.to_hash[:authorized_response][:authorized_result])
+
+    end
+
+    def captured(api_id, api_key, order_id)
+      response = client.request :captured do
+        soap.body = {:apiLoginID => api_id, :apiKey => api_key, 'orderID' => order_id}
+      end
+
+      captured_response = TaxCloud::CapturedResponse.new(response.to_hash[:captured_response][:captured_result])
+    end
+
+  end
+
+end

data/lib/service/base_service.rb

@@ -0,0 +1,13 @@
+module TaxCloud
+
+  class BaseService
+
+    attr_accessor :client
+
+    def initialize(client)
+      self.client = client
+    end
+
+  end
+
+end

data/lib/service/lookup_service.rb

@@ -0,0 +1,20 @@
+module TaxCloud
+  require "service/base_service"
+  require "response/lookup_response"
+
+  class LookupService < BaseService
+
+    def lookup(api_id, api_key, customer_id, cart_id, origin, destination, cart_items)
+
+      response = client.request :lookup do
+        soap.body = {:apiLoginID => api_id, :apiKey => api_key,
+                     'customerID' => customer_id, 'cartID' => cart_id, 'cartItems' => {'CartItem' => cart_items.map(&:to_hash)}, 'origin' => origin.to_hash, 'destination' => destination.to_hash}
+      end
+
+      lookupResponse = TaxCloud::LookupResponse.new(response.to_hash[:lookup_response][:lookup_result])
+
+    end
+
+  end
+
+end

data/lib/service/returned_service.rb

@@ -0,0 +1,19 @@
+module TaxCloud
+
+  require 'response/returned_response'
+
+  # If you have previously completed an order you can return one or more of the items in the order
+  class ReturnedService < BaseService
+
+    def returned(api_id, api_key, order_id, cart_items, returned_date)
+      response = client.request :returned do
+        soap.body = {:apiLoginID => api_id, :apiKey => api_key,
+                     'orderID' => order_id, 'cartItems' => {'CartItem' => cart_items.map(&:to_hash)}, 'returnedDate' => returned_date}
+      end
+
+      returned_response = TaxCloud::ReturnedResponse.new(response.to_hash[:returned_response][:returned_result])
+    end
+
+  end
+
+end

data/lib/service/tic_service.rb

@@ -0,0 +1,26 @@
+module TaxCloud
+  require "service/base_service"
+  require 'response/get_ti_cs_response'
+
+  class TICService < BaseService
+
+    def get_tics(api_id, api_key)
+
+      response = client.request :get_ti_cs do
+        soap.body = {:apiLoginID => api_id, :apiKey => api_key}
+      end
+
+      get_tics_response = TaxCloud::GetTICsResponse.new(response.to_hash[:get_ti_cs_response][:get_ti_cs_result])
+    end
+
+    def get_tic_groups(api_id, api_key)
+      #get_tic_groups
+    end
+
+    def get_tics_by_group(api_id, api_key, group_id)
+      #get_ti_cs_by_group
+    end
+
+  end
+
+end

data/lib/service/verify_address_service.rb

@@ -0,0 +1,26 @@
+module TaxCloud
+
+  require "service/base_service"
+
+  class VerifyAddressService < BaseService
+
+    def verify_address(api_id, api_key, usps_id, address)
+      request_params = {
+          'apiLoginId' => api_id,
+          'apiKey' => api_key,
+          'uspsUserID' => usps_id,
+          'address1' => address.address1,
+          'address2' => address.address2,
+          'city' => address.city,
+          'state' => address.state,
+          'zip5' => address.zip5,
+          'zip4' => address.zip4
+      }
+      response = client.request :verify_address, :body => request_params
+
+      verifyAddressResult = TaxCloud::VerifyAddressResult.new(response.to_hash[:verify_address_response][:verify_address_result])
+    end
+
+  end
+
+end

data/lib/tic.rb

@@ -0,0 +1,14 @@
+module TaxCloud
+  class TIC
+    attr_accessor :tic, :tic_id, :description
+
+    def initialize(tic)
+      puts 'initialize: ' + tic.to_s
+      self.tic = tic
+      self.tic_id = tic['ticid']
+      self.description = tic['description']
+    end
+
+
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,38 @@
+module Helper
+
+  def variable_init
+      @client = Savon::Client.new do
+        wsdl.document = "https://api.taxcloud.net/1.0/TaxCloud.asmx?wsdl"
+      end
+      cart_item = TaxCloud::CartItem.new(:index => 0, :item_id => 0, :tic => '00000', :price => '19.99', :quantity => 1)
+      cart_item1 = TaxCloud::CartItem.new(:index => 1, :item_id => 1, :tic => '20010', :price => '9.99', :quantity => 1)
+
+      # Add a cart item for shipping charges, if applicable
+      cart_item2 = TaxCloud::CartItem.new(:index => 2, :item_id => 99999, :tic => '11010', :price => '19.99', :quantity => 1)
+
+      @cart_items = Array.new
+      @cart_items << cart_item
+      @cart_items << cart_item1
+      @cart_items << cart_item2
+
+      @origin = TaxCloud::Address.new(:address1 => '162 East Avenue', :address2 => 'Third Floor', :city => 'Norwalk', :state => 'CT', :zip5 => '06851')
+
+      #origin = verify_address(client, origin)
+
+      @destination = TaxCloud::Address.new(:address1 => '3121 West Government Way', :address2 => 'Suite 2B', :city => 'Seattle', :state => 'WA', :zip5 => '98199')
+
+      #destination = verify_address(client, destination)
+      @customer_id = 1
+      @cart_id = nil
+      @order_id = 1
+
+      # You will have to populate these values from your TaxCloud merchant account
+      @api_id = ""
+      @api_key = ""
+      @usps_id = ""
+
+      @date_authorized = Date.today
+      @date_captured = Date.today
+      @returned_date = Date.today
+  end
+end

data/spec/service/authorized_service_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper.rb'
+require 'helper.rb'
+require "service/authorized_service"
+require "service/lookup_service"
+
+
+RSpec.configure do |c|
+  c.include Helper
+end
+
+describe "complete transaction by calling AuthorizeAndCapture" do
+
+  before (:all) do
+    variable_init
+  end
+
+
+  it "should complete the transaction using authorized_with_capture" do
+
+    # We need to to a lookup first to create the start of the transaction
+    lookup_service = TaxCloud::LookupService.new(@client)
+    lookup_response = lookup_service.lookup(@api_id, @api_key, @customer_id, @cart_id, @origin, @destination, @cart_items)
+
+    # Here we are letting the service create a cart ID for us
+    @cart_id = lookup_response.cart_id
+
+    # And now for the actual test
+
+    authorized_service = TaxCloud::AuthorizedService.new(@client)
+
+    authorized_response = authorized_service.authorized_with_capture(@api_id, @api_key, @customer_id, @cart_id, @order_id, @date_authorized, @date_captured)
+
+    puts 'authorizedRsp: ' + authorized_response.response_type.to_s
+
+    response_type = authorized_response.response_type
+
+    response_type.should eql 'OK'
+
+
+  end
+
+  it "should complete the transaction using separate authorized and capture calls" do
+    # We need to to a lookup first to create the start of the transaction
+    lookup_service = TaxCloud::LookupService.new(@client)
+    lookup_response = lookup_service.lookup(@api_id, @api_key, @customer_id, @cart_id, @origin, @destination, @cart_items)
+
+    # Here we are letting the service create a cart ID for us
+    @cart_id = lookup_response.cart_id
+
+    # And now for the actual test
+
+    authorized_service = TaxCloud::AuthorizedService.new(@client)
+
+    authorized_response = authorized_service.authorized(@api_id, @api_key, @customer_id, @cart_id, @order_id, @date_authorized)
+
+    puts 'response type: ' + authorized_response.response_type.to_s
+    authorized_response.response_type.should eql 'OK'
+
+    # Now capture the transaction
+    captured_response = authorized_service.captured(@api_id, @api_key, @order_id)
+
+    captured_response.response_type.should eql 'OK'
+
+
+  end
+end

data/spec/service/lookup_service_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper.rb'
+require 'helper.rb'
+
+require "service/lookup_service"
+
+RSpec.configure do |c|
+  c.include Helper
+end
+
+describe "Perform Lookup" do
+
+  before(:all) do
+    variable_init
+  end
+
+  it "should not allow unauthorized access" do
+    api_id = "12345"
+    api_key = "67890"
+
+    lookup_service = TaxCloud::LookupService.new(@client)
+
+    lookup_response = lookup_service.lookup(api_id, api_key, @customer_id, @cart_id, @origin, @destination, @cart_items)
+
+    lookup_response.response_type.to_s.should.eql?("Error")
+    lookup_response.messages[:message].should.eql?("Invalid apiLoginID and/or apiKey")
+  end
+
+  it "should return tax amounts" do
+
+    lookup_service = TaxCloud::LookupService.new(@client)
+
+    lookup_response = lookup_service.lookup(@api_id, @api_key, @customer_id, @cart_id, @origin, @destination, @cart_items)
+
+    lookup_response.response_type.to_s.should.eql?("OK")
+
+    # Note, these amounts are just meant to represent a successful transaction.
+    # The amounts may change as the states adjust their rates. In that case you would have to update this test.
+    lookup_response.cart_items_response.get_taxes(0).should eql("1.89905")
+    lookup_response.cart_items_response.get_taxes(1).should eql("0.94905")
+    lookup_response.cart_items_response.get_taxes(2).should eql("1.89905")
+
+  end
+
+
+end

data/spec/service/returned_service_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper.rb'
+require 'helper.rb'
+require 'service/lookup_service'
+require 'service/authorized_service'
+require 'service/returned_service'
+
+RSpec.configure do |c|
+  c.include Helper
+end
+
+describe "Returned Service" do
+
+  before(:all) do
+    variable_init
+  end
+
+  it "should allow an item to be returned" do
+
+    # An order needs to be completed before an item can be returned
+    lookup_service = TaxCloud::LookupService.new(@client)
+    lookup_response = lookup_service.lookup(@api_id, @api_key, @customer_id, @cart_id, @origin, @destination, @cart_items)
+
+    # Here we are letting the service create a cart ID for us
+    @cart_id = lookup_response.cart_id
+
+    authorized_service = TaxCloud::AuthorizedService.new(@client)
+
+    authorized_response = authorized_service.authorized_with_capture(@api_id, @api_key, @customer_id, @cart_id, @order_id, @date_authorized, @date_captured)
+
+    # And now for the actual test
+    returned_service = TaxCloud::ReturnedService.new(@client)
+    returned_response = returned_service.returned(@api_id, @api_key, @order_id, @cart_items, @returned_date)
+    returned_response.response_type.to_s.should eql 'OK'
+
+  end
+end

data/spec/service/tic_serivce_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper.rb'
+require 'helper.rb'
+
+require 'service/tic_service'
+
+RSpec.configure do |c|
+  c.include Helper
+end
+
+describe "TIC Service" do
+
+  before(:all) do
+    variable_init
+  end
+
+  specify "should return a list of TICs" do
+
+    tic_service = TaxCloud::TICService.new(@client)
+
+    get_tics_response = tic_service.get_tics(@api_id, @api_key)
+
+    get_tics_response.response_type.to_s.should eql 'OK'
+
+    get_tics_response.ti_cs.should_not be nil
+
+    puts 'id: ' + get_tics_response.get_tic(0).tic_id.to_s
+  end
+
+  specify "should return a list of TIC groups" do
+
+    tic_service = TaxCloud::TICService.new(@client)
+
+    get_tic_groups_response = tic_service.get_tic_groups(@api_id, @api_key)
+
+
+  end
+
+  specify "should return a list of TICs per group" do
+
+    tic_service = TaxCloud::TICService.new(@client)
+
+    group_id = 1
+    get_tics_by_group_response = tic_service.get_tics_by_group(@api_id, @api_key, group_id)
+
+    # get_tics_by_group_response.to_s.should eql 'OK'
+  end
+end

data/spec/service/verify_address_service_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper.rb'
+require 'helper.rb'
+require 'service/verify_address_service'
+
+RSpec.configure do |c|
+  c.include Helper
+end
+
+describe "Verify Address Service" do
+
+  before(:all) do
+    variable_init
+  end
+
+  specify "should return a verified address" do
+
+    verify_address_service = TaxCloud::VerifyAddressService.new(@client)
+    verify_address_response = verify_address_service.verify_address(@api_id, @api_key, @usps_id, @origin)
+
+    verify_address_response.address1.to_s.should eql '162 EAST AVE'
+    verify_address_response.zip4.to_s.should eql '5715'
+
+  end
+end