| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038 |
- <?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']);
- }
- }
|