Added support of Billing Reports (#21)

pashamesh · Daniel Tolbert · commit aa5506cb05e7 · 2018-02-15T10:04:37.000-05:00
* Added support of Billing Reports

* Added ability to pass request options to `file` method of bilingreports

* Fixed missing `options` argument of `file` method
diff --git a/README.md b/README.md
@@ -524,3 +524,36 @@ $resertation = $account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8
 $resertation = $account->tnsreservations()->tnsreservation("0099ff73-da96-4303-8a0a-00ff316c07aa");
 $resertation->delete();
 ```
+
+## Billing reports
+
+### Listing all Billing Report instances
+```PHP
+$billingReports = $account->billingreports()->getList();
+```
+
+### Request new billing report
+```PHP
+$billingReport = $account->billingreports()->request(
+    array("Type" => "bdr",
+        "DateRange" => array(
+            "StartDate" => "2018-02-05",
+            "EndDate" => "2018-02-06",
+    )));
+```
+
+### Checking status of the billing report
+```PHP
+$billingReport = $account->billingreports()->billingreport('a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2');
+```
+
+### Download zip with content of the billing report
+```PHP
+$zipStream = $billingReport->file();
+```
+
+### Download zip with content of the billing report and save to file
+```PHP
+$outFile = '/tmp/report.zip';
+$billingReport->file(['stream' => true, 'sink' => $outFile]);
+```
diff --git a/core/Client.php b/core/Client.php
@@ -316,36 +316,46 @@ private function prepareXmlBody($data, $baseNode)
      */
     private function parseResponse($response)
     {
-        $responseBody = (string) $response->getBody();
+        $result = [];
 
-        if (!$responseBody && $response->hasHeader('Location'))
+        if ($response->hasHeader('Location'))
         {
             $location = $response->getHeader('Location');
-            return ['Location' => reset($location)];
+            $result['Location'] = reset($location);
+            unset($location);
         }
 
-        if (!$responseBody)
+        $contentType = $response->getHeader('Content-Type');
+        $contentType = reset($contentType);
+
+        if ($contentType && strpos($contentType, 'zip') !== false)
         {
-            return [];
+            return $response->getBody();
         }
 
-        $contentType = $response->getHeader('Content-Type');
-        $contentType = reset($contentType);
+        $responseBody = (string) $response->getBody();
+
+        if (!$responseBody)
+        {
+            return $result;
+        }
 
         if ($contentType && strpos($contentType, 'json') !== false)
         {
-            return json_decode($responseBody, true);
+            $responseBody = json_decode($responseBody, true);
         }
 
         try
         {
             $xml = new SimpleXMLElement($responseBody);
-            return $this->xml2array($xml);
+            $responseBody = $this->xml2array($xml);
+            unset($xml);
         }
         catch (Exception $e)
         {
-            return [];
         }
+
+        return array_replace($result, $responseBody);
     }
 
     /**
diff --git a/src/Account.php b/src/Account.php
@@ -110,6 +110,21 @@ public function users() {
         return $this->users;
     }
 
+    /**
+     * Get BillingReports instance
+     *
+     * @return BillingReports
+     */
+    public function billingreports()
+    {
+        if (!isset($this->billingReports))
+        {
+            $this->billingReports = new BillingReports($this);
+        }
+
+        return $this->billingReports;
+    }
+
     public function reports() {
         if(!isset($this->reports))
             $this->reports = new Reports($this);
diff --git a/src/BillingReports.php b/src/BillingReports.php
@@ -0,0 +1,138 @@
+<?php
+
+/**
+ * @model BillingReports
+ *
+ */
+
+namespace Iris;
+
+class BillingReports extends RestEntry
+{
+    public function __construct($parent)
+    {
+        $this->parent = $parent;
+        parent::_init(
+            $this->parent->get_rest_client(),
+            $this->parent->get_relative_namespace()
+        );
+    }
+
+    public function getList($filters = [])
+    {
+        $billingReports = [];
+
+        $data = parent::_get('billingreports');
+
+        if (!(isset($data['BillingReportList']['BillingReport']) && is_array($data['BillingReportList']['BillingReport'])))
+        {
+            return $billingReports;
+        }
+
+        foreach ($data['BillingReportList']['BillingReport'] as $item)
+        {
+            if (isset($item['BillingReportId']))
+            {
+                $item['Id'] = $item['BillingReportId'];
+                unset($item['BillingReportId']);
+            }
+            if (isset($item['BillingReportKind']))
+            {
+                $item['Type'] = $item['BillingReportKind'];
+                unset($item['BillingReportKind']);
+            }
+            $billingReports[] = new BillingReport($this, $item);
+        }
+
+        return $billingReports;
+    }
+
+    public function billingreport($id)
+    {
+        $billingReport = new BillingReport($this, ["Id" => $id]);
+        $billingReport->get();
+
+        return $billingReport;
+    }
+
+    public function get_appendix()
+    {
+        return '/billingreports';
+    }
+
+    public function request($data)
+    {
+        $billingReport = new BillingReport($this, $data);
+
+        return $billingReport->save();
+    }
+}
+
+class BillingReport extends RestEntry
+{
+    use BaseModel;
+
+    protected $fields = array(
+        "Id" => array("type" => "string"),
+        "UserId" => array("type" => "string"),
+        "Type" => array("type" => "string"),
+        "DateRange" => array("type" => "\Iris\DateRange"),
+        "ReportStatus" => array("type" => "string"),
+        "CreatedDate" => array("type" => "string"),
+        "Description" => array("type" => "string"),
+    );
+
+    public function __construct($parent, $data)
+    {
+        $this->set_data($data);
+        $this->parent = $parent;
+        parent::_init(
+            $parent->get_rest_client(),
+            $parent->get_relative_namespace()
+        );
+    }
+
+    public function get()
+    {
+        $data = parent::_get($this->get_id());
+        $this->set_data($data);
+    }
+    
+    public function get_id()
+    {
+        if (!isset($this->Id))
+        {
+            throw new \Exception('Id should be provided');
+        }
+
+        return $this->Id;
+    }
+
+    public function save()
+    {
+        $header = parent::post(null, "BillingReport", $this->to_array());
+        $splitted = explode("/", $header['Location']);
+        $this->Id = end($splitted);
+
+        return $this;
+    }
+
+    /**
+     * Download zip report file
+     *
+     * @return mixed
+     * @throws \Exception
+     */
+    public function file($options = [])
+    {
+        if (!isset($this->ReportStatus) || $this->ReportStatus !== 'COMPLETED')
+        {
+            return false;
+        }
+
+        $url = sprintf('%s/%s', $this->get_id(), 'file');
+        $url = parent::get_url($url);
+
+        return $this->client->get($url, $options);
+    }
+}
diff --git a/src/simpleModels/DateRange.php b/src/simpleModels/DateRange.php
@@ -0,0 +1,16 @@
+<?php
+
+namespace Iris;
+
+class DateRange {
+    use BaseModel;
+
+    protected $fields = array(
+        "StartDate" => array("type" => "string"),
+        "EndDate" => array("type" => "string"),
+    );
+
+    public function __construct($data) {
+        $this->set_data($data);
+    }
+}
diff --git a/tests/AccountTest.php b/tests/AccountTest.php
@@ -27,7 +27,38 @@ public static function setUpBeforeClass() {
             new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Quantity><Count>4</Count></Quantity>"),
             new Response(200, [], "<?xml version=\"1.0\"?><TNs><TotalCount>4</TotalCount><Links><first></first></Links><TelephoneNumbers><Count>2</Count><TelephoneNumber>4158714245</TelephoneNumber><TelephoneNumber>4352154439</TelephoneNumber></TelephoneNumbers></TNs>"),
             new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><Quantity><Count>4</Count></Quantity>"),
-            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><BdrCreationResponse><Info>Your BDR archive is currently being constructed</Info> </BdrCreationResponse>")
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><BdrCreationResponse><Info>Your BDR archive is currently being constructed</Info> </BdrCreationResponse>"),
+            new Response(200, [], "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?><BillingReportsRetrievalResponse>
+                                                <BillingReportList>
+                                                    <BillingReport>
+                                                        <BillingReportId>5f8734f0-d7c3-445c-b1e2-cdbb620e4ff7</BillingReportId>
+                                                        <BillingReportKind>DIDSNAP</BillingReportKind>
+                                                        <UserId>jbm</UserId>
+                                                        <ReportStatus>PROCESSING</ReportStatus>
+                                                        <Description>The requested report archive is still being constructed, please check back later.</Description>
+                                                        <CreatedDate>2017-11-01 14:12:16</CreatedDate>
+                                                        <DateRange>
+                                                            <StartDate>2017-01-01</StartDate>
+                                                            <EndDate>2017-09-30</EndDate>
+                                                        </DateRange>
+                                                    </BillingReport>
+                                                    <BillingReport>
+                                                        <BillingReportId>7680a54a-b1f1-4d43-8af6-bf3a701ad202</BillingReportId>
+                                                        <BillingReportKind>DIDSNAP</BillingReportKind>
+                                                        <UserId>jbm</UserId>
+                                                        <ReportStatus>COMPLETE</ReportStatus>
+                                                        <Description>The requested report archive is failed</Description>
+                                                        <CreatedDate>2017-11-06 14:22:21</CreatedDate>
+                                                        <DateRange>
+                                                            <StartDate>2017-05-01</StartDate>
+                                                            <EndDate>2017-10-31</EndDate>
+                                                        </DateRange>
+                                                    </BillingReport>
+                                                </BillingReportList>
+                                            </BillingReportsRetrievalResponse>"),
+            new Response(201, ['Location' => 'https://api.test.inetwork.com:443/v1.0/accounts/9500249/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2'], '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><BillingReportCreationResponse><ReportStatus>RECEIVED</ReportStatus><Description>The report archive is currently being constructed.</Description></BillingReportCreationResponse>'),
+            new Response(200, ['Location' => 'https://api.test.inetwork.com:443/v1.0/accounts/9500249/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2/file'], '<?xml version="1.0" encoding="UTF-8" standalone="yes"?><BillingReportRetrievalResponse><ReportStatus>COMPLETED</ReportStatus><Description>The report archive is constructed.</Description></BillingReportRetrievalResponse>'),
+            new Response(200, ['Content-Type' => 'application/zip'], 'zipcontent'),
         ]);
 
         self::$container = [];
@@ -203,4 +234,48 @@ public function testBdr() {
         self::$index++;
     }
 
+    public function testBillingReports() {
+        $billingReports = self::$account->billingreports()->getList();
+
+        $this->assertEquals(2, count($billingReports));
+        $this->assertEquals('5f8734f0-d7c3-445c-b1e2-cdbb620e4ff7', $billingReports[0]->Id);
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/billingreports", self::$container[self::$index]['request']->getUri());
+        unset($billingReports);
+
+        self::$index++;
+    }
+
+    public function testBillingReportRequest() {
+        $response = self::$account->billingreports()->request(array(
+            'Type' => 'BDR',
+            'DateRange' => array(
+                'StartDate' => '2017-11-01',
+                'EndDate' => '2017-11-02',
+            )
+        ));
+
+        $this->assertEquals("a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2", $response->Id);
+        $this->assertEquals("POST", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/billingreports", self::$container[self::$index]['request']->getUri());
+        self::$index++;
+    }
+
+    public function testBillingReportReadyAndDownload() {
+        $billingReport = self::$account->billingreports()
+            ->billingreport('a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2');
+
+        $this->assertEquals("a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2", $billingReport->Id);
+        $this->assertEquals("COMPLETED", $billingReport->ReportStatus);
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2", self::$container[self::$index]['request']->getUri());
+        self::$index++;
+
+        $zip = $billingReport->file();
+
+        $this->assertEquals("zipcontent", $zip->getContents());
+        $this->assertEquals("GET", self::$container[self::$index]['request']->getMethod());
+        $this->assertEquals("https://api.test.inetwork.com/v1.0/accounts/9500249/billingreports/a12b456c8-abcd-1a3b-a1b2-0a2b4c6d8e0f2/file", self::$container[self::$index]['request']->getUri());
+        self::$index++;
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -316,36 +316,46 @@ private function prepareXmlBody($data, $baseNode)`
`316`	`316`	`*/`
`317`	`317`	`private function parseResponse($response)`
`318`	`318`	`{`
`319`		`- $responseBody = (string) $response->getBody();`
	`319`	`+ $result = [];`
`320`	`320`
`321`		`- if (!$responseBody && $response->hasHeader('Location'))`
	`321`	`+ if ($response->hasHeader('Location'))`
`322`	`322`	`{`
`323`	`323`	`$location = $response->getHeader('Location');`
`324`		`- return ['Location' => reset($location)];`
	`324`	`+ $result['Location'] = reset($location);`
	`325`	`+ unset($location);`
`325`	`326`	`}`
`326`	`327`
`327`		`- if (!$responseBody)`
	`328`	`+ $contentType = $response->getHeader('Content-Type');`
	`329`	`+ $contentType = reset($contentType);`
	`330`	`+`
	`331`	`+ if ($contentType && strpos($contentType, 'zip') !== false)`
`328`	`332`	`{`
`329`		`- return [];`
	`333`	`+ return $response->getBody();`
`330`	`334`	`}`
`331`	`335`
`332`		`- $contentType = $response->getHeader('Content-Type');`
`333`		`- $contentType = reset($contentType);`
	`336`	`+ $responseBody = (string) $response->getBody();`
	`337`	`+`
	`338`	`+ if (!$responseBody)`
	`339`	`+ {`
	`340`	`+ return $result;`
	`341`	`+ }`
`334`	`342`
`335`	`343`	`if ($contentType && strpos($contentType, 'json') !== false)`
`336`	`344`	`{`
`337`		`- return json_decode($responseBody, true);`
	`345`	`+ $responseBody = json_decode($responseBody, true);`
`338`	`346`	`}`
`339`	`347`
`340`	`348`	`try`
`341`	`349`	`{`
`342`	`350`	`$xml = new SimpleXMLElement($responseBody);`
`343`		`- return $this->xml2array($xml);`
	`351`	`+ $responseBody = $this->xml2array($xml);`
	`352`	`+ unset($xml);`
`344`	`353`	`}`
`345`	`354`	`catch (Exception $e)`
`346`	`355`	`{`
`347`		`- return [];`
`348`	`356`	`}`
	`357`	`+`
	`358`	`+ return array_replace($result, $responseBody);`
`349`	`359`	`}`
`350`	`360`
`351`	`361`	`/**`