Added the ability to get ask, bid, and mid.

Author: michaeldrennen

src/ClientCustomPriceFixedIncome.php

@@ -0,0 +1,187 @@
+<?php
+
+namespace DPRMC\InteractiveData;
+
+use DPRMC\CUSIP;
+use DPRMC\InteractiveData\RemotePlusClient\Exceptions\UnparsableDateSentToConstructor;
+
+/**
+ * Class ClientCustomPriceFixedIncome
+ * @package DPRMC\InteractiveData
+ */
+class ClientCustomPriceFixedIncome extends RemotePlusClient {
+
+    /**
+     * @var string YYYY-mm-dd The date you want pricing for.
+     */
+    protected $date;
+
+    /**
+     * @var array The list of CUSIP identifiers that you want daily pricing on.
+     */
+    protected $cusips = [];
+
+    /**
+     * @var array A list of all of the CUSIPs passed into the constructor that were not valid CUSIPs.
+     */
+    protected $invalidCusips = [];
+
+
+    protected $pricesRequested = [];
+
+
+
+    /**
+     * ClientCustomPriceFixedIncome constructor.
+     * @param $user
+     * @param $pass
+     * @param $date
+     * @param $cusips
+     * @param bool $debug
+     * @throws \Exception
+     */
+    public function __construct( $user, $pass, $date, $cusips, $debug = FALSE ) {
+        parent::__construct( $user, $pass );
+        $this->remotePlusDebug = $debug;
+        $this->date            = $this->formatDateForRemotePlus( $date );
+        $this->cusips          = $this->pruneInvalidCusips( $cusips );
+        $this->generateBodyForRequest();
+    }
+
+    /**
+     * @return $this
+     */
+    public function addBestPrice(){
+        $this->pricesRequested[] = 'PRC'; // number 16.7
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function addBid() {
+        $this->pricesRequested[] = 'BID'; // number 16.7
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function addMid() {
+        $this->pricesRequested[] = 'MID'; // number 16.7
+        return $this;
+    }
+
+    /**
+     * @return $this
+     */
+    public function addAsk() {
+        $this->pricesRequested[] = 'ASK'; // number 16.7
+        return $this;
+    }
+
+
+    /**
+     * The Remote Plus API is particular about how dates are formatted.
+     *
+     * @param string $date A string that can be parsed by PHP's strtotime() function.
+     *
+     * @return string A date formatted as YYYYMMDD that can be read by Remote Plus.
+     * @throws \Exception Only thrown if the user passes some garbage into the constructor.
+     */
+    protected function formatDateForRemotePlus( $date ) {
+        $strTime = strtotime( $date );
+        if ( $strTime === FALSE ):
+            throw new UnparsableDateSentToConstructor( "We could not parse the date you sent to the constructor: [" . $date . "]" );
+        endif;
+        $date = date( 'Ymd', $strTime );
+
+        return $date;
+    }
+
+    /**
+     * We don't want to waste time (or money) getting prices on identifiers that are not valid cusips.
+     * Prune out the invalid cusips and save those in the local $invalidCusips property.
+     *
+     * @param array $cusips A list of cusips passed in by the user in the constructor.
+     *
+     * @return array A list of cusips pruned of any values that aren't valid cusips.
+     */
+    protected function pruneInvalidCusips( $cusips ) {
+        $validCusips = [];
+        foreach ( $cusips as $cusip ):
+            if ( CUSIP::isCUSIP( $cusip ) ):
+                $validCusips[] = $cusip;
+            else:
+                $this->invalidCusips[] = $cusip;
+            endif;
+        endforeach;
+
+        return $validCusips;
+    }
+
+    /**
+     * The Remote Plus API requires the request body to be formatted in a very specific way.
+     * The following body is formatted to pull the prices for a list of CUSIPs from a specific date.
+     */
+    protected function generateBodyForRequest() {
+        $pricesRequested = $this->getPricesRequested();
+
+        $this->requestBody = 'Request=' . urlencode( "GET,(" . implode( ',', $this->cusips ) . "),(" . $pricesRequested . ")," . $this->date ) . "&Done=flag\n";
+    }
+
+    /**
+     * @return string
+     * @throws \Exception
+     */
+    protected function getPricesRequested() {
+        if ( empty( $pricesRequested ) ):
+            throw new \Exception( "You have to add at least one price for this request." );
+        endif;
+
+        return implode( ',', $pricesRequested );
+    }
+
+    /**
+     * @return array
+     */
+    protected function processResponse() {
+        $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 ):
+            $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
+     * @codeCoverageIgnore
+     */
+    protected function getBodyFromResponse() {
+        return (string)$this->response->getBody();
+    }
+
+    /**
+     * @param $value
+     *
+     * @return float
+     */
+    protected function formatValueReturnedFromInteractiveData( $value ) {
+        if ( is_numeric( $value ) ) {
+            return (float)$value;
+        }
+
+        // @codeCoverageIgnoreStart
+        return (float)str_replace( '"', '', $value );
+        // @codeCoverageIgnoreEnd
+    }
+}