class Braintree::SubscriptionGateway

Public Class Methods

_add_on_discount_signature() click to toggle source
# File lib/braintree/subscription_gateway.rb, line 117
def self._add_on_discount_signature
  [
    {
      :add_ons => [
        {:add => [:amount, :inherited_from_id, :never_expires, :number_of_billing_cycles, :quantity]},
        {:update => [:amount, :existing_id, :never_expires, :number_of_billing_cycles, :quantity]},
        {:remove => [:_any_key_]}
      ]
    },
    {
      :discounts => [
        {:add => [:amount, :inherited_from_id, :never_expires, :number_of_billing_cycles, :quantity]},
        {:update => [:amount, :existing_id, :never_expires, :number_of_billing_cycles, :quantity]},
        {:remove => [:_any_key_]}
      ]
    }
  ]
end
_create_signature() click to toggle source
# File lib/braintree/subscription_gateway.rb, line 73
def self._create_signature
  [
    :billing_day_of_month,
    :first_billing_date,
    :id,
    :merchant_account_id,
    :never_expires,
    :number_of_billing_cycles,
    :payment_method_token,
    :payment_method_nonce,
    :plan_id,
    :price,
    :trial_duration,
    :trial_duration_unit,
    :trial_period,
    {:options => [
      :do_not_inherit_add_ons_or_discounts,
      :start_immediately,
      {:paypal => [:description]},
    ]},
    {:descriptor => [:name, :phone, :url]}
  ] + _add_on_discount_signature
end
_update_signature() click to toggle source
# File lib/braintree/subscription_gateway.rb, line 97
def self._update_signature
  [
    :id,
    :merchant_account_id,
    :never_expires,
    :number_of_billing_cycles,
    :payment_method_token,
    :payment_method_nonce,
    :plan_id,
    :price,
    {:options => [
      :prorate_charges,
      :replace_all_add_ons_and_discounts,
      :revert_subscription_on_proration_failure,
      {:paypal => [:description]},
    ]},
    {:descriptor => [:name, :phone, :url]}
  ] + _add_on_discount_signature
end
new(gateway) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 5
def initialize(gateway)
  @gateway = gateway
  @config = gateway.config
  @config.assert_has_access_token_or_keys
end

Public Instance Methods

_do_create(path, params) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 136
def _do_create(path, params)
  response = @config.http.post("#{@config.base_merchant_path}#{path}", params)
  if response[:subscription]
    SuccessfulResult.new(:subscription => Subscription._new(@gateway, response[:subscription]))
  elsif response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    raise UnexpectedError, "expected :subscription or :api_error_response"
  end
end
_fetch_subscriptions(search, ids) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 147
def _fetch_subscriptions(search, ids)
  search.ids.in ids
  response = @config.http.post("#{@config.base_merchant_path}/subscriptions/advanced_search", {:search => search.to_hash})
  attributes = response[:subscriptions]
  Util.extract_attribute_as_array(attributes, :subscription).map { |attrs| Subscription._new(@gateway, attrs) }
end
cancel(subscription_id) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 11
def cancel(subscription_id)
  response = @config.http.put("#{@config.base_merchant_path}/subscriptions/#{subscription_id}/cancel")
  if response[:subscription]
    SuccessfulResult.new(:subscription => Subscription._new(@gateway, response[:subscription]))
  elsif response[:api_error_response]
    ErrorResult.new(@gateway, response[:api_error_response])
  else
    raise UnexpectedError, "expected :subscription or :api_error_response"
  end
rescue NotFoundError
  raise NotFoundError, "subscription with id #{subscription_id.inspect} not found"
end
cancel!(*args) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 24
def cancel!(*args)
  return_object_or_raise(:subscription) { cancel(*args) }
end
create(attributes) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 28
def create(attributes)
  Util.verify_keys(SubscriptionGateway._create_signature, attributes)
  _do_create "/subscriptions", :subscription => attributes
end
create!(*args) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 33
def create!(*args)
  return_object_or_raise(:subscription) { create(*args) }
end
find(id) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 37
def find(id)
  raise ArgumentError if id.nil? || id.to_s.strip == ""
  response = @config.http.get("#{@config.base_merchant_path}/subscriptions/#{id}")
  Subscription._new(@gateway, response[:subscription])
rescue NotFoundError
  raise NotFoundError, "subscription with id #{id.inspect} not found"
end
retry_charge(subscription_id, amount=nil, submit_for_settlement=false) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 45
def retry_charge(subscription_id, amount=nil, submit_for_settlement=false)
  @gateway.transaction.retry_subscription_charge(subscription_id, amount, submit_for_settlement)
end
update(subscription_id, attributes) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 57
def update(subscription_id, attributes)
  Util.verify_keys(SubscriptionGateway._update_signature, attributes)
  response = @config.http.put("#{@config.base_merchant_path}/subscriptions/#{subscription_id}", :subscription => attributes)
  if response[:subscription]
    SuccessfulResult.new(:subscription => Subscription._new(@gateway, response[:subscription]))
  elsif response[:api_error_response]
     ErrorResult.new(@gateway, response[:api_error_response])
  else
    raise UnexpectedError, "expected :subscription or :api_error_response"
  end
end
update!(*args) click to toggle source
# File lib/braintree/subscription_gateway.rb, line 69
def update!(*args)
  return_object_or_raise(:subscription) { update(*args) }
end