Add automatic credit card brand detection. Closes thephpleague#18

commit 2a22884
Author: Ben Swinburne <[email protected]>
Date:   Thu Feb 21 22:20:05 2013 +0000

    Run code through php-cs-fixer

commit 918c156
Author: Ben Swinburne <[email protected]>
Date:   Thu Feb 21 22:17:44 2013 +0000

    removed accidental added responsetest

commit 4087a03
Author: Ben Swinburne <[email protected]>
Date:   Thu Feb 21 22:10:29 2013 +0000

    Switch to $brand, drop $type, add detection method. Deleted individual validation methods

commit 45f1b78
Author: Ben Swinburne <[email protected]>
Date:   Thu Feb 21 11:11:23 2013 +0000

    Fixed non array type bug when no addtional card types added

commit e49ad59
Author: Ben Swinburne <[email protected]>
Date:   Thu Feb 21 10:02:02 2013 +0000

    Fixed missing commas causing a parse error

commit ecab6ac
Author: Ben Swinburne <[email protected]>
Date:   Thu Feb 21 00:04:01 2013 +0000

    Added card validation/determination methods

Author: amacneil

src/Omnipay/Common/CreditCard.php

@@ -19,6 +19,19 @@
  */
 class CreditCard
 {
+    const BRAND_VISA = 'visa';
+    const BRAND_MASTERCARD = 'mastercard';
+    const BRAND_DISCOVER = 'discover';
+    const BRAND_AMEX = 'amex';
+    const BRAND_DINERS_CLUB = 'diners_club';
+    const BRAND_JCB = 'jcb';
+    const BRAND_SWITCH = 'switch';
+    const BRAND_SOLO = 'solo';
+    const BRAND_DANKORT = 'dankort';
+    const BRAND_MAESTRO = 'maestro';
+    const BRAND_FORBRUGSFORENINGEN = 'forbrugsforeningen';
+    const BRAND_LASER = 'laser';
+
     /**
      * @var \Symfony\Component\HttpFoundation\ParameterBag
      */
@@ -34,6 +47,35 @@ public function __construct($parameters = null)
         $this->initialize($parameters);
     }
 
+    /**
+     * All known/supported card brands, and a regular expression to match them.
+     *
+     * The order of the card brands is important, as some of the regular expressions overlap.
+     *
+     * Note: The fact that this class knows about a particular card brand does not imply
+     * that your gateway supports it.
+     *
+     * @return array
+     * @link https://github.com/Shopify/active_merchant/blob/master/lib/active_merchant/billing/credit_card_methods.rb
+     */
+    public function getSupportedBrands()
+    {
+        return array(
+            static::BRAND_VISA => '/^4\d{12}(\d{3})?$/',
+            static::BRAND_MASTERCARD => '/^(5[1-5]\d{4}|677189)\d{10}$/',
+            static::BRAND_DISCOVER => '/^(6011|65\d{2}|64[4-9]\d)\d{12}|(62\d{14})$/',
+            static::BRAND_AMEX => '/^3[47]\d{13}$/',
+            static::BRAND_DINERS_CLUB => '/^3(0[0-5]|[68]\d)\d{11}$/',
+            static::BRAND_JCB => '/^35(28|29|[3-8]\d)\d{12}$/',
+            static::BRAND_SWITCH => '/^6759\d{12}(\d{2,3})?$/',
+            static::BRAND_SOLO => '/^6767\d{12}(\d{2,3})?$/',
+            static::BRAND_DANKORT => '/^5019\d{12}$/',
+            static::BRAND_MAESTRO => '/^(5[06-8]|6\d)\d{10,17}$/',
+            static::BRAND_FORBRUGSFORENINGEN => '/^600722\d{10}$/',
+            static::BRAND_LASER => '/^(6304|6706|6709|6771(?!89))\d{8}(\d{4}|\d{6,7})?$/',
+        );
+    }
+
     /**
      * Initialize the object with parameters.
      *
@@ -138,6 +180,22 @@ public function setNumber($value)
         return $this->setParameter('number', preg_replace('/\D/', '', $value));
     }
 
+    /**
+     * Credit Card Brand
+     *
+     * Iterates through known/supported card brands to determine the brand of this card
+     *
+     * @return string
+     */
+    public function getBrand()
+    {
+        foreach ($this->getSupportedBrands() as $brand => $val) {
+            if (preg_match($val, $this->getNumber())) {
+                return $brand;
+            }
+        }
+    }
+
     public function getExpiryMonth()
     {
         return $this->getParameter('expiryMonth');
@@ -218,16 +276,6 @@ public function setIssueNumber($value)
         return $this->setParameter('issueNumber', $value);
     }
 
-    public function getType()
-    {
-        return $this->getParameter('type');
-    }
-
-    public function setType($value)
-    {
-        return $this->setParameter('type', $value);
-    }
-
     public function getBillingAddress1()
     {
         return $this->getParameter('billingAddress1');

src/Omnipay/PayPal/Message/ProAuthorizeRequest.php

@@ -32,13 +32,13 @@ public function getData()
         $data[$prefix.'DESC'] = $this->getDescription();
 
         // add credit card details
-        $data['CREDITCARDTYPE'] = $this->getCard()->getType();
         $data['ACCT'] = $this->getCard()->getNumber();
+        $data['CREDITCARDTYPE'] = $this->getCard()->getBrand();
         $data['EXPDATE'] = $this->getCard()->getExpiryMonth().$this->getCard()->getExpiryYear();
         $data['STARTDATE'] = $this->getCard()->getStartMonth().$this->getCard()->getStartYear();
         $data['CVV2'] = $this->getCard()->getCvv();
         $data['ISSUENUMBER'] = $this->getCard()->getIssueNumber();
-        $data['IPADDRESS'] = '';
+        $data['IPADDRESS'] = $this->getClientIp();
         $data['FIRSTNAME'] = $this->getCard()->getFirstName();
         $data['LASTNAME'] = $this->getCard()->getLastName();
         $data['EMAIL'] = $this->getCard()->getEmail();

src/Omnipay/SagePay/Message/DirectAuthorizeRequest.php

@@ -66,7 +66,7 @@ public function getData()
         $data['CardNumber'] = $this->getCard()->getNumber();
         $data['CV2'] = $this->getCard()->getCvv();
         $data['ExpiryDate'] = $this->getCard()->getExpiryDate('my');
-        $data['CardType'] = $this->getCard()->getType();
+        $data['CardType'] = $this->getCard()->getBrand();
 
         if ($this->getCard()->getStartMonth() and $this->getCard()->getStartYear()) {
             $data['StartDate'] = $this->getCard()->getStartDate('my');

tests/Omnipay/Common/CreditCardTest.php

@@ -131,6 +131,13 @@ public function testValidateNumber()
         $this->card->validate();
     }
 
+    public function testGetSupportedBrands()
+    {
+        $brands = $this->card->getSupportedBrands();
+        $this->assertInternalType('array', $brands);
+        $this->assertArrayHasKey(CreditCard::BRAND_VISA, $brands);
+    }
+
     public function testFirstName()
     {
         $this->card->setFirstName('Bob');
@@ -183,6 +190,48 @@ public function testSetNumberStripsNonDigits()
         $this->assertEquals('4000000000000000', $this->card->getNumber());
     }
 
+    public function testGetBrandDefault()
+    {
+        $card = new CreditCard;
+        $this->assertNull($card->getBrand());
+    }
+
+    public function testGetBrandVisa()
+    {
+        $card = new CreditCard(array('number' => '4242424242424242'));
+        $this->assertSame(CreditCard::BRAND_VISA, $card->getBrand());
+    }
+
+    public function testGetBrandMasterCard()
+    {
+        $card = new CreditCard(array('number' => '5555555555554444'));
+        $this->assertSame(CreditCard::BRAND_MASTERCARD, $card->getBrand());
+    }
+
+    public function testGetBrandAmex()
+    {
+        $card = new CreditCard(array('number' => '378282246310005'));
+        $this->assertSame(CreditCard::BRAND_AMEX, $card->getBrand());
+    }
+
+    public function testGetBrandDiscover()
+    {
+        $card = new CreditCard(array('number' => '6011111111111117'));
+        $this->assertSame(CreditCard::BRAND_DISCOVER, $card->getBrand());
+    }
+
+    public function testGetBrandDinersClub()
+    {
+        $card = new CreditCard(array('number' => '30569309025904'));
+        $this->assertSame(CreditCard::BRAND_DINERS_CLUB, $card->getBrand());
+    }
+
+    public function testGetBrandJcb()
+    {
+        $card = new CreditCard(array('number' => '3530111333300000'));
+        $this->assertSame(CreditCard::BRAND_JCB, $card->getBrand());
+    }
+
     public function testExpiryMonth()
     {
         $this->card->setExpiryMonth(9);
@@ -243,12 +292,6 @@ public function testIssueNumber()
         $this->assertSame('12', $this->card->getIssueNumber());
     }
 
-    public function testType()
-    {
-        $this->card->setType('visa');
-        $this->assertEquals('visa', $this->card->getType());
-    }
-
     public function testBillingAddress1()
     {
         $this->card->setBillingAddress1('31 Spooner St');