Merge pull request #42 from php-http/body

Add Body implementations

Author: sagikazarmark

src/Body.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Http\Client;
+
+use Psr\Http\Message\StreamInterface;
+
+/**
+ * Allows a more input types for body data
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+interface Body
+{
+    /**
+     * Returns a set of headers which is needed to correctly send the body
+     *
+     * Note: these headers SHOULD be overwritten if any matching header is passed manually
+     *
+     * Content-Length is calculated automatically if possible
+     *
+     * @return array
+     */
+    public function getContentHeaders();
+
+    /**
+     * Convert data to a format which can be used to create a proper PSR-7 Stream
+     *
+     * @return string|StreamInterface
+     *
+     * @throws Exception
+     */
+    public function toStreamable();
+}

src/Body/CombinedMultipart.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Http\Client\Body;
+
+/**
+ * Data and files converted to multipart form body
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+class CombinedMultipart extends Multipart
+{
+    /**
+     * @var MultipartData
+     */
+    protected $data;
+
+    /**
+     * @var Files
+     */
+    protected $files;
+
+    /**
+     * @param array       $data
+     * @param array       $files
+     * @param string|null $boundary
+     */
+    public function __construct(array $data, array $files, $boundary = null)
+    {
+        parent::__construct($boundary);
+
+        $this->data = new MultipartData($data, $this->boundary);
+        $this->files = new Files($files, $this->boundary);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toStreamable()
+    {
+        $body = $this->data->toStreamable();
+        $body .= $this->files->toStreamable();
+
+        return $body;
+    }
+}

src/Body/Files.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace Http\Client\Body;
+
+use Http\Client\Exception\RuntimeException;
+
+/**
+ * Files converted to multipart form body
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+class Files extends Multipart
+{
+    /**
+     * @var array
+     */
+    protected $files;
+
+    /**
+     * @param array       $files
+     * @param string|null $boundary
+     */
+    public function __construct(array $files, $boundary = null)
+    {
+        $this->files = $files;
+
+        parent::__construct($boundary);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toStreamable()
+    {
+        $body = '';
+
+        foreach ($this->files as $name => $file) {
+            if (!is_file($file)) {
+                throw new RuntimeException(sprintf('File "%s" does not exist', $file));
+            }
+
+            $body .= sprintf(
+                "--%s\r\nContent-Disposition: form-data; name=\"%s\"; filename=\"%s\"\r\n\r\n%s\r\n",
+                $this->boundary,
+                $name,
+                basename($file),
+                file_get_contents($file)
+            );
+        }
+
+        return $body;
+    }
+}

src/Body/Multipart.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Http\Client\Body;
+
+use Http\Client\Body;
+
+/**
+ * Basic multipart body
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+abstract class Multipart implements Body
+{
+    /**
+     * @var string
+     */
+    protected $boundary;
+
+    /**
+     * @param string|null $boundary
+     */
+    public function __construct($boundary = null)
+    {
+        if (is_null($boundary)) {
+            $boundary = sha1(microtime());
+        }
+
+        $this->boundary = $boundary;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContentHeaders()
+    {
+        return [
+            'Content-Type' => 'multipart/form-data; boundary='.$this->boundary,
+        ];
+    }
+}

src/Body/MultipartData.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace Http\Client\Body;
+
+/**
+ * Data converted to multipart form body
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+class MultipartData extends Multipart
+{
+    /**
+     * @var array
+     */
+    protected $data;
+
+    /**
+     * @param array       $data
+     * @param string|null $boundary
+     */
+    public function __construct(array $data, $boundary = null)
+    {
+        $this->data = $data;
+
+        parent::__construct($boundary);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toStreamable()
+    {
+        return $this->prepareData(null, $this->data);
+    }
+
+    /**
+     * @param string|integer|null $name
+     * @param mixed               $data
+     *
+     * @return string
+     */
+    protected function prepareData($name, $data)
+    {
+        $body = '';
+
+        if (is_array($data)) {
+            foreach ($data as $subName => $subData) {
+                if (!is_null($name)) {
+                    $subName = sprintf('%s[%s]', $name, $subName);
+                }
+
+                $body .= $this->prepareData($subName, $subData);
+            }
+
+            return $body;
+        }
+
+        $body .= sprintf(
+            "--%s\r\nContent-Disposition: form-data; name=\"%s\"\r\n\r\n%s\r\n",
+            $this->files->getBoundary(),
+            $name,
+            $data
+        );
+
+        return $body;
+    }
+}

src/Body/PlainText.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Http\Client\Body;
+
+use Http\Client\Body;
+
+/**
+ * Plain text body
+ *
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+class PlainText implements Body
+{
+    /**
+     * @var string
+     */
+    protected $string;
+
+    /**
+     * @param string $string
+     */
+    public function __construct($string)
+    {
+        $this->string = $string;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContentHeaders()
+    {
+        return [
+            'Content-Type' => 'text/plain',
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toStreamable()
+    {
+        return $this->string;
+    }
+}

src/Body/UrlencodedData.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace Http\Client\Body;
+
+use Http\Client\Body;
+
+/**
+ * @author Márk Sági-Kazár <[email protected]>
+ */
+class UrlencodedData implements Body
+{
+    /**
+     * @var array
+     */
+    protected $data;
+
+    /**
+     * @param array $data
+     */
+    public function __construct(array $data)
+    {
+        $this->data = $data;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getContentHeaders()
+    {
+        return [
+            'Content-Type' => 'application/x-www-form-urlencoded',
+        ];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function toStreamable()
+    {
+        return http_build_query($this->data, null, '&');
+    }
+}

src/Client.php

@@ -2,14 +2,13 @@
 
 namespace Http\Client\Exception;
 
-use Http\Client\Exception;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 
 /**
  * @author GeLo <[email protected]>
  */
-class HttpClientException extends \RuntimeException implements Exception
+class HttpClientException extends RuntimeException
 {
     /**
      * @var RequestInterface|null

src/Exception/HttpClientException.php

@@ -2,13 +2,12 @@
 
 namespace Http\Client\Exception;
 
-use Http\Client\Exception;
 use Psr\Http\Message\ResponseInterface;
 
 /**
  * @author GeLo <[email protected]>
  */
-class MultiHttpClientException extends \RuntimeException implements Exception
+class MultiHttpClientException extends RuntimeException
 {
     /**
      * @var HttpClientException[]