RubyGems - braintree_query - Versions diffs - 0.0.0 → 0.1.0 - Mend

braintree_query 0.0.0 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/README.rdoc +1 -0
data/Rakefile +11 -4
data/VERSION +1 -1
data/lib/braintree_query.rb +2 -0
data/lib/braintree_query/base.rb +69 -0
data/lib/braintree_query/customer.rb +31 -0
data/lib/braintree_query/transaction.rb +2 -52
data/test/test_braintree_query.rb +254 -47
metadata +6 -4

data/README.rdoc CHANGED Viewed

@@ -39,6 +39,7 @@ examples)
 == TODO
 * rdoc
 * better way to do integration tests (i.e. hitting the real server)
+* add better merchant defined field support
 == Note on Patches/Pull Requests

data/Rakefile CHANGED Viewed

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "braintree_query"
-    gem.summary = "Client for accessing Braintree Payment Solution's reporting API."
-    gem.description = "Access Braintree Transactions and Vault records"
+    gem.summary = "Ruby client for accessing Braintree Payment Solution's reporting API"
+    gem.description = "Access Braintree Transactions and Customers"
     gem.email = "jeff@animoto.com"
     gem.homepage = "http://github.com/jjolma/braintree_query"
     gem.authors = ["Jeff Jolma"]
@@ -38,10 +38,17 @@ rescue LoadError
   end
 end
-task :test => :check_dependencies
+task :test => :check_depentrdencies
 task :default => :test
+begin
+  %w{sdoc sdoc-helpers rdiscount}.each { |name| gem name }
+  require 'sdoc_helpers'
+rescue LoadError => ex
+  puts "sdoc support not enabled:"
+  puts ex.inspect
+end
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""

data/VERSION CHANGED Viewed

	@@ -1 +1 @@
1	- 0.0.0
1	+ 0.1.0

data/lib/braintree_query.rb CHANGED Viewed

@@ -1,2 +1,4 @@
+require 'braintree_query/base'
 require 'braintree_query/transaction'
+require 'braintree_query/customer'
 require 'braintree_query/errors'

data/lib/braintree_query/base.rb ADDED Viewed

@@ -0,0 +1,69 @@
+require 'ostruct'
+require 'uri'
+require 'net/https'
+require 'xmlsimple'
+module BraintreeQuery
+  class Base < OpenStruct
+    BASE_URL = "https://secure.braintreepaymentgateway.com/api/query.php"
+    #
+    # Issue a query against Braintree's query API
+    #
+    # Returns a hash of the response
+    #
+    def self.query(options)
+      raise ArgumentError, "username required" unless options[:username]
+      raise ArgumentError, "password required" unless options[:password]
+      query = options.map { |k,v| "#{k}=#{v}" }.join('&')
+      full_url = [BASE_URL, query].join '?'
+      uri = URI.parse(full_url)
+      server = Net::HTTP.new uri.host, uri.port
+      server.use_ssl = uri.scheme == 'https'
+      server.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      response = server.post BASE_URL, query
+      response_hash = XmlSimple.xml_in(response.body, { 'NormaliseSpace' => 2 })
+      response_hash = massage(response_hash)
+      if response_hash && err_msg = response_hash['error_response']
+        if err_msg =~ /Invalid Username/
+          raise BraintreeQuery::CredentialError, err_msg
+        else
+          raise BraintreeQuery::Error, err_msg
+        end
+      end
+      response_hash
+    end
+    private
+    # massage the hash generated from XmlSimple into something more usable
+    # stolen and trimmed from rails' Hash.from_xml
+    def self.massage(value)
+      case value.class.to_s
+      when 'Hash'
+        if value.size == 0
+          nil
+        else
+          xml_value = value.inject({}) do |h,(k,v)|
+            h[k] = massage(v)
+            h
+          end
+        end
+      when 'Array'
+        value.map! { |i| massage(i) }
+        case value.length
+        when 0 then nil
+        when 1 then value.first
+        else value
+        end
+      when 'String'
+        value
+      else
+        raise "can't massage #{value.class.name} - #{value.inspect}"
+      end
+    end
+  end
+end

data/lib/braintree_query/customer.rb ADDED Viewed

@@ -0,0 +1,31 @@
+module BraintreeQuery
+  class Customer < BraintreeQuery::Base
+    class << self
+      def all(options={})
+        find_all options
+      end
+      def find(vault_id, options={})
+        find_all(options.merge(:customer_vault_id => vault_id)).first
+      end
+      def find_all(options)
+        response_hash = query(options.merge('report_type' => 'customer_vault'))
+        customers = []
+        if response_hash
+          customer_hashes = response_hash['customer_vault']
+          customer_hashes = customer_hashes['customer'] if customer_hashes
+          # handle the single result scenario
+          if customer_hashes.is_a?(Hash)
+            customer_hashes = [customer_hashes]
+          end
+          customer_hashes.each do |customer_hash|
+            customers << Customer.new(customer_hash)
+          end
+        end
+        customers
+      end
+    end
+  end
+end

data/lib/braintree_query/transaction.rb CHANGED Viewed

@@ -1,11 +1,5 @@
-require 'uri'
-require 'net/https'
-require 'xmlsimple'
-require 'ostruct'
 module BraintreeQuery
-  class Transaction < OpenStruct
-    BASE_URL = "https://secure.braintreepaymentgateway.com/api/query.php"
+  class Transaction < BraintreeQuery::Base
     class << self
       def all(options={})
         find_all options
@@ -16,26 +10,9 @@ module BraintreeQuery
       end
       def find_all(options)
-        query = options.map { |k,v| "#{k}=#{v}" }.join('&')
-        full_url = [BASE_URL, query].join '?'
-        uri = URI.parse(full_url)
-        server = Net::HTTP.new uri.host, uri.port
-        server.use_ssl = uri.scheme == 'https'
-        server.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        response = server.post BASE_URL, query
-        response_hash = XmlSimple.xml_in(response.body, { 'NormaliseSpace' => 2 })
-        response_hash = massage(response_hash)
+        response_hash = query(options)
         txns = []
         if response_hash
-          if err_msg = response_hash['error_response']
-            if err_msg =~ /Invalid Username/
-              raise BraintreeQuery::CredentialError, err_msg
-            else
-              raise BraintreeQuery::Error, err_msg
-            end
-          end
           txn_hashes = response_hash['transaction']
           # handle the single result scenario
@@ -48,33 +25,6 @@ module BraintreeQuery
         end
         txns
       end
-      # stolen and trimmed from rails' Hash.from_xml
-      def massage(value)
-        case value.class.to_s
-        when 'Hash'
-          if value.size == 0
-            nil
-          else
-            xml_value = value.inject({}) do |h,(k,v)|
-              h[k] = massage(v)
-              h
-            end
-          end
-        when 'Array'
-          value.map! { |i| massage(i) }
-          case value.length
-          when 0 then nil
-          when 1 then value.first
-          else value
-          end
-        when 'String'
-          value
-        else
-          raise "can't massage #{value.class.name} - #{value.inspect}"
-        end
-      end
     end
   end
 end

data/test/test_braintree_query.rb CHANGED Viewed

@@ -9,83 +9,132 @@ class TestBraintreeQuery < Test::Unit::TestCase
     FakeWeb.allow_net_connect = false
   end
-  def test_find_within_unknown_txn_id
+  #
+  # Transaction
+  #
+  def test_find_transaction_with_unknown_txn_id
     FakeWeb.register_uri(:post, /.*/, :body => empty_transactions_xml)
-    assert_nil BraintreeQuery::Transaction.find(12345)
+    assert_nil BraintreeQuery::Transaction.find(12345, :username => 'foo', :password => 'bar')
   end
-  def test_find
+  def test_find_transaction
     FakeWeb.register_uri(:post, /.*/, :body => single_transaction_xml)
     txn_id = 1177101697
-    txn = BraintreeQuery::Transaction.find(123)
+    txn = BraintreeQuery::Transaction.find(123, :username => 'foo', :password => 'bar')
     assert_not_nil txn
     assert_equal txn_id.to_s, txn.transaction_id
     assert_equal 'Eric', txn.first_name
   end
-  def test_all
+  def test_all_transactions
     FakeWeb.register_uri(:post, /.*/, :body => multiple_transaction_xml)
-    txns = BraintreeQuery::Transaction.all
+    txns = BraintreeQuery::Transaction.all(:username => 'foo', :password => 'bar')
     assert_not_nil txns
     assert_equal 2, txns.size
     assert_equal ['1176380853', '1176380089'].sort, txns.map(&:transaction_id).sort
   end
-  def test_handles_credential_error
+  def test_transaction_handles_credential_error
     FakeWeb.register_uri(:post, /.*/, :body => error_xml)
     assert_raises BraintreeQuery::CredentialError do
-      BraintreeQuery::Transaction.all
+      BraintreeQuery::Transaction.all(:username => 'foo', :password => 'bar')
     end
   end
-  def test_handles_generic_error
+  def test_transaction_handles_generic_error
     FakeWeb.register_uri(:post, /.*/, :body => generic_error_xml)
     assert_raises BraintreeQuery::Error do
-      BraintreeQuery::Transaction.all
+      BraintreeQuery::Transaction.all(:username => 'foo', :password => 'bar')
     end
   end
-  # TODO handle the 'action' section of a transaction (can have multiple e.g. if refunded)
-  # TODO best way to do integration tests that actually hit the server?
-  #    def test_integration_find
-  #      FakeWeb.allow_net_connect = true
-  #      txn_id = 1177101697
-  #      txn = BraintreeQuery::Transaction.find(1177101697, :username => 'testapi', :password => 'password1')
-  #      assert_equal txn_id.to_s, txn.transaction_id
-  #    end
-  #
-  #    def test_integration_all_by_date_range
-  #      FakeWeb.allow_net_connect = true
-  #
-  #      # 15 minute window with three transactions
-  #      start = ['2010', '01', '20', '15', '00'].join
-  #      finish = ['2010', '01', '20', '15', '18'].join
-  #      txns = BraintreeQuery::Transaction.all(:username => 'testapi',
-  #                                             :password => 'password1',
-  #                                             :start_date => start,
-  #                                             :end_date => finish)
-  #
-  #      assert_equal 3, txns.size
-  #      assert_equal ["1177097583", "1177098339", "1177099345"].sort, txns.map(&:transaction_id).sort
-  #    end
   #
-  #    def test_integration_find_refunds
-  #      FakeWeb.allow_net_connect = true
+  # Customer
   #
-  #      # 12 hour window with two refunds
-  #      start =  ['2010', '01', '19', '00'].join
-  #      finish = ['2010', '01', '19', '12'].join
-  #      txns = BraintreeQuery::Transaction.all(:username => 'testapi',
-  #                                             :password => 'password1',
-  #                                             :start_date => start,
-  #                                             :end_date => finish,
-  #                                             :action_type => 'refund')
-  #      assert_equal 2, txns.size
-  #      assert_equal ["1176565207", "1176565239"].sort, txns.map(&:transaction_id).sort
-  #    end
+  def test_customer_find_with_unknown_cookie
+    FakeWeb.register_uri(:post, /.*/, :body => empty_customers_xml)
+    assert_nil BraintreeQuery::Customer.find(12345, :username => 'foo', :password => 'bar')
+  end
+  def test_find_customer
+    FakeWeb.register_uri(:post, /.*/, :body => single_customer_xml)
+    vault_id = '4008081888597345'
+    c = BraintreeQuery::Customer.find(vault_id, :username => 'foo', :password => 'bar')
+    assert_not_nil c
+    assert_equal vault_id.to_s, c.customer_vault_id
+    assert_equal '4xxxxxxxxxxx1111', c.cc_number
+    assert_equal '0111', c.cc_exp
+  end
+  def test_all_customers
+    FakeWeb.register_uri(:post, /.*/, :body => multiple_customers_xml)
+    customers = BraintreeQuery::Customer.all(:username => 'foo', :password => 'bar')
+    assert_not_nil customers
+    assert_equal 2, customers.size
+    assert_equal ['0111', '0112'].sort, customers.map(&:cc_exp).sort
+  end
+  def test_customer_handles_credential_error
+    FakeWeb.register_uri(:post, /.*/, :body => error_xml)
+    assert_raises BraintreeQuery::CredentialError do
+      BraintreeQuery::Customer.all(:username => 'foo', :password => 'bar')
+    end
+  end
+  def test_customer_handles_generic_error
+    FakeWeb.register_uri(:post, /.*/, :body => generic_error_xml)
+    assert_raises BraintreeQuery::Error do
+      BraintreeQuery::Customer.all(:username => 'foo', :password => 'bar')
+    end
+  end
+  # TODO handle the 'action' section of a transaction (can have multiple e.g. if refunded)
+  if false # integration
+     def test_integration_find
+       FakeWeb.allow_net_connect = true
+       txn_id = 1179747037
+       txn = BraintreeQuery::Transaction.find(txn_id, :username => 'testapi', :password => 'password1')
+       assert_equal txn_id.to_s, txn.transaction_id
+     end
+     def test_integration_all_by_date_range
+       FakeWeb.allow_net_connect = true
+       # 15 minute window with three transactions
+       # their admin interface shows in central time (-6 hours)
+       start = ['2010', '01', '27', '15', '00'].join
+       finish = ['2010', '01', '27', '15', '30'].join
+       txns = BraintreeQuery::Transaction.all(:username => 'testapi',
+                                              :password => 'password1',
+                                              :start_date => start,
+                                              :end_date => finish)
+       assert_equal 3, txns.size
+       assert_equal ["1179713614", "1179713932", '1179714121'].sort, txns.map(&:transaction_id).sort
+     end
+     def test_integration_find_refunds
+       FakeWeb.allow_net_connect = true
+       # window with two refunds
+       start =  ['2010', '01', '27', '00'].join
+       finish = ['2010', '01', '27', '03'].join
+       txns = BraintreeQuery::Transaction.all(:username => 'testapi',
+                                              :password => 'password1',
+                                              :start_date => start,
+                                              :end_date => finish,
+                                              :action_type => 'refund')
+       assert_equal 2, txns.size
+       assert_equal ['1179527112', '1179527128'].sort, txns.map(&:transaction_id).sort
+     end
+  end # integration
   protected
   def empty_transactions_xml
@@ -96,6 +145,14 @@ class TestBraintreeQuery < Test::Unit::TestCase
     EOF
   end
+  def empty_customers_xml
+    <<-EOF
+      <?xml version="1.0" encoding="UTF-8"?>
+      <nm_response>
+      </nm_response>
+    EOF
+  end
   def error_xml
     <<-EOF
       <?xml version="1.0" encoding="UTF-8"?>
@@ -351,6 +408,156 @@ class TestBraintreeQuery < Test::Unit::TestCase
     </nm_response>
     EOF
   end
+  def single_customer_xml
+    <<-EOF
+<nm_response>
+  <customer_vault>
+    <customer id=" 4008081888597345">
+      <first_name>GGH</first_name>
+      <last_name>null</last_name>
+      <address_1>5645 Main Street</address_1>
+      <address_2></address_2>
+      <company></company>
+      <city>Jacksonville</city>
+      <state>FL</state>
+      <postal_code>32209</postal_code>
+      <country>US</country>
+      <email></email>
+      <phone>null</phone>
+      <fax></fax>
+      <cell_phone></cell_phone>
+      <customertaxid></customertaxid>
+      <website></website>
+      <shipping_first_name></shipping_first_name>
+      <shipping_last_name></shipping_last_name>
+      <shipping_address_1></shipping_address_1>
+      <shipping_address_2></shipping_address_2>
+      <shipping_company></shipping_company>
+      <shipping_city></shipping_city>
+      <shipping_state></shipping_state>
+      <shipping_postal_code></shipping_postal_code>
+      <shipping_country></shipping_country>
+      <shipping_email></shipping_email>
+      <shipping_carrier></shipping_carrier>
+      <tracking_number></tracking_number>
+      <shipping_date></shipping_date>
+      <shipping></shipping>
+      <cc_number>4xxxxxxxxxxx1111</cc_number>
+      <cc_hash>b096459008ccf92840b826f531353860</cc_hash>
+      <cc_exp>0111</cc_exp>
+      <check_account></check_account>
+      <check_hash></check_hash>
+      <check_aba></check_aba>
+      <check_name></check_name>
+      <account_holder_type></account_holder_type>
+      <account_type></account_type>
+      <sec_code></sec_code>
+      <processor_id></processor_id>
+      <cc_bin>405501</cc_bin>
+      <customer_vault_id>4008081888597345</customer_vault_id>
+    </customer>
+  </customer_vault>
+</nm_response>
+    EOF
+  end
+  def multiple_customers_xml
+    <<-EOF
+<nm_response>
+  <customer_vault>
+    <customer id=" 4008081888597345">
+      <first_name>GGH</first_name>
+      <last_name>null</last_name>
+      <address_1>5645 Main Street</address_1>
+      <address_2></address_2>
+      <company></company>
+      <city>Jacksonville</city>
+      <state>FL</state>
+      <postal_code>32209</postal_code>
+      <country>US</country>
+      <email></email>
+      <phone>null</phone>
+      <fax></fax>
+      <cell_phone></cell_phone>
+      <customertaxid></customertaxid>
+      <website></website>
+      <shipping_first_name></shipping_first_name>
+      <shipping_last_name></shipping_last_name>
+      <shipping_address_1></shipping_address_1>
+      <shipping_address_2></shipping_address_2>
+      <shipping_company></shipping_company>
+      <shipping_city></shipping_city>
+      <shipping_state></shipping_state>
+      <shipping_postal_code></shipping_postal_code>
+      <shipping_country></shipping_country>
+      <shipping_email></shipping_email>
+      <shipping_carrier></shipping_carrier>
+      <tracking_number></tracking_number>
+      <shipping_date></shipping_date>
+      <shipping></shipping>
+      <cc_number>4xxxxxxxxxxx1111</cc_number>
+      <cc_hash>b096459008ccf92840b826f531353860</cc_hash>
+      <cc_exp>0111</cc_exp>
+      <check_account></check_account>
+      <check_hash></check_hash>
+      <check_aba></check_aba>
+      <check_name></check_name>
+      <account_holder_type></account_holder_type>
+      <account_type></account_type>
+      <sec_code></sec_code>
+      <processor_id></processor_id>
+      <cc_bin>405501</cc_bin>
+      <customer_vault_id> 4008081888597345</customer_vault_id>
+      </customer>
+    <customer id=" 4008081888597346">
+      <first_name>GGH</first_name>
+      <last_name>null</last_name>
+      <address_1>5645 Main Street</address_1>
+      <address_2></address_2>
+      <company></company>
+      <city>Jacksonville</city>
+      <state>FL</state>
+      <postal_code>32209</postal_code>
+      <country>US</country>
+      <email></email>
+      <phone>null</phone>
+      <fax></fax>
+      <cell_phone></cell_phone>
+      <customertaxid></customertaxid>
+      <website></website>
+      <shipping_first_name></shipping_first_name>
+      <shipping_last_name></shipping_last_name>
+      <shipping_address_1></shipping_address_1>
+      <shipping_address_2></shipping_address_2>
+      <shipping_company></shipping_company>
+      <shipping_city></shipping_city>
+      <shipping_state></shipping_state>
+      <shipping_postal_code></shipping_postal_code>
+      <shipping_country></shipping_country>
+      <shipping_email></shipping_email>
+      <shipping_carrier></shipping_carrier>
+      <tracking_number></tracking_number>
+      <shipping_date></shipping_date>
+      <shipping></shipping>
+      <cc_number>4xxxxxxxxxxx1111</cc_number>
+      <cc_hash>b096459008ccf92840b826f531353860</cc_hash>
+      <cc_exp>0112</cc_exp>
+      <check_account></check_account>
+      <check_hash></check_hash>
+      <check_aba></check_aba>
+      <check_name></check_name>
+      <account_holder_type></account_holder_type>
+      <account_type></account_type>
+      <sec_code></sec_code>
+      <processor_id></processor_id>
+      <cc_bin>405501</cc_bin>
+      <customer_vault_id> 4008081888597346</customer_vault_id>
+    </customer>
+  </customer_vault>
+</nm_response>
+    EOF
+  end
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: braintree_query
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Jeff Jolma
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-01-20 00:00:00 -05:00
+date: 2010-01-29 00:00:00 -05:00
 default_executable:
 dependencies: []
-description: Access Braintree Transactions and Vault records
+description: Access Braintree Transactions and Customers
 email: jeff@animoto.com
 executables: []
@@ -28,6 +28,8 @@ files:
 - Rakefile
 - VERSION
 - lib/braintree_query.rb
+- lib/braintree_query/base.rb
+- lib/braintree_query/customer.rb
 - lib/braintree_query/errors.rb
 - lib/braintree_query/transaction.rb
 - test/helper.rb
@@ -59,7 +61,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key:
 specification_version: 3
-summary: Client for accessing Braintree Payment Solution's reporting API.
+summary: Ruby client for accessing Braintree Payment Solution's reporting API
 test_files:
 - test/helper.rb
 - test/test_braintree_query.rb