Merge branch 'hotfix/48-status-update-via-post'

Close #53
Fixes #48
Fixes #49

Author: weierophinney

CHANGELOG.md

@@ -22,14 +22,20 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- [#51](https://github.com/zendframework/ZendService_Twitter/pull/51) fixes
-  submission of direct messages to the Twitter API. Payloads for DMs have been
-  broken since the 3.0.0 release.
+- [#53](https://github.com/zendframework/ZendService_Twitter/pull/53) fixes
+  issues in the majority of POST endpoints. Due to a mis-read of the Twitter API
+  documentation, we were sending JSON payloads, when only a small subset of such
+  endpoints actually can accept JSON. In particular, `statuses/update` was
+  affected. The patch in this releases fixes all such endpoints.
 
 - [#52](https://github.com/zendframework/ZendService_Twitter/pull/52) fixes
   the `search/tweets` logic concerning geocode parameter validation, ensuring it
   no longer raises an exception for a valid geocode parameter.
 
+- [#51](https://github.com/zendframework/ZendService_Twitter/pull/51) fixes
+  submission of direct messages to the Twitter API. Payloads for DMs have been
+  broken since the 3.0.0 release.
+
 ## 3.0.1 - 2017-08-17
 
 ### Added

TODO.md

@@ -71,3 +71,9 @@ The following is a list of Twitter API methods not yet implemented:
 - users/suggestions
 - users/suggestions/:slug
 - users/suggestions/:slug/members
+
+## Fixes/functionality updates
+
+- Use `Normalizer` class to get normalized string, and then use that to count
+  number of characters for purpose of string lengths.
+- Update allowed status length to 280 characters.

src/Twitter.php

@@ -32,6 +32,15 @@ class Twitter
      */
     const OAUTH_BASE_URI = 'https://api.twitter.com/oauth';
 
+    /**
+     * Paths that use JSON payloads (vs form-encoded)
+     */
+    const PATHS_JSON_PAYLOAD = [
+        'direct_messages/events/new',
+        'direct_messages/welcome_messages/new',
+        'direct_messages/welcome_messages/rules/new',
+    ];
+
     /**
      * 246 is the current limit for a status message, 140 characters are displayed
      * initially, with the remainder linked from the web UI or client. The limit is
@@ -402,7 +411,12 @@ public function post(string $path, $data = null) : Response
     {
         $client = $this->getHttpClient();
         $this->init($path, $client);
-        $response = $this->performPost(Http\Request::METHOD_POST, $data, $client);
+        $response = $this->performPost(
+            Http\Request::METHOD_POST,
+            $data,
+            $client,
+            in_array($path, self::PATHS_JSON_PAYLOAD, true)
+        );
         return new Response($response);
     }
 
@@ -1272,6 +1286,7 @@ public function statusesUpdate(string $status, $inReplyToStatusId = null, $extra
         if ($inReplyToStatusId) {
             $params['in_reply_to_status_id'] = $inReplyToStatusId;
         }
+
         return $this->post($path, $params);
     }
 
@@ -1499,21 +1514,17 @@ protected function validateScreenName(string $name) : string
      * is JSON-encoded before being passed to the request body.
      *
      * @param null|string|array|\stdClass $data Raw data to send
+     * @param bool $asJson Whether or not the data should be submitted as JSON
+     *     (vs form urlencoded, which is the default)
      */
-    protected function performPost(string $method, $data, Http\Client $client) : Http\Response
+    protected function performPost(string $method, $data, Http\Client $client, bool $asJson) : Http\Response
     {
-        if (is_array($data) || is_object($data)) {
-            $data = json_encode($data, $this->jsonFlags);
-        }
+        $client->setMethod($method);
 
-        if (! empty($data)) {
-            $client->setRawBody($data);
-            $client->getRequest()
-                ->getHeaders()
-                ->addHeaderLine('Content-Type', 'application/json');
-        }
+        $asJson
+            ? $this->prepareJsonPayloadForClient($client, $data)
+            : $this->prepareFormPayloadForClient($client, $data);
 
-        $client->setMethod($method);
         return $client->send();
     }
 
@@ -1629,4 +1640,36 @@ protected function createUserListParameter($ids, array $params, string $context)
         $params['screen_name'] = implode(',', $ids);
         return $params;
     }
+
+    /**
+     * Prepare a JSON payload for the HTTP client.
+     */
+    private function prepareJsonPayloadForClient(Http\Client $client, $data)
+    {
+        if (is_array($data) || is_object($data)) {
+            $data = json_encode($data, $this->jsonFlags);
+        }
+
+        if (empty($data) || ! is_string($data)) {
+            return;
+        }
+
+        $client->getRequest()
+            ->getHeaders()
+            ->addHeaderLine('Content-Type', 'application/json');
+
+        $client->setRawBody($data);
+    }
+
+    /**
+     * Prepare a form-url-encoded payload for the HTTP client.
+     */
+    private function prepareFormPayloadForClient(Http\Client $client, $data)
+    {
+        if (! is_array($data)) {
+            return;
+        }
+
+        $client->setParameterPost($data);
+    }
 }

test/TwitterTest.php

@@ -65,18 +65,16 @@ protected function stubOAuthClient(
         $client->setHeaders(['Accept-Charset' => 'ISO-8859-1,utf-8'])->will([$client, 'reveal']);
         $client->clearCookies()->will([$client, 'reveal']);
         $client->getCookies()->willReturn([]);
+
         if (null !== $params && $method === 'GET') {
             $client->setParameterGet($params)->shouldBeCalled();
         }
-        if (null !== $params && $method === 'POST') {
-            $requestBody = json_encode($params, $this->jsonFlags);
-            $client->setRawBody($requestBody)->shouldBeCalled();
-
-            $headers = $this->prophesize(Http\Headers::class);
-            $headers->addHeaderLine('Content-Type', 'application/json')->shouldBeCalled();
-            $request = $this->prophesize(Http\Request::class);
-            $request->getHeaders()->will([$headers, 'reveal']);
-            $client->getRequest()->will([$request, 'reveal']);
+
+        if ($method === 'POST' && null !== $params) {
+            $pathMinusExtension = str_replace('.json', '', $path);
+            in_array($pathMinusExtension, Twitter\Twitter::PATHS_JSON_PAYLOAD, true)
+                ? $this->prepareJsonPayloadForClient($client, $params)
+                : $this->prepareFormEncodedPayloadForClient($client, $params);
         }
 
         $response = $this->prophesize(Http\Response::class);
@@ -103,6 +101,23 @@ protected function stubOAuthClient(
         return $client->reveal();
     }
 
+    protected function prepareJsonPayloadForClient($client, array $params = null)
+    {
+        $headers = $this->prophesize(Http\Headers::class);
+        $headers->addHeaderLine('Content-Type', 'application/json')->shouldBeCalled();
+        $request = $this->prophesize(Http\Request::class);
+        $request->getHeaders()->will([$headers, 'reveal']);
+        $client->getRequest()->will([$request, 'reveal']);
+
+        $requestBody = json_encode($params, $this->jsonFlags);
+        $client->setRawBody($requestBody)->shouldBeCalled();
+    }
+
+    protected function prepareFormEncodedPayloadForClient($client, array $params = null)
+    {
+        $client->setParameterPost($params)->will([$client, 'reveal']);
+    }
+
     public function stubHttpClientInitialization()
     {
         $client = $this->prophesize(OAuthClient::class);