12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037 |
- <?php
- namespace GuzzleHttp\Tests\Command\Guzzle;
- use GuzzleHttp\Client as HttpClient;
- use GuzzleHttp\Command\CommandInterface;
- use GuzzleHttp\Command\Guzzle\Description;
- use GuzzleHttp\Command\Guzzle\GuzzleClient;
- use GuzzleHttp\Command\Result;
- use GuzzleHttp\Command\ResultInterface;
- use GuzzleHttp\Handler\MockHandler;
- use GuzzleHttp\Psr7\Request;
- use GuzzleHttp\Psr7\Response;
- use Psr\Http\Message\RequestInterface;
- use Psr\Http\Message\ResponseInterface;
- /**
- * @covers \GuzzleHttp\Command\Guzzle\GuzzleClient
- */
- class GuzzleClientTest extends \PHPUnit_Framework_TestCase
- {
- public function testExecuteCommandViaMagicMethod()
- {
- $client = $this->getServiceClient(
- [
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foofoo":"barbar"}'),
- ],
- null,
- $this->commandToRequestTransformer()
- );
- // Synchronous
- $result1 = $client->doThatThingYouDo(['fizz' => 'buzz']);
- $this->assertEquals('bar', $result1['foo']);
- $this->assertEquals('buzz', $result1['_request']['fizz']);
- $this->assertEquals('doThatThingYouDo', $result1['_request']['action']);
- // Asynchronous
- $result2 = $client->doThatThingOtherYouDoAsync(['fizz' => 'buzz'])->wait();
- $this->assertEquals('barbar', $result2['foofoo']);
- $this->assertEquals('doThatThingOtherYouDo', $result2['_request']['action']);
- }
- public function testExecuteWithQueryLocation()
- {
- $mock = new MockHandler();
- $client = $this->getServiceClient(
- [
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foo":"bar"}')
- ],
- $mock
- );
- $client->doQueryLocation(['foo' => 'Foo']);
- $this->assertEquals('foo=Foo', $mock->getLastRequest()->getUri()->getQuery());
- $client->doQueryLocation([
- 'foo' => 'Foo',
- 'bar' => 'Bar',
- 'baz' => 'Baz'
- ]);
- $last = $mock->getLastRequest();
- $this->assertEquals('foo=Foo&bar=Bar&baz=Baz', $last->getUri()->getQuery());
- }
- public function testExecuteWithBodyLocation()
- {
- $mock = new MockHandler();
- $client = $this->getServiceClient(
- [
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foo":"bar"}')
- ],
- $mock
- );
- $client->doBodyLocation(['foo' => 'Foo']);
- $this->assertEquals('foo=Foo', (string) $mock->getLastRequest()->getBody());
- $client->doBodyLocation([
- 'foo' => 'Foo',
- 'bar' => 'Bar',
- 'baz' => 'Baz'
- ]);
- $this->assertEquals('foo=Foo&bar=Bar&baz=Baz', (string) $mock->getLastRequest()->getBody());
- }
- public function testExecuteWithJsonLocation()
- {
- $mock = new MockHandler();
- $client = $this->getServiceClient(
- [
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foo":"bar"}')
- ],
- $mock
- );
- $client->doJsonLocation(['foo' => 'Foo']);
- $this->assertEquals('{"foo":"Foo"}', (string) $mock->getLastRequest()->getBody());
- $client->doJsonLocation([
- 'foo' => 'Foo',
- 'bar' => 'Bar',
- 'baz' => 'Baz'
- ]);
- $this->assertEquals('{"foo":"Foo","bar":"Bar","baz":"Baz"}', (string) $mock->getLastRequest()->getBody());
- }
- public function testExecuteWithHeaderLocation()
- {
- $mock = new MockHandler();
- $client = $this->getServiceClient(
- [
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foo":"bar"}')
- ],
- $mock
- );
- $client->doHeaderLocation(['foo' => 'Foo']);
- $this->assertEquals(['Foo'], $mock->getLastRequest()->getHeader('foo'));
- $client->doHeaderLocation([
- 'foo' => 'Foo',
- 'bar' => 'Bar',
- 'baz' => 'Baz'
- ]);
- $this->assertEquals(['Foo'], $mock->getLastRequest()->getHeader('foo'));
- $this->assertEquals(['Bar'], $mock->getLastRequest()->getHeader('bar'));
- $this->assertEquals(['Baz'], $mock->getLastRequest()->getHeader('baz'));
- }
- public function testExecuteWithXmlLocation()
- {
- $mock = new MockHandler();
- $client = $this->getServiceClient(
- [
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foo":"bar"}')
- ],
- $mock
- );
- $client->doXmlLocation(['foo' => 'Foo']);
- $this->assertEquals(
- "<?xml version=\"1.0\"?>\n<Request><foo>Foo</foo></Request>\n",
- (string) $mock->getLastRequest()->getBody()
- );
- $client->doXmlLocation([
- 'foo' => 'Foo',
- 'bar' => 'Bar',
- 'baz' => 'Baz'
- ]);
- $this->assertEquals(
- "<?xml version=\"1.0\"?>\n<Request><foo>Foo</foo><bar>Bar</bar><baz>Baz</baz></Request>\n",
- $mock->getLastRequest()->getBody()
- );
- }
-
- public function testExecuteWithMultiPartLocation()
- {
- $mock = new MockHandler();
- $client = $this->getServiceClient(
- [
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foo":"bar"}'),
- new Response(200, [], '{"foo":"bar"}')
- ],
- $mock
- );
- $client->doMultiPartLocation(['foo' => 'Foo']);
- $multiPartRequestBody = (string) $mock->getLastRequest()->getBody();
- $this->assertContains('name="foo"', $multiPartRequestBody);
- $this->assertContains('Foo', $multiPartRequestBody);
- $client->doMultiPartLocation([
- 'foo' => 'Foo',
- 'bar' => 'Bar',
- 'baz' => 'Baz'
- ]);
- $multiPartRequestBody = (string) $mock->getLastRequest()->getBody();
- $this->assertContains('name="foo"', $multiPartRequestBody);
- $this->assertContains('Foo', $multiPartRequestBody);
- $this->assertContains('name="bar"', $multiPartRequestBody);
- $this->assertContains('Bar', $multiPartRequestBody);
- $this->assertContains('name="baz"', $multiPartRequestBody);
- $this->assertContains('Baz', $multiPartRequestBody);
- $client->doMultiPartLocation([
- 'file' => fopen(dirname(__FILE__) . '/Asset/test.html', 'r'),
- ]);
- $multiPartRequestBody = (string) $mock->getLastRequest()->getBody();
- $this->assertContains('name="file"', $multiPartRequestBody);
- $this->assertContains('filename="test.html"', $multiPartRequestBody);
- $this->assertContains('<title>Title</title>', $multiPartRequestBody);
- }
- public function testHasConfig()
- {
- $client = new HttpClient();
- $description = new Description([]);
- $guzzle = new GuzzleClient(
- $client,
- $description,
- $this->commandToRequestTransformer(),
- $this->responseToResultTransformer(),
- null,
- ['foo' => 'bar']
- );
- $this->assertSame($client, $guzzle->getHttpClient());
- $this->assertSame($description, $guzzle->getDescription());
- $this->assertEquals('bar', $guzzle->getConfig('foo'));
- $this->assertEquals([], $guzzle->getConfig('defaults'));
- $guzzle->setConfig('abc', 'listen');
- $this->assertEquals('listen', $guzzle->getConfig('abc'));
- }
- public function testAddsValidateHandlerWhenTrue()
- {
- $client = new HttpClient();
- $description = new Description([]);
- $guzzle = new GuzzleClient(
- $client,
- $description,
- $this->commandToRequestTransformer(),
- $this->responseToResultTransformer(),
- null,
- [
- 'validate' => true,
- 'process' => false
- ]
- );
- $handlers = explode("\n", $guzzle->getHandlerStack()->__toString());
- $handlers = array_filter($handlers);
- $this->assertCount(3, $handlers);
- }
- public function testDisablesHandlersWhenFalse()
- {
- $client = new HttpClient();
- $description = new Description([]);
- $guzzle = new GuzzleClient(
- $client,
- $description,
- $this->commandToRequestTransformer(),
- $this->responseToResultTransformer(),
- null,
- [
- 'validate' => false,
- 'process' => false
- ]
- );
- $handlers = explode("\n", $guzzle->getHandlerStack()->__toString());
- $handlers = array_filter($handlers);
- $this->assertCount(1, $handlers);
- }
- public function testValidateDescription()
- {
- $client = new HttpClient();
- $description = new Description(
- [
- 'name' => 'Testing API ',
- 'baseUri' => 'http://httpbin.org/',
- 'operations' => [
- 'Foo' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get',
- 'parameters' => [
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Bar',
- 'location' => 'query'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'baz',
- 'location' => 'query'
- ],
- ],
- 'responseModel' => 'Foo'
- ],
- ],
- 'models' => [
- 'Foo' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'location' => 'json',
- 'type' => 'string'
- ],
- 'location' => [
- 'location' => 'header',
- 'sentAs' => 'Location',
- 'type' => 'string'
- ],
- 'age' => [
- 'location' => 'json',
- 'type' => 'integer'
- ],
- 'statusCode' => [
- 'location' => 'statusCode',
- 'type' => 'integer'
- ],
- ],
- ],
- ],
- ]
- );
- $guzzle = new GuzzleClient(
- $client,
- $description,
- null,
- null,
- null,
- [
- 'validate' => true,
- 'process' => false
- ]
- );
- $command = $guzzle->getCommand('Foo', ['baz' => 'BAZ']);
- /** @var ResponseInterface $response */
- $response = $guzzle->execute($command);
- $this->assertInstanceOf(Response::class, $response);
- $this->assertEquals(200, $response->getStatusCode());
- }
- /**
- * @expectedException \GuzzleHttp\Command\Exception\CommandException
- * @expectedExceptionMessage Validation errors: [baz] is a required string: baz
- */
- public function testValidateDescriptionFailsDueMissingRequiredParameter()
- {
- $client = new HttpClient();
- $description = new Description(
- [
- 'name' => 'Testing API ',
- 'baseUri' => 'http://httpbin.org/',
- 'operations' => [
- 'Foo' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get',
- 'parameters' => [
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Bar',
- 'location' => 'query'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => true,
- 'description' => 'baz',
- 'location' => 'query'
- ],
- ],
- 'responseModel' => 'Foo'
- ],
- ],
- 'models' => [
- 'Foo' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'location' => 'json',
- 'type' => 'string'
- ],
- 'location' => [
- 'location' => 'header',
- 'sentAs' => 'Location',
- 'type' => 'string'
- ],
- 'age' => [
- 'location' => 'json',
- 'type' => 'integer'
- ],
- 'statusCode' => [
- 'location' => 'statusCode',
- 'type' => 'integer'
- ],
- ],
- ],
- ],
- ]
- );
- $guzzle = new GuzzleClient(
- $client,
- $description,
- null,
- null,
- null,
- [
- 'validate' => true,
- 'process' => false
- ]
- );
- $command = $guzzle->getCommand('Foo');
- /** @var ResultInterface $result */
- $result = $guzzle->execute($command);
- $this->assertInstanceOf(Result::class, $result);
- $result = $result->toArray();
- $this->assertEquals(200, $result['statusCode']);
- }
- /**
- * @expectedException \GuzzleHttp\Command\Exception\CommandException
- * @expectedExceptionMessage Validation errors: [baz] must be of type integer
- */
- public function testValidateDescriptionFailsDueTypeMismatch()
- {
- $client = new HttpClient();
- $description = new Description(
- [
- 'name' => 'Testing API ',
- 'baseUri' => 'http://httpbin.org/',
- 'operations' => [
- 'Foo' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get',
- 'parameters' => [
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Bar',
- 'location' => 'query'
- ],
- 'baz' => [
- 'type' => 'integer',
- 'required' => true,
- 'description' => 'baz',
- 'location' => 'query'
- ],
- ],
- 'responseModel' => 'Foo'
- ],
- ],
- 'models' => [
- 'Foo' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'location' => 'json',
- 'type' => 'string'
- ],
- 'location' => [
- 'location' => 'header',
- 'sentAs' => 'Location',
- 'type' => 'string'
- ],
- 'age' => [
- 'location' => 'json',
- 'type' => 'integer'
- ],
- 'statusCode' => [
- 'location' => 'statusCode',
- 'type' => 'integer'
- ],
- ],
- ],
- ],
- ]
- );
- $guzzle = new GuzzleClient(
- $client,
- $description,
- null,
- null,
- null,
- [
- 'validate' => true,
- 'process' => false
- ]
- );
- $command = $guzzle->getCommand('Foo', ['baz' => 'Hello']);
- /** @var ResultInterface $result */
- $result = $guzzle->execute($command);
- $this->assertInstanceOf(Result::class, $result);
- $result = $result->toArray();
- $this->assertEquals(200, $result['statusCode']);
- }
- public function testValidateDescriptionDoesNotFailWhenSendingIntegerButExpectingString()
- {
- $client = new HttpClient();
- $description = new Description(
- [
- 'name' => 'Testing API ',
- 'baseUri' => 'http://httpbin.org/',
- 'operations' => [
- 'Foo' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get',
- 'parameters' => [
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Bar',
- 'location' => 'query'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => true,
- 'description' => 'baz',
- 'location' => 'query'
- ],
- ],
- 'responseModel' => 'Foo'
- ],
- ],
- 'models' => [
- 'Foo' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'location' => 'json',
- 'type' => 'string'
- ],
- 'location' => [
- 'location' => 'header',
- 'sentAs' => 'Location',
- 'type' => 'string'
- ],
- 'age' => [
- 'location' => 'json',
- 'type' => 'integer'
- ],
- 'statusCode' => [
- 'location' => 'statusCode',
- 'type' => 'integer'
- ],
- ],
- ],
- ],
- ]
- );
- $guzzle = new GuzzleClient($client, $description);
- $command = $guzzle->getCommand('Foo', ['baz' => 42]);
- /** @var ResultInterface $result */
- $result = $guzzle->execute($command);
- $this->assertInstanceOf(Result::class, $result);
- $result = $result->toArray();
- $this->assertEquals(200, $result['statusCode']);
- }
- public function testMagicMethodExecutesCommands()
- {
- $client = new HttpClient();
- $description = new Description(
- [
- 'name' => 'Testing API ',
- 'baseUri' => 'http://httpbin.org/',
- 'operations' => [
- 'Foo' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get',
- 'parameters' => [
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Bar',
- 'location' => 'query'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => true,
- 'description' => 'baz',
- 'location' => 'query'
- ],
- ],
- 'responseModel' => 'Foo'
- ],
- ],
- 'models' => [
- 'Foo' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'location' => 'json',
- 'type' => 'string'
- ],
- 'location' => [
- 'location' => 'header',
- 'sentAs' => 'Location',
- 'type' => 'string'
- ],
- 'age' => [
- 'location' => 'json',
- 'type' => 'integer'
- ],
- 'statusCode' => [
- 'location' => 'statusCode',
- 'type' => 'integer'
- ],
- ],
- ],
- ],
- ]
- );
- $guzzle = $this->getMockBuilder(GuzzleClient::class)
- ->setConstructorArgs([
- $client,
- $description
- ])
- ->setMethods(['execute'])
- ->getMock();
- $guzzle->expects($this->once())
- ->method('execute')
- ->will($this->returnValue('foo'));
- $this->assertEquals('foo', $guzzle->foo([]));
- }
- /**
- * @expectedException \InvalidArgumentException
- * @expectedExceptionMessage No operation found named Foo
- */
- public function testThrowsWhenOperationNotFoundInDescription()
- {
- $client = new HttpClient();
- $description = new Description([]);
- $guzzle = new GuzzleClient(
- $client,
- $description,
- $this->commandToRequestTransformer(),
- $this->responseToResultTransformer()
- );
- $guzzle->getCommand('foo');
- }
- public function testReturnsProcessedResponse()
- {
- $client = new HttpClient();
- $description = new Description(
- [
- 'name' => 'Testing API ',
- 'baseUri' => 'http://httpbin.org/',
- 'operations' => [
- 'Foo' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get',
- 'parameters' => [
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Bar',
- 'location' => 'query'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => true,
- 'description' => 'baz',
- 'location' => 'query'
- ],
- ],
- 'responseModel' => 'Foo'
- ],
- ],
- 'models' => [
- 'Foo' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'location' => 'json',
- 'type' => 'string'
- ],
- 'location' => [
- 'location' => 'header',
- 'sentAs' => 'Location',
- 'type' => 'string'
- ],
- 'age' => [
- 'location' => 'json',
- 'type' => 'integer'
- ],
- 'statusCode' => [
- 'location' => 'statusCode',
- 'type' => 'integer'
- ],
- ],
- ],
- ],
- ]
- );
- $guzzle = new GuzzleClient($client, $description, null, null);
- $command = $guzzle->getCommand('foo', ['baz' => 'BAZ']);
- /** @var ResultInterface $result */
- $result = $guzzle->execute($command);
- $this->assertInstanceOf(Result::class, $result);
- $result = $result->toArray();
- $this->assertEquals(200, $result['statusCode']);
- }
- private function getServiceClient(
- array $responses,
- MockHandler $mock = null,
- callable $commandToRequestTransformer = null
- ) {
- $mock = $mock ?: new MockHandler();
- foreach ($responses as $response) {
- $mock->append($response);
- }
- return new GuzzleClient(
- new HttpClient([
- 'handler' => $mock
- ]),
- $this->getDescription(),
- $commandToRequestTransformer,
- $this->responseToResultTransformer(),
- null,
- ['foo' => 'bar']
- );
- }
- private function commandToRequestTransformer()
- {
- return function (CommandInterface $command) {
- $data = $command->toArray();
- $data['action'] = $command->getName();
- return new Request('POST', '/', [], http_build_query($data));
- };
- }
- private function responseToResultTransformer()
- {
- return function (ResponseInterface $response, RequestInterface $request, CommandInterface $command) {
- $data = \GuzzleHttp\json_decode($response->getBody(), true);
- parse_str($request->getBody(), $data['_request']);
- return new Result($data);
- };
- }
- private function getDescription()
- {
- return new Description(
- [
- 'name' => 'Testing API ',
- 'baseUri' => 'http://httpbin.org/',
- 'operations' => [
- 'doThatThingYouDo' => [
- 'responseModel' => 'Bar'
- ],
- 'doThatThingOtherYouDo' => [
- 'responseModel' => 'Foo'
- ],
- 'doQueryLocation' => [
- 'httpMethod' => 'GET',
- 'uri' => '/queryLocation',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing query request location',
- 'location' => 'query'
- ],
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing query request location',
- 'location' => 'query'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing query request location',
- 'location' => 'query'
- ]
- ],
- 'responseModel' => 'QueryResponse'
- ],
- 'doBodyLocation' => [
- 'httpMethod' => 'GET',
- 'uri' => '/bodyLocation',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing body request location',
- 'location' => 'body'
- ],
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing body request location',
- 'location' => 'body'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing body request location',
- 'location' => 'body'
- ]
- ],
- 'responseModel' => 'BodyResponse'
- ],
- 'doJsonLocation' => [
- 'httpMethod' => 'GET',
- 'uri' => '/jsonLocation',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing json request location',
- 'location' => 'json'
- ],
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing json request location',
- 'location' => 'json'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing json request location',
- 'location' => 'json'
- ]
- ],
- 'responseModel' => 'JsonResponse'
- ],
- 'doHeaderLocation' => [
- 'httpMethod' => 'GET',
- 'uri' => '/headerLocation',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing header request location',
- 'location' => 'header'
- ],
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing header request location',
- 'location' => 'header'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing header request location',
- 'location' => 'header'
- ]
- ],
- 'responseModel' => 'HeaderResponse'
- ],
- 'doXmlLocation' => [
- 'httpMethod' => 'GET',
- 'uri' => '/xmlLocation',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing xml request location',
- 'location' => 'xml'
- ],
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing xml request location',
- 'location' => 'xml'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing xml request location',
- 'location' => 'xml'
- ]
- ],
- 'responseModel' => 'XmlResponse'
- ],
- 'doMultiPartLocation' => [
- 'httpMethod' => 'POST',
- 'uri' => '/multipartLocation',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing multipart request location',
- 'location' => 'multipart'
- ],
- 'bar' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing multipart request location',
- 'location' => 'multipart'
- ],
- 'baz' => [
- 'type' => 'string',
- 'required' => false,
- 'description' => 'Testing multipart request location',
- 'location' => 'multipart'
- ],
- 'file' => [
- 'type' => 'any',
- 'required' => false,
- 'description' => 'Testing multipart request location',
- 'location' => 'multipart'
- ]
- ],
- 'responseModel' => 'MultipartResponse'
- ],
- ],
- 'models' => [
- 'Foo' => [
- 'type' => 'object',
- 'properties' => [
- 'code' => [
- 'location' => 'statusCode'
- ]
- ]
- ],
- 'Bar' => [
- 'type' => 'object',
- 'properties' => [
- 'code' => ['
- location' => 'statusCode'
- ]
- ]
- ]
- ]
- ]
- );
- }
- public function testDocumentationExampleFromReadme()
- {
- $client = new HttpClient();
- $description = new Description([
- 'baseUrl' => 'http://httpbin.org/',
- 'operations' => [
- 'testing' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get{?foo}',
- 'responseModel' => 'getResponse',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'location' => 'uri'
- ],
- 'bar' => [
- 'type' => 'string',
- 'location' => 'query'
- ]
- ]
- ]
- ],
- 'models' => [
- 'getResponse' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'location' => 'json'
- ]
- ]
- ]
- ]);
- $guzzle = new GuzzleClient($client, $description);
- $result = $guzzle->testing(['foo' => 'bar']);
- $this->assertEquals('bar', $result['args']['foo']);
- }
- public function testDescriptionWithExtends()
- {
- $client = new HttpClient();
- $description = new Description([
- 'baseUrl' => 'http://httpbin.org/',
- 'operations' => [
- 'testing' => [
- 'httpMethod' => 'GET',
- 'uri' => '/get',
- 'responseModel' => 'getResponse',
- 'parameters' => [
- 'foo' => [
- 'type' => 'string',
- 'default' => 'foo',
- 'location' => 'query'
- ]
- ]
- ],
- 'testing_extends' => [
- 'extends' => 'testing',
- 'responseModel' => 'getResponse',
- 'parameters' => [
- 'bar' => [
- 'type' => 'string',
- 'location' => 'query'
- ]
- ]
- ],
- ],
- 'models' => [
- 'getResponse' => [
- 'type' => 'object',
- 'additionalProperties' => [
- 'location' => 'json'
- ]
- ]
- ]
- ]);
- $guzzle = new GuzzleClient($client, $description);
- $result = $guzzle->testing_extends(['bar' => 'bar']);
- $this->assertEquals('bar', $result['args']['bar']);
- $this->assertEquals('foo', $result['args']['foo']);
- }
- }
|