Merge 18fc8ee into 7f90803

src/Operation.php

@@ -8,6 +8,7 @@
 use gossi\swagger\parts\ProducesPart;
 use gossi\swagger\parts\ResponsesPart;
 use gossi\swagger\parts\SchemesPart;
+use gossi\swagger\parts\SecurityPart;
 use gossi\swagger\parts\TagsPart;
 use phootwork\collection\CollectionUtils;
 use phootwork\lang\Arrayable;
@@ -17,6 +18,7 @@ class Operation extends AbstractModel implements Arrayable {
 	use ConsumesPart;
 	use ProducesPart;
 	use TagsPart;
+	use SecurityPart;
 	use ParametersPart;
 	use ResponsesPart;
 	use SchemesPart;
@@ -51,6 +53,7 @@ private function parse($contents = []) {
 		$this->parseConsumes($data);
 		$this->parseProduces($data);
 		$this->parseTags($data);
+		$this->parseSecurity($data);
 		$this->parseParameters($data);
 		$this->parseResponses($data);
 		$this->parseSchemes($data);
@@ -60,8 +63,8 @@ private function parse($contents = []) {
 
 	public function toArray() {
 		return $this->export('summary', 'description', 'operationId', 'deprecated',
-				'consumes', 'produces', 'parameters', 'responses', 'schemes', 'tags',
-				'externalDocs');
+				'consumes', 'produces', 'security', 'parameters', 'responses', 'schemes',
+				'tags', 'externalDocs');
 	}
 
 	/**

src/SecurityScheme.php

@@ -1,17 +1,40 @@
 <?php
 namespace gossi\swagger;
 
-class SecurityScheme {
+use phootwork\lang\Arrayable;
+
+class SecurityScheme extends AbstractModel implements Arrayable {
 
 	/** @var string */
 	private $name;
 
+	/** @var string */
+	private $type;
+
+	/** @var string */
+	private $description;
+
+	/**
+	 * @param string $name
+	 * @param array $contents
+	 */
 	public function __construct($name, $contents = []) {
 		$this->name = $name;
 		$this->parse($contents);
 	}
 
+	/**
+	 * @param array $contents
+	 */
 	private function parse($contents = []) {
+		$this->type = $contents->get('type');
+		$this->description = $contents->get('description');
+	}
 
+	/**
+	 * @return array
+	 */
+	public function toArray() {
+		return $this->export('type', 'description');
 	}
 }

src/Swagger.php

@@ -121,7 +121,7 @@ private function parse($contents) {
 
 	public function toArray() {
 		return $this->export('swagger', 'info', 'host', 'basePath', 'schemes', 'consumes', 'produces',
-			'paths', 'definitions', 'parameters', 'responses', 'tags', 'externalDocs'
+			'securityDefinitions', 'paths', 'definitions', 'parameters', 'responses', 'tags', 'externalDocs'
 		);
 	}
 

src/parts/SecurityPart.php

@@ -0,0 +1,31 @@
+<?php
+namespace gossi\swagger\parts;
+
+use phootwork\collection\Map;
+
+trait SecurityPart {
+
+	/** @var object */
+	private $security;
+
+	private function parseSecurity(Map $data) {
+		$this->security = $data->get('security');
+	}
+
+	/**
+	 * @return object
+	 */
+	public function getSecurity() {
+		return $this->security;
+	}
+
+	/**
+	 * @param object $security
+	 * @return $this
+	 */
+	public function setSecurity($security) {
+		$this->security = $security;
+		return $this;
+	}
+
+}

tests/BasicAuthTest.php

@@ -0,0 +1,27 @@
+<?php
+namespace gossi\swagger\tests;
+
+use gossi\swagger\Swagger;
+use phootwork\file\exception\FileNotFoundException;
+use phootwork\file\File;
+use phootwork\json\Json;
+
+class BasicAuth extends \PHPUnit_Framework_TestCase {
+
+	private function fileToArray($filename) {
+		$file = new File($filename);
+
+		if (!$file->exists()) {
+			throw new FileNotFoundException(sprintf('File not found at: %s', $filename));
+		}
+
+		return Json::decode($file->read());
+	}
+
+	public function testUser() {
+		$filename = __DIR__ . '/fixtures/basic-auth.json';
+		$swagger = Swagger::fromFile($filename);
+
+		$this->assertEquals($this->fileToArray($filename), $swagger->toArray());
+	}
+}

tests/fixtures/basic-auth.json

@@ -0,0 +1,35 @@
+{
+	"swagger": "2.0",
+	"info": {
+		"version": "1.0.0",
+		"title": "Basic Auth Example",
+		"description": "An example for how to use Basic Auth with Swagger.\nServer code is available [here](https://github.com/mohsen1/basic-auth-server). It's running on Heroku.\n\n**User Name and Password**\n* User Name: `user`\n* Password: `pass`\n"
+	},
+	"host": "basic-auth-server.herokuapp.com",
+	"schemes": [
+		"http",
+		"https"
+	],
+	"securityDefinitions": {
+		"basicAuth": {
+			"type": "basic",
+			"description": "HTTP Basic Authentication. Works over `HTTP` and `HTTPS`"
+		}
+	},
+	"paths": {
+		"/": {
+			"get": {
+				"security": [
+					{
+						"basicAuth": []
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Will send `Authenticated` if authentication is succesful, otherwise it will send `Unauthorized`"
+					}
+				}
+			}
+		}
+	}
+}