braintree 2.4.0 → 2.5.1

data/lib/braintree/credit_card.rb

@@ -1,8 +1,5 @@
 module Braintree
-  # == More Information
-  #
-  # For more detailed documentation on CreditCards, see http://www.braintreepaymentsolutions.com/gateway/credit-card-api
-  # For more detailed documentation on CreditCard verification, see http://www.braintreepaymentsolutions.com/gateway/credit-card-verification-api
+  # See http://www.braintreepaymentsolutions.com/docs/ruby
   class CreditCard
     include BaseModule # :nodoc:
 
@@ -32,131 +29,125 @@ module Braintree
     attr_reader :billing_address, :bin, :card_type, :cardholder_name, :created_at, :customer_id, :expiration_month,
       :expiration_year, :last_4, :subscriptions, :token, :updated_at
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create
     def self.create(attributes)
-      if attributes.has_key?(:expiration_date) && (attributes.has_key?(:expiration_month) || attributes.has_key?(:expiration_year))
-        raise ArgumentError.new("create with both expiration_month and expiration_year or only expiration_date")
-      end
-      Util.verify_keys(_create_signature, attributes)
-      _do_create("/payment_methods", :credit_card => attributes)
+      Configuration.gateway.credit_card.create(attributes)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create
     def self.create!(attributes)
       return_object_or_raise(:credit_card) { create(attributes) }
     end
 
-    # The transparent redirect URL to use to create a credit card.
+    # Deprecated. Use Braintree::TransparentRedirect.url
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create_tr
     def self.create_credit_card_url
       warn "[DEPRECATED] CreditCard.create_credit_card_url is deprecated. Please use TransparentRedirect.url"
-      "#{Braintree::Configuration.base_merchant_url}/payment_methods/all/create_via_transparent_redirect_request"
+      Configuration.gateway.credit_card.create_credit_card_url
     end
 
+    # Deprecated. Use Braintree::TransparentRedirect.confirm
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/create_tr
     def self.create_from_transparent_redirect(query_string)
       warn "[DEPRECATED] CreditCard.create_from_transparent_redirect is deprecated. Please use TransparentRedirect.confirm"
-      params = TransparentRedirect.parse_and_validate_query_string query_string
-      _do_create("/payment_methods/all/confirm_transparent_redirect_request", :id => params[:id])
+      Configuration.gateway.credit_card.create_from_transparent_redirect(query_string)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.credit(token, transaction_attributes)
-      Transaction.credit(transaction_attributes.merge(
-        :payment_method_token => token
-      ))
+      Transaction.credit(transaction_attributes.merge(:payment_method_token => token))
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.credit!(token, transaction_attributes)
       return_object_or_raise(:transaction) { credit(token, transaction_attributes) }
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/delete
     def self.delete(token)
-      Http.delete("/payment_methods/#{token}")
+      Configuration.gateway.credit_card.delete(token)
     end
 
-    # Returns a ResourceCollection of expired credit cards.
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/search
     def self.expired(options = {})
-      response = Http.post("/payment_methods/all/expired_ids")
-      ResourceCollection.new(response) { |ids| _fetch_expired(ids) }
+      Configuration.gateway.credit_card.expired(options)
     end
 
-    # Returns a ResourceCollection of credit cards expiring between +start_date+ and +end_date+ inclusive.
-    # Only the month and year of the start and end dates are used.
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/search
     def self.expiring_between(start_date, end_date, options = {})
-      formatted_start_date = start_date.strftime('%m%Y')
-      formatted_end_date = end_date.strftime('%m%Y')
-      response = Http.post("/payment_methods/all/expiring_ids?start=#{formatted_start_date}&end=#{formatted_end_date}")
-      ResourceCollection.new(response) { |ids| _fetch_expiring_between(formatted_start_date, formatted_end_date, ids) }
+      Configuration.gateway.credit_card.expiring_between(start_date, end_date, options)
     end
 
-    # Finds the credit card with the given +token+. Raises a NotFoundError if it cannot be found.
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/search
     def self.find(token)
-      response = Http.get "/payment_methods/#{token}"
-      new(response[:credit_card])
-    rescue NotFoundError
-      raise NotFoundError, "payment method with token #{token.inspect} not found"
+      Configuration.gateway.credit_card.find(token)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.sale(token, transaction_attributes)
-      Transaction.sale(transaction_attributes.merge(
-        :payment_method_token => token
-      ))
+      Configuration.gateway.transaction.sale(transaction_attributes.merge(:payment_method_token => token))
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def self.sale!(token, transaction_attributes)
       return_object_or_raise(:transaction) { sale(token, transaction_attributes) }
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
     def self.update(token, attributes)
-      Util.verify_keys(_update_signature, attributes)
-      _do_update(:put, "/payment_methods/#{token}", :credit_card => attributes)
+      Configuration.gateway.credit_card.update(token, attributes)
     end
 
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
     def self.update!(token, attributes)
       return_object_or_raise(:credit_card) { update(token, attributes) }
     end
 
+    # Deprecated. Use Braintree::TransparentRedirect.confirm
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update_tr
     def self.update_from_transparent_redirect(query_string)
       warn "[DEPRECATED] CreditCard.update_via_transparent_redirect_request is deprecated. Please use TransparentRedirect.confirm"
-      params = TransparentRedirect.parse_and_validate_query_string query_string
-      _do_update(:post, "/payment_methods/all/confirm_transparent_redirect_request", :id => params[:id])
+      Configuration.gateway.credit_card.update_from_transparent_redirect(query_string)
     end
 
-    # The transparent redirect URL to use to update a credit card.
+    # Deprecated. Use Braintree::TransparentRedirect.url
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update_tr
     def self.update_credit_card_url
       warn "[DEPRECATED] CreditCard.update_credit_card_url is deprecated. Please use TransparentRedirect.url"
-      "#{Braintree::Configuration.base_merchant_url}/payment_methods/all/update_via_transparent_redirect_request"
-    end
-
-    def self._fetch_expired(ids)
-      response = Http.post("/payment_methods/all/expired", :search => {:ids => ids})
-      attributes = response[:payment_methods]
-      Util.extract_attribute_as_array(attributes, :credit_card).map { |attrs| _new(attrs) }
+      Configuration.gateway.credit_card.update_credit_card_url
     end
 
-    def self._fetch_expiring_between(formatted_start_date, formatted_end_date, ids)
-      response = Http.post(
-        "/payment_methods/all/expiring?start=#{formatted_start_date}&end=#{formatted_end_date}",
-        :search => {:ids => ids}
-      )
-      attributes = response[:payment_methods]
-      Util.extract_attribute_as_array(attributes, :credit_card).map { |attrs| _new(attrs) }
-    end
-
-    def initialize(attributes) # :nodoc:
-      _init attributes
-      @subscriptions = (@subscriptions || []).map { |subscription_hash| Subscription._new(subscription_hash) }
+    def initialize(gateway, attributes) # :nodoc:
+      @gateway = gateway
+      set_instance_variables_from_hash(attributes)
+      @billing_address = attributes[:billing_address] ? Address._new(@gateway, attributes[:billing_address]) : nil
+      @subscriptions = (@subscriptions || []).map { |subscription_hash| Subscription._new(@gateway, subscription_hash) }
     end
 
-    # Creates a credit transaction for this credit card.
+    # Deprecated. Use Braintree::CreditCard.credit
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def credit(transaction_attributes)
-      Transaction.credit(transaction_attributes.merge(
-        :payment_method_token => self.token
-      ))
+      warn "[DEPRECATED] credit as an instance method is deprecated. Please use CreditCard.credit"
+      @gateway.transaction.credit(transaction_attributes.merge(:payment_method_token => token))
     end
 
+    # Deprecated. Use Braintree::CreditCard.credit!
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def credit!(transaction_attributes)
+      warn "[DEPRECATED] credit! as an instance method is deprecated. Please use CreditCard.credit!"
       return_object_or_raise(:transaction) { credit(transaction_attributes) }
     end
 
+    # Deprecated. Use Braintree::CreditCard.delete
+    #
+    # http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/delete
     def delete
-      CreditCard.delete(token)
+      warn "[DEPRECATED] delete as an instance method is deprecated. Please use CreditCard.delete"
+      @gateway.credit_card.delete(token)
     end
 
     # Returns true if this credit card is the customer's default.
@@ -187,29 +178,39 @@ module Braintree
       "#{bin}******#{last_4}"
     end
 
-    # Creates a sale transaction for this credit card.
+    # Deprecated. Use Braintree::CreditCard.sale
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/transactions/create_from_vault
     def sale(transaction_attributes)
-      CreditCard.sale(self.token, transaction_attributes)
+      warn "[DEPRECATED] sale as an instance method is deprecated. Please use CreditCard.sale"
+      @gateway.transaction.sale(transaction_attributes.merge(:payment_method_token => token))
     end
 
+    # Deprecated. Use Braintree::CreditCard.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
 
+    # Deprecated. Use Braintree::CreditCard.update
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
     def update(attributes)
-      Util.verify_keys(self.class._update_signature, attributes)
-      response = Http.put "/payment_methods/#{token}", :credit_card => attributes
-      if response[:credit_card]
-        _init response[:credit_card]
-        SuccessfulResult.new(:credit_card => self)
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :credit_card or :api_error_response"
+      warn "[DEPRECATED] update as an instance method is deprecated. Please use CreditCard.update"
+      result = @gateway.credit_card.update(token, attributes)
+      if result.success?
+        copy_instance_variables_from_object result.credit_card
       end
+      result
     end
 
+    # Deprecated. Use Braintree::CreditCard.update!
+    #
+    # See http://www.braintreepaymentsolutions.com/docs/ruby/credit_cards/update
     def update!(attributes)
+      warn "[DEPRECATED] update! as an instance method is deprecated. Please use CreditCard.update!"
       return_object_or_raise(:credit_card) { update(attributes) }
     end
 
@@ -230,63 +231,8 @@ module Braintree
       ]
     end
 
-    def self._create_signature # :nodoc:
-      _signature(:create)
-    end
-
     def self._new(*args) # :nodoc:
       self.new *args
     end
-
-    def self._do_create(url, params=nil) # :nodoc:
-      response = Http.post url, params
-      if response[:credit_card]
-        SuccessfulResult.new(:credit_card => new(response[:credit_card]))
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :credit_card or :api_error_response"
-      end
-    end
-
-    def self._do_update(http_verb, url, params) # :nodoc:
-      response = Http.send http_verb, url, params
-      if response[:credit_card]
-        SuccessfulResult.new(:credit_card => new(response[:credit_card]))
-      elsif response[:api_error_response]
-        ErrorResult.new(response[:api_error_response])
-      else
-        raise UnexpectedError, "expected :credit_card or :api_error_response"
-      end
-    end
-
-    def self._update_signature # :nodoc:
-      _signature(:update)
-    end
-
-    def self._signature(type) # :nodoc:
-      billing_address_params = Address._shared_signature
-      signature = [
-        :cardholder_name, :cvv, :expiration_date, :expiration_month, :expiration_year, :number, :token,
-        {:options => [:make_default, :verification_merchant_account_id, :verify_card]},
-        {:billing_address => billing_address_params}
-      ]
-
-      case type
-      when :create
-        signature << :customer_id
-      when :update
-        billing_address_params << {:options => [:update_existing]}
-      else
-        raise ArgumentError
-      end
-
-      return signature
-    end
-
-    def _init(attributes) # :nodoc:
-      set_instance_variables_from_hash(attributes)
-      @billing_address = attributes[:billing_address] ? Address._new(attributes[:billing_address]) : nil
-    end
   end
 end

data/lib/braintree/credit_card_gateway.rb

@@ -0,0 +1,133 @@
+module Braintree
+  class CreditCardGateway # :nodoc:
+    def initialize(gateway)
+      @gateway = gateway
+      @config = gateway.config
+    end
+
+    def create(attributes)
+      if attributes.has_key?(:expiration_date) && (attributes.has_key?(:expiration_month) || attributes.has_key?(:expiration_year))
+        raise ArgumentError.new("create with both expiration_month and expiration_year or only expiration_date")
+      end
+      Util.verify_keys(CreditCardGateway._create_signature, attributes)
+      _do_create("/payment_methods", :credit_card => attributes)
+    end
+
+    # Deprecated
+    def create_credit_card_url
+      "#{@config.base_merchant_url}/payment_methods/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("/payment_methods/all/confirm_transparent_redirect_request", :id => params[:id])
+    end
+
+    def delete(token)
+      @config.http.delete("/payment_methods/#{token}")
+    end
+
+    def expired(options = {})
+      response = @config.http.post("/payment_methods/all/expired_ids")
+      ResourceCollection.new(response) { |ids| _fetch_expired(ids) }
+    end
+
+    def expiring_between(start_date, end_date, options = {})
+      formatted_start_date = start_date.strftime('%m%Y')
+      formatted_end_date = end_date.strftime('%m%Y')
+      response = @config.http.post("/payment_methods/all/expiring_ids?start=#{formatted_start_date}&end=#{formatted_end_date}")
+      ResourceCollection.new(response) { |ids| _fetch_expiring_between(formatted_start_date, formatted_end_date, ids) }
+    end
+
+    def find(token)
+      response = @config.http.get "/payment_methods/#{token}"
+      CreditCard._new(@gateway, response[:credit_card])
+    rescue NotFoundError
+      raise NotFoundError, "payment method with token #{token.inspect} not found"
+    end
+
+    def update(token, attributes)
+      Util.verify_keys(CreditCardGateway._update_signature, attributes)
+      _do_update(:put, "/payment_methods/#{token}", :credit_card => attributes)
+    end
+
+    # Deprecated
+    def update_from_transparent_redirect(query_string)
+      warn "[DEPRECATED] CreditCard.update_via_transparent_redirect_request is deprecated. Please use TransparentRedirect.confirm"
+      params = @gateway.transparent_redirect.parse_and_validate_query_string query_string
+      _do_update(:post, "/payment_methods/all/confirm_transparent_redirect_request", :id => params[:id])
+    end
+
+    # Deprecated
+    def update_credit_card_url
+      warn "[DEPRECATED] CreditCard.update_credit_card_url is deprecated. Please use TransparentRedirect.url"
+      "#{@config.base_merchant_url}/payment_methods/all/update_via_transparent_redirect_request"
+    end
+
+    def self._create_signature # :nodoc:
+      _signature(:create)
+    end
+
+    def self._update_signature # :nodoc:
+      _signature(:update)
+    end
+
+    def self._signature(type) # :nodoc:
+      billing_address_params = AddressGateway._shared_signature
+      signature = [
+        :cardholder_name, :cvv, :expiration_date, :expiration_month, :expiration_year, :number, :token,
+        {:options => [:make_default, :verification_merchant_account_id, :verify_card]},
+        {:billing_address => billing_address_params}
+      ]
+
+      case type
+      when :create
+        signature << :customer_id
+      when :update
+        billing_address_params << {:options => [:update_existing]}
+      else
+        raise ArgumentError
+      end
+
+      return signature
+    end
+
+    def _do_create(url, params=nil) # :nodoc:
+      response = @config.http.post url, params
+      if response[:credit_card]
+        SuccessfulResult.new(:credit_card => CreditCard._new(@gateway, response[:credit_card]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :credit_card or :api_error_response"
+      end
+    end
+
+    def _do_update(http_verb, url, params) # :nodoc:
+      response = @config.http.send http_verb, url, params
+      if response[:credit_card]
+        SuccessfulResult.new(:credit_card => CreditCard._new(@gateway, response[:credit_card]))
+      elsif response[:api_error_response]
+        ErrorResult.new(@gateway, response[:api_error_response])
+      else
+        raise UnexpectedError, "expected :credit_card or :api_error_response"
+      end
+    end
+
+    def _fetch_expired(ids) # :nodoc:
+      response = @config.http.post("/payment_methods/all/expired", :search => {:ids => ids})
+      attributes = response[:payment_methods]
+      Util.extract_attribute_as_array(attributes, :credit_card).map { |attrs| CreditCard._new(@gateway, attrs) }
+    end
+
+    def _fetch_expiring_between(formatted_start_date, formatted_end_date, ids) # :nodoc:
+      response = @config.http.post(
+        "/payment_methods/all/expiring?start=#{formatted_start_date}&end=#{formatted_end_date}",
+        :search => {:ids => ids}
+      )
+      attributes = response[:payment_methods]
+      Util.extract_attribute_as_array(attributes, :credit_card).map { |attrs| CreditCard._new(@gateway, attrs) }
+    end
+  end
+end

data/lib/braintree/credit_card_verification.rb

@@ -1,7 +1,15 @@
 module Braintree
+  # See http://www.braintreepaymentsolutions.com/docs/ruby/general/card_verification
   class CreditCardVerification
     include BaseModule
 
+    module Status
+      FAILED = 'failed'
+      GATEWAY_REJECTED = 'gateway_rejected'
+      PROCESSOR_DECLINED = 'processor_declined'
+      VERIFIED = 'verified'
+    end
+
     attr_reader :avs_error_response_code, :avs_postal_code_response_code, :avs_street_address_response_code,
       :cvv_response_code, :merchant_account_id, :processor_response_code, :processor_response_text, :status,
       :gateway_rejection_reason