Stubbing out and testing the run function.

Author: michaeldrennen

src/ClientDailyPriceFixedIncome.php

@@ -95,21 +95,29 @@ protected function generateBodyForRequest() {
      * @return array
      */
     protected function processResponse() {
-        $body = (string)$this->response->getBody();
-
+        $body   = $this->getBodyFromResponse();
         $prices = explode( "\n", $body );
         $prices = array_map( 'trim', $prices );
-
+        $prices = array_filter( $prices );
         array_pop( $prices ); // Remove the CRC check.
 
         $return = [];
-        foreach ( $this->cusips as $i => $cusip ) {
+        foreach ( $this->cusips as $i => $cusip ):
             $return[ $cusip ] = $this->formatValueReturnedFromInteractiveData( $prices[ $i ] );
-        }
+        endforeach;
 
         return $return;
     }
 
+    /**
+     * Extracted this into it's own function so I can stub and test without
+     * having to make a request to the IDC server.
+     * @return string
+     */
+    protected function getBodyFromResponse() {
+        return (string)$this->response->getBody();
+    }
+
     protected function formatValueReturnedFromInteractiveData( $value ) {
         if ( is_numeric( $value ) ) {
             return (float)$value;

src/RemotePlusClient.php

@@ -112,28 +112,21 @@ protected function encodeUserAndPassForBasicAuthentication( $username, $pass ) {
         return base64_encode( $username . ':' . $pass );
     }
 
-    /**
-     * Getter method for the Response object.
-     * @return Response
-     */
-    public function getResponse() {
-        return $this->response;
-    }
-
     /**
      * @return mixed
      */
     public function run() {
-        $this->sendRequest();
+        $this->response = $this->sendRequest();
 
         return $this->processResponse();
     }
 
     /**
      * Sends the request to Remote Plus, and saves the Response object into our local $response property.
+     * @return Response The Guzzle response object.
      */
-    public function sendRequest() {
-        $this->response = $this->client->request( 'POST', $this->page, [ 'debug'   => $this->remotePlusDebug,
+    protected function sendRequest() {
+        return $this->client->request( 'POST', $this->page, [ 'debug'              => $this->remotePlusDebug,
                                                                          'version' => $this->remotePlusHttpVersion,
                                                                          'headers' => [ 'Content-Type'  => $this->remotePlusContentType,
                                                                                         'Authorization' => $this->getAuthenticationHeaderValue( $this->user, $this->pass ), ],

tests/ClientDailyPriceFixedIncomeTest.php

@@ -4,7 +4,9 @@
 use DPRMC\InteractiveData\ClientDailyPriceFixedIncome;
 use DPRMC\InteractiveData\RemotePlusClient\Exceptions\UnparsableDateSentToConstructor;
 use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Psr7\Response;
 use PHPUnit\Framework\TestCase;
+use ReflectionObject;
 
 class ClientDailyPriceFixedIncomeTest extends TestCase {
 
@@ -14,6 +16,8 @@ class ClientDailyPriceFixedIncomeTest extends TestCase {
 
     protected $validDate = '2017-07-31';
 
+    protected $validPrices = [ '38259P508' => 919.46 ];
+
     protected $invalidDate = 'this is not a date';
 
     protected $validCusips = [ '38259P508' ]; // Google
@@ -54,4 +58,28 @@ public function testRunWithInvalidCredentials() {
         $client = new ClientDailyPriceFixedIncome( $this->invalidUser, $this->invalidPass, $this->validDate, $this->validCusips, FALSE );
         $client->run();
     }
+
+    public function testRunWithStubResponse() {
+        $client = new ClientDailyPriceFixedIncome( $this->invalidUser, $this->invalidPass, $this->validDate, $this->validCusips, FALSE );
+
+        // Create a stub for the ClientDailyPriceFixedIncome class.
+        $stubClient = $this->createPartialMock( ClientDailyPriceFixedIncome::class, [ 'sendRequest',
+                                                                                      'getBodyFromResponse' ] );
+        // Configure the stub.
+        $stubClient->method( 'sendRequest' )
+                   ->willReturn( new Response() );
+
+        $fileContents = file_get_contents( './tests/files/38259P508.txt' );
+        $stubClient->method( 'getBodyFromResponse' )
+                   ->willReturn( $fileContents );
+
+        // Stub CUSIP list
+        $refObject   = new ReflectionObject( $stubClient );
+        $refProperty = $refObject->getProperty( 'cusips' );
+        $refProperty->setAccessible( TRUE );
+        $refProperty->setValue( $stubClient, $this->validCusips );
+        $cusipPriceArray = $stubClient->run();
+        $this->assertArrayHasKey( $this->validCusips[ 0 ], $cusipPriceArray );
+        $this->assertEquals( $this->validPrices[ $this->validCusips[ 0 ] ], $cusipPriceArray[ $this->validCusips[ 0 ] ] );
+    }
 }

tests/files/38259P508.txt

@@ -0,0 +1,2 @@
+919.46
+\CRC=66ee