braintree 2.4.0 → 2.5.1

data/lib/braintree/customer.rb

@@ -1,147 +1,123 @@
 module Braintree
-  # == More Information
-  #
-  # For more detailed documentation on Customers, see http://www.braintreepaymentsolutions.com/gateway/customer-api
+  # See http://www.braintreepaymentsolutions.com/docs/ruby
   class Customer
     include BaseModule
 
     attr_reader :addresses, :company, :created_at, :credit_cards, :email, :fax, :first_name, :id, :last_name,
       :phone, :updated_at, :website, :custom_fields
 
-    # Returns a ResourceCollection of all customers stored in the vault.
-    #
-    #   customers = Braintree::Customer.all
-    #   customers.each do |customer|
-    #     puts "Customer #{customer.id} email is #{customer.email}"
-    #   end
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/search
     def self.all
-      response = Http.post "/customers/advanced_search_ids"
-      ResourceCollection.new(response) { |ids| _fetch_customers(ids) }
-    end
-
-    def self._fetch_customers(ids)
-      response = Http.post "/customers/advanced_search", {:search => {:ids => ids}}
-      attributes = response[:customers]
-      Util.extract_attribute_as_array(attributes, :customer).map { |attrs| _new(attrs) }
+      Configuration.gateway.customer.all
     end
 
-    # Creates a customer using the given +attributes+. If <tt>:id</tt> is not passed,
-    # the gateway will generate it.
-    #
-    #   result = Braintree::Customer.create(
-    #     :first_name => "John",
-    #     :last_name => "Smith",
-    #     :company => "Smith Co.",
-    #     :email => "john@smith.com",
-    #     :website => "www.smithco.com",
-    #     :fax => "419-555-1234",
-    #     :phone => "614-555-1234"
-    #   )
-    #   if result.success?
-    #     puts "Created customer #{result.customer.id}
-    #   else
-    #     puts "Could not create customer, see result.errors"
-    #   end
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/create
     def self.create(attributes = {})
-      Util.verify_keys(_create_signature, attributes)
-      _do_create "/customers", :customer => attributes
+      Configuration.gateway.customer.create(attributes)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/create
     def self.create!(attributes = {})
       return_object_or_raise(:customer) { create(attributes) }
     end
 
+    # Deprecated. Use Braintree::TransparentRedirect.url
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/create_tr
     def self.create_customer_url
       warn "[DEPRECATED] Customer.create_customer_url is deprecated. Please use TransparentRedirect.url"
-      "#{Braintree::Configuration.base_merchant_url}/customers/all/create_via_transparent_redirect_request"
+      Configuration.gateway.customer.create_customer_url
     end
 
+    # Deprecated. Use Braintree::TransparentRedirect.confirm
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/create_tr
     def self.create_from_transparent_redirect(query_string)
       warn "[DEPRECATED] Customer.create_from_transparent_redirect is deprecated. Please use TransparentRedirect.confirm"
-      params = TransparentRedirect.parse_and_validate_query_string query_string
-      _do_create("/customers/all/confirm_transparent_redirect_request", :id => params[:id])
+      Configuration.gateway.customer.create_from_transparent_redirect(query_string)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.credit(customer_id, transaction_attributes)
       Transaction.credit(transaction_attributes.merge(:customer_id => customer_id))
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.credit!(customer_id, transaction_attributes)
        return_object_or_raise(:transaction){ credit(customer_id, transaction_attributes) }
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/delete
     def self.delete(customer_id)
-      Http.delete("/customers/#{customer_id}")
-      SuccessfulResult.new
+      Configuration.gateway.customer.delete(customer_id)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/search
     def self.find(customer_id)
-      raise ArgumentError, "customer_id contains invalid characters" unless customer_id.to_s =~ /\A[\w-]+\z/
-      raise ArgumentError, "customer_id cannot be blank" if customer_id.to_s == ""
-      response = Http.get("/customers/#{customer_id}")
-      new(response[:customer])
-    rescue NotFoundError
-      raise NotFoundError, "customer with id #{customer_id.inspect} not found"
+      Configuration.gateway.customer.find(customer_id)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.sale(customer_id, transaction_attributes)
       Transaction.sale(transaction_attributes.merge(:customer_id => customer_id))
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.sale!(customer_id, transaction_attributes)
-       return_object_or_raise(:transaction){ sale(customer_id, transaction_attributes) }
+      return_object_or_raise(:transaction) { sale(customer_id, transaction_attributes) }
     end
 
     # Returns a ResourceCollection of transactions for the customer with the given +customer_id+.
     def self.transactions(customer_id, options = {})
-      response = Http.post "/customers/#{customer_id}/transaction_ids"
-      ResourceCollection.new(response) { |ids| _fetch_transactions(customer_id, ids) }
-    end
-
-    def self._fetch_transactions(customer_id, ids)
-      response = Http.post "/customers/#{customer_id}/transactions", :search => {:ids => ids}
-      attributes = response[:credit_card_transactions]
-      Util.extract_attribute_as_array(attributes, :transaction).map do |transaction_attributes|
-        Transaction._new transaction_attributes
-      end
+      Configuration.gateway.customer.transactions(customer_id, options = {})
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/update
     def self.update(customer_id, attributes)
-      Util.verify_keys(_update_signature, attributes)
-      _do_update(:put, "/customers/#{customer_id}", :customer => attributes)
+      Configuration.gateway.customer.update(customer_id, attributes)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/update
     def self.update!(customer_id, attributes)
       return_object_or_raise(:customer) { update(customer_id, attributes) }
     end
 
+    # Deprecated. Use Braintree::TransparentRedirect.url
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/update_tr
     def self.update_customer_url
       warn "[DEPRECATED] Customer.update_customer_url is deprecated. Please use TransparentRedirect.url"
-      "#{Braintree::Configuration.base_merchant_url}/customers/all/update_via_transparent_redirect_request"
+      Configuration.gateway.customer.update_customer_url
     end
 
+    # Deprecated. Use Braintree::TransparentRedirect.confirm
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/update_tr
     def self.update_from_transparent_redirect(query_string)
       warn "[DEPRECATED] Customer.update_from_transparent_redirect is deprecated. Please use TransparentRedirect.confirm"
-      params = TransparentRedirect.parse_and_validate_query_string(query_string)
-      _do_update(:post, "/customers/all/confirm_transparent_redirect_request", :id => params[:id])
+      Configuration.gateway.customer.update_from_transparent_redirect(query_string)
     end
 
-    def initialize(attributes) # :nodoc:
+    def initialize(gateway, attributes) # :nodoc:
+      @gateway = gateway
       set_instance_variables_from_hash(attributes)
-      @credit_cards = (@credit_cards || []).map { |pm| CreditCard._new pm }
-      @addresses = (@addresses || []).map { |addr| Address._new addr }
+      @credit_cards = (@credit_cards || []).map { |pm| CreditCard._new gateway, pm }
+      @addresses = (@addresses || []).map { |addr| Address._new gateway, addr }
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def credit(transaction_attributes)
-      Customer.credit(id, transaction_attributes)
+      @gateway.transaction.credit(transaction_attributes.merge(:customer_id => id))
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def credit!(transaction_attributes)
       return_object_or_raise(:transaction) { credit(transaction_attributes) }
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/delete
     def delete
-      Customer.delete(id)
+      @gateway.customer.delete(id)
     end
 
     def inspect # :nodoc:
@@ -154,35 +130,48 @@ module Braintree
       "#<#{self.class} #{nice_attributes.join(', ')}>"
     end
 
+    # Deprecated. Use Braintree::Customer.sale
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def sale(transaction_attributes)
-      Customer.sale(id, transaction_attributes)
+      warn "[DEPRECATED] sale as an instance method is deprecated. Please use CreditCard.sale"
+      @gateway.transaction.sale(transaction_attributes.merge(:customer_id => id))
     end
 
+    # Deprecated. Use Braintree::Customer.sale!
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def sale!(transaction_attributes)
+      warn "[DEPRECATED] sale! as an instance method is deprecated. Please use CreditCard.sale!"
       return_object_or_raise(:transaction) { sale(transaction_attributes) }
     end
 
     # Returns a ResourceCollection of transactions for the customer.
     def transactions(options = {})
-      Customer.transactions(id, options)
+      @gateway.customer.transactions(id, options)
     end
 
+    # Deprecated. Use Braintree::Customer.update
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/update
     def update(attributes)
-      response = Http.put "/customers/#{id}", :customer => attributes
-      if response[:customer]
-        set_instance_variables_from_hash response[:customer]
-        SuccessfulResult.new(:customer => self)
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise "expected :customer or :errors"
+      warn "[DEPRECATED] update as an instance method is deprecated. Please use CreditCard.update"
+      result = @gateway.customer.update(id, attributes)
+      if result.success?
+        copy_instance_variables_from_object result.customer
       end
+      result
     end
 
+    # Deprecated. Use Braintree::Customer.update!
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/update
     def update!(attributes)
+      warn "[DEPRECATED] update! as an instance method is deprecated. Please use CreditCard.update!"
       return_object_or_raise(:customer) { update(attributes) }
     end
 
+    # Returns true if +other+ is a Customer with the same id
     def ==(other)
       return false unless other.is_a?(Customer)
       id == other.id
@@ -192,56 +181,14 @@ module Braintree
       protected :new
     end
 
-    def self._attributes # :nodoc:
-      [
-        :addresses, :company, :credit_cards, :email, :fax, :first_name, :id, :last_name, :phone, :website,
-        :created_at, :updated_at
-      ]
-    end
-
-    def self._create_signature # :nodoc:
-      credit_card_signature = CreditCard._create_signature - [:customer_id]
-      [
-        :company, :email, :fax, :first_name, :id, :last_name, :phone, :website,
-        {:credit_card => credit_card_signature},
-        {:custom_fields => :_any_key_}
-      ]
-    end
-
-    def self._do_create(url, params=nil) # :nodoc:
-      response = Http.post url, params
-      if response[:customer]
-        SuccessfulResult.new(:customer => new(response[:customer]))
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise "expected :customer or :api_error_response"
-      end
-    end
-
-    def self._do_update(http_verb, url, params) # :nodoc:
-      response = Http.send http_verb, url, params
-      if response[:customer]
-        SuccessfulResult.new(:customer => new(response[:customer]))
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :customer or :api_error_response"
-      end
-    end
-
     def self._new(*args) # :nodoc:
       self.new *args
     end
 
-    def self._update_signature # :nodoc:
-      credit_card_signature = CreditCard._update_signature - [:customer_id]
-      credit_card_options = credit_card_signature.find { |item| item.respond_to?(:keys) && item.keys == [:options] }
-      credit_card_options[:options] << :update_existing_token
+    def self._attributes # :nodoc:
       [
-        :company, :email, :fax, :first_name, :id, :last_name, :phone, :website,
-        {:credit_card => credit_card_signature},
-        {:custom_fields => :_any_key_}
+        :addresses, :company, :credit_cards, :email, :fax, :first_name, :id, :last_name, :phone, :website,
+        :created_at, :updated_at
       ]
     end
   end

data/lib/braintree/customer_gateway.rb

@@ -0,0 +1,121 @@
+module Braintree
+  class CustomerGateway # :nodoc:
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+    end
+
+    def all
+      response = @config.http.post "/customers/advanced_search_ids"
+      ResourceCollection.new(response) { |ids| _fetch_customers(ids) }
+    end
+
+    def create(attributes = {})
+      Util.verify_keys(CustomerGateway._create_signature, attributes)
+      _do_create "/customers", :customer => attributes
+    end
+
+    # Deprecated
+    def create_customer_url
+      "#{@config.base_merchant_url}/customers/all/create_via_transparent_redirect_request"
+    end
+
+    # Deprecated
+    def create_from_transparent_redirect(query_string)
+      params = @gateway.transparent_redirect.parse_and_validate_query_string query_string
+      _do_create("/customers/all/confirm_transparent_redirect_request", :id => params[:id])
+    end
+
+    def delete(customer_id)
+      @config.http.delete("/customers/#{customer_id}")
+      SuccessfulResult.new
+    end
+
+    def find(customer_id)
+      raise ArgumentError, "customer_id contains invalid characters" unless customer_id.to_s =~ /\A[\w-]+\z/
+      raise ArgumentError, "customer_id cannot be blank" if customer_id.to_s == ""
+      response = @config.http.get("/customers/#{customer_id}")
+      Customer._new(@gateway, response[:customer])
+    rescue NotFoundError
+      raise NotFoundError, "customer with id #{customer_id.inspect} not found"
+    end
+
+    def transactions(customer_id, options = {})
+      response = @config.http.post "/customers/#{customer_id}/transaction_ids"
+      ResourceCollection.new(response) { |ids| _fetch_transactions(customer_id, ids) }
+    end
+
+    def update(customer_id, attributes)
+      Util.verify_keys(CustomerGateway._update_signature, attributes)
+      _do_update(:put, "/customers/#{customer_id}", :customer => attributes)
+    end
+
+    # Deprecated
+    def update_customer_url
+      warn "[DEPRECATED] Customer.update_customer_url is deprecated. Please use TransparentRedirect.url"
+      "#{@config.base_merchant_url}/customers/all/update_via_transparent_redirect_request"
+    end
+
+    # Deprecated
+    def update_from_transparent_redirect(query_string)
+      params = @gateway.transparent_redirect.parse_and_validate_query_string(query_string)
+      _do_update(:post, "/customers/all/confirm_transparent_redirect_request", :id => params[:id])
+    end
+
+    def self._create_signature # :nodoc:
+      credit_card_signature = CreditCardGateway._create_signature - [:customer_id]
+      [
+        :company, :email, :fax, :first_name, :id, :last_name, :phone, :website,
+        {:credit_card => credit_card_signature},
+        {:custom_fields => :_any_key_}
+      ]
+    end
+
+    def _do_create(url, params=nil) # :nodoc:
+      response = @config.http.post url, params
+      if response[:customer]
+        SuccessfulResult.new(:customer => Customer._new(@gateway, response[:customer]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise "expected :customer or :api_error_response"
+      end
+    end
+
+    def _do_update(http_verb, url, params) # :nodoc:
+      response = @config.http.send http_verb, url, params
+      if response[:customer]
+        SuccessfulResult.new(:customer => Customer._new(@gateway, response[:customer]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :customer or :api_error_response"
+      end
+    end
+
+    def _fetch_customers(ids) # :nodoc:
+      response = @config.http.post "/customers/advanced_search", {:search => {:ids => ids}}
+      attributes = response[:customers]
+      Util.extract_attribute_as_array(attributes, :customer).map { |attrs| Customer._new(@gateway, attrs) }
+    end
+
+    def _fetch_transactions(customer_id, ids) # :nodoc:
+      response = @config.http.post "/customers/#{customer_id}/transactions", :search => {:ids => ids}
+      attributes = response[:credit_card_transactions]
+      Util.extract_attribute_as_array(attributes, :transaction).map do |transaction_attributes|
+        Transaction._new @gateway, transaction_attributes
+      end
+    end
+
+    def self._update_signature # :nodoc:
+      credit_card_signature = CreditCardGateway._update_signature - [:customer_id]
+      credit_card_options = credit_card_signature.find { |item| item.respond_to?(:keys) && item.keys == [:options] }
+      credit_card_options[:options] << :update_existing_token
+      [
+        :company, :email, :fax, :first_name, :id, :last_name, :phone, :website,
+        {:credit_card => credit_card_signature},
+        {:custom_fields => :_any_key_}
+      ]
+    end
+  end
+end

data/lib/braintree/digest.rb

@@ -1,7 +1,7 @@
 module Braintree
   module Digest # :nodoc:
-    def self.hexdigest(string)
-      _hmac_sha1(Configuration.private_key, string)
+    def self.hexdigest(private_key, string)
+      _hmac_sha1(private_key, string)
     end
 
     def self._hmac_sha1(key, message)

data/lib/braintree/discount.rb

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

data/lib/braintree/error_codes.rb

@@ -3,6 +3,7 @@ module Braintree
   # The constants should be used to check for a specific validation error in a ValidationErrorCollection.
   # The error messages returned from the server may change, but the codes will remain the same.
   module ErrorCodes
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/addresses/validations
     module Address
       CannotBeBlank = "81801"
       CompanyIsTooLong = "81802"
@@ -23,6 +24,7 @@ module Braintree
       StreetAddressIsTooLong = "81812"
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/validations
     module CreditCard
       BillingAddressConflict = "91701"
       BillingAddressIdIsInvalid = "91702"
@@ -54,6 +56,7 @@ module Braintree
       end
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/customers/validations
     module Customer
       CompanyIsTooLong = "81601"
       CustomFieldIsInvalid = "91602"
@@ -64,7 +67,8 @@ module Braintree
       FaxIsTooLong = "81607"
       FirstNameIsTooLong = "81608"
       IdIsInUse = "91609"
-      IdIsInvaild = "91610"
+      IdIsInvaild = "91610" # Deprecated
+      IdIsInvalid = "91610"
       IdIsNotAllowed = "91611"
       IdIsRequired = "91613"
       IdIsTooLong = "91612"
@@ -74,10 +78,26 @@ module Braintree
       WebsiteIsTooLong = "81615"
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/subscriptions/validations
     module Subscription
+      BillingDayOfMonthCannotBeUpdated = "91918"
+      BillingDayOfMonthIsInvalid = "91914"
+      BillingDayOfMonthMustBeNumeric = "91913"
+      CannotAddDuplicateAddonOrDiscount = "91911"
       CannotEditCanceledSubscription = "81901"
-      IdIsInUse =  "81902"
+      CannotEditExpiredSubscription = "81910"
+      CannotEditPriceChangingFieldsOnPastDueSubscription = "91920"
+      FirstBillingDateCannotBeInThePast = "91916"
+      FirstBillingDateCannotBeUpdated = "91919"
+      FirstBillingDateIsInvalid = "91915"
+      IdIsInUse = "81902"
+      InconsistentNumberOfBillingCycles = "91908"
+      InconsistentStartDate = "91917"
       MerchantAccountIdIsInvalid = "91901"
+      NumberOfBillingCyclesCannotBeBlank = "91912"
+      NumberOfBillingCyclesIsTooSmall = "91909"
+      NumberOfBillingCyclesMustBeGreaterThanZero = "91907"
+      NumberOfBillingCyclesMustBeNumeric = "91906"
       PaymentMethodTokenCardTypeIsNotAccepted = "91902"
       PaymentMethodTokenIsInvalid = "91903"
       PaymentMethodTokenNotAssociatedWithCustomer = "91905"
@@ -86,16 +106,39 @@ module Braintree
       PriceFormatIsInvalid = "81904"
       StatusIsCanceled = "81905"
       TokenFormatIsInvalid = "81906"
-      TrialDurationFormatIsInvalid =  "81907"
+      TrialDurationFormatIsInvalid = "81907"
       TrialDurationIsRequired = "81908"
-      TrialDurationUnitIsInvalid =  "81909"
+      TrialDurationUnitIsInvalid = "81909"
+
+      module Modification
+        AmountCannotBeBlank = "92003"
+        AmountIsInvalid = "92002"
+        CannotEditModificationsOnPastDueSubscription = "92022"
+        CannotUpdateAndRemove = "92015"
+        ExistingIdIsIncorrectKind = "92020"
+        ExistingIdIsInvalid = "92011"
+        ExistingIdIsRequired = "92012"
+        IdToRemoveIsIncorrectKind = "92021"
+        IdToRemoveIsNotPresent = "92016"
+        InconsistentNumberOfBillingCycles = "92018"
+        InheritedFromIdIsInvalid = "92013"
+        InheritedFromIdIsRequired = "92014"
+        NumberOfBillingCyclesCannotBeBlank = "92017"
+        NumberOfBillingCyclesIsInvalid = "92005"
+        NumberOfBillingCyclesMustBeGreaterThanZero = "92019"
+        QuantityCannotBeBlank = "92004"
+        QuantityIsInvalid = "92001"
+        QuantityMustBeGreaterThanZero = "92010"
+      end
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/validations
     module Transaction
       AmountCannotBeNegative = "81501"
       AmountIsRequired = "81502"
       AmountIsInvalid = "81503"
       AmountIsTooLarge = "81528"
+      AmountMustBeGreaterThanZero = "81531"
       BillingAddressConflict = "91530"
       CannotBeVoided = "91504"
       CannotRefundCredit = "91505"
@@ -108,7 +151,8 @@ module Braintree
       CustomerIdIsInvalid = "91510"
       CustomerDoesNotHaveCreditCard = "91511"
       HasAlreadyBeenRefunded = "91512"
-      MerchantAccountNameIsInvalid = "91513"
+      MerchantAccountIdIsInvalid = "91513"
+      MerchantAccountNameIsInvalid = "91513" # Deprecated
       MerchantAccountIsSuspended = "91514"
       OrderIdIsTooLong = "91501"
       PaymentMethodConflict = "91515"
@@ -122,6 +166,7 @@ module Braintree
       SettlementAmountIsTooLarge = "91522"
       SubscriptionDoesNotBelongToCustomer = "91529"
       SubscriptionIdIsInvalid = "91528"
+      SubscriptionStatusMustBePastDue = "91531"
       TypeIsInvalid = "91523"
       TypeIsRequired = "91524"
       module Options