Merge pull request #152 from Nexmo/get-prefix-pricing

Add prefix pricing endpoint

Author: lornajane

README.md

@@ -465,6 +465,25 @@ try {
     echo $e->getMessage();
 }
 ```
+### Pricing
+
+#### Prefix Pricing
+
+If you know the prefix of a country that you want to call, you can use the `prefix-pricing` endpoint to
+find out costs to call that number. Each prefix can return multiple countries (e.g. `1` returns `US`, `CA` and `UM`):
+
+```
+$results = $client->account()->getPrefixPricing('1');
+foreach ($results as $r) {
+    echo $r['country_code'].PHP_EOL;
+    echo $r['country_name'].PHP_EOL;
+    foreach ($r['networks'] as $n) {
+        echo $n->getName() .' :: '.$n->getCode().' :: '.$n->getPrefixPrice().PHP_EOL;
+    }
+    echo "----------------".PHP_EOL;
+}
+```
+
 
 ## Troubleshooting
 
@@ -494,8 +513,9 @@ API Coverage
     * [X] Balance
     * [X] Pricing
     * [ ] Settings
-    * [ ] Top Up
+    * [X] Top Up
     * [X] Secret Management
+    * [X] Pricing
     * [X] Numbers
         * [X] Search
         * [X] Buy
@@ -519,16 +539,16 @@ API Coverage
         * [X] Message
         * [X] Messages
         * [X] Rejections
-    * [ ] US Short Codes
-        * [ ] Two-Factor Authentication
-        * [ ] Event Based Alerts
-            * [ ] Sending Alerts
-            * [ ] Campaign Subscription Management
+    * [X] US Short Codes
+        * [X] Two-Factor Authentication
+        * [X] Event Based Alerts
+            * [X] Sending Alerts
+            * [X] Campaign Subscription Management
 * Voice
     * [X] Outbound Call
-    * [ ] Inbound Call
-    * [ ] Text-To-Speech Call
-    * [ ] Text-To-Speech Prompt
+    * [X] Inbound Call
+    * [X] Text-To-Speech Call
+    * [X] Text-To-Speech Prompt
 
 Contributing
 ------------

src/Account/Client.php

@@ -15,6 +15,47 @@ class Client implements ClientAwareInterface
 {
     use ClientAwareTrait;
 
+    public function getPrefixPricing($prefix)
+    {
+        $queryString = http_build_query([
+            'prefix' => $prefix
+        ]);
+
+        $request = new Request(
+            $this->getClient()->getRestUrl() . '/account/get-prefix-pricing/outbound?'.$queryString,
+            'GET',
+            'php://temp'
+        );
+
+        $response = $this->client->send($request);
+        $rawBody = $response->getBody()->getContents();
+
+        $body = json_decode($rawBody, true);
+
+        $codeCategory = (int) ($response->getStatusCode()/100);
+        if ($codeCategory != 2) {
+            if ($codeCategory == 4) {
+                throw new Exception\Request($body['error-code-label']);
+            }else if ($codeCategory == 5) {
+                throw new Exception\Server($body['error-code-label']);
+            }
+        }
+
+        if ($body['count'] == 0) {
+            return [];
+        }
+
+        // Multiple countries can match each prefix
+        $prices = [];
+
+        foreach ($body['prices'] as $p) {
+            $prefixPrice = new PrefixPrice();
+            $prefixPrice->jsonUnserialize($p);
+            $prices[] = $prefixPrice;
+        }
+        return $prices;
+    }
+
     public function getSmsPrice($country)
     {
         $body = $this->makePricingRequest($country, 'sms');

src/Account/PrefixPrice.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Nexmo\Account;
+
+class PrefixPrice extends Price {
+    protected $priceMethod = 'getPrefixPrice';
+
+    public function getCurrency()
+    {
+        throw new Exception('Currency is unavailable from this endpoint');
+    }
+}
+

src/Account/Price.php

@@ -41,7 +41,11 @@ public function getDialingPrefix()
 
     public function getDefaultPrice()
     {
-        return $this['default_price'];
+        if (isset($this['default_price'])) {
+            return $this['default_price'];
+        }
+
+        return $this['mt'];
     }
 
     public function getCurrency()
@@ -71,15 +75,42 @@ public function jsonUnserialize(array $json)
         $data = [];
         foreach ($json as $k => $v){
             $k = ltrim(strtolower(preg_replace('/[A-Z]([A-Z](?![a-z]))*/', '_$0', $k)), '_');
+
+            // PrefixPrice fixes
+            if ($k == 'country') {
+                $k = 'country_code';
+            }
+
+            if ($k == 'name') {
+                $data['country_display_name'] = $v;
+                $data['country_name'] = $v;
+            }
+
+            if ($k == 'prefix') {
+                $k = 'dialing_prefix';
+            }
+
             $data[$k] = $v;
         }
 
         // Create objects for all the nested networks too
         $networks = [];
-        foreach ($json['networks'] as $n){
-            $network = new Network($n['networkCode'], $n['networkName']);
-            $network->jsonUnserialize($n);
-            $networks[$network->getCode()] = $network;
+        if (isset($json['networks'])) {
+            foreach ($json['networks'] as $n){
+                if (isset($n['code'])) {
+                    $n['networkCode'] = $n['code'];
+                    unset ($n['code']);
+                }
+
+                if (isset($n['network'])) {
+                    $n['networkName'] = $n['network'];
+                    unset ($n['network']);
+                }
+
+                $network = new Network($n['networkCode'], $n['networkName']);
+                $network->jsonUnserialize($n);
+                $networks[$network->getCode()] = $network;
+            }
         }
 
         $data['networks'] = $networks;

src/Network.php

@@ -50,6 +50,10 @@ public function getOutboundVoicePrice()
         return $this['price'];
     }
 
+    public function getPrefixPrice() {
+        return $this['mt_price'];
+    }
+
     public function getCurrency()
     {
         return $this['currency'];
@@ -90,4 +94,4 @@ public function offsetUnset($offset)
     {
         throw new Exception('Network is read only');
     }
-}
+}

test/Account/ClientTest.php

@@ -14,6 +14,7 @@
 use Nexmo\Network;
 use Nexmo\Account\SmsPrice;
 use Nexmo\Account\VoicePrice;
+use Nexmo\Account\PrefixPrice;
 use Nexmo\Account\Client;
 use Zend\Diactoros\Response;
 use NexmoTest\Psr7AssertionTrait;
@@ -102,6 +103,22 @@ public function testGetVoicePricing()
         $this->assertInstanceOf(Network::class, $voicePrice['networks']['311310']);
     }
 
+    public function testGetPrefixPricing()
+    {
+        $this->nexmoClient->send(Argument::that(function (RequestInterface $request) {
+            $this->assertEquals('/account/get-prefix-pricing/outbound', $request->getUri()->getPath());
+            $this->assertEquals('rest.nexmo.com', $request->getUri()->getHost());
+            $this->assertEquals('GET', $request->getMethod());
+            $this->assertRequestQueryContains('prefix', '263', $request);
+
+            return true;
+        }))->shouldBeCalledTimes(1)->willReturn($this->getResponse('prefix-pricing'));
+
+        $prefixPrice = $this->accountClient->getPrefixPricing('263');
+        $this->assertInstanceOf(PrefixPrice::class, $prefixPrice[0]);
+        $this->assertInstanceOf(Network::class, $prefixPrice[0]['networks']['64804']);
+    }
+
     public function testListSecrets()
     {
         $this->nexmoClient->send(Argument::that(function (RequestInterface $request) {

test/Account/PrefixPriceTest.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * Nexmo Client Library for PHP
+ *
+ * @copyright Copyright (c) 2016 Nexmo, Inc. (http://nexmo.com)
+ * @license   https://github.com/Nexmo/nexmo-php/blob/master/LICENSE.txt MIT License
+ */
+
+namespace NexmoTest\Account;
+
+use Nexmo\Network;
+use Nexmo\Account\PrefixPrice;
+use PHPUnit\Framework\TestCase;
+
+class PrefixPriceTest extends TestCase
+{
+    public function setUp()
+    {
+    }
+
+    /**
+     * @dataProvider prefixPriceProvider
+     */
+    public function testFromArray($prefixPrice)
+    {
+        $this->assertEquals("ZW", $prefixPrice->getCountryCode());
+        $this->assertEquals("Zimbabwe", $prefixPrice->getCountryName());
+        $this->assertEquals("263", $prefixPrice->getDialingPrefix());
+    }
+
+    /**
+     * @dataProvider prefixPriceProvider
+     */
+    public function testGetters($prefixPrice)
+    {
+        $this->assertEquals("ZW", $prefixPrice->getCountryCode());
+        $this->assertEquals("Zimbabwe", $prefixPrice->getCountryName());
+        $this->assertEquals("Zimbabwe", $prefixPrice->getCountryDisplayName());
+        $this->assertEquals("263", $prefixPrice->getDialingPrefix());
+    }
+
+    /**
+     * @dataProvider prefixPriceProvider
+     */
+    public function testArrayAccess($prefixPrice)
+    {
+        $this->assertEquals("ZW", $prefixPrice['country_code']);
+        $this->assertEquals("Zimbabwe", $prefixPrice['country_name']);
+        $this->assertEquals("Zimbabwe", $prefixPrice['country_display_name']);
+        $this->assertEquals("263", $prefixPrice['dialing_prefix']);
+    }
+
+    /**
+     * @dataProvider prefixPriceProvider
+     */
+    public function testUsesCustomPriceForKnownNetwork($prefixPrice)
+    {
+        $this->assertEquals("0.123", $prefixPrice->getPriceForNetwork('21039'));
+    }
+
+    public function prefixPriceProvider()
+    {
+        $r = [];
+
+        $prefixPrice = new PrefixPrice();
+        $prefixPrice->jsonUnserialize([
+            'country' => 'ZW',
+            'name' => 'Zimbabwe',
+            'prefix' => 263,
+            'networks' => [
+                [
+                    'code' => '21039',
+                    'network' => 'Demo Network',
+                    'mtPrice' => '0.123'
+                ]
+            ]
+        ]);
+        $r['jsonUnserialize'] = [$prefixPrice];
+
+        return $r;
+    }
+}
+

test/Account/responses/prefix-pricing.json

@@ -0,0 +1 @@
+{"count":1,"prices":[{"country":"ZW","name":"Zimbabwe","prefix":"263","mt":"0.02570000","networks":[{"code":"ZW-TOLL-FREE","network":"Zimbabwe Toll Free","mtPrice":"0.02570000"},{"code":"ZW-UNKNOWN","network":"Zimbabwe Unknown","mtPrice":"0.02570000"},{"code":"ZW-VOIP","network":"Zimbabwe VoIP","mtPrice":"0.02570000"},{"code":"64801","network":"NetOne","mtPrice":"0.02570000"},{"code":"64803","network":"Telecel","mtPrice":"0.02570000"},{"code":"64804","network":"Econet","mtPrice":"0.02570000"}],"countryDisplayName":"Zimbabwe"}]}