Module: StripeMock::RequestHandlers::Invoices

Included in:
Instance
Defined in:
lib/stripe_mock/request_handlers/invoices.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(klass) ⇒ Object



5
6
7
8
9
10
11
12
13
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 5

def Invoices.included(klass)
  klass.add_handler 'post /v1/invoices',               :new_invoice
  klass.add_handler 'get /v1/invoices/upcoming',       :upcoming_invoice
  klass.add_handler 'get /v1/invoices/(.*)/lines',     :get_invoice_line_items
  klass.add_handler 'get /v1/invoices/(.*)',           :get_invoice
  klass.add_handler 'get /v1/invoices',                :list_invoices
  klass.add_handler 'post /v1/invoices/(.*)/pay',      :pay_invoice
  klass.add_handler 'post /v1/invoices/(.*)',          :update_invoice
end

Instance Method Details

#get_invoice(route, method_url, params, headers) ⇒ Object



41
42
43
44
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 41

def get_invoice(route, method_url, params, headers)
  route =~ method_url
  assert_existence :invoice, $1, invoices[$1]
end

#get_invoice_line_items(route, method_url, params, headers) ⇒ Object



46
47
48
49
50
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 46

def get_invoice_line_items(route, method_url, params, headers)
  route =~ method_url
  assert_existence :invoice, $1, invoices[$1]
  invoices[$1][:lines]
end

#list_invoices(route, method_url, params, headers) ⇒ Object



28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 28

def list_invoices(route, method_url, params, headers)
  params[:offset] ||= 0
  params[:limit] ||= 10

  result = invoices.clone

  if params[:customer]
    result.delete_if { |k,v| v[:customer] != params[:customer] }
  end

  Data.mock_list_object(result.values, params)
end

#new_invoice(route, method_url, params, headers) ⇒ Object



15
16
17
18
19
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 15

def new_invoice(route, method_url, params, headers)
  id = new_id('in')
  invoice_item = Data.mock_line_item()
  invoices[id] = Data.mock_invoice([invoice_item], params.merge(:id => id))
end

#pay_invoice(route, method_url, params, headers) ⇒ Object



52
53
54
55
56
57
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 52

def pay_invoice(route, method_url, params, headers)
  route =~ method_url
  assert_existence :invoice, $1, invoices[$1]
  charge = invoice_charge(invoices[$1])
  invoices[$1].merge!(:paid => true, :attempted => true, :charge => charge[:id])
end

#upcoming_invoice(route, method_url, params, headers) ⇒ Object

Raises:

  • (Stripe::InvalidRequestError)


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 59

def upcoming_invoice(route, method_url, params, headers)
  route =~ method_url
  raise Stripe::InvalidRequestError.new('Missing required param: customer', nil, http_status: 400) if params[:customer].nil?
  raise Stripe::InvalidRequestError.new('When previewing changes to a subscription, you must specify either `subscription` or `subscription_items`', nil, http_status: 400) if !params[:subscription_proration_date].nil? && params[:subscription].nil? && params[:subscription_plan].nil?
  raise Stripe::InvalidRequestError.new('Cannot specify proration date without specifying a subscription', nil, http_status: 400) if !params[:subscription_proration_date].nil? && params[:subscription].nil?

  customer = customers[params[:customer]]
  assert_existence :customer, params[:customer], customer

  raise Stripe::InvalidRequestError.new("No upcoming invoices for customer: #{customer[:id]}", nil, http_status: 404) if customer[:subscriptions][:data].length == 0

  subscription =
    if params[:subscription]
      customer[:subscriptions][:data].select{|s|s[:id] == params[:subscription]}.first
    else
      customer[:subscriptions][:data].min_by { |sub| sub[:current_period_end] }
    end

  if params[:subscription_proration_date] && !((subscription[:current_period_start]..subscription[:current_period_end]) === params[:subscription_proration_date])
    raise Stripe::InvalidRequestError.new('Cannot specify proration date outside of current subscription period', nil, http_status: 400)
  end

  prorating = false
  subscription_proration_date = nil
  subscription_plan_id = params[:subscription_plan] || subscription[:plan][:id]
  subscription_quantity = params[:subscription_quantity] || subscription[:quantity]
  if subscription_plan_id != subscription[:plan][:id] || subscription_quantity != subscription[:quantity]
    prorating = true
    invoice_date = Time.now.to_i
    subscription_plan = assert_existence :plan, subscription_plan_id, plans[subscription_plan_id.to_s]
    preview_subscription = Data.mock_subscription
    preview_subscription = resolve_subscription_changes(preview_subscription, [subscription_plan], customer, { trial_end: params[:subscription_trial_end] })
    preview_subscription[:id] = subscription[:id]
    preview_subscription[:quantity] = subscription_quantity
    subscription_proration_date = params[:subscription_proration_date] || Time.now
  else
    preview_subscription = subscription
    invoice_date = subscription[:current_period_end]
  end

  invoice_lines = []

  if prorating
    unused_amount = subscription[:plan][:amount] * subscription[:quantity] * (subscription[:current_period_end] - subscription_proration_date.to_i) / (subscription[:current_period_end] - subscription[:current_period_start])
    invoice_lines << Data.mock_line_item(
                             id: new_id('ii'),
                             amount: -unused_amount,
                             description: 'Unused time',
                             plan: subscription[:plan],
                             period: {
                                 start: subscription_proration_date.to_i,
                                 end: subscription[:current_period_end]
                             },
                             quantity: subscription[:quantity],
                             proration: true
    )

    preview_plan = assert_existence :plan, params[:subscription_plan], plans[params[:subscription_plan]]
    if preview_plan[:interval] == subscription[:plan][:interval] && preview_plan[:interval_count] == subscription[:plan][:interval_count] && params[:subscription_trial_end].nil?
      remaining_amount = preview_plan[:amount] * subscription_quantity * (subscription[:current_period_end] - subscription_proration_date.to_i) / (subscription[:current_period_end] - subscription[:current_period_start])
      invoice_lines << Data.mock_line_item(
                               id: new_id('ii'),
                               amount: remaining_amount,
                               description: 'Remaining time',
                               plan: preview_plan,
                               period: {
                                   start: subscription_proration_date.to_i,
                                   end: subscription[:current_period_end]
                               },
                               quantity: subscription_quantity,
                               proration: true
      )
    end
  end

  subscription_line = get_mock_subscription_line_item(preview_subscription)
  invoice_lines << subscription_line

  Data.mock_invoice(invoice_lines,
    id: new_id('in'),
    customer: customer[:id],
    discount: customer[:discount],
    date: invoice_date,
    starting_balance: customer[:account_balance],
    subscription: preview_subscription[:id],
    period_start: prorating ? invoice_date : preview_subscription[:current_period_start],
    period_end: prorating ? invoice_date : preview_subscription[:current_period_end],
    next_payment_attempt: preview_subscription[:current_period_end] + 3600 )
end

#update_invoice(route, method_url, params, headers) ⇒ Object



21
22
23
24
25
26
# File 'lib/stripe_mock/request_handlers/invoices.rb', line 21

def update_invoice(route, method_url, params, headers)
  route =~ method_url
  params.delete(:lines) if params[:lines]
  assert_existence :invoice, $1, invoices[$1]
  invoices[$1].merge!(params)
end