Added support for request body parameters

1.1.0 adds support for adding custom request body parameters. The remove.bg api has developed beyond its first initial release where it only allowed a limited set of request body parameters.

Now you can specify paramters such as, "type", "format", "roi", "crop", "bg_color" and many more.

This package now supports all of these request body parameters with the 'body' method.

Happy background removing!

Author: mtownsend5512

README.md

@@ -86,22 +86,38 @@ file_put_contents('path/to/your/file5.png', base64_decode($base64Url));
 
 ### Advanced usage
 
-Remove.bg offers several parameters for each api call. For an up to date list, you should always check the [remove.bg api documentation](https://www.remove.bg/api).
+Remove.bg offers several request body parameters for each api call. For an up to date list, you should always check the [remove.bg api documentation](https://www.remove.bg/api).
 
-Here is an example of an api call configured with specific parameters.
+Here is an example of an api call configured with specific request body parameters.
 
 ````php
 $removebg = new RemoveBg($apiKey);
 
 // Directly saving files
 $removebg->url($absoluteUrl)
-->headers([
+->body([
     'size' => '4k', // regular, medium, hd, 4k, auto
-    'type' => 'product', // auto, person, product
+    'bg_color' => '#CBD5E0',
+    'add_shadow' => true, // primarily used for automotive photos as of the time this documentation was written
     'channels' => 'rgba', // rgba, alpha
 ])
 ->save('path/to/your/file.png');
 ````
+
+You may also directly specify request header parameters. As of right now this does not appear to offer much functionality in terms of how the Remove.bg api will consume these headers, but we thought it was important to expose this functionality. Consider the following example:
+
+````php
+$removebg = new RemoveBg($apiKey);
+
+// Directly saving files
+$removebg->url($absoluteUrl)
+->headers([
+    'X-Foo-Header' => 'Some Bar Value',
+    'X-Foo-Header-2' => 'Some Bar Value 2',
+])
+->save('path/to/your/file.png');
+````
+
 ### Using the global helper (Laravel)
 
 If you are using Laravel, this package provides a convenient helper function which is globally accessible.

src/RemoveBg.php

@@ -18,6 +18,12 @@ class RemoveBg
      */
     public $apiKey;
 
+    /**
+     * Additional request parameters to be included in the body of the api call
+     * @var array
+     */
+    public $body = [];
+
     /**
      * The remove.bg url endpoint used for the request
      *
@@ -106,6 +112,19 @@ public function base64(string $base64)
         return $this;
     }
 
+    /**
+     * Accepts an associative array of data which will be
+     * added to the request body of the api call
+     *
+     * @param  array  $body
+     * @return Mtownsend\RemoveBg\RemoveBg
+     */
+    public function body(array $body)
+    {
+        $this->body = array_merge($this->body, $body);
+        return $this;
+    }
+
     /**
      * Return the fully qualified remove.bg url
      * to which an api request will be sent
@@ -152,6 +171,29 @@ protected function formatFileName($filename)
         return substr($filename, 0, strpos($filename, '.')) . '.png';
     }
 
+    /**
+     * Formats the additional request body into the
+     * acceptable format for the remove.bg api
+     *
+     * @return array
+     */
+    protected function formatBody()
+    {
+        switch ($this->imageFormat) {
+            case 'image_file':
+                $index = 0;
+                foreach ($this->body as $key => $value) {
+                    $data[$index]['name'] = $key;
+                    $data[$index]['contents'] = $value;
+                    $index++;
+                }
+                break;
+            default:
+                $data = $this->body;
+        }
+        return $data;
+    }
+
     /**
      * Formats the request into the acceptable
      * format for the remove.bg api
@@ -162,17 +204,19 @@ protected function formatPayload()
     {
         switch ($this->imageFormat) {
             case 'image_url':
-                return ['form_params' => [$this->imageFormat => $this->payload]];
+                return ['form_params' => array_merge([$this->imageFormat => $this->payload], $this->formatBody())];
                 break;
             case 'image_file':
-                return ['multipart' => [[
-                    'name' => 'image_file',
-                    'contents' => file_get_contents($this->payload),
-                    'filename' => $this->formatFileName($this->fileName)
-                ]]];
+                return ['multipart' => array_merge([
+                    [
+                        'name' => 'image_file',
+                        'contents' => file_get_contents($this->payload),
+                        'filename' => $this->formatFileName($this->fileName)
+                    ]
+                ], $this->formatBody())];
                 break;
             case 'image_file_b64':
-                return ['form_params' => [$this->imageFormat => $this->payload]];
+                return ['form_params' => array_merge([$this->imageFormat => $this->payload], $this->formatBody())];
                 break;
         }
     }