global_collect 0.1.0

data/spec/global_collect_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'the GC module' do
+  before(:each) do
+    GlobalCollect.instance_variable_set(:@wire_logger, nil)
+  end
+  after(:each) do
+    GlobalCollect.instance_variable_set(:@wire_logger, nil)
+  end
+  
+  it "should default to version 1.0" do
+    GlobalCollect.default_api_version.should == "1.0"
+  end
+  it "should error on an invalid environment" do
+    GlobalCollect.environment = :foo
+    lambda { GlobalCollect.merchant_link_client }.should raise_error(ArgumentError)
+  end
+  it "should error on an invalid auth scheme" do
+    GlobalCollect.authentication_scheme = :foo
+    lambda { GlobalCollect.merchant_link_client }.should raise_error(ArgumentError)
+  end
+  it "should return a merchant link client" do
+    GlobalCollect.authentication_scheme = :ip_check
+    GlobalCollect.environment = :test
+    GlobalCollect.merchant_link_client.should_not be_nil
+  end
+  it "should write to a log file, if provided" do
+    begin
+      GlobalCollect.wire_log_file = File.join(File.dirname(__FILE__), "support", "test_log.log")
+      GlobalCollect.wire_logger.debug("foo")
+      log = File.open(GlobalCollect.wire_log_file, "r").read.strip.should include('foo')
+    ensure
+      FileUtils.rm_f(GlobalCollect.wire_log_file)
+    end
+  end
+  
+  it "should write to your logger if provided" do
+    logger = mock(:logger)
+    logger.should_receive(:debug).with("foo")
+    GlobalCollect.wire_logger = logger
+    GlobalCollect.wire_logger.debug("foo")
+  end
+end

data/spec/request_models/base_spec.rb

@@ -0,0 +1,31 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+class TestRequestModel < GlobalCollect::RequestModels::Base
+  def fields; {"PLACEHOLDER" => ["AN12", "R"]}; end
+end
+
+describe "the base model" do
+  it "should validate cleanly on good attributes" do
+    base = TestRequestModel.new("PLACEHOLDER" => "FOOBAR")
+    base.validate.should be_true
+  end
+  
+  it "should not validate on empty attributes" do
+    base = TestRequestModel.new({})
+    base.validate.should be_false
+  end
+  
+  it "should not validate on bad attributes" do
+    base = TestRequestModel.new("PLACEHOLDER" => "FOOBARFOOBARFOOBAR")
+    base.validate.should be_false
+  end
+  
+  it "should not allow a bad key to be set" do
+    base = TestRequestModel.new("PLACEHOLDER" => "FOOBAR")
+    lambda { base["FOO"] = "BAR" }.should raise_error(ArgumentError)
+  end
+  
+  it "should not allow a bad key to be read" do
+    base = TestRequestModel.new("PLACEHOLDER" => "FOOBAR")
+    lambda { base["FOO"] }.should raise_error(ArgumentError)
+  end
+end

data/spec/request_models/insert_order_with_payment/credit_card_online_payment_spec.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the credit card online payment model" do
+  it "should return the proper suggested mixins" do
+    model = GlobalCollect::RequestModels::InsertOrderWithPayment::CreditCardOnlinePayment.new({})
+    model.suggested_response_mixins.should == [
+      GlobalCollect::Responses::SuccessRow,
+      GlobalCollect::Responses::InsertOrderWithPayment::CreditCardOnlinePaymentResponseMethods
+    ]
+  end
+end

data/spec/request_models/insert_order_with_payment/hosted_credit_card_online_payment_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the hosted credit card online payment model" do
+  it "should set HOSTEDINDICATOR to '1' when not provided" do
+    model = GlobalCollect::RequestModels::InsertOrderWithPayment::HostedCreditCardOnlinePayment.new(
+      "PAYMENTPRODUCTID" => "1",
+      "AMOUNT"           => "1",
+      "CURRENCYCODE"     => "USD",
+      "LANGUAGECODE"     => "en",
+      "COUNTRYCODE"      => "US"
+    )
+    model["HOSTEDINDICATOR"].should == "1"
+  end
+  
+  it "should set HOSTEDINDICATOR to '1' when it is set to something invalid" do
+    model = GlobalCollect::RequestModels::InsertOrderWithPayment::HostedCreditCardOnlinePayment.new(
+      "PAYMENTPRODUCTID" => "1",
+      "AMOUNT"           => "1",
+      "CURRENCYCODE"     => "USD",
+      "LANGUAGECODE"     => "en",
+      "COUNTRYCODE"      => "US",
+      "HOSTEDINDICATOR"  => "2123123213"
+    )
+    model["HOSTEDINDICATOR"].should == "1"
+  end
+  
+  it "should set HOSTEDINDICATOR to '1' when it is set to the wrong thing" do
+    model = GlobalCollect::RequestModels::InsertOrderWithPayment::HostedCreditCardOnlinePayment.new(
+      "PAYMENTPRODUCTID" => "1",
+      "AMOUNT"           => "1",
+      "CURRENCYCODE"     => "USD",
+      "LANGUAGECODE"     => "en",
+      "COUNTRYCODE"      => "US",
+      "HOSTEDINDICATOR"  => "0"
+    )
+    model["HOSTEDINDICATOR"].should == "1"
+  end
+end

data/spec/requests/base_spec.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "the base request" do
+  before(:all) do
+    GlobalCollect.merchant_id = 666
+    GlobalCollect.authentication_scheme = :ip_check
+    GlobalCollect.ip_address = '0.0.0.0'
+    GlobalCollect::default_api_version = "2.0"
+  end
+  
+  it "should have the correct wrapping xml elements" do
+    request = GlobalCollect::Requests::Base.new("FOO_ACTION")
+    xml = request.to_xml do |params_node|
+    end
+    xml.should have_xpath("/XML/REQUEST")
+  end
+  
+  it "should render the action" do
+    request = GlobalCollect::Requests::Base.new("FOO_ACTION")
+    xml = request.to_xml do |params_node|; end
+    xml.should match_xpath("/XML/REQUEST/ACTION", "FOO_ACTION")
+  end
+  
+  it "should render contents" do
+    request = GlobalCollect::Requests::Base.new("FOO_ACTION")
+    xml = request.to_xml do |params_node|
+      params_node.tag!("FOO_NODE")
+    end
+    xml.should have_xpath("/XML/REQUEST/PARAMS/FOO_NODE")
+  end
+  
+  it "should have the correct meta fields" do
+    request = GlobalCollect::Requests::Base.new("FOO_ACTION")
+
+    xml = request.to_xml do |params_node|; end
+    xml.should match_xpath("/XML/REQUEST/META/IPADDRESS", "0.0.0.0")
+    xml.should match_xpath("/XML/REQUEST/META/VERSION", "2.0")
+    xml.should match_xpath("/XML/REQUEST/META/MERCHANTID", "666")
+  end
+end

data/spec/requests/composite_spec.rb

@@ -0,0 +1,48 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+class TestModel
+  attr_reader :validate
+  def initialize(valid);@validate=valid;end
+  def suggested_response_mixins;[];end
+  def errors; {}; end
+end
+class TestModelBuilder
+  def initialize(model);end
+  def build(node)
+    node.tag!("FOO_NODE")
+  end
+end
+
+module MixinTest
+end
+class TestMixinModel < TestModel
+  def suggested_response_mixins
+    [MixinTest, MixinTest]
+  end
+end
+
+describe "the composite request" do
+  it "should build properly from model-builder pairs" do
+    pair = [TestModel.new(true), TestModelBuilder]
+    request = GlobalCollect::Requests::Composite.new("FOO_ACTION", [pair])
+    xml = request.to_xml
+    xml.should have_xpath("/XML/REQUEST/PARAMS/FOO_NODE")
+  end
+  
+  it "should fail on an invalid model" do
+    pair = [TestModel.new(false), TestModelBuilder]
+    request = GlobalCollect::Requests::Composite.new("FOO_ACTION", [pair])
+    lambda { request.to_xml }.should raise_error(Exception, /Invalid model/)
+  end
+  
+  it "should fail on unpaired models and builders" do
+    pair = [TestModel.new(false)]
+    lambda { GlobalCollect::Requests::Composite.new("FOO_ACTION", [pair]) }.should raise_error(ArgumentError, /pairs/)
+  end
+  
+  it "should not suggest duplicate mixins" do
+    pair = [TestMixinModel.new(true), TestModelBuilder]
+    request = GlobalCollect::Requests::Composite.new("FOO_ACTION", [pair])
+    request.suggested_response_mixins.size.should == 1
+  end
+end

data/spec/requests/convert_amount.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "the convert amount request" do
+  before(:each) do
+    @request = GlobalCollect::Requests::ConvertAmount.new(
+      "100",
+      "USD",
+      "GBP"
+    )
+  end
+  it "should build the right action" do
+    xml = @request.to_xml
+    xml.should match_xpath("/XML/REQUEST/ACTION", "CONVERT_AMOUNT")
+  end
+  
+  it "should build basic fields" do
+    xml = @request.to_xml
+    xml.should match_xpath("/XML/REQUEST/PARAMS/GENERAL/AMOUNT", "100")
+    xml.should match_xpath("/XML/REQUEST/PARAMS/GENERAL/SOURCECURRENCYCODE", "USD")
+    xml.should match_xpath("/XML/REQUEST/PARAMS/GENERAL/TARGETCURRENCYCODE", "GBP")
+  end
+  
+  it "should wrap the fields" do
+    xml = @request.to_xml
+    xml.should have_xpath("/XML/REQUEST/PARAMS/GENERAL")
+  end
+  
+  it "should suggest the correct mixins" do
+    @request.suggested_response_mixins.should == [
+      GlobalCollect::Responses::SuccessRow,
+      GlobalCollect::Responses::ConvertAmount::ResponseMethods
+    ]
+  end
+end

data/spec/requests/insert_order_with_payment_spec.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+class AirlineDataBuilder
+  def initialize(data);end
+  def build(node)
+    node.tag!("AIRLINEDATA") do |airline_node|
+      airline_node.tag!("FOO")
+    end
+  end
+end
+class AirlineDataModel
+  def validate;true;end
+  def suggested_response_mixins;[];end
+end
+describe "the insert order with payment request" do
+  before(:each) do
+    @order = GlobalCollect::RequestModels::InsertOrderWithPayment::Order.new(
+      "ORDERID"                        => "1234567890",
+      "AMOUNT"                         => "1234",
+      "CURRENCYCODE"                   => "USD",
+      "LANGUAGECODE"                   => "en",
+      "COUNTRYCODE"                    => "US",
+      "MERCHANTREFERENCE"              => "ASDASDASD"
+    )
+    @payment = GlobalCollect::RequestModels::InsertOrderWithPayment::Payment.new(
+      "PAYMENTPRODUCTID" => "1",
+      "AMOUNT"           => "1234",
+      "CURRENCYCODE"     => "USD",
+      "LANGUAGECODE"     => "en",
+      "COUNTRYCODE"      => "US"
+    )
+    @request = GlobalCollect::Requests::InsertOrderWithPayment.new(
+      [ @order, GlobalCollect::Builders::InsertOrderWithPayment::Order ],
+      [ @payment, GlobalCollect::Builders::InsertOrderWithPayment::Payment ]
+    )
+  end
+  it "should have the correct action" do
+    xml = @request.to_xml
+    xml.should match_xpath("/XML/REQUEST/ACTION", "INSERT_ORDERWITHPAYMENT")
+  end
+  
+  it "should have a payment node" do
+    xml = @request.to_xml
+    xml.should have_xpath("/XML/REQUEST/PARAMS/PAYMENT")
+  end
+  
+  it "should have an order node" do
+    xml = @request.to_xml
+    xml.should have_xpath("/XML/REQUEST/PARAMS/ORDER")
+  end
+  
+  it "should allow extra builders, like AIRLINEDATA" do
+    @request = GlobalCollect::Requests::InsertOrderWithPayment.new(
+      [ @order, GlobalCollect::Builders::InsertOrderWithPayment::Order ],
+      [ @payment, GlobalCollect::Builders::InsertOrderWithPayment::Payment ],
+      [ AirlineDataModel.new, AirlineDataBuilder ]
+    )
+    xml = @request.to_xml
+    xml.should have_xpath("/XML/REQUEST/PARAMS/AIRLINEDATA/FOO")
+  end
+end

data/spec/requests/simple_spec.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+class SimpleTestRequest < GlobalCollect::Requests::Simple
+  def fields
+    {
+      "FOO" => ["N10", "R"]
+    }
+  end
+end
+
+class WrappedSimpleTestRequest < SimpleTestRequest
+  def wrapper;"PARAPPA";end
+end
+describe "the simple request" do
+  it "should build the right action" do
+    request = SimpleTestRequest.new("WHAM",{"FOO" => "123"})
+    xml = request.to_xml
+    xml.should match_xpath("/XML/REQUEST/ACTION", "WHAM")
+  end
+  
+  it "should build basic fields" do
+    request = SimpleTestRequest.new("WHAM",{"FOO" => "123"})
+    xml = request.to_xml
+    xml.should match_xpath("/XML/REQUEST/PARAMS/FOO", "123")
+  end
+  
+  it "should wrap the fields" do
+    request = WrappedSimpleTestRequest.new("WHAM",{"FOO" => "123"})
+    xml = request.to_xml
+    xml.should match_xpath("/XML/REQUEST/PARAMS/PARAPPA/FOO", "123")
+  end
+  
+  it "should validate fields" do
+    request = SimpleTestRequest.new("WHAM",{"FOO" => "abc"})
+    lambda { request.to_xml }.should raise_error(Exception, /Invalid field 'FOO'/)
+  end
+end

data/spec/responses/base_spec.rb

@@ -0,0 +1,59 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe "the base response" do
+  describe "on a successful response" do
+    before(:each) do
+      @response = load_canned_response('successful_iowp_response.xml')
+    end
+
+    it "should identify success" do
+      @response.success?.should == true
+    end
+
+    it "should identify meta fields correctly" do
+      @response.request_id.should == "3000852"
+      @response.response_datetime.should == Time.parse("Fri Apr 09 02:03:09 -0700 2010")
+    end
+    
+    it "should give you the raw hash to access" do
+      @response.hash.should_not be_blank
+    end
+    
+    it "should not provide the errors" do
+      @response.errors.should be_empty
+    end
+    
+    it "should provide the raw and parsed response" do
+      @response.response_hash.should be_a(Hash)
+      xml = @response.raw_response
+      xml.should have_xpath("/XML/REQUEST/META")
+    end
+  end
+  
+  describe "on an unsuccessful response" do
+    before(:each) do
+      @response = load_canned_response('unsuccessful_iowp_response.xml')
+    end
+
+    it "should identify success" do
+      @response.success?.should == false
+    end
+
+    it "should identify meta fields correctly" do
+      @response.request_id.should == "3000854"
+      @response.response_datetime.should == Time.parse("Fri Apr 09 02:03:28 -0700 2010")
+    end
+    
+    it "should provide the errors" do
+      @response.errors.should_not be_empty
+      @response.errors.first.code.should_not be_blank
+      @response.errors.first.message.should_not be_blank
+    end
+    
+    it "should provide the raw and parsed response" do
+      @response.response_hash.should be_a(Hash)
+      xml = @response.raw_response
+      xml.should have_xpath("/XML/REQUEST/META")
+    end
+  end
+end

data/spec/responses/convert_amount/response_methods_spec.rb

@@ -0,0 +1,13 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the convert amount response methods" do
+  before(:each) do
+    @response = load_canned_response('successful_convert_amount_response.xml')
+    @response.extend(GlobalCollect::Responses::SuccessRow)
+    @response.extend(GlobalCollect::Responses::ConvertAmount::ResponseMethods)
+  end
+
+  it "should see the methods" do
+    @response.converted_amount.should == "1174"
+  end
+end

data/spec/responses/do_refund/response_methods_spec.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "the do refund response methods" do
+  before(:each) do
+    @response = load_canned_response('successful_do_refund_response.xml')
+    @response.extend(GlobalCollect::Responses::SuccessRow)
+    @response.extend(GlobalCollect::Responses::DoRefund::ResponseMethods)
+  end
+
+  it "should see the methods" do
+    @response.status_id.should == "800"
+    @response.payment_status.should_not be_nil
+    @response.payment_status.code.should be(800)
+  end
+end