Merge pull request #182 from islamdarwish/master

Implement list Plan and tests

.travis.yml

@@ -1,7 +1,6 @@
 language: php
 
 php:
-  - 5.3
   - 5.4
   - 5.5
   - 5.6
@@ -17,6 +16,7 @@ matrix:
   include:
     - php: 5.3
       env: setup=lowest
+      dist: precise
     - php: 5.5
       env: setup=stable
 

phpunit.xml.dist~

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false"
+         syntaxCheck="false">
+    <testsuites>
+        <testsuite name="Omnipay Test Suite">
+            <directory>./tests/</directory>
+        </testsuite>
+    </testsuites>
+    <listeners>
+        <listener class="Mockery\Adapter\Phpunit\TestListener" file="vendor/mockery/mockery/library/Mockery/Adapter/Phpunit/TestListener.php" />
+    </listeners>
+    <filter>
+        <whitelist>
+            <directory>./src</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Message/RestListPlanRequest.php

@@ -0,0 +1,242 @@
+<?php
+/**
+ * PayPal REST List Plans Request
+ */
+
+namespace Omnipay\PayPal\Message;
+
+/**
+ * PayPal REST List Plans Request
+ *
+ * Use this call to get a list of plans in any state (CREATED, ACTIVE, etc.).
+ * The plans returned are the plans made by the merchant making the call.
+ *
+ *
+ * ### Example
+ *
+ * #### Initialize Gateway
+ *
+ * <code>
+ *   // Create a gateway for the PayPal RestGateway
+ *   // (routes to GatewayFactory::create)
+ *   $gateway = Omnipay::create('PayPal_Rest');
+ *
+ *   // Initialise the gateway
+ *   $gateway->initialize(array(
+ *       'clientId' => 'MyPayPalClientId',
+ *       'secret'   => 'MyPayPalSecret',
+ *       'testMode' => true, // Or false when you are ready for live transactions
+ *   ));
+ * </code>
+ *
+ * #### List all plans that have state CREATED
+ * <code>
+ *
+ *   // List all billing plans
+ *   $transaction = $gateway->listPlan([
+ *       'state' => CREATED,
+ *   ]);
+ *   $response = $transaction->send();
+ *   $data = $response->getData();
+ *   echo "Gateway listPlan response data == " . print_r($data, true) . "\n";
+ * </code>
+ *
+ * ### Request Sample
+ *
+ * This is from the PayPal web site:
+ *
+ * <code>
+ * curl -v -X GET https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=3&status=ACTIVE&page=1\
+ * -H "Content-Type:application/json" \
+ * -H "Authorization: Bearer Access-Token"
+ * </code>
+ *
+ * ### Response Sample
+ *
+ * This is from the PayPal web site:
+ *
+ * <code>
+ * {
+ * "total_items": "166",
+ * "total_pages": "83",
+ * "plans": [
+ * {
+ * "id": "P-7DC96732KA7763723UOPKETA",
+ * "state": "ACTIVE",
+ * "name": "Plan with Regular and Trial Payment Definitions",
+ * "description": "Plan with regular and trial billing payment definitions.",
+ * "type": "FIXED",
+ * "create_time": "2017-08-22T04:41:52.836Z",
+ * "update_time": "2017-08-22T04:41:53.169Z",
+ * "links": [
+ * {
+ * "href": "https://api.sandbox.paypal.com//v1/payments/billing-plans/P-7DC96732KA7763723UOPKETA",
+ * "rel": "self",
+ * "method": "GET"
+ * }
+ * ]
+ * },
+ * {
+ * "id": "P-1TV69435N82273154UPWDU4I",
+ * "state": "ACTIVE",
+ * "name": "Plan with Regular Payment Definition",
+ * "description": "Plan with one regular payment definition, minimal merchant preferences, and no shipping fee",
+ * "type": "INFINITE",
+ * "create_time": "2017-08-22T04:41:55.623Z",
+ * "update_time": "2017-08-22T04:41:56.055Z",
+ * "links": [
+ * {
+ * "href": "https://api.sandbox.paypal.com//v1/payments/billing-plans/P-1TV69435N82273154UPWDU4I",
+ * "rel": "self",
+ * "method": "GET"
+ * }
+ * ]
+ * }
+ * ],
+ * "links": [
+ * {
+ * "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=1&start=3&status=active",
+ * "rel": "start",
+ * "method": "GET"
+ * },
+ * {
+ * "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=0&status=active",
+ * "rel": "previous_page",
+ * "method": "GET"
+ * },
+ * {
+ * "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=2&status=active",
+ * "rel": "next_page",
+ * "method": "GET"
+ * },
+ * {
+ * "href": "https://api.sandbox.paypal.com/v1/payments/billing-plans?page_size=2&page=82&status=active",
+ * "rel": "last",
+ * "method": "GET"
+ * }
+ * ]
+ * }
+ *
+ * </code>
+ *
+ * @link https://developer.paypal.com/docs/api/payments.billing-plans#plan_list
+ */
+class RestListPlanRequest extends AbstractRestRequest
+{
+    /**
+     *
+     * Get the request page
+     *
+     * @return integer
+     */
+
+    public function getPage()
+    {
+        return $this->getParameter('page');
+    }
+
+
+    /**
+     * Set the request page
+     *
+     * @param integer $value
+     * @return AbstractRestRequest provides a fluent interface.
+     */
+    public function setPage($value)
+    {
+        return $this->setParameter('page', $value);
+    }
+
+    /**
+     * Get the request status
+     *
+     * @return string
+     */
+    public function getStatus()
+    {
+        return $this->getParameter('status');
+    }
+
+    /**
+     * Set the request status
+     *
+     * @param string $value
+     * @return AbstractRestRequest provides a fluent interface.
+     */
+    public function setStatus($value)
+    {
+        return $this->setParameter('status', $value);
+    }
+
+    /**
+     * Get the request page size
+     *
+     * @return string
+     */
+    public function getPageSize()
+    {
+        return $this->getParameter('pageSize');
+    }
+
+    /**
+     * Set the request page size
+     *
+     * @param string $value
+     * @return AbstractRestRequest provides a fluent interface.
+     */
+    public function setPageSize($value)
+    {
+        return $this->setParameter('pageSize', $value);
+    }
+
+    /**
+     * Get the request total required
+     *
+     * @return string
+     */
+    public function getTotalRequired()
+    {
+        return $this->getParameter('totalRequired');
+    }
+
+    /**
+     * Set the request total required
+     *
+     * @param string $value
+     * @return AbstractRestRequest provides a fluent interface.
+     */
+    public function setTotalRequired($value)
+    {
+        return $this->setParameter('totalRequired', $value);
+    }
+
+
+
+
+    public function getData()
+    {
+        return array(
+            'page'             => $this->getPage(),
+            'status'          => $this->getStatus(),
+            'page_size'       => $this->getPageSize(),
+            'total_required'        => $this->getTotalRequired()
+        );
+    }
+
+    /**
+     * Get HTTP Method.
+     *
+     * The HTTP method for list plans requests must be GET.
+     *
+     * @return string
+     */
+    protected function getHttpMethod()
+    {
+        return 'GET';
+    }
+
+    public function getEndpoint()
+    {
+        return parent::getEndpoint() . '/payments/billing-plans';
+    }
+}

src/RestGateway.php

@@ -603,7 +603,22 @@ public function updatePlan(array $parameters = array())
     }
 
     // TODO: Retrieve a plan
-    // TODO: List plans
+
+
+    /**
+     * List billing plans.
+     *
+     * Use this call to get a list of plans in any state (CREATED, ACTIVE, etc.).
+     * The plans returned are the plans made by the merchant making the call.
+     *
+     * @link https://developer.paypal.com/docs/api/payments.billing-plans#plan_list
+     * @param array $parameters
+     * @return \Omnipay\PayPal\Message\RestListPlanRequest
+     */
+    public function listPlan(array $parameters = array())
+    {
+        return $this->createRequest('\Omnipay\PayPal\Message\RestListPlanRequest', $parameters);
+    }
 
     /**
      * Create a subscription.

tests/Message/RestListPlanRequestTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Omnipay\PayPal\Message;
+
+use Omnipay\Tests\TestCase;
+
+class RestListPlanRequestTest extends TestCase
+{
+    /** @var \Omnipay\PayPal\Message\RestListPlanRequest */
+    private $request;
+
+    public function setUp()
+    {
+        $client = $this->getHttpClient();
+        $request = $this->getHttpRequest();
+        $this->request = new RestListPlanRequest($client, $request);
+    }
+
+    public function testGetData()
+    {
+        $data = $this->request->getData();
+        $this->assertArrayHasKey('page',$data);
+        $this->assertArrayHasKey('status',$data);
+        $this->assertArrayHasKey('page_size',$data);
+        $this->assertArrayHasKey('total_required',$data);
+    }
+
+    public function testEndpoint()
+    {
+        $this->assertStringEndsWith('/payments/billing-plans', $this->request->getEndpoint());
+    }
+
+}

tests/RestGatewayTest.php

@@ -154,6 +154,27 @@ public function testFetchTransaction()
         $this->assertEmpty($data);
     }
 
+    public function testListPlan()
+    {
+        $request = $this->gateway->listPlan(array(
+            'page'         => 0,
+            'status'       => 'ACTIVE',
+            'pageSize'    => 10, //number of plans in a single page
+            'totalRequired'     => 'yes'
+        ));
+
+        $this->assertInstanceOf('\Omnipay\PayPal\Message\RestListPlanRequest', $request);
+        $this->assertSame(0, $request->getPage());
+        $this->assertSame('ACTIVE', $request->getStatus());
+        $this->assertSame(10, $request->getPageSize());
+        $this->assertSame('yes', $request->getTotalRequired());
+
+        $endPoint = $request->getEndpoint();
+        $this->assertSame('https://api.paypal.com/v1/payments/billing-plans', $endPoint);
+        $data = $request->getData();
+        $this->assertNotEmpty($data);
+    }
+
     public function testFetchPurchase()
     {
         $request = $this->gateway->fetchPurchase(array('transactionReference' => 'abc123'));