google4r-checkout 0.1.0

data/test/unit/area_test.rb

@@ -0,0 +1,44 @@
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+#--
+# Project:   google_checkout4r 
+# File:      test/unit/area_test.rb
+# Author:    Manuel Holtgrewe <purestorm at ggnore dot net>
+# Copyright: (c) 2007 by Manuel Holtgrewe
+# License:   MIT License as follows:
+#
+# 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. 
+#++
+
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+
+# Test for the class Area.
+class Google4R::Checkout::AreaTest < Test::Unit::TestCase
+  include Google4R::Checkout
+  
+  def test_instanciating_area_raises_runtime_error
+    assert_raises(RuntimeError) { Area.new }
+  end
+end

data/test/unit/checkout_command_test.rb

@@ -0,0 +1,116 @@
+#--
+# Project:   google_checkout4r 
+# File:      test/unit/checkout_command_test.rb
+# Author:    Manuel Holtgrewe <purestorm at ggnore dot net>
+# Copyright: (c) 2007 by Manuel Holtgrewe
+# License:   MIT License as follows:
+#
+# 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. 
+#++
+
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+
+# Tests for the CheckoutCommand class.
+class Google4R::Checkout::CheckoutCommandTest < Test::Unit::TestCase
+  include Google4R::Checkout
+
+  def setup
+    @frontend = Frontend.new(FRONTEND_CONFIGURATION)
+    @frontend.tax_table_factory = TestTaxTableFactory.new
+    @command = @frontend.create_checkout_command
+  end
+
+  def test_tax_table_factory_works_correctly
+    TestTaxTableFactory.any_instance.stubs(:effective_tax_tables_at).returns([:tax_table])
+    
+    frontend = Frontend.new(FRONTEND_CONFIGURATION)
+    frontend.tax_table_factory = TestTaxTableFactory.new
+    command = frontend.create_checkout_command
+    
+    assert_equal [:tax_table], command.tax_tables
+  end
+  
+  def test_initialized_correctly
+    assert_equal @frontend, @command.frontend
+    assert_kind_of ShoppingCart, @command.shopping_cart
+    assert_equal [], @command.shipping_methods
+    assert_nil @command.edit_cart_url
+    assert_nil @command.continue_shopping_url
+    assert_nil @command.request_buyer_phone_number
+  end
+  
+  def test_command_behaves_correctly
+    [ :frontend, :shopping_cart, :tax_tables, :shipping_methods, :create_shipping_method,
+      :edit_cart_url, :edit_cart_url=, :continue_shopping_url, :continue_shopping_url=,
+      :request_buyer_phone_number, :request_buyer_phone_number=
+    ].each do |symbol|
+      assert_respond_to @command, symbol
+    end
+  end
+  
+  def test_accessors_work_correctly
+    @command.edit_cart_url = "edit cart url"
+    assert_equal "edit cart url", @command.edit_cart_url
+    
+    @command.continue_shopping_url = "continue shopping url"
+    assert_equal "continue shopping url", @command.continue_shopping_url
+    
+    @command.request_buyer_phone_number = true
+    assert_equal true, @command.request_buyer_phone_number
+  end
+
+  def test_create_shipping_method_works_correctly_with_block
+    [ PickupShipping, FlatRateShipping ].each do |clazz|
+  
+      shipping = nil
+
+      res = 
+        @command.create_shipping_method(clazz) do |obj|
+          shipping = obj
+          assert_kind_of clazz, obj
+        end
+    
+      assert_equal res, shipping
+      assert @command.shipping_methods.include?(shipping)
+    end
+  end
+  
+  def test_create_shipping_method_works_correctly_without_block
+    [ PickupShipping, FlatRateShipping ].each do |clazz|
+      obj = @command.create_shipping_method(clazz)
+    
+      assert_kind_of clazz, obj
+    
+      assert @command.shipping_methods.include?(obj)
+    end
+  end
+  
+  def test_create_shipping_method_raises_exception_on_invalid_clazz_parameter
+    assert_raises(ArgumentError) { @command.create_shipping_method(String) }
+  end
+  
+  def test_to_xml_does_not_raise_exception
+    assert_nothing_raised { @command.to_xml }
+  end
+end

data/test/unit/checkout_command_xml_generator_test.rb

@@ -0,0 +1,203 @@
+#--
+# Project:   google_checkout4r 
+# File:      test/unit/checkout_command_xml_generator_test.rb
+# Author:    Manuel Holtgrewe <purestorm at ggnore dot net>
+# Copyright: (c) 2007 by Manuel Holtgrewe
+# License:   MIT License as follows:
+#
+# 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. 
+#++
+
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+
+require 'tempfile'
+require 'open3'
+require 'rexml/document'
+
+# Test for the class UsZipArea.
+#
+# TODO: Make the tests querying Google Checkout's diagnose service and the XSD validation optional.
+class Google4R::Checkout::CheckoutCommandXmlGeneratorTest < Test::Unit::TestCase
+  include Google4R::Checkout
+  
+  def setup
+    @schema_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'xml', 'apiv2.xsd'))
+    @expected_path = File.expand_path(File.join(File.dirname(__FILE__), '..', 'xml', 'test_check_persisting_works_expected.xml'))
+    
+    @frontend = Frontend.new(FRONTEND_CONFIGURATION)
+    @frontend.tax_table_factory = TestTaxTableFactory.new
+    @command = @frontend.create_checkout_command
+    @generator = CheckoutCommandXmlGenerator.new(@command)
+  end
+  
+  # Note that this is not really a good test. We do not actually compare anything.
+  # Instead, we simply generate some XML, validate it using XSD via xmllint and then
+  # compare it to the output that we validated by reading it earlier.
+  def test_check_persisting_works
+    tax_tables = Array.new
+    table = TaxTable.new(false)
+    table.name = 'Default Table'
+    table.create_rule do |rule|
+      rule.rate = 0.04
+      rule.area = UsCountryArea.new
+      rule.area.area = UsCountryArea::ALL
+    end
+    table.create_rule do |rule|
+      rule.area=Google4R::Checkout::PostalArea.new('GB', 'S6*')
+      rule.shipping_taxed=true
+      rule.rate=0.03
+    end
+    table.create_rule do |rule|
+      rule.area=Google4R::Checkout::WorldArea.new
+      rule.shipping_taxed=true
+      rule.rate=0.10
+    end
+    tax_tables << table
+    nondefault_table = TaxTable.new(false)
+    nondefault_table.name = 'Special Table'
+    nondefault_table.create_rule do |rule|
+      rule.rate = 0.02
+      rule.area = UsCountryArea.new
+      rule.area.area = UsCountryArea::ALL
+    end
+    tax_tables << nondefault_table
+    
+    TestTaxTableFactory.any_instance.stubs(:effective_tax_tables_at).returns(tax_tables)
+    @frontend.tax_table_factory = TestTaxTableFactory.new
+    @command = @frontend.create_checkout_command
+    
+    @command.continue_shopping_url = 'http://wwww.example.com/continue_shopping'
+    @command.edit_cart_url = 'http://wwww.example.com/edit_cart'
+    @command.request_buyer_phone_number = false
+    @generator = CheckoutCommandXmlGenerator.new(@command)
+    
+    @command.shopping_cart.expires_at = Time.parse('2007-11-29T15:33:20 UTC')
+    
+    @command.create_shipping_method(PickupShipping) do |shipping|
+      shipping.name = 'Pickup Test Shipping'
+      shipping.price = Money.new(100, 'USD')
+    end
+    
+    @command.create_shipping_method(FlatRateShipping) do |shipping|
+      shipping.name = 'State Test Shipping'
+      shipping.price = Money.new(100, 'USD')
+      
+      shipping.create_allowed_area(UsStateArea)  { |area| area.state = 'CA' }
+      shipping.create_excluded_area(UsStateArea) { |area| area.state = 'TX' }
+    end
+    
+    @command.create_shipping_method(FlatRateShipping) do |shipping|
+      shipping.name = 'Country Area Test Shipping'
+      shipping.price = Money.new(100, 'USD')
+
+      shipping.create_allowed_area(UsCountryArea)  { |area| area.area = UsCountryArea::FULL_50_STATES }
+      shipping.create_excluded_area(UsCountryArea) { |area| area.area = UsCountryArea::CONTINENTAL_48 }
+    end
+    
+    @command.create_shipping_method(FlatRateShipping) do |shipping|
+      shipping.name = 'Zip Test Shipping'
+      shipping.price = Money.new(100, 'USD')
+
+      shipping.create_allowed_area(UsZipArea)  { |area| area.pattern = '1*' }
+      shipping.create_excluded_area(UsZipArea) { |area| area.pattern = '12*' }
+    end
+    
+    @command.shopping_cart.private_data = { 'we' => 'can pass in some data here'.split }
+    
+    1.upto(10) do |i|
+      @command.shopping_cart.create_item do |item|
+        item.name = "Item Name #{i}"
+        item.description = "Description #{i}"
+        item.unit_price = Money.new(i * 1000, 'USD')
+        item.quantity = i * 2
+        item.id = "Merchant ID #{i}"
+        if i == 1 then
+          item.private_data = { 'some' => { 'data' => 'Yeah, Yeah!' }, 'bars' => { 'bar' => [ 1, 2 ] } }
+        end
+        
+        item.tax_table = nondefault_table if i % 2 == 1
+      end
+    end
+    
+    xml_str = @generator.generate
+    assert_xml_validates_against_xml_schema(@schema_path, xml_str)
+    assert_string_equals_file_contents(@expected_path, xml_str)
+    assert_google_checkout_diagnose_returns_no_warnings(xml_str)
+  end
+  
+  # Test that values within hashes are persisted correctly.
+  def test_process_hash_processes_hash_values_correctly
+    element = REXML::Element.new('root')
+    @generator.instance_eval { process_hash(element, { 'key' => 'value' }) }
+    assert_equal "<root><key>value</key></root>", element.to_s
+  end
+  
+  protected
+    
+    def assert_google_checkout_diagnose_returns_no_warnings(xml_str)
+      tmpfile = Tempfile.new('xml_output')
+      tmpfile << xml_str
+      tmpfile.flush
+
+      url = "https://%s:%s@sandbox.google.com/checkout/cws/v2/Merchant/%s/request/diagnose" %
+        [ FRONTEND_CONFIGURATION[:merchant_id], FRONTEND_CONFIGURATION[:merchant_key], 
+          FRONTEND_CONFIGURATION[:merchant_id] ]
+
+      stdin, stdout, stderr = Open3.popen3("curl", "-d", "@#{tmpfile.path}", url)
+      outstr = stdout.read
+      errstr = stderr.read
+      
+      assert (outstr != ''), 'curl command not available'
+      
+      # Check that there is no <warnings> tag in the XML.
+      xml_document = REXML::Document.new(outstr)
+      assert 0, xml_document.root.elements.to_a('//warnings').size
+      
+      tmpfile.close!
+    end
+  
+    def assert_xml_validates_against_xml_schema(schema_path, xml_str)
+      tmpfile = Tempfile.new('xml_output')
+      tmpfile << xml_str
+      tmpfile.flush
+      
+      #puts "---\n#{xml_str}\n---"
+      
+      stdin, stdout, stderr = Open3.popen3("xmllint", "--schema", schema_path, tmpfile.path)
+      outstr = stdout.read
+      errstr = stderr.read
+      if errstr !~ /validates$/ then
+        assert false, "The document did not validate: ---\nOUT:#{outstr}\nERR:#{errstr}\n---"
+      else
+        assert true
+      end
+      
+      tmpfile.close!
+    end
+    
+    def assert_string_equals_file_contents(expected_path, xml_str)
+      file_contents = File.open(expected_path, 'r') { |f| f.read }
+      assert_strings_equal file_contents, xml_str
+    end
+end

data/test/unit/command_test.rb

@@ -0,0 +1,115 @@
+#--
+# Project:   google_checkout4r 
+# File:      test/unit/command_test.rb
+# Author:    Manuel Holtgrewe <purestorm at ggnore dot net>
+# Copyright: (c) 2007 by Manuel Holtgrewe
+# License:   MIT License as follows:
+#
+# 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. 
+#++
+
+require File.expand_path(File.dirname(__FILE__)) + '/../test_helper'
+
+require 'google4r/checkout'
+
+require 'test/frontend_configuration'
+
+require 'net/http'
+
+require 'base64'
+
+class TestCommand < Google4R::Checkout::Command
+  XML_REPRESENTATION = "<?xml version='1.0' ?><root />" 
+  
+  def to_xml
+    XML_REPRESENTATION
+  end
+end
+
+# Test for the class Command.
+class Google4R::Checkout::CommandTest < Test::Unit::TestCase
+  include Google4R::Checkout
+  
+  def setup
+    @frontend = Frontend.new(FRONTEND_CONFIGURATION)
+    @frontend.tax_table_factory = TestTaxTableFactory.new
+    @command = TestCommand.new(@frontend)
+  end
+  
+  def test_sending_fails_if_certificate_validation_fails
+    OpenSSL::SSL::SSLSocket.any_instance.stubs(:connect).raises(OpenSSL::SSL::SSLError, 'certificate verify failed')
+    
+    assert_raises(OpenSSL::SSL::SSLError) { @command.send_to_google_checkout }
+  end
+  
+  def test_to_xml_raises_not_implemented_error
+    assert_raises(NotImplementedError) { Command.new(Frontend.new(FRONTEND_CONFIGURATION)).to_xml }
+  end
+  
+  def test_unknown_xml_response_in_body_raises_runtime_error
+    mock_body = '<?xml version="1.0" ?><unexpected-tag />'
+    
+    success_response = Net::HTTPSuccess.new(Net::HTTP.version_1_2, 200, "OK")
+    success_response.expects(:body).returns(mock_body)
+    
+    Net::HTTP.any_instance.stubs(:request).returns(success_response)
+    
+    assert_raises(RuntimeError) { @command.send_to_google_checkout }
+  end
+  
+  def test_invalid_response_code_raises_runtime_error
+    unknown_response = mock()
+    unknown_response.expects(:code)
+    unknown_response.expects(:message)
+    
+    Net::HTTP.any_instance.stubs(:request).returns(unknown_response)
+    
+    assert_raises(RuntimeError) { @command.send_to_google_checkout }
+  end
+  
+  def test_error_tag_in_response_code_raises_google_checkout_error
+    mock_body = '<?xml version="1.0" encoding="UTF-8"?><error xmlns="http://checkout.google.com/schema/2" serial-number="foo-bar"><error-message>Malformed URL component: expected id: (\d{10})|(\d{15}), but got something-different</error-message></error>'
+    
+    error_response = Net::HTTPClientError.new(Net::HTTP.version_1_2, 400, "Bad Request")
+    error_response.expects(:body).returns(mock_body)
+    
+    Net::HTTP.any_instance.stubs(:request).returns(error_response)
+    
+    assert_raises(GoogleCheckoutError) { @command.send_to_google_checkout }
+  end
+  
+  def test_send_to_google_checkout_works_correctly_if_200_is_returned
+    mock_body = '<?xml version="1.0" encoding="UTF-8"?><checkout-redirect xmlns="http://checkout.google.com/schema/2" serial-number="foo-bar"><redirect-url>https://sandbox.google.com/checkout/view/buy?o=shoppingcart&amp;shoppingcart=foo-bar</redirect-url></checkout-redirect>'
+    
+    success_response = Net::HTTPSuccess.new(Net::HTTP.version_1_2, 200, "OK")
+    success_response.expects(:body).returns(mock_body)
+    
+    Net::HTTP.any_instance.stubs(:request).returns(success_response)
+
+    Net::HTTP::Post.any_instance.expects(:basic_auth).with(FRONTEND_CONFIGURATION[:merchant_id], 
+      FRONTEND_CONFIGURATION[:merchant_key])
+    
+    result = @command.send_to_google_checkout
+    
+    assert_kind_of CheckoutRedirectResponse, result
+    assert_equal 'foo-bar', result.serial_number
+    assert_equal 'https://sandbox.google.com/checkout/view/buy?o=shoppingcart&shoppingcart=foo-bar', result.redirect_url
+  end
+end