doc: example shows new-style usage
authorIvan Kohler <ivan@freeside.biz>
Mon, 25 Jun 2018 22:18:56 +0000 (15:18 -0700)
committerIvan Kohler <ivan@freeside.biz>
Mon, 25 Jun 2018 22:18:56 +0000 (15:18 -0700)
CreditCard.pm
t/validate_card.t

index 79c7df1..e6d3cd9 100644 (file)
@@ -5,7 +5,7 @@ use vars qw( @ISA $VERSION @EXPORT @EXPORT_OK %EXPORT_TAGS $Country );
 
 @ISA = qw( Exporter );
 
-$VERSION = "0.37_01";
+$VERSION = "0.37_02";
 
 @EXPORT = qw( cardtype validate generate_last_digit );
 @EXPORT_OK = qw( receipt_cardtype validate_card );
@@ -19,11 +19,25 @@ C<Business::CreditCard> - Validate/generate credit card checksums/names
 
 =head1 SYNOPSIS
 
+    ##
+    # new-style, supported since 0.36 released Jun 14 2016
+    ##
+
+    use Business::CreditCard qw( 0.36 :NEW );
+    print validate_card("5276 4400 6542 1319");
+    print cardtype("5276 4400 6542 1319");
+
+
+    ##
+    # old interface, deprecated but still supported for backwards compatibility
+    ##
+
     use Business::CreditCard;
  
     print validate("5276 4400 6542 1319");
     print cardtype("5276 4400 6542 1319");
-    print generate_last_digit("5276 4400 6542 131");
+    
 
 Business::CreditCard is available at a CPAN site near you.
 
@@ -33,7 +47,7 @@ These subroutines tell you whether a credit card number is
 self-consistent -- whether the last digit of the number is a valid
 checksum for the preceding digits.  
 
-The validate() subroutine returns 1 if the card number provided passes
+The validate_card() subroutine returns 1 if the card number provided passes
 the checksum test, and 0 otherwise.
 
 The cardtype() subroutine returns a string containing the type of
@@ -79,7 +93,7 @@ whether a card is real, or whether it's been stolen, or to actually process
 charges, you need a Merchant account.  See L<Business::OnlinePayment>.
 
 These subroutines will also work if you provide the arguments
-as numbers instead of strings, e.g. C<validate(5276440065421319)>.  
+as numbers instead of strings, e.g. C<validate_card(5276440065421319)>.  
 
 =head1 PROCESSING AGREEMENTS
 
@@ -215,7 +229,7 @@ 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 release with the
+is worth it to stop our namespace pollution.  Maybe do a 1.00 release with the
 current API and 2.00 is when this happens (with a 1.99_01 pre-release)?
 
 =head1 SEE ALSO
index 76fcca0..8d3d8cf 100644 (file)
@@ -12,7 +12,7 @@ my @bad_table=(
 );
 
 use Test::More tests => 4; #haha no scalar(@test_table) + scalar(@bad_table);
-use Business::CreditCard qw( :NEW );
+use Business::CreditCard qw( 0.36 :NEW );
 
 foreach my $card (@test_table) {
   ok( validate_card($card), "validate_card($card)" );