braintree_query 0.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Jolma
+
+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.

data/README.rdoc

@@ -0,0 +1,55 @@
+= braintree_query
+
+Client for accessing Braintree Payment Solution's reporting API.
+
+To see their API: http://dev.braintreepaymentsolutions.com/query/
+
+Username and password must be passed in to the finder methods (see
+examples)
+
+== Example usage
+
+  # find a specific transaction
+  txn = BraintreeQuery::Transaction.find(1177101697, :username => 'testapi', :password => 'password1')
+  txn.condition
+  #=> 'pendingsettlement'
+
+  # find transactions within a time range
+  txns = BraintreeQuery::Transaction.all(:username => 'testapi',
+                                         :password => 'password1',
+                                         :start_date => ['2010', '01', '20', '15', '00'].join,
+                                         :end_date => ['2010', '01', '20', '15', '18'].join)
+  txns.size
+  #=> 3
+  txns.map(&:condition)
+  #=> ["pending", "pending", "pendingsettlement"]
+
+  # find refunds within a time range
+  txns = BraintreeQuery::Transaction.all(:username => 'testapi',
+                                         :password => 'password1',
+                                         :start_date => ['2010', '01', '19', '00'].join,
+                                         :end_date => ['2010', '01', '19', '12'].join,
+                                         :action_type => 'refund')
+  txns.map(&:transaction_id)
+  #=> ["1176565207", "1176565239"]
+
+  txns.map(&:original_transaction_id)
+  #=> ["1176565193", "1176565221"]
+
+== TODO
+* rdoc
+* better way to do integration tests (i.e. hitting the real server)
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jeff Jolma. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+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.email = "jeff@animoto.com"
+    gem.homepage = "http://github.com/jjolma/braintree_query"
+    gem.authors = ["Jeff Jolma"]
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "braintree_query #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/braintree_query/errors.rb

@@ -0,0 +1,4 @@
+module BraintreeQuery
+  class Error < StandardError; end
+  class CredentialError < Error; end
+end

data/lib/braintree_query/transaction.rb

@@ -0,0 +1,80 @@
+require 'uri'
+require 'net/https'
+require 'xmlsimple'
+require 'ostruct'
+
+module BraintreeQuery
+  class Transaction < OpenStruct
+    BASE_URL = "https://secure.braintreepaymentgateway.com/api/query.php"
+    class << self
+      def all(options={})
+        find_all options
+      end
+
+      def find(txn_id, options={})
+        find_all(options.merge(:transaction_id => txn_id)).first
+      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)
+
+        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
+          if txn_hashes.is_a?(Hash)
+            txn_hashes = [txn_hashes]
+          end
+          txn_hashes.each do |txn_hash|
+            txns << Transaction.new(txn_hash)
+          end
+        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/lib/braintree_query.rb

@@ -0,0 +1,2 @@
+require 'braintree_query/transaction'
+require 'braintree_query/errors'

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'braintree_query'
+

data/test/test_braintree_query.rb

@@ -0,0 +1,356 @@
+require 'helper'
+
+# TODO add this as a gem requirement (at least for test mode)
+require 'fakeweb'
+
+class TestBraintreeQuery < Test::Unit::TestCase
+  def setup
+    # HTTP requests mocked out in respective tests
+    FakeWeb.allow_net_connect = false
+  end
+
+  def test_find_within_unknown_txn_id
+    FakeWeb.register_uri(:post, /.*/, :body => empty_transactions_xml)
+    assert_nil BraintreeQuery::Transaction.find(12345)
+  end
+
+  def test_find
+    FakeWeb.register_uri(:post, /.*/, :body => single_transaction_xml)
+
+    txn_id = 1177101697
+    txn = BraintreeQuery::Transaction.find(123)
+    assert_not_nil txn
+    assert_equal txn_id.to_s, txn.transaction_id
+    assert_equal 'Eric', txn.first_name
+  end
+
+  def test_all
+    FakeWeb.register_uri(:post, /.*/, :body => multiple_transaction_xml)
+
+    txns = BraintreeQuery::Transaction.all
+    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
+    FakeWeb.register_uri(:post, /.*/, :body => error_xml)
+    assert_raises BraintreeQuery::CredentialError do
+      BraintreeQuery::Transaction.all
+    end
+  end
+
+  def test_handles_generic_error
+    FakeWeb.register_uri(:post, /.*/, :body => generic_error_xml)
+    assert_raises BraintreeQuery::Error do
+      BraintreeQuery::Transaction.all
+    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
+  #
+  #      # 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
+
+  protected
+  def empty_transactions_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"?>
+      <nm_response>
+        <error_response>Invalid Username/Password REFID:201239399</error_response>
+      </nm_response>
+    EOF
+  end
+
+  def generic_error_xml
+    <<-EOF
+      <?xml version="1.0" encoding="UTF-8"?>
+      <nm_response>
+        <error_response>Some error we don't explicitely handle</error_response>
+      </nm_response>
+    EOF
+  end
+
+  def single_transaction_xml
+    <<-EOF
+      <?xml version="1.0" encoding="UTF-8"?>
+      <nm_response>
+      	<transaction>
+      		<transaction_id>1177101697</transaction_id>
+      		<platform_id></platform_id>
+      		<transaction_type>cc</transaction_type>
+      		<condition>pendingsettlement</condition>
+      		<order_id></order_id>
+      		<authorization_code>123456</authorization_code>
+      		<ponumber></ponumber>
+      		<order_description></order_description>
+      		<first_name>Eric</first_name>
+      		<last_name>Cartman</last_name>
+      		<address_1></address_1>
+      		<address_2></address_2>
+      		<company></company>
+      		<city></city>
+      		<state></state>
+      		<postal_code></postal_code>
+      		<country></country>
+      		<email></email>
+      		<phone></phone>
+      		<fax></fax>
+      		<cell_phone></cell_phone>
+      		<customertaxid></customertaxid>
+      		<customerid>906770526</customerid>
+      		<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>f6c609e195d9d4c185dcc8ca662f0180</cc_hash>
+      		<cc_exp>0614</cc_exp>
+      		<cavv></cavv>
+      		<cavv_result></cavv_result>
+      		<xid></xid>
+      		<avs_response></avs_response>
+      		<csc_response></csc_response>
+      		<cardholder_auth></cardholder_auth>
+      		<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>ccprocessora</processor_id>
+      		<tax>0.00</tax>
+      		<currency>USD</currency>
+      		<cc_bin>411111</cc_bin>
+      		<action>
+      			<amount>100.00</amount>
+      			<action_type>sale</action_type>
+      			<date>20100120152810</date>
+      			<success>1</success>
+      			<ip_address>85.50.70.53</ip_address>
+      			<source>api</source>
+      			<username>testapi</username>
+      			<response_text>SUCCESS</response_text>
+      			<batch_id>0</batch_id>
+      			<processor_batch_id></processor_batch_id>
+      		</action>
+      	</transaction>
+      </nm_response>
+      EOF
+  end
+
+  def multiple_transaction_xml
+    <<-EOF
+    <?xml version="1.0" encoding="UTF-8"?>
+    <nm_response>
+      <transaction>
+        <transaction_id>1176380089</transaction_id>
+        <platform_id></platform_id>
+        <transaction_type>cc</transaction_type>
+        <condition>pendingsettlement</condition>
+        <order_id></order_id>
+        <authorization_code>123456</authorization_code>
+        <ponumber></ponumber>
+        <order_description></order_description>
+        <first_name></first_name>
+        <last_name></last_name>
+        <address_1></address_1>
+        <address_2></address_2>
+        <company></company>
+        <city></city>
+        <state></state>
+        <postal_code></postal_code>
+        <country></country>
+        <email></email>
+        <phone></phone>
+        <fax></fax>
+        <cell_phone></cell_phone>
+        <customertaxid></customertaxid>
+        <customerid>1641772517</customerid>
+        <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>f6c609e195d9d4c185dcc8ca662f0180</cc_hash>
+        <cc_exp>1010</cc_exp>
+        <cavv></cavv>
+        <cavv_result></cavv_result>
+        <xid></xid>
+        <avs_response></avs_response>
+        <csc_response></csc_response>
+        <cardholder_auth></cardholder_auth>
+        <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>ccprocessora</processor_id>
+        <tax>0.00</tax>
+        <currency>USD</currency>
+        <cc_bin>411111</cc_bin>
+        <action>
+          <amount>1476.00</amount>
+          <action_type>sale</action_type>
+          <date>20100118171150</date>
+          <success>1</success>
+          <ip_address>208.86.238.43</ip_address>
+          <source>api</source>
+          <username>testapi</username>
+          <response_text>SUCCESS</response_text>
+          <batch_id>0</batch_id>
+          <processor_batch_id></processor_batch_id>
+        </action>
+      </transaction>
+      <transaction>
+        <transaction_id>1176380853</transaction_id>
+        <platform_id></platform_id>
+        <transaction_type>cc</transaction_type>
+        <condition>pending</condition>
+        <order_id>b08209bc-0454-11df-b21a-0800270ecde6</order_id>
+        <authorization_code>123456</authorization_code>
+        <ponumber></ponumber>
+        <order_description></order_description>
+        <first_name></first_name>
+        <last_name></last_name>
+        <address_1></address_1>
+        <address_2></address_2>
+        <company></company>
+        <city></city>
+        <state></state>
+        <postal_code>12344</postal_code>
+        <country></country>
+        <email></email>
+        <phone></phone>
+        <fax></fax>
+        <cell_phone></cell_phone>
+        <customertaxid></customertaxid>
+        <customerid>279963267</customerid>
+        <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>f6c609e195d9d4c185dcc8ca662f0180</cc_hash>
+        <cc_exp>0621</cc_exp>
+        <cavv></cavv>
+        <cavv_result></cavv_result>
+        <xid></xid>
+        <avs_response>N</avs_response>
+        <csc_response>M</csc_response>
+        <cardholder_auth></cardholder_auth>
+        <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>ccprocessora</processor_id>
+        <tax>0.00</tax>
+        <currency>USD</currency>
+        <cc_bin>411111</cc_bin>
+        <product>
+          <sku>Pages50</sku>
+          <quantity></quantity>
+          <description></description>
+          <amount></amount>
+        </product>
+        <action>
+          <amount>1.00</amount>
+          <action_type>auth</action_type>
+          <date>20100118171243</date>
+          <success>1</success>
+          <ip_address>74.73.145.54</ip_address>
+          <source>api</source>
+          <username>BraintreeTest</username>
+          <response_text>SUCCESS</response_text>
+          <batch_id>0</batch_id>
+          <processor_batch_id></processor_batch_id>
+        </action>
+      </transaction>
+    </nm_response>
+    EOF
+  end
+end
+
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: braintree_query
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jeff Jolma
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-20 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Access Braintree Transactions and Vault records
+email: jeff@animoto.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/braintree_query.rb
+- lib/braintree_query/errors.rb
+- lib/braintree_query/transaction.rb
+- test/helper.rb
+- test/test_braintree_query.rb
+has_rdoc: true
+homepage: http://github.com/jjolma/braintree_query
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Client for accessing Braintree Payment Solution's reporting API.
+test_files: 
+- test/helper.rb
+- test/test_braintree_query.rb