spreedly 2.0.0 → 2.0.1

data/HISTORY.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2.0.1
+* List the transactions for a payment method
+* Allow adding other gateways
+* Listing Payment Methods (retained on an account)
+* Updating a Payment Method
+* Listing Your Gateways
+* Finding a Gateway
+* Fix Ruby 1.9.2 private method issue
+* Add ability to find a bank account payment method
+* Add ability to redact a gateway
+
 ## 2.0.0
 * This gem is now intended for the Spreedly API.  For the Spreedly
   Subscriptions API, you can use the spreedly_subscriptions gem

data/README.md

@@ -230,10 +230,10 @@ transaction.order_id      # => '30-9904-31114'
 env.find_transaction_transcript(transaction_token)
 ```
 
-#### Updating a payment method
+#### Updating a credit card
 
 ``` ruby
-env.update_payment_method(payment_method_token, first_name: 'JimBob', last_name: 'Jones')
+env.update_credit_card(credit_card_token, first_name: 'JimBob', last_name: 'Jones')
 ```
 
 #### Adding other types of gateways

data/lib/spreedly/common/fields.rb

@@ -37,7 +37,6 @@ module Spreedly
         subclass.instance_variable_set("@fields", instance_variable_get("@fields"))
       end
 
-      private
       def add_accessor_for(f, field_type)
         case field_type
         when :boolean

data/lib/spreedly/connection.rb

@@ -28,8 +28,8 @@ module Spreedly
     private
     def http
       http = Net::HTTP.new(endpoint.host, endpoint.port)
-      http.open_timeout = 60
-      http.read_timeout = 60
+      http.open_timeout = 64
+      http.read_timeout = 64
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_PEER
       http.ca_file = File.dirname(__FILE__) + '/../certs/cacert.pem'

data/lib/spreedly/environment.rb

@@ -66,13 +66,28 @@ module Spreedly
       Transaction.new_from(xml_doc)
     end
 
-    def list_transactions(since_token = nil)
-      xml_doc = ssl_get(list_transactions_url(since_token), headers)
+    def redact_gateway(gateway_token, options = {})
+      xml_doc = ssl_put(redact_gateway_url(gateway_token), '', headers)
+      Transaction.new_from(xml_doc)
+    end
+
+    def list_transactions(since_token = nil, payment_method_token = nil)
+      xml_doc = ssl_get(list_transactions_url(since_token, payment_method_token), headers)
       Transaction.new_list_from(xml_doc)
     end
 
-    def add_gateway(gateway_type, options = {})
-      body = add_gateway_body(gateway_type, options)
+    def list_payment_methods(since_token = nil)
+      xml_doc = ssl_get(list_payment_methods_url(since_token), headers)
+      PaymentMethod.new_list_from(xml_doc)
+    end
+
+    def list_gateways(since_token = nil)
+      xml_doc = ssl_get(list_gateways_url(since_token), headers)
+      Gateway.new_list_from(xml_doc)
+    end
+
+    def add_gateway(gateway_type, credentials = {})
+      body = add_gateway_body(gateway_type, credentials)
       xml_doc = ssl_post(add_gateway_url, body, headers)
       Gateway.new(xml_doc)
     end
@@ -81,6 +96,12 @@ module Spreedly
       api_post(add_payment_method_url, add_credit_card_body(options))
     end
 
+    def update_credit_card(credit_card_token, options)
+      body = update_credit_card_body(options)
+      xml_doc = ssl_put(update_payment_method_url(credit_card_token), body, headers)
+      PaymentMethod.new_from(xml_doc)
+    end
+
     private
     def headers
       {
@@ -132,9 +153,10 @@ module Spreedly
       end
     end
 
-    def add_gateway_body(gateway_type, options)
+    def add_gateway_body(gateway_type, credentials)
       build_xml_request('gateway') do |doc|
         doc.gateway_type gateway_type
+        add_to_doc(doc, credentials, *credentials.keys)
       end
     end
 
@@ -148,6 +170,13 @@ module Spreedly
       end
     end
 
+    def update_credit_card_body(options)
+      build_xml_request('payment_method') do |doc|
+        add_to_doc(doc, options, :email, :month, :first_name, :last_name, :year,
+                   :address1, :address2, :city, :state, :zip, :country, :phone_number)
+      end
+    end
+
     def add_to_doc(doc, options, *attributes)
       attributes.each do |attr|
         doc.send(attr, options[attr.to_sym]) if options[attr.to_sym]

data/lib/spreedly/gateway.rb

@@ -4,6 +4,28 @@ module Spreedly
   class Gateway < Model
 
     field :gateway_type, :state, :name
+    attr_reader :credentials
+
+    def initialize(xml_doc)
+      super
+      init_credentials(xml_doc)
+    end
+
+    def self.new_list_from(xml_doc)
+      gateways = xml_doc.xpath('.//gateways/gateway')
+      gateways.map do |each|
+        self.new(each)
+      end
+    end
+
+    private
+    def init_credentials(xml_doc)
+      @credentials = {}
+
+      xml_doc.xpath('.//credentials/credential').each do |each|
+        @credentials[each.at_xpath('.//name').text] = each.at_xpath('.//value').text
+      end
+    end
 
   end
 

data/lib/spreedly/payment_methods/bank_account.rb

@@ -0,0 +1,9 @@
+module Spreedly
+
+  class BankAccount < PaymentMethod
+    field :first_name, :last_name, :full_name, :bank_name
+    field :account_type, :account_holder_type, :routing_number_display_digits
+    field :account_number_display_digits, :routing_number, :account_number
+  end
+
+end

data/lib/spreedly/payment_methods/payment_method.rb

@@ -22,6 +22,15 @@ module Spreedly
         return Paypal.new(xml_doc)
       when 'sprel'
         return Sprel.new(xml_doc)
+      when 'bank_account'
+        return BankAccount.new(xml_doc)
+      end
+    end
+
+    def self.new_list_from(xml_doc)
+      payment_methods = xml_doc.xpath('.//payment_methods/payment_method')
+      payment_methods.map do |each|
+        self.new_from(each)
       end
     end
 

data/lib/spreedly/transactions/redact_gateway.rb

@@ -0,0 +1,14 @@
+module Spreedly
+
+  class RedactGateway < Transaction
+
+    attr_reader :gateway
+
+    def initialize(xml_doc)
+      super
+      @gateway = Gateway.new(xml_doc.at_xpath('.//gateway'))
+    end
+
+  end
+
+end

data/lib/spreedly/transactions/transaction.rb

@@ -24,6 +24,8 @@ module Spreedly
         return RetainPaymentMethod.new(xml_doc)
       when 'RedactPaymentMethod'
         return RedactPaymentMethod.new(xml_doc)
+      when 'RedactGateway'
+        return RedactGateway.new(xml_doc)
       else
         Transaction.new(xml_doc)
       end

data/lib/spreedly/urls.rb

@@ -46,9 +46,25 @@ module Spreedly
       "#{base_url}/v1/payment_methods/#{payment_method_token}/redact.xml"
     end
 
-    def list_transactions_url(since_token)
+    def redact_gateway_url(gateway_token)
+      "#{base_url}/v1/gateways/#{gateway_token}/redact.xml"
+    end
+
+    def list_transactions_url(since_token, payment_method_token)
+      since_param = "?since_token=#{since_token}" if since_token
+      return "#{base_url}/v1/transactions.xml#{since_param}" unless payment_method_token
+
+      "#{base_url}/v1/payment_methods/#{payment_method_token}/transactions.xml#{since_param}"
+    end
+
+    def list_payment_methods_url(since_token)
       since_param = "?since_token=#{since_token}" if since_token
-      "#{base_url}/v1/transactions.xml#{since_param}"
+      "#{base_url}/v1/payment_methods.xml#{since_param}"
+    end
+
+    def list_gateways_url(since_token)
+      since_param = "?since_token=#{since_token}" if since_token
+      "#{base_url}/v1/gateways.xml#{since_param}"
     end
 
     def add_gateway_url
@@ -59,6 +75,10 @@ module Spreedly
       "#{base_url}/v1/payment_methods.xml"
     end
 
+    def update_payment_method_url(token)
+      "#{base_url}/v1/payment_methods/#{token}.xml"
+    end
+
   end
 
 end

data/lib/spreedly/version.rb

@@ -1,3 +1,3 @@
 module Spreedly
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/lib/spreedly.rb

@@ -9,6 +9,7 @@ require 'spreedly/payment_methods/payment_method'
 require 'spreedly/payment_methods/credit_card'
 require 'spreedly/payment_methods/paypal'
 require 'spreedly/payment_methods/sprel'
+require 'spreedly/payment_methods/bank_account'
 require 'spreedly/transactions/transaction'
 require 'spreedly/transactions/gateway_transaction'
 require 'spreedly/transactions/add_payment_method'
@@ -20,6 +21,7 @@ require 'spreedly/transactions/capture'
 require 'spreedly/transactions/refund'
 require 'spreedly/transactions/retain_payment_method'
 require 'spreedly/transactions/redact_payment_method'
+require 'spreedly/transactions/redact_gateway'
 require 'spreedly/gateway'
 require 'spreedly/error'
 

data/test/remote/remote_add_gateway_test.rb

@@ -24,7 +24,13 @@ class RemoteAddGatewayTest < Test::Unit::TestCase
     gateway = @environment.add_gateway(:test)
     assert_equal "test", gateway.gateway_type
     assert_equal "retained", gateway.state
-    assert_equal "Test", gateway.name
+    assert_equal "Spreedly Test", gateway.name
+  end
+
+  def test_need_active_account
+    assert_raise_with_message(Spreedly::PaymentRequiredError, "Your account has not been activated for real transactions. Please update your subscription settings.") do
+      gateway = @environment.add_gateway(:wirecard)
+    end
   end
 
 end

data/test/remote/remote_find_gateway_test.rb

@@ -23,9 +23,10 @@ class RemoteFindGatewayTest < Test::Unit::TestCase
 
     found = @environment.find_gateway(gateway.token)
 
-    assert_equal gateway.token, found.token
-    assert_equal "Test", gateway.name
-    assert_equal "retained", gateway.state
+    assert_equal(gateway.token, found.token)
+    assert_equal("Spreedly Test", gateway.name)
+    assert_equal("retained", gateway.state)
+    assert_equal({}, gateway.credentials)
   end
 
 end

data/test/remote/remote_list_gateways_test.rb

@@ -0,0 +1,35 @@
+
+require 'test_helper'
+
+class RemoteListGatewaysTest < 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.list_gateways
+    end
+  end
+
+  def test_successfully_list_gateways
+    g1 = @environment.add_gateway(:test).token
+    g2 = @environment.add_gateway(:test).token
+    g3 = @environment.add_gateway(:test).token
+
+    first_twenty = @environment.list_gateways
+    assert_equal 20, first_twenty.size
+    assert_kind_of Spreedly::Model, first_twenty.first
+
+    gateways = @environment.list_gateways(g1)
+    assert_equal 2, gateways.size
+    assert_kind_of(Spreedly::Gateway, gateways.first)
+    assert_kind_of(Spreedly::Gateway, gateways.last)
+
+    assert_equal g2, gateways.first.token
+    assert_equal g3, gateways.last.token
+  end
+
+end
+

data/test/remote/remote_list_payment_methods_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+class RemoteListPaymentMethodsTest < 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.list_payment_methods
+    end
+  end
+
+  def test_successfully_list_payment_methods
+    c1 = create_card_on(@environment).token
+    c2 = create_card_on(@environment).token
+    c3 = create_card_on(@environment).token
+
+    first_twenty = @environment.list_payment_methods
+    assert_equal 20, first_twenty.size
+    assert_kind_of Spreedly::Model, first_twenty.first
+
+    payment_methods = @environment.list_payment_methods(c1)
+    assert_equal 2, payment_methods.size
+    assert_kind_of(Spreedly::CreditCard, payment_methods.first)
+    assert_kind_of(Spreedly::CreditCard, payment_methods.last)
+
+    assert_equal c2, payment_methods.first.token
+    assert_equal c3, payment_methods.last.token
+  end
+
+end
+

data/test/remote/remote_list_transactions_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class RemoteTransactionsTest < Test::Unit::TestCase
+class RemoteListTransactionsTest < Test::Unit::TestCase
 
   def setup
     @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)
@@ -33,4 +33,32 @@ class RemoteTransactionsTest < Test::Unit::TestCase
     assert_equal 22, transactions.last.amount
   end
 
+  def test_successfully_list_transactions_for_a_payment_method
+    gateway_token = @environment.add_gateway(:test).token
+    card_token = create_card_on(@environment).token
+
+    t1 = @environment.purchase_on_gateway(gateway_token, card_token, 144)
+    t2 = @environment.authorize_on_gateway(gateway_token, card_token, 444)
+    t3 = @environment.capture_transaction(t2.token, amount: 22)
+
+    all = @environment.list_transactions(nil, card_token)
+    assert_equal 5, all.size
+    assert_kind_of Spreedly::Model, all.first
+
+    next_group = @environment.list_transactions(t1.token, card_token)
+    assert_equal 2, next_group.size
+    assert_kind_of(Spreedly::Authorization, next_group.first)
+    assert_kind_of(Spreedly::Capture, next_group.last)
+
+    assert_equal 444, next_group.first.amount
+    assert_equal 22, next_group.last.amount
+  end
+
+  def test_list_transactions_non_existent_payment_method
+    assert_raise_with_message(Spreedly::NotFoundError, "Unable to find the specified payment method.") do
+       @environment.list_transactions(nil, 'nonExistentToken')
+    end
+  end
+
 end
+

data/test/remote/remote_redact_gateway_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class RemoteRedactGatewayTest < 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.redact_gateway('gateway_token')
+    end
+  end
+
+  def test_gateway_token_token_not_found
+    assert_raise_with_message(Spreedly::NotFoundError, "Unable to find the specified gateway.") do
+      @environment.redact_gateway('unknown_token')
+    end
+  end
+
+  def test_successful_redact
+    gateway = @environment.add_gateway(:test)
+
+    transaction = @environment.redact_gateway(gateway.token)
+
+    assert transaction.succeeded?
+    assert_equal 'redacted', transaction.gateway.state
+  end
+
+end

data/test/remote/{remote_redact_test.rb → remote_redact_payment_method_test.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class RemoteRedactTest < Test::Unit::TestCase
+class RemoteRedactPaymentMethodTest < Test::Unit::TestCase
 
   def setup
     @environment = Spreedly::Environment.new(remote_test_environment_key, remote_test_access_secret)

data/test/remote/remote_update_credit_card_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class RemoteUpdateCreditCardTest < 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.update_credit_card("card_token", card_deets)
+    end
+  end
+
+  def test_non_existent_card_token
+    assert_raise_with_message(Spreedly::NotFoundError, "Unable to find the specified payment method.") do
+      @environment.update_credit_card('unknown_card', card_deets)
+    end
+  end
+
+  def test_failed_with_validation_errors
+    card = create_card_on(@environment)
+    error = assert_raises(Spreedly::TransactionCreationError) do
+      @environment.update_credit_card(card.token, card_deets(last_name: '', first_name: ' '))
+    end
+
+    expected_errors = [
+      { attribute: "first_name", key: "errors.blank", message: "First name can't be blank" },
+      { attribute: "last_name", key: "errors.blank", message: "Last name can't be blank" }
+    ]
+
+    assert_equal expected_errors, error.errors
+    assert_equal "First name can't be blank\nLast name can't be blank", error.message
+  end
+
+  def test_successful_update_card
+    card = create_card_on(@environment)
+    result = @environment.update_credit_card(card.token, card_deets)
+
+    assert_kind_of(Spreedly::CreditCard, result)
+    assert_equal 'Cauthon', result.last_name
+    assert_equal 'Mat', result.first_name
+    assert_equal 'cauthon@wot.com', result.email
+  end
+
+  private
+  def card_deets(options = {})
+    {
+      email: 'cauthon@wot.com', month: 1, year: 2019,
+      last_name: 'Cauthon', first_name: 'Mat'
+    }.merge(options)
+  end
+
+end

data/test/unit/add_gateway_test.rb

@@ -13,14 +13,24 @@ class AddGatewayTest < Test::Unit::TestCase
     @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
+    assert_equal("4dFb93AiRDEJ18MS9xDGMyu22uO", gateway.token)
+    assert_equal("test", gateway.gateway_type)
+    assert_equal("retained", gateway.state)
+    assert_equal("Test", gateway.name)
+    assert_equal({}, gateway.credentials)
   end
 
-  # TODO
-  # Tests coming for characteristics, payment_methods, and gateway_specific_fields.
-  # We'll also soon handle adding other types of gateways.
+  def test_request_body_params
+    body = get_request_body(successful_add_test_gateway_response) do
+      @environment.add_gateway(:wirecard, username: "TheUserName", password: "ThePassword", business_case_signature: "TheSig")
+    end
+
+    gateway = body.xpath('./gateway')
+    assert_xpaths_in gateway,
+      [ './gateway_type', 'wirecard' ],
+      [ './username', 'TheUserName' ],
+      [ './password', 'ThePassword' ],
+      [ './business_case_signature', 'TheSig']
+  end
 
 end

data/test/unit/find_gateway_test.rb

@@ -13,10 +13,11 @@ class FindGatewayTest < Test::Unit::TestCase
     g = find_using(successful_get_gateway_response)
 
     assert_kind_of(Spreedly::Gateway, g)
-    assert_equal("RsVlPgS4dMzeeUpKXxk01rMMRrQ", g.token)
-    assert_equal Time.parse("2013-08-07 18:53:30 UTC"), g.created_at
-    assert_equal Time.parse("2013-08-07 18:53:30 UTC"), g.updated_at
-    assert_equal 'redacted', g.state
+    assert_equal("5YqAdCL5AaxdbDdo1yZCkB4r74p", g.token)
+    assert_equal(Time.parse("2013-08-23 14:52:25 UTC"), g.created_at)
+    assert_equal(Time.parse("2013-08-23 14:52:25 UTC"), g.updated_at)
+    assert_equal('redacted', g.state)
+    assert_equal({ 'username' => "UsernameOfAwesome", 'business_case_signature' => "Super Sig" }, g.credentials)
   end
 
   private

data/test/unit/find_payment_method_test.rb

@@ -80,6 +80,29 @@ class FindPaymentMethodTest < Test::Unit::TestCase
     assert_equal("retained", paypal.storage_state)
   end
 
+  def test_successfully_find_bank_account
+    b = find_using(successful_get_bank_account_response)
+
+    assert_kind_of(Spreedly::BankAccount, b)
+    assert_equal "seeQDV0jwJwFa1FUUsph6kPMTj", b.token
+    assert_equal "daniel@waterhouse.com", b.email
+    assert_equal(1376673633, b.created_at.to_i)
+    assert_equal(1376673633, b.updated_at.to_i)
+    assert_equal("GeekyNote", b.data)
+    assert_equal("cached", b.storage_state)
+    assert_equal("Daniel", b.first_name)
+    assert_equal("Waterhouse", b.last_name)
+    assert_equal("Daniel Waterhouse", b.full_name)
+    assert_equal("First Bank of Crypto", b.bank_name)
+    assert_equal("checking", b.account_type)
+    assert_equal("personal", b.account_holder_type)
+    assert_equal("021", b.routing_number_display_digits)
+    assert_equal("4321", b.account_number_display_digits)
+    assert_equal("021*", b.routing_number)
+    assert_equal("*4321", b.account_number)
+    assert_equal([], b.errors)
+  end
+
   private
   def find_using(response)
     @environment.stubs(:raw_ssl_request).returns(response)

data/test/unit/list_gateways_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+require 'unit/response_stubs/list_gateways_stubs'
+
+class ListGatewaysTest < Test::Unit::TestCase
+
+  include ListGatewaysStubs
+
+  def setup
+    @environment = Spreedly::Environment.new("key", "secret")
+  end
+
+  def test_successful_list_payment_methods
+    list = list_using(successful_list_gateways_response)
+
+    assert_kind_of(Array, list)
+    assert_equal 2, list.size
+
+    assert_equal 'OJUFe5ZR6pFfL4i4ZGVmvGWkZUY', list.first.token
+    assert_equal '52wqOssuKZSXEYde30AGTG6xl8v', list.last.token
+    assert_kind_of Spreedly::Gateway, list.first
+    assert_kind_of Spreedly::Gateway, list.last
+  end
+
+  def test_request_url
+    assert_request_url 'https://core.spreedly.com/v1/gateways.xml' do
+      @environment.list_gateways
+    end
+
+    assert_request_url 'https://core.spreedly.com/v1/gateways.xml?since_token=SomeToken' do
+      @environment.list_gateways("SomeToken")
+    end
+  end
+
+  private
+  def list_using(response)
+    @environment.stubs(:raw_ssl_request).returns(response)
+    @environment.list_gateways
+  end
+
+  def assert_request_url(expected_url)
+    actual_url = get_request_url(successful_list_gateways_response) do
+      yield
+    end
+    assert_equal expected_url, actual_url
+  end
+
+end