braintree 2.4.0 → 2.5.1

data/README.rdoc

@@ -65,6 +65,10 @@ Example of using bang method:
 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.
 
+== More Information
+
+* Documentation[http://www.braintreepaymentsolutions.com/docs/ruby]
+
 == 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

data/lib/braintree.rb

@@ -3,6 +3,7 @@ require "cgi"
 require "date"
 require "digest/sha1"
 require "enumerator"
+require "forwardable"
 require "logger"
 require "net/http"
 require "net/https"
@@ -18,41 +19,51 @@ end
 
 require "braintree/exceptions"
 require "braintree/base_module"
+require "braintree/modification"
 
-require "braintree/address.rb"
-require "braintree/advanced_search.rb"
-require "braintree/configuration.rb"
-require "braintree/credit_card.rb"
-require "braintree/credit_card_verification.rb"
-require "braintree/customer.rb"
-require "braintree/digest.rb"
-require "braintree/error_codes.rb"
-require "braintree/error_result.rb"
-require "braintree/errors.rb"
-require "braintree/http.rb"
-require "braintree/resource_collection.rb"
-require "braintree/ssl_expiration_check.rb"
+require "braintree/add_on"
+require "braintree/address"
+require "braintree/address_gateway"
+require "braintree/advanced_search"
+require "braintree/configuration"
+require "braintree/credit_card"
+require "braintree/credit_card_gateway"
+require "braintree/credit_card_verification"
+require "braintree/customer"
+require "braintree/customer_gateway"
+require "braintree/digest"
+require "braintree/discount"
+require "braintree/error_codes"
+require "braintree/error_result"
+require "braintree/errors"
+require "braintree/gateway"
+require "braintree/http"
+require "braintree/resource_collection"
+require "braintree/ssl_expiration_check"
 require "braintree/subscription"
+require "braintree/subscription_gateway"
 require "braintree/subscription_search"
-require "braintree/successful_result.rb"
-require "braintree/test/credit_card_numbers.rb"
-require "braintree/test/transaction_amounts.rb"
-require "braintree/transaction.rb"
-require "braintree/transaction_search.rb"
-require "braintree/transaction/address_details.rb"
-require "braintree/transaction/credit_card_details.rb"
-require "braintree/transaction/customer_details.rb"
-require "braintree/transaction/status_details.rb"
-require "braintree/transparent_redirect.rb"
-require "braintree/util.rb"
-require "braintree/validation_error.rb"
-require "braintree/validation_error_collection.rb"
-require "braintree/version.rb"
-require "braintree/xml.rb"
-require "braintree/xml/generator.rb"
-require "braintree/xml/libxml.rb"
-require "braintree/xml/rexml.rb"
-require "braintree/xml/parser.rb"
+require "braintree/successful_result"
+require "braintree/test/credit_card_numbers"
+require "braintree/test/transaction_amounts"
+require "braintree/transaction"
+require "braintree/transaction/address_details"
+require "braintree/transaction/credit_card_details"
+require "braintree/transaction/customer_details"
+require "braintree/transaction_gateway"
+require "braintree/transaction_search"
+require "braintree/transaction/status_details"
+require "braintree/transparent_redirect"
+require "braintree/transparent_redirect_gateway"
+require "braintree/util"
+require "braintree/validation_error"
+require "braintree/validation_error_collection"
+require "braintree/version"
+require "braintree/xml"
+require "braintree/xml/generator"
+require "braintree/xml/libxml"
+require "braintree/xml/rexml"
+require "braintree/xml/parser"
 
 Braintree::SSLExpirationCheck.check_dates
 

data/lib/braintree/add_on.rb

@@ -0,0 +1,4 @@
+module Braintree
+  class AddOn < Modification
+  end
+end

data/lib/braintree/address.rb

@@ -1,7 +1,5 @@
 module Braintree
-  # An Address belongs to a Customer. It can be associated to a
-  # CreditCard as the billing address. It can also be used
-  # as the shipping address when creating a Transaction.
+  # See http://www.braintreepaymentsolutions.com/docs/ruby/addresses/details
   class Address
     include BaseModule # :nodoc:
 
@@ -10,21 +8,7 @@ module Braintree
       :country_code_alpha2, :country_code_alpha3, :country_code_numeric
 
     def self.create(attributes)
-      Util.verify_keys(_create_signature, attributes)
-      unless attributes[:customer_id]
-        raise ArgumentError, "Expected hash to contain a :customer_id"
-      end
-      unless attributes[:customer_id] =~ /\A[0-9A-Za-z_-]+\z/
-        raise ArgumentError, ":customer_id contains invalid characters"
-      end
-      response = Http.post "/customers/#{attributes.delete(:customer_id)}/addresses", :address => attributes
-      if response[:address]
-        SuccessfulResult.new(:address => new(response[:address]))
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :address or :api_error_response"
-      end
+      Configuration.gateway.address.create(attributes)
     end
 
     def self.create!(attributes)
@@ -32,39 +16,23 @@ module Braintree
     end
 
     def self.delete(customer_or_customer_id, address_id)
-      customer_id = _determine_customer_id(customer_or_customer_id)
-      Http.delete("/customers/#{customer_id}/addresses/#{address_id}")
-      SuccessfulResult.new
+      Configuration.gateway.address.delete(customer_or_customer_id, address_id)
     end
 
-    # Finds the address with the given +address_id+ that is associated to the given +customer_or_customer_id+.
-    # If the address cannot be found, a NotFoundError will be raised.
     def self.find(customer_or_customer_id, address_id)
-      customer_id = _determine_customer_id(customer_or_customer_id)
-      response = Http.get("/customers/#{customer_id}/addresses/#{address_id}")
-      new(response[:address])
-    rescue NotFoundError
-      raise NotFoundError, "address for customer #{customer_id.inspect} with id #{address_id.inspect} not found"
+      Configuration.gateway.address.find(customer_or_customer_id, address_id)
     end
 
     def self.update(customer_or_customer_id, address_id, attributes)
-      Util.verify_keys(_update_signature, attributes)
-      customer_id = _determine_customer_id(customer_or_customer_id)
-      response = Http.put "/customers/#{customer_id}/addresses/#{address_id}", :address => attributes
-      if response[:address]
-        SuccessfulResult.new(:address => new(response[:address]))
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :address or :api_error_response"
-      end
+      Configuration.gateway.address.update(customer_or_customer_id, address_id, attributes)
     end
 
     def self.update!(customer_or_customer_id, address_id, attributes)
       return_object_or_raise(:address) { update(customer_or_customer_id, address_id, attributes) }
     end
 
-    def initialize(attributes) # :nodoc:
+    def initialize(gateway, attributes) # :nodoc:
+      @gateway = gateway
       set_instance_variables_from_hash(attributes)
     end
 
@@ -73,25 +41,25 @@ module Braintree
       id == other.id && customer_id == other.customer_id
     end
 
-    # Deletes the address.
+    # Deprecated. Use Braintree::Address.delete
     def delete
-      Address.delete(customer_id, self.id)
+      warn "[DEPRECATED] delete as an instance method is deprecated. Please use CreditCard.delete"
+      @gateway.address.delete(customer_id, self.id)
     end
 
+    # Deprecated. Use Braintree::Address.update
     def update(attributes)
-      Util.verify_keys(self.class._update_signature, attributes)
-      response = Http.put "/customers/#{customer_id}/addresses/#{id}", :address => attributes
-      if response[:address]
-        set_instance_variables_from_hash response[:address]
-        SuccessfulResult.new(:address => self)
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :address or :api_error_response"
+      warn "[DEPRECATED] update as an instance method is deprecated. Please use CreditCard.update"
+      result = @gateway.address.update(customer_id, id, attributes)
+      if result.success?
+        copy_instance_variables_from_object result.address
       end
+      result
     end
 
+    # Deprecated. Use Braintree::Address.update!
     def update!(attributes)
+      warn "[DEPRECATED] update! as an instance method is deprecated. Please use CreditCard.update!"
       return_object_or_raise(:address) { update(attributes) }
     end
 
@@ -99,30 +67,8 @@ module Braintree
       protected :new
     end
 
-    def self._create_signature # :nodoc:
-      _shared_signature + [:customer_id]
-    end
-
-    def self._determine_customer_id(customer_or_customer_id) # :nodoc:
-      customer_id = customer_or_customer_id.is_a?(Customer) ? customer_or_customer_id.id : customer_or_customer_id
-      unless customer_id =~ /\A[\w_-]+\z/
-        raise ArgumentError, "customer_id contains invalid characters"
-      end
-      customer_id
-    end
-
-    def self._shared_signature # :nodoc:
-      [:company, :country_code_alpha2, :country_code_alpha3, :country_code_numeric,
-        :country_name, :extended_address, :first_name,
-        :last_name, :locality, :postal_code, :region, :street_address]
-    end
-
     def self._new(*args) # :nodoc:
       self.new *args
     end
-
-    def self._update_signature # :nodoc:
-      _create_signature
-    end
   end
 end

data/lib/braintree/address_gateway.rb

@@ -0,0 +1,76 @@
+module Braintree
+  class AddressGateway # :nodoc
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+    end
+
+    def create(attributes)
+      Util.verify_keys(AddressGateway._create_signature, attributes)
+      unless attributes[:customer_id]
+        raise ArgumentError, "Expected hash to contain a :customer_id"
+      end
+      unless attributes[:customer_id] =~ /\A[0-9A-Za-z_-]+\z/
+        raise ArgumentError, ":customer_id contains invalid characters"
+      end
+      response = @config.http.post "/customers/#{attributes.delete(:customer_id)}/addresses", :address => attributes
+      if response[:address]
+        SuccessfulResult.new(:address => Address._new(@gateway, response[:address]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :address or :api_error_response"
+      end
+    end
+
+    def delete(customer_or_customer_id, address_id)
+      customer_id = _determine_customer_id(customer_or_customer_id)
+      @config.http.delete("/customers/#{customer_id}/addresses/#{address_id}")
+      SuccessfulResult.new
+    end
+
+    def find(customer_or_customer_id, address_id)
+      customer_id = _determine_customer_id(customer_or_customer_id)
+      response = @config.http.get("/customers/#{customer_id}/addresses/#{address_id}")
+      Address._new(@gateway, response[:address])
+    rescue NotFoundError
+      raise NotFoundError, "address for customer #{customer_id.inspect} with id #{address_id.inspect} not found"
+    end
+
+    def update(customer_or_customer_id, address_id, attributes)
+      Util.verify_keys(AddressGateway._update_signature, attributes)
+      customer_id = _determine_customer_id(customer_or_customer_id)
+      response = @config.http.put "/customers/#{customer_id}/addresses/#{address_id}", :address => attributes
+      if response[:address]
+        SuccessfulResult.new(:address => Address._new(@gateway, response[:address]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :address or :api_error_response"
+      end
+    end
+
+    def _determine_customer_id(customer_or_customer_id) # :nodoc:
+      customer_id = customer_or_customer_id.is_a?(Customer) ? customer_or_customer_id.id : customer_or_customer_id
+      unless customer_id =~ /\A[\w_-]+\z/
+        raise ArgumentError, "customer_id contains invalid characters"
+      end
+      customer_id
+    end
+
+    def self._create_signature # :nodoc:
+      _shared_signature + [:customer_id]
+    end
+
+    def self._shared_signature # :nodoc:
+      [:company, :country_code_alpha2, :country_code_alpha3, :country_code_numeric,
+        :country_name, :extended_address, :first_name,
+        :last_name, :locality, :postal_code, :region, :street_address]
+    end
+
+    def self._update_signature # :nodoc:
+      _create_signature
+    end
+  end
+end
+

data/lib/braintree/advanced_search.rb

@@ -1,6 +1,6 @@
 module Braintree
-  class AdvancedSearch
-    class SearchNode
+  class AdvancedSearch # :nodoc:
+    class SearchNode # :nodoc:
       def self.operators(*operator_names)
         operator_names.each do |operator|
           define_method(operator) do |value|
@@ -14,25 +14,25 @@ module Braintree
       end
     end
 
-    class EqualityNode < SearchNode
+    class EqualityNode < SearchNode # :nodoc:
       operators :is, :is_not
     end
 
-    class PartialMatchNode < EqualityNode
+    class PartialMatchNode < EqualityNode # :nodoc:
       operators :ends_with, :starts_with
     end
 
-    class TextNode < PartialMatchNode
+    class TextNode < PartialMatchNode # :nodoc:
       operators :contains
     end
 
-    class KeyValueNode < SearchNode
+    class KeyValueNode < SearchNode # :nodoc:
       def is(value)
         @parent.add_criteria(@node_name, value)
       end
     end
 
-    class MultipleValueNode < SearchNode
+    class MultipleValueNode < SearchNode # :nodoc:
       def in(*values)
         values.flatten!
 
@@ -44,10 +44,6 @@ module Braintree
         @parent.add_criteria(@node_name, values)
       end
 
-      def is(value)
-        self.in(value)
-      end
-
       def initialize(name, parent, options)
         super(name, parent)
         @options = options
@@ -56,9 +52,25 @@ module Braintree
       def allowed_values
         @options[:allows]
       end
+
+      def is(value)
+        self.in(value)
+      end
+    end
+
+    class MultipleValueOrTextNode < MultipleValueNode
+      extend Forwardable
+      def_delegators :@text_node, :contains, :ends_with, :is, :is_not, :starts_with
+
+      def initialize(name, parent, options)
+        super
+        @text_node = TextNode.new(name, parent)
+      end
     end
 
-    class RangeNode < SearchNode
+    class RangeNode < SearchNode # :nodoc:
+      operators :is
+
       def between(min, max)
         self >= min
         self <= max
@@ -73,7 +85,7 @@ module Braintree
       end
     end
 
-    def self.search_fields(*fields)
+    def self.text_fields(*fields)
       _create_field_accessors(fields, TextNode)
     end
 
@@ -91,6 +103,12 @@ module Braintree
       end
     end
 
+    def self.multiple_value_or_text_field(field, options={})
+      define_method(field) do
+        MultipleValueOrTextNode.new(field, self, options)
+      end
+    end
+
     def self.key_value_fields(*fields)
       _create_field_accessors(fields, KeyValueNode)
     end

data/lib/braintree/base_module.rb

@@ -10,6 +10,12 @@ module Braintree
         end
       end
 
+      def copy_instance_variables_from_object(object)
+        object.instance_variables.each do |ivar|
+          instance_variable_set ivar, object.instance_variable_get(ivar)
+        end
+      end
+
       def set_instance_variables_from_hash(hash)
         hash.each do |key, value|
           instance_variable_set "@#{key}", value

data/lib/braintree/configuration.rb

@@ -1,19 +1,12 @@
 module Braintree
-  # The following configuration attributes need to be set to use the gem:
-  # * merchant_id
-  # * public_key
-  # * private_key
-  # * environment
-  #
-  # By default, the logger will log to +STDOUT+. The log level is set to info.
-  # The logger can be set to any Logger object.
-  module Configuration
+  # See http://www.braintreepaymentsolutions.com/docs/ruby
+  class Configuration
     API_VERSION = "2" # :nodoc:
 
     class << self
-      attr_accessor :logger
-      attr_writer :merchant_id, :public_key, :private_key
+      attr_writer :custom_user_agent, :logger, :merchant_id, :public_key, :private_key
     end
+    attr_reader :logger, :merchant_id, :public_key, :private_key
 
     def self.expectant_reader(*attributes) # :nodoc:
       attributes.each do |attribute|
@@ -26,16 +19,53 @@ module Braintree
     end
     expectant_reader :environment, :merchant_id, :public_key, :private_key
 
-    def self.base_merchant_url # :nodoc:
-      "#{protocol}://#{server}:#{port}#{base_merchant_path}"
+    # Sets the Braintree environment to use. Valid values are <tt>:sandbox</tt> and <tt>:production</tt>
+    def self.environment=(env)
+      unless [:development, :qa, :sandbox, :production].include?(env)
+        raise ArgumentError, "#{env.inspect} is not a valid environment"
+      end
+      @environment = env
+    end
+
+    def self.gateway # :nodoc:
+      Braintree::Gateway.new(instantiate)
+    end
+
+    def self.instantiate # :nodoc:
+      config = new(
+        :custom_user_agent => @custom_user_agent,
+        :environment => environment,
+        :logger => logger,
+        :merchant_id => merchant_id,
+        :private_key => private_key,
+        :public_key => public_key
+      )
+    end
+
+    def self.logger
+      @logger ||= _default_logger
+    end
+
+    def initialize(options = {})
+      [:environment, :merchant_id, :public_key, :private_key, :custom_user_agent, :logger].each do |attr|
+        instance_variable_set "@#{attr}", options[attr]
+      end
     end
 
-    def self.base_merchant_path # :nodoc:
-      "/merchants/#{Braintree::Configuration.merchant_id}"
+    def api_version # :nodoc:
+      API_VERSION
     end
 
-    def self.ca_file # :nodoc:
-      case environment
+    def base_merchant_path # :nodoc:
+      "/merchants/#{merchant_id}"
+    end
+
+    def base_merchant_url # :nodoc:
+      "#{protocol}://#{server}:#{port}#{base_merchant_path}"
+    end
+
+    def ca_file # :nodoc:
+      case @environment
       when :qa, :sandbox
         File.expand_path(File.join(File.dirname(__FILE__), "..", "ssl", "sandbox_braintreegateway_com.ca.crt"))
       when :production
@@ -43,20 +73,12 @@ module Braintree
       end
     end
 
-    # Sets the Braintree environment to use. Valid values are <tt>:sandbox</tt> and <tt>:production</tt>
-    def self.environment=(env)
-      unless [:development, :qa, :sandbox, :production].include?(env)
-        raise ArgumentError, "#{env.inspect} is not a valid environment"
-      end
-      @environment = env
-    end
-
-    def self.logger # :nodoc:
-      @logger ||= _default_logger
+    def http # :nodoc:
+      Http.new(self)
     end
 
-    def self.port # :nodoc:
-      case environment
+    def port # :nodoc:
+      case @environment
       when :development
         ENV['GATEWAY_PORT'] || 3000
       when :production, :qa, :sandbox
@@ -64,12 +86,12 @@ module Braintree
       end
     end
 
-    def self.protocol # :nodoc:
+    def protocol # :nodoc:
       ssl? ? "https" : "http"
     end
 
-    def self.server # :nodoc:
-      case environment
+    def server # :nodoc:
+      case @environment
       when :development
         "localhost"
       when :production
@@ -81,8 +103,8 @@ module Braintree
       end
     end
 
-    def self.ssl? # :nodoc:
-      case environment
+    def ssl? # :nodoc:
+      case @environment
       when :development
         false
       when :production, :qa, :sandbox
@@ -90,11 +112,7 @@ module Braintree
       end
     end
 
-    def self.custom_user_agent=(custom_user_agent)
-      @custom_user_agent = custom_user_agent
-    end
-
-    def self.user_agent
+    def user_agent # :nodoc:
       base_user_agent = "Braintree Ruby Gem #{Braintree::Version::String}"
       @custom_user_agent ? "#{base_user_agent} (#{@custom_user_agent})" : base_user_agent
     end