Class: ActiveMerchant::Billing::CreditCard

Inherits:

Object

• Object
• ActiveMerchant::Billing::CreditCard

show all

Includes:

CreditCardMethods, Validateable

Defined in:

lib/active_merchant/billing/credit_card.rb,
lib/active_merchant/billing/expiry_date.rb

Overview

cc = CreditCard.new(
  :first_name => 'Steve',
  :last_name  => 'Smith',
  :month      => '9',
  :year       => '2010',
  :type       => 'visa',
  :number     => '4242424242424242'
)

cc.valid? # => true
cc.display_number # => XXXX-XXXX-XXXX-4242

Defined Under Namespace

Classes: ExpiryDate

Constant Summary

Constant Summary

Constants included from CreditCardMethods

ActiveMerchant::Billing::CreditCardMethods::CARD_COMPANIES

Instance Attribute Summary (collapse)

• - (String) first_name

  Returns or sets the first name of the card holder.

• - (Object) issue_number

  Required for Switch / Solo cards.

• - (String) last_name

  Returns or sets the last name of the card holder.

• - (Integer) month

  Returns or sets the expiry month for the card.

• - (String) number

  Returns or sets the credit card number.

• - (Object) start_month

  Required for Switch / Solo cards.

• - (Object) start_year

  Required for Switch / Solo cards.

• - (String) type (also: #brand)

  Returns or sets the credit card type.

• - (String) verification_value

  Returns or sets the card verification value.

• - (Integer) year

  Returns or sets the expiry year for the card.

Class Method Summary (collapse)

• + (Boolean) requires_verification_value?

Instance Method Summary (collapse)

• - (String) display_number

  Returns a display-friendly version of the card number.

• - (Boolean) expired?

  Returns whether the credit card has expired.

• - (ExpiryDate) expiry_date

  Provides proxy access to an expiry date object.

• - (Object) first_digits
• - (Boolean) first_name?

  Returns whether the first_name attribute has been set.

• - (Object) last_digits
• - (Boolean) last_name?

  Returns whether the last_name attribute has been set.

• - (String) name

  Returns the full name of the card holder.

• - (Object) name=(full_name)
• - (Boolean) name?

  Returns whether either the first_name or the last_name attributes has been set.

• - (Object) validate

  Validates the credit card details.

• - (Boolean) verification_value?

Methods included from CreditCardMethods

included, #valid_expiry_year?, #valid_issue_number?, #valid_month?, #valid_start_year?

96
97
98

# File 'lib/active_merchant/billing/credit_card.rb', line 96

def first_name
  @first_name
end

104
105
106

# File 'lib/active_merchant/billing/credit_card.rb', line 104

def issue_number
  @issue_number
end

101
102
103

# File 'lib/active_merchant/billing/credit_card.rb', line 101

def last_name
  @last_name
end

64
65
66

# File 'lib/active_merchant/billing/credit_card.rb', line 64

def month
  @month
end

59
60
61

# File 'lib/active_merchant/billing/credit_card.rb', line 59

def number
  @number
end

104
105
106

# File 'lib/active_merchant/billing/credit_card.rb', line 104

def start_month
  @start_month
end

104
105
106

# File 'lib/active_merchant/billing/credit_card.rb', line 104

def start_year
  @start_year
end

91
92
93

# File 'lib/active_merchant/billing/credit_card.rb', line 91

def type
  @type
end

113
114
115

# File 'lib/active_merchant/billing/credit_card.rb', line 113

def verification_value
  @verification_value
end

69
70
71

# File 'lib/active_merchant/billing/credit_card.rb', line 69

def year
  @year
end

200
201
202

# File 'lib/active_merchant/billing/credit_card.rb', line 200

def self.requires_verification_value?
  require_verification_value
end

credit_card = CreditCard.new(:number => "2132542376824338")
credit_card.display_number  # "XXXX-XXXX-XXXX-4338"

173
174
175

# File 'lib/active_merchant/billing/credit_card.rb', line 173

def display_number
  self.class.mask(number)
end

127
128
129

# File 'lib/active_merchant/billing/credit_card.rb', line 127

def expired?
  expiry_date.expired?
end

120
121
122

# File 'lib/active_merchant/billing/credit_card.rb', line 120

def expiry_date
  ExpiryDate.new(@month, @year)
end

177
178
179

# File 'lib/active_merchant/billing/credit_card.rb', line 177

def first_digits
  self.class.first_digits(number)
end

137
138
139

# File 'lib/active_merchant/billing/credit_card.rb', line 137

def first_name?
  @first_name.present?
end

181
182
183

# File 'lib/active_merchant/billing/credit_card.rb', line 181

def last_digits
  self.class.last_digits(number)
end

142
143
144

# File 'lib/active_merchant/billing/credit_card.rb', line 142

def last_name?
  @last_name.present?
end

149
150
151

# File 'lib/active_merchant/billing/credit_card.rb', line 149

def name
  [@first_name, @last_name].compact.join(' ')
end

153
154
155
156
157

# File 'lib/active_merchant/billing/credit_card.rb', line 153

def name=(full_name)
  names = full_name.split
  self.last_name  = names.pop
  self.first_name = names.join(" ")
end

132
133
134

# File 'lib/active_merchant/billing/credit_card.rb', line 132

def name?
  first_name? || last_name?
end

188
189
190
191
192
193
194
195
196
197
198

# File 'lib/active_merchant/billing/credit_card.rb', line 188

def validate
  validate_essential_attributes

  # Bogus card is pretty much for testing purposes. Lets just skip these extra tests if its used
  return if type == 'bogus'

  validate_card_type
  validate_card_number
  validate_verification_value
  validate_switch_or_solo_attributes
end

159
160
161

# File 'lib/active_merchant/billing/credit_card.rb', line 159

def verification_value?
  !@verification_value.blank?
end