Module: Spree::Core::ControllerHelpers::PaymentParameters Private

Included in:
BaseController
Defined in:
lib/spree/core/controller_helpers/payment_parameters.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Instance Method Summary (collapse)

Instance Method Details

- (Object) move_existing_card_into_payments_attributes(params)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method handles the awkwardness of how the html forms are currently set up for frontend.

This method expects a params hash in the format of:

{
  order: {
    existing_card: '123',
    ...other params...
  },
  cvc_confirm: '456', # optional
  ...other params...
}

And this method modifies the params into the format of:

{
  order: {
    payments_attributes: [
      {
        source_attributes: {
          existing_card_id: '123',
          verification_value: '456',
        },
      },
    ]
    ...other params...
  },
  ...other params...
}


96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/spree/core/controller_helpers/payment_parameters.rb', line 96

def move_existing_card_into_payments_attributes(params)
  return params if params[:order].blank?

  card_id = params[:order][:existing_card].presence
  cvc_confirm = params[:cvc_confirm].presence

  return params if card_id.nil?

  params[:order][:payments_attributes] = [
    {
      source_attributes: {
        existing_card_id: card_id,
        verification_value: cvc_confirm
      }
    }
  ]

  params[:order].delete(:existing_card)
  params.delete(:cvc_confirm)

  params
end

- (Object) move_payment_source_into_payments_attributes(params)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method handles the awkwardness of how the html forms are currently set up for frontend.

This method expects a params hash in the format of:

{
  payment_source: {
    # The keys here are spree_payment_method.id's
    '1' => {...source attributes for payment method 1...},
    '2' => {...source attributes for payment method 2...},
  },
  order: {
    # Note that only a single entry is expected/handled in this array
    payments_attributes: [
      {
        payment_method_id: '1',
      },
    ],
    ...other params...
  },
  ...other params...
}

And this method modifies the params into the format of:

{
  order: {
    payments_attributes: [
      {
        payment_method_id: '1',
        source_attributes: {...source attributes for payment method 1...}
      },
    ],
    ...other params...
  },
  ...other params...
}


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/spree/core/controller_helpers/payment_parameters.rb', line 41

def move_payment_source_into_payments_attributes(params)
  # Step 1: Gather all the information and ensure all the pieces are there.

  return params if params[:payment_source].blank?

  payment_params = params[:order] &&
                   params[:order][:payments_attributes] &&
                   params[:order][:payments_attributes].first
  return params if payment_params.blank?

  payment_method_id = payment_params[:payment_method_id]
  return params if payment_method_id.blank?

  source_params = params[:payment_source][payment_method_id]
  return params if source_params.blank?

  # Step 2: Perform the modifications.

  payment_params[:source_attributes] = source_params
  params.delete(:payment_source)

  params
end

- (Object) move_wallet_payment_source_id_into_payments_attributes(params)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method handles the awkwardness of how the html forms are currently set up for frontend.

This method expects a params hash in the format of:

{
  order: {
    wallet_payment_source_id: '123',
    ...other params...
  },
  cvc_confirm: '456', # optional
  ...other params...
}

And this method modifies the params into the format of:

{
  order: {
    payments_attributes: [
      {
        source_attributes: {
          wallet_payment_source_id: '123',
          verification_value: '456',
        },
      },
    ]
    ...other params...
  },
  ...other params...
}


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/spree/core/controller_helpers/payment_parameters.rb', line 150

def move_wallet_payment_source_id_into_payments_attributes(params)
  return params if params[:order].blank?

  wallet_payment_source_id = params[:order][:wallet_payment_source_id].presence
  cvc_confirm = params[:cvc_confirm].presence

  return params if wallet_payment_source_id.nil?

  params[:order][:payments_attributes] = [
    {
      source_attributes: {
        wallet_payment_source_id: wallet_payment_source_id,
        verification_value: cvc_confirm
      }
    }
  ]

  params[:order].delete(:wallet_payment_source_id)
  params.delete(:cvc_confirm)

  params
end

- (Object) set_payment_parameters_amount(params, order)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This is a strange thing to do since an order can have multiple payments but we always assume that it only has a single payment and that its amount should be the current order total. Also, this is pretty much overridden when the order transitions to confirm by the logic inside of Order#add_store_credit_payments. We should reconsider this method and its usage at some point.

This method expects a params hash in the format of:

{
  order: {
    # Note that only a single entry is expected/handled in this array
    payments_attributes: [
      {
        ...params...
      },
    ],
    ...other params...
  },
  ...other params...
}

And this method modifies the params into the format of:

{
  order: {
    payments_attributes: [
      {
        ...params...
        amount: <the order total>,
      },
    ],
    ...other params...
  },
  ...other params...
}


210
211
212
213
214
215
216
217
# File 'lib/spree/core/controller_helpers/payment_parameters.rb', line 210

def set_payment_parameters_amount(params, order)
  return params if params[:order].blank?
  return params if params[:order][:payments_attributes].blank?

  params[:order][:payments_attributes].first[:amount] = order.total

  params
end