Contents

= Braintree Ruby Client Library

The Braintree gem provides integration access to the Braintree Gateway.

== Dependencies

* builder
* libxml-ruby

== Quick Start Example

  require "rubygems"
  require "braintree"

  Braintree::Configuration.environment = :sandbox
  Braintree::Configuration.merchant_id = "the_merchant_id"
  Braintree::Configuration.public_key = "a_public_key"
  Braintree::Configuration.private_key = "a_private_key"

  transaction = Braintree::Transaction.sale!(
    :amount => "100.00",
    :credit_card => {
      :number => "5105105105105100",
      :expiration_date => "05/12"
    }
  )
  puts "Transaction ID: #{transaction.id}"
  puts "Status: #{transaction.status}"

== Bang Methods

Most methods have a bang and a non-bang version (e.g. <tt>Braintree::Customer.create</tt> and <tt>Braintree::Customer.create!</tt>).
The non-bang version will either return a +SuccessfulResult+ or an +ErrorResult+. The bang version will either return
the created or updated resource, or it will raise a ValidationsFailed exception.

Example of using non-bang method:

  result = Braintree::Customer.create!(:first_name => "Josh")
  if result.success?
    puts "Created customer #{result.customer.id}
  else
    puts "Validations failed"
    result.errors.for(:customer).each do |error|
      puts error.message
    end
  end

Example of using bang method:

  begin
    customer = Braintree::Customer.create!(:first_name => "Josh")
    puts "Created customer #{customer.id}
  rescue Braintree::ValidationsFailed
    puts "Validations failed"
  end

We recommend using the bang methods when you assume that the data is valid and do not expect validations to fail.
Otherwise, we recommend using the non-bang methods.

== Tests

The unit specs can be run by anyone on any system, but the integration specs are meant to be run against a local development
server of our gateway code.  These integration specs are not meant for public consumption and will likely fail if run on
your system.

== License

See the LICENSE file.

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
braintree-1.2.0	README.rdoc
braintree-1.1.3	README.rdoc
braintree-1.1.2	README.rdoc
braintree-1.1.1	README.rdoc