spreedly 1.4.0 → 2.0.0

data/test/remote/remote_retain_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class RemoteRetainTest < Test::Unit::TestCase
+
+  def setup
+    @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)
+  end
+
+  def test_invalid_login
+    assert_invalid_login do |environment|
+      environment.retain_payment_method('payment_method_token')
+    end
+  end
+
+  def test_payment_method_token_token_not_found
+    assert_raise_with_message(Spreedly::NotFoundError, "Unable to find the specified payment method.") do
+      @environment.retain_payment_method('unknown_token')
+    end
+  end
+
+  def test_successful_retain
+    card_token = create_card_on(@environment, retained: false).token
+
+    transaction = @environment.retain_payment_method(card_token)
+    assert transaction.succeeded?
+    assert_equal "Succeeded!", transaction.message
+    assert_equal 'retained', transaction.payment_method.storage_state
+  end
+
+  def test_failed_retain
+    card_token = create_card_on(@environment).token
+    @environment.redact_payment_method(card_token)
+
+    transaction = @environment.retain_payment_method(card_token)
+    assert !transaction.succeeded?
+    assert_equal "The payment method has been redacted. Therefore, it cannot be retained.", transaction.message
+  end
+
+end

data/test/remote/remote_void_test.rb

@@ -0,0 +1,64 @@
+require 'test_helper'
+
+class RemoteVoidTest < Test::Unit::TestCase
+
+  def setup
+    @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)
+  end
+
+  def test_invalid_login
+    assert_invalid_login do |environment|
+      environment.void_transaction('transaction_token')
+    end
+  end
+
+  def test_transaction_token_not_found
+    assert_raise_with_message(Spreedly::NotFoundError, "Unable to find the specified reference transaction.") do
+      @environment.void_transaction('unknown_transaction')
+    end
+  end
+
+  def test_needs_succeeded_reference
+    gateway_token = @environment.add_gateway(:test).token
+    card_token = create_failed_card_on(@environment).token
+    transaction = @environment.purchase_on_gateway(gateway_token, card_token, 144)
+    assert !transaction.succeeded?
+
+    assert_raise_with_message(Spreedly::TransactionCreationError, "The reference transaction did not succeed. Only successful reference transactions are permitted.") do
+      @environment.void_transaction(transaction.token)
+    end
+  end
+
+  def test_successful_void
+    gateway_token = @environment.add_gateway(:test).token
+    card_token = create_card_on(@environment).token
+    purchase = @environment.purchase_on_gateway(gateway_token, card_token, 144)
+    assert purchase.succeeded?
+
+    void = @environment.void_transaction(purchase.token)
+    assert void.succeeded?
+    assert_equal "Succeeded!", void.message
+    assert_equal gateway_token, void.gateway_token
+  end
+
+  def test_optional_arguments
+    gateway_token = @environment.add_gateway(:test).token
+    card_token = create_card_on(@environment).token
+    purchase = @environment.purchase_on_gateway(gateway_token, card_token, 144)
+    assert purchase.succeeded?
+
+    void = @environment.void_transaction(purchase.token, order_id: "8675",
+                                                   description: "SuperDuper",
+                                                   ip: "183.128.100.103",
+                                                   merchant_name_descriptor: "Real Stuff",
+                                                   merchant_location_descriptor: "Raleigh")
+
+    assert void.succeeded?
+    assert_equal "8675", void.order_id
+    assert_equal "SuperDuper", void.description
+    assert_equal "183.128.100.103", void.ip
+    assert_equal "Real Stuff", void.merchant_name_descriptor
+    assert_equal "Raleigh", void.merchant_location_descriptor
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+
+require 'test/unit'
+require 'mocha/setup'
+require 'awesome_print'
+require 'logger'
+require 'log_buddy'
+require 'spreedly'
+require 'credentials/test_credentials'
+require 'helpers/stub_response'
+require 'helpers/creation_helper'
+require 'helpers/assertions'
+require 'helpers/communication_helper'
+
+LogBuddy.init(use_awesome_print: true, logger: Logger.new(nil))
+
+
+Test::Unit::TestCase.class_eval do
+  include Spreedly::TestCredentials
+  include Spreedly::CreationHelper
+  include Spreedly::Assertions
+  include Spreedly::CommunicationHelper
+end
+

data/test/unit/add_credit_card_test.rb

@@ -0,0 +1,74 @@
+require 'test_helper'
+require 'unit/response_stubs/add_credit_card_stubs'
+
+class AddCreditCreditCardTest < Test::Unit::TestCase
+
+  include AddCreditCardStubs
+
+  def setup
+    @environment = Spreedly::Environment.new("key", "secret")
+  end
+
+  def test_successful_add_credit_card
+    t = add_card_using(successful_add_credit_card_response)
+
+    assert_kind_of(Spreedly::AddPaymentMethod, t)
+    assert_kind_of(Spreedly::CreditCard, t.payment_method)
+
+    assert_equal '6wxjN6HcDik8e3mAhBaaoVGSImH', t.token
+    assert !t.retained?
+    assert t.succeeded?
+    assert_equal Time.parse("2013-08-02T18:04:45Z"), t.created_at
+    assert_equal Time.parse("2013-08-02T18:04:45Z"), t.updated_at
+    assert_equal 'Succeeded!', t.message
+
+    assert_equal "AXaBXfVUqhaGMg8ytf8isiMAAL9", t.payment_method.token
+    assert_equal "Eland Venture", t.payment_method.full_name
+    assert_equal "Don't test everything here, since find_payment_method tests it all.", t.payment_method.data
+  end
+
+  def test_request_body_params
+    body = get_request_body(successful_add_credit_card_response) do
+      @environment.add_credit_card(full_card_details)
+    end
+
+    payment_method = body.xpath('./payment_method')
+    assert_xpaths_in payment_method,
+      [ './data', 'talent: Late' ],
+      [ './email', 'leavenworth@free.com' ],
+      [ './retained', 'true' ]
+
+    card = body.xpath('./payment_method/credit_card')
+    assert_xpaths_in card,
+      [ './first_name', 'Leavenworth' ],
+      [ './last_name', 'Smedry' ],
+      [ './number', '9555555555554444' ],
+      [ './month', '3' ],
+      [ './year', '2021' ],
+      [ './address1', '10 Dragon Lane' ],
+      [ './address2', 'Suite 9' ],
+      [ './city', 'Tuki Tuki' ],
+      [ './state', 'Mokia' ],
+      [ './zip', '1122' ],
+      [ './country', 'Free Kingdoms' ],
+      [ './phone_number', '81Ab' ]
+  end
+
+  private
+  def add_card_using(response)
+    @environment.stubs(:raw_ssl_request).returns(response)
+    @environment.add_credit_card(ignored: "Because response is stubbed")
+  end
+
+  def full_card_details
+    {
+      email: 'leavenworth@free.com', number: '9555555555554444', month: 3, year: 2021,
+      last_name: 'Smedry', first_name: 'Leavenworth', data: "talent: Late",
+      address1: '10 Dragon Lane', address2: 'Suite 9', city: 'Tuki Tuki', state: 'Mokia',
+      zip: '1122', country: 'Free Kingdoms', phone_number: '81Ab', retained: true
+    }
+  end
+
+end
+
+

data/test/unit/add_gateway_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+require 'unit/response_stubs/add_gateway_stubs'
+
+class AddGatewayTest < Test::Unit::TestCase
+
+  include AddGatewayStubs
+
+  def setup
+    @environment = Spreedly::Environment.new("key", "secret")
+  end
+
+  def test_add_test_gateway
+    @environment.stubs(:raw_ssl_request).returns(successful_add_test_gateway_response)
+
+    gateway = @environment.add_gateway(:test)
+    assert_equal "4dFb93AiRDEJ18MS9xDGMyu22uO", gateway.token
+    assert_equal "test", gateway.gateway_type
+    assert_equal "retained", gateway.state
+    assert_equal "Test", gateway.name
+  end
+
+  # TODO
+  # Tests coming for characteristics, payment_methods, and gateway_specific_fields.
+  # We'll also soon handle adding other types of gateways.
+
+end

data/test/unit/authorize_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+require 'unit/response_stubs/authorization_stubs'
+
+class AuthorizeTest < Test::Unit::TestCase
+
+  include AuthorizationStubs
+
+  def setup
+    @environment = Spreedly::Environment.new("key", "secret")
+  end
+
+  def test_successful_authorize
+    t = authorize_using(successful_authorize_response)
+
+    assert_kind_of(Spreedly::Authorization, t)
+    assert_equal 'NjsT1PRC5pHyz89H01bj1t2AVNo', t.token
+    assert_equal 345, t.amount
+    assert t.on_test_gateway?
+    assert_equal Time.parse("2013-08-05 13:11:28 UTC"), t.created_at
+    assert_equal Time.parse("2013-08-05 13:11:28 UTC"), t.updated_at
+    assert_equal 'USD', t.currency_code
+    assert t.succeeded?
+    assert_equal 'succeeded', t.state
+    assert_equal '99a1', t.order_id
+    assert_equal '182.129.106.102', t.ip
+    assert_equal 'LotsOCoffee', t.description
+    assert_equal 'My Writeoff Inc.', t.merchant_name_descriptor
+    assert_equal 'Tax Free Zone', t.merchant_location_descriptor
+    assert_equal 'YjWxOjbpeieXsZFdAsbhM2DFgLe', t.gateway_token
+
+    assert_equal 'Nh2Vw0kAoSQvcJDpK52q4dZlrVJ', t.payment_method.token
+    assert_equal 'Forthrast', t.payment_method.last_name
+
+    assert t.response.success
+    assert_equal 'Successful authorize', t.response.message
+  end
+
+  def test_failed_authorize
+    t = authorize_using(failed_authorize_response)
+
+    assert_kind_of(Spreedly::Authorization, t)
+    assert_equal 'PHuCG2kfgyr92CgKuqlblFbgZJP', t.token
+    assert_equal 2391, t.amount
+    assert !t.succeeded?
+    assert_equal 'gateway_processing_failed', t.state
+
+    assert_equal 'The eagle may have perished.', t.response.error_detail
+  end
+
+  def test_request_body_params
+    body = get_request_body(successful_authorize_response) do
+      @environment.authorize_on_gateway("TheGatewayToken", "TheCardToken", 2001, all_possible_options)
+    end
+
+    transaction = body.xpath('./transaction')
+    assert_xpaths_in transaction,
+      [ './amount', '2001' ],
+      [ './currency_code', 'CAD' ],
+      [ './payment_method_token', 'TheCardToken' ],
+      [ './order_id', '8669' ],
+      [ './description', 'Gold Farmin' ],
+      [ './ip', '183.128.100.102' ],
+      [ './merchant_name_descriptor', 'TRain' ],
+      [ './merchant_location_descriptor', 'British Colombia' ],
+      [ './retain_on_success', 'true' ]
+  end
+
+
+  private
+  def authorize_using(response)
+    @environment.stubs(:raw_ssl_request).returns(response)
+    @environment.authorize_on_gateway("IgnoredGatewayTokenSinceResponseIsStubbed", "IgnoredPaymentMethodTokenSinceResponseIsStubbed", 5921)
+  end
+
+  def all_possible_options
+    {
+      currency_code: "CAD",
+      order_id: "8669",
+      description: "Gold Farmin",
+      ip: "183.128.100.102",
+      merchant_name_descriptor: "TRain",
+      merchant_location_descriptor: "British Colombia",
+      retain_on_success: true
+    }
+  end
+
+end

data/test/unit/capture_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+require 'unit/response_stubs/capture_stubs'
+
+class CaptureTest < Test::Unit::TestCase
+
+  include CaptureStubs
+
+  def setup
+    @environment = Spreedly::Environment.new("key", "secret")
+  end
+
+  def test_successful_capture
+    t = capture_using(successful_capture_response)
+
+    assert_kind_of(Spreedly::Capture, t)
+    assert_equal 'T41uDjYsxGybSsp7RHuRTohMjg2', t.token
+    assert_equal 801, t.amount
+    assert t.on_test_gateway?
+    assert_equal Time.parse("2013-08-05 13:58:50 UTC"), t.created_at
+    assert_equal Time.parse("2013-08-05 13:58:50 UTC"), t.updated_at
+    assert_equal 'USD', t.currency_code
+    assert t.succeeded?
+    assert_equal 'succeeded', t.state
+    assert_equal '99a1', t.order_id
+    assert_equal '182.129.106.102', t.ip
+    assert_equal 'LotsOCoffee', t.description
+    assert_equal 'My Writeoff Inc.', t.merchant_name_descriptor
+    assert_equal 'Tax Free Zone', t.merchant_location_descriptor
+    assert_equal 'SoPblCOGDwaRyym68XGWeRiCy1C', t.gateway_token
+    assert_equal 'PH6U2tyFWtDSVp88bNW2nnGy5rk', t.reference_token
+
+    assert t.response.success
+    assert_equal 'Successful capture', t.response.message
+  end
+
+  def test_failed_capture
+    t = capture_using(failed_capture_response)
+
+    assert_kind_of(Spreedly::Capture, t)
+    assert_equal 'Z4XAoSG11rd4zo9p9sRxpstKufX', t.token
+    assert_equal 44, t.amount
+    assert !t.succeeded?
+    assert_equal 'gateway_processing_failed', t.state
+
+    assert_equal 'The eagle has hit the window.', t.response.error_detail
+  end
+
+  def test_empty_request_body_params
+    body = get_request_body(successful_capture_response) do
+      @environment.capture_transaction("TheAuthorizationToken")
+    end
+
+    assert_nil body.root
+  end
+
+  def test_request_body_params
+    body = get_request_body(successful_capture_response) do
+      @environment.capture_transaction("TheAuthorizationToken", all_possible_options)
+    end
+
+    transaction = body.xpath('./transaction')
+    assert_xpaths_in transaction,
+      [ './amount', '29' ],
+      [ './currency_code', 'CAD' ],
+      [ './order_id', '8668' ],
+      [ './description', 'Gold Farmin' ],
+      [ './ip', '183.128.100.102' ],
+      [ './merchant_name_descriptor', 'TRain' ],
+      [ './merchant_location_descriptor', 'British Colombia' ]
+  end
+
+
+  private
+  def capture_using(response)
+    @environment.stubs(:raw_ssl_request).returns(response)
+    @environment.capture_transaction("IgnoredTokenSinceResponseIsStubbed")
+  end
+
+  def all_possible_options
+    {
+      amount: 29,
+      currency_code: "CAD",
+      order_id: "8668",
+      description: "Gold Farmin",
+      ip: "183.128.100.102",
+      merchant_name_descriptor: "TRain",
+      merchant_location_descriptor: "British Colombia"
+    }
+  end
+
+end

data/test/unit/environment_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class EnvironmentTest < Test::Unit::TestCase
+
+  def setup
+    @environment = Spreedly::Environment.new("TheKey", "TheAccessSecret")
+  end
+
+  def test_currency_code_defaults_to_usd
+    assert_equal "USD", @environment.currency_code
+  end
+
+  def test_currency_code_can_be_overridden
+    environment = Spreedly::Environment.new("TheKey", "TheAccessSecret", currency_code: "EUR")
+    assert_equal "EUR", environment.currency_code
+  end
+
+end

data/test/unit/fields_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class FieldsTest < Test::Unit::TestCase
+
+  class ModelWithFields
+    include Spreedly::Fields
+    field :message, :amount, :on_test_gateway, :updated_at, :succeeded
+  end
+
+  class ModelWithTypedFields
+    include Spreedly::Fields
+    field :message
+    field :succeeded, :on_test_gateway, type: :boolean
+    field :amount, type: :integer
+    field :updated_at, type: :date_time
+  end
+
+  def setup
+    @model = ModelWithFields.new
+    @typed_model = ModelWithTypedFields.new
+  end
+
+  def test_defaults_to_nil
+    assert_nil @model.message
+    assert_nil @model.amount
+    assert_nil @model.on_test_gateway
+    assert_nil @model.updated_at
+    assert_nil @model.succeeded
+  end
+
+  def test_defaults_to_nil_for_typed_fields
+    assert_nil @typed_model.message
+    assert_nil @typed_model.amount
+    assert_nil @typed_model.on_test_gateway
+    assert_nil @typed_model.on_test_gateway?
+    assert_nil @typed_model.updated_at
+    assert_nil @typed_model.succeeded
+    assert_nil @typed_model.succeeded?
+  end
+
+  def test_initialize_fields_for_strings
+    @model.initialize_fields(Nokogiri::XML(xml))
+    assert_equal "The eagle flies at dawn.", @model.message
+    assert_equal "5148", @model.amount
+    assert_equal "true", @model.on_test_gateway
+    assert_equal "2013-07-31T19:51:57Z", @model.updated_at
+    assert_equal "false", @model.succeeded
+  end
+
+  def test_initialize_fields_for_typed_fields
+    @typed_model.initialize_fields(Nokogiri::XML(xml))
+    assert_equal "The eagle flies at dawn.", @typed_model.message
+    assert_equal 5148, @typed_model.amount
+    assert_equal true, @typed_model.on_test_gateway
+    assert_equal true, @typed_model.on_test_gateway?
+    assert_equal Time.parse("2013-07-31T19:51:57Z"), @typed_model.updated_at
+    assert_equal false, @typed_model.succeeded
+    assert_equal false, @typed_model.succeeded?
+  end
+
+
+  private
+  def xml
+    <<-XML
+      <the_model>
+        <amount>5148</amount>
+        <on_test_gateway>true</on_test_gateway>
+        <updated_at>2013-07-31T19:51:57Z</updated_at>
+        <succeeded>false</succeeded>
+        <message>The eagle flies at dawn.</message>
+      </the_model>
+    XML
+  end
+
+end