deSymfony 2013 Consumiendo APIs REST con Guzzle y Symfony2

Guzzle es un cliente HTTP que facilita de forma increíble el crear, consumir e interactuar con servicios web, como por ejemplo, la api REST de un servicio web como Twitter, Amazon AWS, Github, entre otros.

Nos ofrece completo control del estándar HTTP para la generación de un Request y nos permite de forma organizada manejar el Response y definir modelos sobre las respuestas para actuar mas facilmente sobre ellas.

En esta charla se introducirá como configurar la libreria de forma independiente en menos de 10 minutos, y como integrarlo en un proyecto de Symfony2 y Silex, para empezar a atacar APIs, se explicaran sus usos mas comunes, se hablara de proyectos que ya lo tienen incorporado (como Drupal, el Amazon AWS SDK para PHP, y la libreria Goutte, para hacer Webscraping, de Fabien Potencier, entre otras).

Se terminara con un ejemplo practico en dos proyectos de Acilia, para atacar a un servicio web (emailvision), para envíos de emails transaccionales y masivos de dos aplicaciones y posterior recopilación de reportes de dichos envíos, todo mediante llamadas y respuestas HTTP a una API REST.

Transcript

3. Albert Jessurum
4. Albert Jessurum acilia.es
5. Albert Jessurum acilia.es chess.com
6. Albert Jessurum acilia.es chess.com Maracaibo, Venezuela
7. Albert Jessurum acilia.es chess.com Maracaibo, Venezuela @ajessu
8. Albert Jessurum acilia.es chess.com Maracaibo, Venezuela @ajessu github.com/ajessu
9. Albert Jessurum acilia.es chess.com Maracaibo, Venezuela @ajessu github.com/ajessu Fan de Symfony
10. Albert Jessurum acilia.es chess.com Maracaibo, Venezuela @ajessu github.com/ajessu Fan de Symfony
11. Albert Jessurum acilia.es chess.com Maracaibo, Venezuela @ajessu github.com/ajessu Fan de Symfony
12. Guzzle
13. ¿Que es Guzzle?
14. ¿Que es Guzzle?
15. ¿Que es Guzzle? • Cliente para realizar peticiones http
16. ¿Que es Guzzle? • Cliente para realizar peticiones http • cURL
17. ¿Que es Guzzle? • Cliente para realizar peticiones http • cURL • Conexiones persistentes
18. ¿Que es Guzzle? • Cliente para realizar peticiones http • cURL • Conexiones persistentes • Peticiones paralelas
19. ¿Que es Guzzle? • Cliente para realizar peticiones http • cURL • Conexiones persistentes • Peticiones paralelas • Plugins
20. ¿Por que Guzzle?
21. ¿Por que Guzzle?
22. ¿Por que Guzzle? • Peticiones http en general
23. ¿Por que Guzzle? • Peticiones http en general • API
24. ¿Por que Guzzle? • Peticiones http en general • API • Scrapping
25. ¿Por que Guzzle? • Peticiones http en general • API • Scrapping • Envio de datos/reportes (POST)
26. Alternativas
27. Alternativas
28. Alternativas • file_get_contents/fopen
29. Alternativas • file_get_contents/fopen • cURL
30. Alternativas • file_get_contents/fopen • cURL • pecl_http
31. Alternativas • file_get_contents/fopen • cURL • pecl_http • Zend_Http
32. Alternativas • file_get_contents/fopen • cURL • pecl_http • Zend_Http • Buzz
33. Proyectos que usan Guzzle
34. Proyectos que usan Guzzle
35. Proyectos que usan Guzzle • Drupal 8
36. Proyectos que usan Guzzle • Drupal 8 • Goutte
37. Proyectos que usan Guzzle • Drupal 8 • Goutte • Amazon AWS
38. Guzzle en menos de 1 minuto
39. Guzzle en menos de 1 minuto
40. Guzzle en menos de 1 minuto // Version >= 3.7
41. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount();
42. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com');
43. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com');
44. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com'); // Para un poco mas de control
45. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com'); // Para un poco mas de control use Guzzle\Http\Client;
46. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com'); // Para un poco mas de control use Guzzle\Http\Client;
47. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com'); // Para un poco mas de control use Guzzle\Http\Client; $client = new Client('http://desymfony.com');
48. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com'); // Para un poco mas de control use Guzzle\Http\Client; $client = new Client('http://desymfony.com'); $request = $client->get('/');
49. Guzzle en menos de 1 minuto // Version >= 3.7 Guzzle\Http\StaticClient::mount(); $response = Guzzle::get('http://desymfony.com'); // Para un poco mas de control use Guzzle\Http\Client; $client = new Client('http://desymfony.com'); $request = $client->get('/'); $response = $request->send();
50. Guzzle HTTP Client
51. Guzzle HTTP Client
52. Guzzle HTTP Client • Clientes
53. Guzzle HTTP Client • Clientes • Requests • Sin body • Con body
54. Guzzle HTTP Client • Clientes • Requests • Sin body • Con body • Responses
55. Guzzle HTTP Client Client Object
56. Client Object $client = new Client('https://api.github.com/test'); // Absoluta $request = $client->get('https://api.github.com/test'); // https://api.github.com/test // relativa (con slash) $request = $client->get('/users'); // https://api.github.com/users // relativa (sin slash) $request = $client->get('users'); // https://api.github.com/test/users // Configuración de la petición $client->setUserAgent('Test/123');
57. Guzzle HTTP Client Request Object
58. Request Object // Crear un método en especifico $client->createRequest('METODO', $uri, array $headers, $body, $options); // GET $client->get($uri, array $headers, $options); //HEAD $client->head($uri, array $headers, $options); //DELETE $client->delete($uri, array $headers, $body, $options); //POST $client->post($uri, array $headers, $postBody, $options); //PUT $client->put($uri, array $headers, $body, $options); //PATCH $client->patch($uri, array $headers, $body, $options);
59. Request Object // Una petición simple: $request = $client->head('/path?id=123&nombre=abc'); $response = $request->send(); // Una petición con cuerpo adjunto $request = $client->post('http://test.com/upload') ->addPostFiles(array('file' => '/ruta/a/ documento.json')); $response = $request->send(); // Content-Type: application/json
60. Request Object $request = $client->createRequest('COPY', 'http:// example.com/foo', array( 'Destination' => 'http://test.com/bar', 'Overwrite' => 'T' )); $response = $request->send();
61. Guzzle HTTP Client Response Object
62. Response Object $response = $client->get('http://www.amazon.com')->send(); echo $response->getStatusCode(); // 200 echo $response->isSuccessful(); // true $response->isRedirect(); // false
63. Response Object // Respuesta de la petición echo $response->getBody(); // Si el formato es correcto: // Devuelve un array de la respuesta json de la petición echo $response->json(); // Devuelve un objeto SimpleXMLElement de la petición echo $response->xml();
64. Plugins
65. Response Object // Envía una petición si, y otra no con el plugin: // UnaSiOtraNoPlugin $unaSiOtraNo = new UnaSiOtraNoPlugin(); $client->addSubscriber($unaSiOtraNo);
66. Plugins • Async plugin • Backoff retry plugin • HTTP Cache plugin • OAuth plugin • Cookie plugin • History plugin • Log plugin • MD5 validator plugin • Mock plugin
67. Plugins Async plugin
68. Plugins Backoff retry plugin
69. Plugins HTTP Cache Plugin
70. HTTP Cache Plugin
71. HTTP Cache Plugin
72. HTTP Cache Plugin • Chequea el HEAD del Request, para verificar el status.
73. HTTP Cache Plugin • Chequea el HEAD del Request, para verificar el status.
74. HTTP Cache Plugin • Chequea el HEAD del Request, para verificar el status. • Se puede crear una cache falsa
75. Plugins OAuth Plugin
76. OAuth Plugin
77. OAuth Plugin
78. OAuth Plugin • OAuth 1.0 (Twiiter)
79. OAuth Plugin • OAuth 1.0 (Twiiter) • OAuth 2.0 (Facebook)
80. OAuth Plugin • OAuth 1.0 (Twiiter) • OAuth 2.0 (Facebook) • OAuth2 en los planes pero sin fecha: ( https://github.com/guzzle/guzzle/issues/319 )
81. OAuth Plugin • OAuth 1.0 (Twiiter) • OAuth 2.0 (Facebook) • OAuth2 en los planes pero sin fecha: ( https://github.com/guzzle/guzzle/issues/319 )
82. OAuth Plugin • OAuth 1.0 (Twiiter) • OAuth 2.0 (Facebook) • OAuth2 en los planes pero sin fecha: ( https://github.com/guzzle/guzzle/issues/319 )
83. // Cargando el plugin OAuth $client = new Client('http://api.twitter.com/1.1'); $oauth = new OauthPlugin(array( 'consumer_key' => 'mi_key', 'consumer_secret' => 'mi_string_secreto', 'token' => 'mi_token', 'token_secret' => 'mi_token_secreto' )); $client->addSubscriber($oauth); $request = $client->get('statuses/public_timeline.json'); $response = $request->send();
84. Service Builder
85. Service Builder // Create cliente de twitter $client = TwitterClient::factory(array( 'consumer_key' => '****', 'consumer_secret' => '****', 'token' => '****', 'token_secret' => '****' ));
86. Service Builder // Crear un cliente desde un factory $builder = ServiceBuilder::factory('/ruta/a/config.json'); $twitter = $builder->get('twitter');
87. Service Builder { "services": { "twitter_ajessu": { "class": "ajessu\TwitterClient", "params": { "consumer_key": "****", "consumer_secret": "****", "token": "****", "token_secret": "****" } }, "twitter_desymfony": { "class": "ajessu\TwitterClient", "params": { "consumer_key": "****", "consumer_secret": "****", "token": "****", "token_secret": "****" } } } } $twitter_ajessu = $builder->get('twitter_ajessu'); $twitter_desymfony = $builder->get('twitter_desymfony');
88. Service Definition
89. Service Builder { "name": "string", "apiVersion": "string|number", "baseUrl": "string", "description": "string", "operations": {}, "models": {}, "includes": ["string.php", "string.json"] }
90. Service Builder { "includes":[ "connection.json" ], "name": "IndividualMember", "apiVersion": "0.1", "description": "Individual Member Api for Emailvision", "baseUrl": "{schema}://{server}/apimember/services/rest", "operations": { "InsertOrUpdateMember": { "httpMethod": "POST", "uri": "member/insertOrUpdateMember/{token}", "summary": "Updates a user if it exists, otherwise it updates it", "responseClass": "InsertOrUpdateMember", "parameters": { "token": { "location": "uri", "description": "Connection token", "required": true }, "user": { "location": "body", "description": "User values in xml", "required": true }, "Content-Type": { "location": "header", "default": "application/xml" } } } } }
91. Service Builder { "name": "Connection", "apiVersion": "0.1", "description": "Connection Api for Emailvision", "operations": { "OpenConnection": { "httpMethod": "GET", "uri": "connect/open/{apiLogin}/{apiPassword}/{apiKey}", "summary": "Opens the connection", "responseClass": "OpenConnection", "parameters": { "apiLogin": { "location": "uri", "description": "API username", "required": true }, "apiPassword": { "location": "uri", "description": "API password", "required": true }, "apiKey": { "location": "uri", "description": "API secret key", "required": true } } }, ... }, "models": { "OpenConnection": { "type": "object", "properties": { "token": { "location": "xml", "type": "string", "sentAs": "result" }, "status": { "type": "int", "location": "statusCode" } } }, ... } }
92. Service Builder $memberClient = DataIndividualClient::factory(); // Get the token $openConnectionCommand = $memberClient->getCommand( 'OpenConnection', array( 'apiLogin' => '*****', 'apiPassword' => '****', 'apiKey' => ‘*********’ ) ); $openConnectionResponse = $memberClient->execute($openConnectionCommand); $token = $openConnectionResponse['token']; $body = EntityBody::factory(‘/foo/user.xml’); $updateUserCommand = $memberClient->getCommand( 'InsertOrUpdateMember', array( 'token' => $token, 'user' => $body ) ); $memberClient->execute($updateUserCommand); // Close connection $closeConnectionCommand = $memberClient->getCommand( 'CloseConnection', array('token' => $token) ); $memberClient->execute($closeConnectionCommand);
93. Guzzle en silex
94. Guzzle en silex $app = new Application(); $app->register(new GuzzleServiceProvider(), array( 'guzzle.services' => '/ruta/a/servicios.json', ));
95. Guzzle en Symfony2
96. Guzzle en Symfony2
97. Guzzle en Symfony2 • Varios bundles
98. Guzzle en Symfony2 • Varios bundles • Mejor opción hoy: MisdGuzzleBundle ( https://github.com/misd-service-development/guzzle-bundle )
99. Guzzle en Symfony2 • Varios bundles • Mejor opción hoy: MisdGuzzleBundle ( https://github.com/misd-service-development/guzzle-bundle ) • Discusion (hace tres dias) = Vamos a unirlos! ( https://github.com/misd-service-development/guzzle-bundle/issues/28 )k
100. Guzzle en Symfony2 // app/AppKernel.php class AppKernel extends Kernel { // ... public function registerBundles() { $bundles = array( // ... new Misd\GuzzleBundle\MisdGuzzleBundle() ); } }
101. Guzzle en Symfony2 // MyBundle/Resources/config/services.xml <service id="example.client" class="%guzzle.client.class%"> <tag name="guzzle.client"/> <argument>http://api.example.com/</argument> <argument type="collection"> <argument key="setting1">true</argument> <argument key="setting2">false</argument> </argument> <call method="addSubscriber"> <argument type="service" id="some_guzzle_plugin"/> </call> <call method="setUserAgent"> <argument>My Guzzle client</argument> <argument>true</argument> </call> <call method="setDescription"> <argument type="service" id="example.client.service_description"/> </call> </service>
102. Guzzle en Symfony2 $client = $this->get('example.client'); // Service description: <service id="example.client.service_description" class="%guzzle.service_description.class%" factory-class="%guzzle.service_description.class%" factory-method="factory"> <argument>%path.to.my.service_description.file%</ argument> </service>
103. Gracias! Feedback: https://joind.in/8840 Albert Jessurum @ajessu github.com/ajessu