Merge pull request #91 from turbo124/main

Allow downloading PDFs via API
invoiceninja · Sep 7, 2022 · f69f001 · f69f001
2 parents 176a9d4 + 7b4c8ea
commit f69f001
Show file tree

Hide file tree

Showing 6 changed files with 79 additions and 6 deletions.
diff --git a/src/Endpoints/BaseEntity.php b/src/Endpoints/BaseEntity.php
@@ -67,5 +67,14 @@ public function create(array $entity, array $includes = [])
         return $this->ninja->send("POST", "{$this->uri}", $query);
     }
 
+    public function download(array $entity, array $includes = [])
+    {
+        $data = ['ids' => $entity, 'action' => 'download', 'stream' => false];
+
+        $query = ['form_params' => $data, 'query' => $includes];
+
+        return $this->ninja->stream("POST", "{$this->uri}/bulk", $query);
+
+    }
 }
 
diff --git a/src/InvoiceNinja.php b/src/InvoiceNinja.php
@@ -262,6 +262,33 @@ public function send(string $method, string $uri, array $payload)
 		}
 	}
 
+	public function stream(string $method, string $uri, array $payload)
+	{
+
+		$this->httpClient();
+
+		$url = $this->getUrl() . $uri;
+
+		try{
+
+			$response =  $this->httpClient->request($method, $url, $payload);
+
+			$body = $response->getBody();
+
+			return (string)$body;
+
+		}
+		catch(GuzzleException $e) {
+
+            if (method_exists($e, 'hasResponse') && method_exists($e, 'getResponse') && $e->hasResponse()) 
+            	throw ApiException::createFromResponse($e->getResponse());
+
+            throw new ApiException($e->getMessage(), $e->getCode());
+
+		}
+
+	}
+
 }
 
 
diff --git a/tests/ExpenseCategoriesTest.php b/tests/ExpenseCategoriesTest.php
@@ -32,7 +32,7 @@ public function testExpenseCategoriesPost()
         $ninja = new InvoiceNinja($this->token);
         $ninja->setUrl($this->url);
 
-        $expense_categories = $ninja->expense_categories->create(['name' => $this->faker->firstName]);
+        $expense_categories = $ninja->expense_categories->create(['name' => $this->faker->text(10)]);
 
         $this->assertTrue(is_array($expense_categories));
 
@@ -48,7 +48,7 @@ public function testExpenseCategoryGet()
         $ninja = new InvoiceNinja($this->token);
         $ninja->setUrl($this->url);
 
-        $expense_categories = $ninja->expense_categories->create(['name' => $this->faker->firstName]);
+        $expense_categories = $ninja->expense_categories->create(['name' => $this->faker->text(10)]);
 
         $this->assertTrue(is_array($expense_categories));
 
@@ -68,9 +68,11 @@ public function testExpenseCategoryPut()
         $ninja = new InvoiceNinja($this->token);
         $ninja->setUrl($this->url);
 
-        $expense_categories = $ninja->expense_categories->create(['name' => $this->faker->firstName]);
+        $expense_category = $this->faker->text(10);
+
+        $expense_categories = $ninja->expense_categories->create(['name' => $expense_category]);
 
-        $expense_categories = $ninja->expense_categories->update($expense_categories['data']['id'], ['name' => $this->faker->firstName]);
+        $expense_categories = $ninja->expense_categories->update($expense_categories['data']['id'], ['name' => $this->faker->text(10)]);
 
         $this->assertTrue(is_array($expense_categories));
 

diff --git a/tests/GroupSettingsTest.php b/tests/GroupSettingsTest.php
@@ -32,7 +32,6 @@ public function testAddGroupSetting()
         $ninja = new InvoiceNinja($this->token);
         $ninja->setUrl($this->url);
 
-
         $settings = new \stdClass;
         $settings->currency_id = '1';
 

diff --git a/tests/InvoicesTest.php b/tests/InvoicesTest.php
@@ -181,4 +181,38 @@ public function testInvoicePostWithMultiItemsMarkSent()
 
     } 
 
+    public function testDownloadInvoice()
+    {
+
+        $ninja = new InvoiceNinja($this->token);
+        $ninja->setUrl($this->url);
+
+        $client = $ninja->clients->create(['name' => 'Brand spanking new client']);
+
+        $invoice = [
+            'client_id' => $client['data']['id'],
+            'line_items' => [
+                [
+                    'product_key' => 'test',
+                    'notes' => 'description',
+                    'quantity' => 1,
+                    'cost' => 10
+                ],
+                [                
+                    'product_key' => 'test',
+                    'notes' => 'description',
+                    'quantity' => 1,
+                    'cost' => 10
+                ],
+            ],
+        ];
+
+        $invoice = $ninja->invoices->create($invoice, ['mark_sent' => "true"]);
+
+        $download = $ninja->invoices->download([$invoice['data']['id']]);
+
+        $this->assertNotNull($download);
+
+    }
+
 }
diff --git a/tests/PaymentsTest.php b/tests/PaymentsTest.php
@@ -69,7 +69,9 @@ public function testInvoicePost()
         $ninja = new InvoiceNinja($this->token);
         $ninja->setUrl($this->url);
 
-        $payments = $ninja->payments->create(['client_id' => '7LDdwRb1YK', 'amount' => 10]);
+        $client = $ninja->clients->create(['name' => 'Brand spanking new client']);
+
+        $payments = $ninja->payments->create(['client_id' => $client['data']['id'], 'amount' => 10]);
 
         $this->assertTrue(is_array($payments));