0.36
[Business-CreditCard.git] / CreditCard.pm
index c8dd6de..12dbf0d 100644 (file)
@@ -1,11 +1,15 @@
 package Business::CreditCard;
 
 require Exporter;
-use vars qw( @ISA $VERSION $Country );
+use vars qw( @ISA $VERSION @EXPORT @EXPORT_OK %EXPORT_TAGS $Country );
 
 @ISA = qw( Exporter );
 
-$VERSION = "0.32";
+$VERSION = "0.36";
+
+@EXPORT = qw( cardtype validate generate_last_digit );
+@EXPORT_OK = qw( receipt_cardtype validate_card );
+$EXPORT_TAGS{NEW} = [ qw( validate_card cardtype receipt_cardtype ) ];
 
 $Country = 'US';
 
@@ -59,11 +63,11 @@ cards are now recognized as "Discover card").
 
 As of 0.30, cardtype() will accept a partial card masked with "x", "X', ".",
 "*" or "_".  Only the first 2-6 digits and the length are significant;
-whitespace and dashes are removed.  To recognize just Visa, MasterCard and
-Amex, you only need the first two digits; to recognize almost all cards
-except some Switch cards, you need the first four digits, and to recognize
-all cards including the remaining Switch cards, you need the first six
-digits.
+whitespace and dashes are removed.  With two digits, Visa, MasterCard, Discover
+and Amex are recognized (versions before 0.36 needed four digits to recognize
+all Discover cards).  With four digits, almost all cards except some
+Switch cards are recognized.  With six digits (the full "BIN" or "IIN"), all
+cards are recognized.  Six digits are also required for receipt_cardtype().
 
 The generate_last_digit() subroutine computes and returns the last
 digit of the card given the preceding digits.  With a 16-digit card,
@@ -83,7 +87,7 @@ Credit card issuers have recently been forming agreements to process cards on
 other networks, in which one type of card is processed as another card type.
 
 By default, Business::CreditCard returns the type the card should be treated as
-in the US and Canada.  You can change this to return the type the card should
+in the US.  You can change this to return the type the card should
 be treated as in a different country by setting
 C<$Business::CreditCard::Country> to your two-letter country code.  This
 is probably what you want to determine if you accept the card, or which
@@ -99,40 +103,51 @@ Here are the currently known agreements:
 
 =item Most Diner's club is now identified as Discover.  (This supercedes the earlier identification of some Diner's club cards as MasterCard inside the US and Canada.)
 
-=item JCB cards in the 3528-3589 range are identified as Discover inside the US and Canada.
+=item JCB cards in the 3528-3589 range are identified as Discover inside the US and territories.
 
-=item China Union Pay cards are identified as Discover cards outside China.
+=item China Union Pay cards are identified as Discover cards in the US, Mexico and most Caribbean countries.
 
 =back
 
-=head1 NOTE ON INTENDED PURPOSE
+=head1 RECEIPT REQUIREMENTS
+
+Discover requires some cards processed on its network to display "PayPal"
+on receipts instead of "Discover".  The receipt_cardtype() subroutine will
+return "PayPal card" for these cards only, and otherwise the same output as
+cardtype().
+
+Use this for receipt display/printing only.
+
+Note: this subroutine is not exported by default like the others.
+Before 0.36, you needed to call this subroutine fully-qualified, as
+Business::CreditCard::receipt_cardtype()
+
+In 0.36 and later, you can import it into your namespace:
 
-This module is for verifying I<real world> B<credit cards>.  It is B<NOT> a
-pedantic implementation of the ISO 7812 standard, a general-purpose LUHN
-implementation, or intended for use with "creditcard-like account numbers".
+  use Business::CreditCard qw( :DEFAULT receipt_cardtype );
 
-=head1 AUTHOR
+
+=head1 ORIGINAL AUTHOR
 
 Jon Orwant
 
 The Perl Journal and MIT Media Lab
 
-orwant@tpj.com
+=head1 MAINTAINER
 
 Current maintainer is Ivan Kohler <ivan-business-creditcard@420.am>.
-Please don't bother Jon with emails about this module.
 
 Lee Lawrence <LeeL@aspin.co.uk>, Neale Banks <neale@lowendale.com.au> and
 Max Becker <Max.Becker@firstgate.com> contributed support for additional card
 types.  Lee also contributed a working test.pl.  Alexandr Ciornii
 <alexchorny@gmail.com> contributed code cleanups.  Jason Terry
-<jterry@bluhost.com> contributed updates for Discover BIN ranges.
+<jterry@bluehost.com> contributed updates for Discover BIN ranges.
 
 =head1 COPYRIGHT AND LICENSE
 
 Copyright (C) 1995,1996,1997 Jon Orwant
 Copyright (C) 2001-2006 Ivan Kohler
-Copyright (C) 2007-2013 Freeside Internet Services, Inc.
+Copyright (C) 2007-2016 Freeside Internet Services, Inc.
 
 This library is free software; you can redistribute it and/or modify
 it under the same terms as Perl itself, either Perl version 5.8.8 or,
@@ -150,6 +165,43 @@ how to change things to behave in a more modern fashion without breaking
 existing code?  "use Business::CreditCard <some_minimum_version>" turns it off?
 Explicitly ask to turn it off and list that in the SYNOPSIS?
 
+=head2 validate() and @EXPORT transition plan
+
+First (done in 0.36): 
+
+validate_card() is the new name for validate().  Both work for now.
+
+New-style usage (not recommended for code that needs to support B:CC before 0.36):
+
+  use Business::CreditCard qw( :NEW );
+
+You get validate_card(), cardtype() and receipt_cardtype().  You can also ask
+for them explicitly / individually:
+
+  use Business::CreditCard qw( validate_card cardtype receipt_cardtype );
+
+
+Second (we're at now now): 
+
+Waiting for 0.36+ to become more prevalent.
+
+
+Third:
+
+Recommend new-style usage.  Maybe asking for a specific minimum version turns
+it on too?
+
+
+Fourth:
+ (this is the incompatible part):
+
+Don't export validate() (or anything else [separately?]) by default.
+
+This is the part that will break things and we probably won't do for a long
+time, until new-style usage is the norm and the tradeoff of breaking old code
+is worth it to stop or namespace pollution.  Maybe do a 1.00 releaes with the
+current API and 2.00 is when this happens (with a 1.99_01 pre-release)?
+
 =head1 SEE ALSO
 
 L<Business::CreditCard::Object> is a wrapper around Business::CreditCard
@@ -164,8 +216,6 @@ providing credit card number verification (LUHN checking).
 
 =cut
 
-@EXPORT = qw(cardtype validate generate_last_digit);
-
 ## ref http://neilb.org/reviews/luhn.html#Comparison it looks like
 ## Business::CCCheck is 2x faster than we are.  looking at their implementation
 ## not entirely a fair comparison, we also do the equivalent of their CC_clean,
@@ -174,6 +224,9 @@ providing credit card number verification (LUHN checking).
 ## a lot more than just 6011*, they don't handle processing agreements, etc.
 
 sub cardtype {
+    # Allow use as a class method
+    shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' );
+
     my ($number) = @_;
 
     $number =~ s/[\s\-]//go;
@@ -191,33 +244,32 @@ sub cardtype {
             && 0+$number;
     }
 
-    return "VISA card" if $number =~ /^4[0-8][\dx]{11}([\dx]{3})?$/o;
+    return "VISA card" if $number =~ /^4[0-8][\dx]{11,17}$/o;
 
     return "MasterCard"
-      if   $number =~ /^5[1-5][\dx]{14}$/o
-      ;# || ( $number =~ /^36[\dx]{12}/ && $Country =~ /^(US|CA)$/oi );
+      if $number =~ /^5[1-5][\dx]{14}$/o
+      || $number =~ /^2 ( 22[1-9] | 2[3-9][\dx] | [3-6][\dx]{2} | 7[0-1][\dx] | 720 ) [\dx]{12}$/xo
+      || $number =~ /^2[2-7]xx[\dx]{12}$/o;
 
     return "American Express card" if $number =~ /^3[47][\dx]{13}$/o;
 
     return "Discover card"
-      if   $number =~ /^30[0-5][\dx]{11}([\dx]{2})?$/o  #diner's: 300-305
-      ||   $number =~ /^3095[\dx]{10}([\dx]{2})?$/o     #diner's: 3095
-      ||   $number =~ /^3[689][\dx]{12}([\dx]{2})?$/o   #diner's: 36 38 and 39
-      ||   $number =~ /^6011[\dx]{12}$/o
-      ||   $number =~ /^64[4-9][\dx]{13}$/o
-      ||   $number =~ /^65[\dx]{14}$/o
-      || ( $number =~ /^62[24-68][\dx]{13}$/o && uc($Country) ne 'CN' ) #CUP
-      || ( $number =~ /^35(2[89]|[3-8][\dx])[\dx]{12}$/o && uc($Country) eq 'US' );
+      if   $number =~ /^30[0-5x][\dx]{13,16}$/o  #diner's:  300-305, 30x
+      ||   $number =~ /^309[5x][\dx]{12}$/o      #          3095, 309x
+      ||   $number =~ /^36[\dx]{12,17}$/o        #          36
+      ||   $number =~ /^3[89][\dx]{14,17}$/o     #          38 and 39
+      ||   $number =~ /^60[1x]{2}[\dx]{12,15}$/o #discover: 6011 601x 60xx
+      ||   $number =~ /^64[4-9x][\dx]{13,16}$/o  #          644-649, 64x 
+      ||   $number =~ /^65[\dx]{14,17}$/o        #          65
+      || ( $number =~ /^62[24-68x][\dx]{13,16}$/o && $Country =~ /^(US|MX|AI|AG|AW|BS|BB|BM|BQ|VG|KY|CW|DM|DO|GD|GP|JM|MQ|MS|BL|KN|LC|VC|MF|SX|TT|TC)$/oi ) #China Union Pay identified as Discover in US, Mexico and Caribbean
+      || ( $number =~ /^35(2[89x]|[3-8][\dx]|xx)[\dx]{12,15}$/o && $Country =~ /^(US|PR|VI|MP|PW|GU)$/oi ); #JCB cards in the 3528-3589 range are identified as Discover in US, Puerto Rico, US Virgin Islands, Northern Mariana Islands, Palau and Guam
 
     return "Switch"
       if $number =~ /^49(03(0[2-9]|3[5-9])|11(0[1-2]|7[4-9]|8[1-2])|36[0-9]{2})[\dx]{10}([\dx]{2,3})?$/o
       || $number =~ /^564182[\dx]{10}([\dx]{2,3})?$/o
       || $number =~ /^6(3(33[0-4][0-9])|759[0-9]{2})[\dx]{10}([\dx]{2,3})?$/o;
     #redunant with above, catch 49* that's not Switch
-    return "VISA card" if $number =~ /^4[\dx]{12}([\dx]{3})?$/o;
-
-    #return "Diner's Club/Carte Blanche"
-    #  if $number =~ /^3(0[0-59]|[68][\dx])[\dx]{11}$/o;
+    return "VISA card" if $number =~ /^4[\dx]{12,18}$/o;
 
     #"Diners Club enRoute"
     return "enRoute" if $number =~ /^2(014|149)[\dx]{11}$/o;
@@ -241,7 +293,25 @@ sub cardtype {
     return "Unknown";
 }
 
+sub receipt_cardtype {
+    # Allow use as a class method
+    shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' );
+
+    my ($number) = @_;
+
+    $number =~ s/[\s\-]//go;
+    $number =~ s/[x\*\.\_]/x/gio;
+
+    #ref Discover IIN Bulletin Feb 2015_021715
+    return "PayPal card" if $number =~ /^6(01104|506[01]0)[\dx]{10,13}$/o;
+
+    cardtype($number);
+}
+
 sub generate_last_digit {
+    # Allow use as a class method
+    shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' );
+
     my ($number) = @_;
 
     die "invalid operation" if length($number) == 8 || length($number) == 9;
@@ -261,7 +331,7 @@ sub generate_last_digit {
 
 ## this (GPLed) code from Business::CCCheck is apparantly 4x faster than ours
 ## ref http://neilb.org/reviews/luhn.html#Comparison
-## maybe see if we can spped ours up a bit
+## maybe see if we can speed ours up a bit
 #  my @ccn = split('',$ccn);
 #  my $even = 0;
 #  $ccn = 0;
@@ -273,7 +343,13 @@ sub generate_last_digit {
 #  }
 #  $type = '' if $ccn % 10;
 #  return $type;
-sub validate {
+
+sub validate { validate_card(@_); }
+
+sub validate_card {
+    # Allow use as a class method
+    shift if UNIVERSAL::isa( $_[0], 'Business::CreditCard' );
+
     my ($number) = @_;
 
     my ($i, $sum, $weight);