Package launch

.gitignore

@@ -0,0 +1,3 @@
+composer.lock
+vendor
+.DS_Store

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Mark Townsend <mtownsend5512@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,142 @@
+The missing XML support for Laravel's Response class.
+
+This package is designed to work with the [Laravel](https://laravel.com) framework.
+
+## Installation
+
+Install via composer:
+
+```
+composer require mtownsend/response-xml
+```
+
+### Registering the service provider
+
+For Laravel 5.4 and lower, add the following line to your ``config/app.php``:
+
+```php
+/*
+ * Package Service Providers...
+ */
+Mtownsend\ResponseXml\Providers\ResponseXmlServiceProvider::class,
+```
+
+For Laravel 5.5 and greater, the package will auto register the provider for you.
+
+### Using Lumen
+
+To register the service provider, add the following line to ``app/bootstrap/app.php``:
+
+```php
+$app->register(Mtownsend\ResponseXml\Providers\ResponseXmlServiceProvider::class);
+```
+
+## Quick start
+
+### Respond with xml
+
+```php
+$data = [
+    'status' => 'success',
+    'data' => [
+        'first_name' => 'John',
+        'last_name' => 'Smith',
+    ]
+];
+return response()->xml($data);
+
+// Returns:
+// <?xml version="1.0"?>
+// <response>
+//     <status>success</status>
+//     <data>
+//         <first_name>John</first_name>
+//         <last_name>Smith</last_name>
+//     </data>
+// </response>
+```
+
+### Respond with xml from a collection or eloquent query
+
+You may also pass a collection to be transformed into xml.
+
+```php
+return response()->xml(User::all());
+```
+
+### Respond with existing xml
+
+If you already have xml, you can pass it to the ``xml`` method to respond.
+
+```php
+$xml = <<<XML
+<?xml version="1.0"?>
+<response>
+    <status>success</status>
+    <data>
+        <first_name>John</first_name>
+        <last_name>Smith</last_name>
+    </data>
+</response>
+XML;
+return response()->xml($xml);
+```
+
+### Respond with the request's preferred format (xml/json)
+
+If you want to respond with either xml or json on the fly without writing if/else statements you may use the ``->preferredFormat()`` method. This will take the request's ``Accept`` header and try to determine which format the request wants to be served. If this header is nonexistent, it will default to json. **Note:** when using this method, it will automatically set your response's ``Content-Type`` header to match the request's ``Accept`` header.
+
+```php
+$data = [
+    'status' => 'success',
+    'data' => [
+        'first_name' => 'John',
+        'last_name' => 'Smith',
+    ]
+];
+return response()->preferredFormat($data);
+```
+
+## Methods and arguments
+
+**Response method**
+
+``->xml($xml, $status = 200, array $headers = [], $xmlRoot = 'response')``
+
+The ``$xml`` argument is the data you want to be transformed into xml (may also be a premade xml string).
+
+``$status`` is the http code your response will send.
+
+``$headers`` is an array of key/values of http headers your response will return.
+
+``$xmlRoot`` will change the root xml element. Default is ``response``.
+
+**Response method**
+
+``->preferredFormat($data, $status = 200, array $headers = [], $xmlRoot = 'response')``
+
+See ``->xml()`` method arguments.
+
+The only difference between this method and ``->xml()`` is ``$data`` can potentially be transformed to json and ``$xmlRoot`` will be ignored if the response is json.
+
+## Purpose
+
+Have you ever found yourself wishing Laravel offered the same exemplary support for returning XML responses as it does for JSON? Imagine you are creating an api platform and want to be inclusive of other apps that would prefer to make XML requests to your application - sometimes the reasons are more than preferential. Wouldn't it be a dream if you could return XML as simply as writing ``return response()->xml($data);`` and it just worked? **Now you can!**
+
+This package achieves one critical goal: respond with XML as easily as you can with JSON in your Laravel application.
+
+## Other packages you may be interested in
+
+- [mtownsend/collection-xml](https://github.com/mtownsend5512/collection-xml)
+- [mtownsend/request-xml](https://github.com/mtownsend5512/request-xml)
+- [mtownsend/xml-to-array](https://github.com/mtownsend5512/xml-to-array)
+
+## Credits
+
+- Mark Townsend
+- [Spatie](https://spatie.be/)
+- All Contributors
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -0,0 +1,46 @@
+{
+    "name": "mtownsend/response-xml",
+    "description": "The missing XML support for Laravel's Response class.",
+    "keywords": [
+        "response",
+        "laravel",
+        "xml"
+    ],
+    "authors": [
+        {
+            "name": "Mark Townsend",
+            "email": "mtownsend5512@gmail.com",
+            "role": "Developer"
+        }
+    ],
+	"autoload": {
+        "psr-4": {
+            "Mtownsend\\ResponseXml\\": "src"
+        }
+    },
+    "require": {
+        "php": "~7.0",
+        "illuminate/http": "^5.2",
+        "illuminate/routing":  "^5.2",
+        "illuminate/support": "^5.3",
+        "illuminate/container": "^5.2",
+        "spatie/array-to-xml": "^2.6"
+    },
+    "require-dev": {
+      "phpunit/phpunit": "^6.4",
+      "laravel/framework": "^5.0"
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "Mtownsend\\ResponseXml\\Test\\": "tests/"
+        }
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Mtownsend\\ResponseXml\\Providers\\ResponseXmlServiceProvider"
+            ]
+        }
+    },
+    "minimum-stability": "stable"
+}

phpunit.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php"
+         backupGlobals="false"
+         backupStaticAttributes="false"
+         colors="true"
+         verbose="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="MyPackage Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+        </whitelist>
+    </filter>
+</phpunit>

src/Providers/ResponseXmlServiceProvider.php

@@ -0,0 +1,55 @@
+<?php
+
+namespace Mtownsend\ResponseXml\Providers;
+
+use Illuminate\Container\Container;
+use Illuminate\Routing\ResponseFactory as Response;
+use Illuminate\Support\ServiceProvider;
+use Illuminate\Support\Str;
+use Spatie\ArrayToXml\ArrayToXml;
+
+class ResponseXmlServiceProvider extends ServiceProvider
+{
+    /**
+     * Bootstrap any application services.
+     *
+     * @return void
+     */
+    public function boot()
+    {
+        //
+    }
+
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        Response::macro('xml', function ($xml, $status = 200, array $headers = [], $xmlRoot = 'response') {
+            if (is_array($xml)) {
+                $xml = ArrayToXml::convert($xml, $xmlRoot);
+            } elseif (is_object($xml) && method_exists($xml, 'toArray')) {
+                $xml = ArrayToXml::convert($xml->toArray(), $xmlRoot);
+            } elseif (is_string($xml)) {
+                $xml = $xml;
+            } else {
+                $xml = '';
+            }
+            if (!isset($headers['Content-Type'])) {
+                $headers = array_merge($headers, ['Content-Type' => 'application/xml']);
+            }
+            return Response::make($xml, $status, $headers);
+        });
+
+        Response::macro('preferredFormat', function ($data, $status = 200, array $headers = [], $xmlRoot = 'response') {
+            $request = Container::getInstance()->make('request');
+            if (Str::contains($request->headers->get('Accept'), 'xml')) {
+                return $this->xml($data, $status, array_merge($headers, ['Content-Type' => $request->headers->get('Accept')]), $xmlRoot);
+            } else {
+                return $this->json($data, $status, array_merge($headers, ['Content-Type' => $request->headers->get('Accept')]));
+            }
+        });
+    }
+}