Rename ticker model to rate model

Closes #75
seegno · Apr 27, 2015 · e2e292f · e2e292f
1 parent caeff1b
commit e2e292f
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 67 deletions.
diff --git a/README.md b/README.md
@@ -197,15 +197,15 @@ The above produces the output shown below:
 ```php
 Array
 (
-    [0] => Bitreserve\Model\Ticker Object
+    [0] => Bitreserve\Model\Rate Object
         (
             [ask:protected] => 1
             [bid:protected] => 1
             [currency:protected] => BTC
             [pair:protected] => BTCBTC
         )
 
-    [1] => Bitreserve\Model\Ticker Object
+    [1] => Bitreserve\Model\Rate Object
         (
             [ask:protected] => 234.89
             [bid:protected] => 234.8

diff --git a/examples/Ticker.php b/examples/Ticker.php
@@ -8,14 +8,14 @@
 // AUTHORIZATION_TOKEN because the Ticker endpoint is public.
 $client = new Client();
 
-// Get tickers.
-$tickers = $client->getTicker();
+// Get rates.
+$rates = $client->getTicker();
 
 echo "*** Current exchange rates ***\n";
 
-foreach ($tickers as $ticker) {
-    echo sprintf("Pair: %s\n", $ticker->getPair());
-    echo sprintf("Ask: 1 %s = %s %s\n", substr($ticker->getPair(), 0, 3), $ticker->getAsk(), $ticker->getCurrency());
-    echo sprintf("Bid: 1 %s = %s %s\n", substr($ticker->getPair(), 0, 3), $ticker->getBid(), $ticker->getCurrency());
+foreach ($rates as $rate) {
+    echo sprintf("Pair: %s\n", $rate->getPair());
+    echo sprintf("Ask: 1 %s = %s %s\n", substr($rate->getPair(), 0, 3), $rate->getAsk(), $rate->getCurrency());
+    echo sprintf("Bid: 1 %s = %s %s\n", substr($rate->getPair(), 0, 3), $rate->getBid(), $rate->getCurrency());
     echo "\n";
 }
diff --git a/lib/Bitreserve/BitreserveClient.php b/lib/Bitreserve/BitreserveClient.php
@@ -4,8 +4,8 @@
 
 use Bitreserve\HttpClient\HttpClient;
 use Bitreserve\HttpClient\HttpClientInterface;
+use Bitreserve\Model\Rate;
 use Bitreserve\Model\Reserve;
-use Bitreserve\Model\Ticker;
 use Bitreserve\Model\Token;
 use Bitreserve\Model\Transaction;
 
@@ -123,14 +123,14 @@ public function setOption($name, $value)
      */
     public function getCurrencies()
     {
-        $tickers = $this->getTicker();
+        $rates = $this->getTicker();
 
-        return array_reduce($tickers, function($currencies, $ticker) {
-            if (in_array($ticker->getCurrency(), $currencies)) {
+        return array_reduce($rates, function($currencies, $rate) {
+            if (in_array($rate->getCurrency(), $currencies)) {
                 return $currencies;
             }
 
-            $currencies[] = $ticker->getCurrency();
+            $currencies[] = $rate->getCurrency();
 
             return $currencies;
         }, array());
@@ -145,8 +145,8 @@ public function getTicker()
     {
         $response = $this->get('/ticker');
 
-        return array_map(function($ticker) {
-            return new Ticker($this, $ticker);
+        return array_map(function($rate) {
+            return new Rate($this,($rate));
         }, $response->getContent());
     }
 
@@ -161,8 +161,8 @@ public function getTickerByCurrency($currency)
     {
         $response = $this->get(sprintf('/ticker/%s', rawurlencode($currency)));
 
-        return array_map(function($ticker) {
-            return new Ticker($this, $ticker);
+        return array_map(function($rate) {
+            return new Rate($this, $rate);
         }, $response->getContent());
     }
 

diff --git a/lib/Bitreserve/Model/Ticker.php → lib/Bitreserve/Model/Rate.php b/lib/Bitreserve/Model/Ticker.php → lib/Bitreserve/Model/Rate.php
@@ -5,9 +5,9 @@
 use Bitreserve\BitreserveClient;
 
 /**
- * Ticker Model.
+ * Rate Model.
  */
-class Ticker extends BaseModel implements TickerInterface
+class Rate extends BaseModel implements RateInterface
 {
     /**
      * Ask.

diff --git a/lib/Bitreserve/Model/TickerInterface.php → lib/Bitreserve/Model/RateInterface.php b/lib/Bitreserve/Model/TickerInterface.php → lib/Bitreserve/Model/RateInterface.php
@@ -3,33 +3,33 @@
 namespace Bitreserve\Model;
 
 /**
- * TokenInterface.
+ * RateInterface.
  */
-interface TickerInterface
+interface RateInterface
 {
     /**
-     * Gets ticker ask.
+     * Gets rate ask.
      *
      * @return $ask
      */
     public function getAsk();
 
     /**
-     * Gets ticker bid.
+     * Gets rate bid.
      *
      * @return $bid
      */
     public function getBid();
 
     /**
-     * Gets ticker currency.
+     * Gets rate currency.
      *
      * @return $currency
      */
     public function getCurrency();
 
     /**
-     * Gets ticker pair.
+     * Gets rate pair.
      *
      * @return $pair
      */

diff --git a/test/Bitreserve/Tests/Functional/BitreserveClientTest.php b/test/Bitreserve/Tests/Functional/BitreserveClientTest.php
@@ -14,31 +14,31 @@ class BitreserveClientTest extends TestCase
     /**
      * @test
      */
-    public function shouldReturnTickers()
+    public function shouldReturnRates()
     {
-        $tickers = $this->client->getTicker();
+        $rates = $this->client->getTicker();
 
-        foreach ($tickers as $ticker) {
-            $this->assertObjectHasAttribute('ask', $ticker);
-            $this->assertObjectHasAttribute('bid', $ticker);
-            $this->assertObjectHasAttribute('currency', $ticker);
-            $this->assertObjectHasAttribute('pair', $ticker);
+        foreach ($rates as $rate) {
+            $this->assertObjectHasAttribute('ask', $rate);
+            $this->assertObjectHasAttribute('bid', $rate);
+            $this->assertObjectHasAttribute('currency', $rate);
+            $this->assertObjectHasAttribute('pair', $rate);
         }
     }
 
     /**
      * @test
      * @dataProvider getCurrenciesProvider
      */
-    public function shouldReturnTickersForACurrency($currency)
+    public function shouldReturnRatesForACurrency($currency)
     {
-        $tickers = $this->client->getTickerByCurrency($currency);
+        $rates = $this->client->getTickerByCurrency($currency);
 
-        foreach ($tickers as $ticker) {
-            $this->assertObjectHasAttribute('ask', $ticker);
-            $this->assertObjectHasAttribute('bid', $ticker);
-            $this->assertObjectHasAttribute('currency', $ticker);
-            $this->assertObjectHasAttribute('pair', $ticker);
+        foreach ($rates as $rate) {
+            $this->assertObjectHasAttribute('ask', $rate);
+            $this->assertObjectHasAttribute('bid', $rate);
+            $this->assertObjectHasAttribute('currency', $rate);
+            $this->assertObjectHasAttribute('pair', $rate);
         }
     }
 
@@ -50,7 +50,7 @@ public function shouldThrowExceptionWhenCurrencyIsNotValid()
     {
         $currency = 'FOO';
 
-        $tickers = $this->client->getTickerByCurrency($currency);
+        $rates = $this->client->getTickerByCurrency($currency);
     }
 
     /**

diff --git a/test/Bitreserve/Tests/Unit/BitreserveClientTest.php b/test/Bitreserve/Tests/Unit/BitreserveClientTest.php
@@ -64,7 +64,7 @@ public function shouldThrowAuthenticationRequiredExceptionWhenGettingToken()
     /**
      * @test
      */
-    public function shouldReturnTickers()
+    public function shouldReturnRates()
     {
         $data = array(array(
             'ask' => $this->faker->randomFloat,
@@ -89,19 +89,19 @@ public function shouldReturnTickers()
             ->with('/ticker')
             ->will($this->returnValue($response));
 
-        $tickers = $client->getTicker();
+        $rates = $client->getTicker();
 
-        $this->assertCount(count($data), $tickers);
+        $this->assertCount(count($data), $rates);
 
-        foreach ($tickers as $ticker) {
-            $this->assertInstanceOf('Bitreserve\Model\Ticker', $ticker);
+        foreach ($rates as $rate) {
+            $this->assertInstanceOf('Bitreserve\Model\Rate', $rate);
         }
     }
 
     /**
      * @test
      */
-    public function shouldReturnTickersByCurrency()
+    public function shouldReturnRatesByCurrency()
     {
         $expectedCurrency = $this->faker->currencyCode;
 
@@ -128,14 +128,14 @@ public function shouldReturnTickersByCurrency()
             ->with(sprintf('/ticker/%s', $expectedCurrency))
             ->will($this->returnValue($response));
 
-        $tickers = $client->getTickerByCurrency($expectedCurrency);
+        $rates = $client->getTickerByCurrency($expectedCurrency);
 
-        $this->assertCount(count($data), $tickers);
+        $this->assertCount(count($data), $rates);
 
-        foreach ($tickers as $ticker) {
-            $this->assertInstanceOf('Bitreserve\Model\Ticker', $ticker);
+        foreach ($rates as $rate) {
+            $this->assertInstanceOf('Bitreserve\Model\Rate', $rate);
 
-            $this->assertRegExp(sprintf('/%s/', $expectedCurrency), $ticker->getPair());
+            $this->assertRegExp(sprintf('/%s/', $expectedCurrency), $rate->getPair());
         }
     }
 

diff --git a/...itreserve/Tests/Unit/Model/TickerTest.php → .../Bitreserve/Tests/Unit/Model/RateTest.php b/...itreserve/Tests/Unit/Model/TickerTest.php → .../Bitreserve/Tests/Unit/Model/RateTest.php
@@ -2,26 +2,26 @@
 
 namespace Bitreserve\Tests\Unit\Model;
 
-use Bitreserve\Model\Ticker;
+use Bitreserve\Model\Rate;
 
 /**
- * TickerTest.
+ * RateTest.
  */
-class TickerTest extends TestCase
+class RateTest extends TestCase
 {
     /**
      * @test
      */
-    public function shouldReturnInstanceOfTicker()
+    public function shouldReturnInstanceOfRate()
     {
         $data = array('ask' => '1');
 
         $client = $this->getBitreserveClientMock();
 
-        $ticker = new Ticker($client, $data);
+        $rate = new Rate($client, $data);
 
-        $this->assertInstanceOf('Bitreserve\BitreserveClient', $ticker->getClient());
-        $this->assertInstanceOf('Bitreserve\Model\Ticker', $ticker);
+        $this->assertInstanceOf('Bitreserve\BitreserveClient', $rate->getClient());
+        $this->assertInstanceOf('Bitreserve\Model\Rate', $rate);
     }
 
     /**
@@ -33,9 +33,9 @@ public function shouldReturnAsk()
 
         $client = $this->getBitreserveClientMock();
 
-        $ticker = new Ticker($client, $data);
+        $rate = new Rate($client, $data);
 
-        $this->assertEquals($data['ask'], $ticker->getAsk());
+        $this->assertEquals($data['ask'], $rate->getAsk());
     }
 
     /**
@@ -47,9 +47,9 @@ public function shouldReturnBid()
 
         $client = $this->getBitreserveClientMock();
 
-        $ticker = new Ticker($client, $data);
+        $rate = new Rate($client, $data);
 
-        $this->assertEquals($data['bid'], $ticker->getBid());
+        $this->assertEquals($data['bid'], $rate->getBid());
     }
 
     /**
@@ -61,9 +61,9 @@ public function shouldReturnCurrency()
 
         $client = $this->getBitreserveClientMock();
 
-        $ticker = new Ticker($client, $data);
+        $rate = new Rate($client, $data);
 
-        $this->assertEquals($data['currency'], $ticker->getCurrency());
+        $this->assertEquals($data['currency'], $rate->getCurrency());
     }
 
     /**
@@ -75,13 +75,13 @@ public function shouldReturnPair()
 
         $client = $this->getBitreserveClientMock();
 
-        $ticker = new Ticker($client, $data);
+        $rate = new Rate($client, $data);
 
-        $this->assertEquals($data['pair'], $ticker->getPair());
+        $this->assertEquals($data['pair'], $rate->getPair());
     }
 
     protected function getModelClass()
     {
-        return 'Bitreserve\Model\Ticker';
+        return 'Bitreserve\Model\Rate';
     }
 }