Merge pull request #76 from wp-cli/headers-envelope-formt

Add `--format=headers` and `--format=envelope` to `list` and `get`
wp-cli · Jul 11, 2016 · c41e737 · c41e737
2 parents a46bb23 + fe1be22
commit c41e737
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 4 deletions.
diff --git a/features/comment.feature b/features/comment.feature
@@ -56,6 +56,18 @@ Feature: Manage WordPress comments through the REST API
       [{"author_name":"Mr WordPress"}]
       """
 
+    When I run `wp rest comment list --format=headers`
+    Then STDOUT should be JSON containing:
+      """
+      {"X-WP-TotalPages":1}
+      """
+
+    When I run `wp rest comment list --format=envelope`
+    Then STDOUT should be JSON containing:
+      """
+      {"headers":{"X-WP-TotalPages":1}}
+      """
+
   Scenario: List comments with different contexts
     When I run `wp rest comment list --context=embed --format=csv`
     Then STDOUT should contain:
@@ -98,6 +110,12 @@ Feature: Manage WordPress comments through the REST API
       {"author_name":"Mr WordPress"}
       """
 
+    When I run `wp rest comment get 1 --format=envelope`
+    Then STDOUT should be JSON containing:
+      """
+      {"body":{"author_name":"Mr WordPress"}}
+      """
+
   Scenario: Create a comment
     When I run `wp rest comment create --post=1 --content="Hello World, again" --user=1`
     Then STDOUT should contain:

diff --git a/inc/RestCommand.php b/inc/RestCommand.php
@@ -126,7 +126,7 @@ public function delete_item( $args, $assoc_args ) {
 	 * @subcommand get
 	 */
 	public function get_item( $args, $assoc_args ) {
-		list( $status, $body ) = $this->do_request( 'GET', $this->get_filled_route( $args ), $assoc_args );
+		list( $status, $body, $headers ) = $this->do_request( 'GET', $this->get_filled_route( $args ), $assoc_args );
 
 		if ( ! empty( $assoc_args['fields'] ) ) {
 			$fields = explode( ',', $assoc_args['fields'] );
@@ -137,8 +137,16 @@ public function get_item( $args, $assoc_args ) {
 			}
 		}
 
-		if ( ! empty( $assoc_args['format'] ) && 'body' === $assoc_args['format'] ) {
+		if ( 'headers' === $assoc_args['format'] ) {
+			echo json_encode( $headers );
+		} else if ( 'body' === $assoc_args['format'] ) {
 			echo json_encode( $body );
+		} else if ( 'envelope' === $assoc_args['format'] ) {
+			echo json_encode( array(
+				'body'        => $body,
+				'headers'     => $headers,
+				'status'      => $status,
+			) );
 		} else {
 			$formatter = $this->get_formatter( $assoc_args );
 			$formatter->display_item( $body );
@@ -177,8 +185,16 @@ public function list_items( $args, $assoc_args ) {
 
 		if ( ! empty( $assoc_args['format'] ) && 'count' === $assoc_args['format'] ) {
 			echo (int) $headers['X-WP-Total'];
-		} else if ( ! empty( $assoc_args['format'] ) && 'body' === $assoc_args['format'] ) {
+		} else if ( 'headers' === $assoc_args['format'] ) {
+			echo json_encode( $headers );
+		} else if ( 'body' === $assoc_args['format'] ) {
 			echo json_encode( $body );
+		} else if ( 'envelope' === $assoc_args['format'] ) {
+			echo json_encode( array(
+				'body'        => $body,
+				'headers'     => $headers,
+				'status'      => $status,
+			) );
 		} else {
 			$formatter = $this->get_formatter( $assoc_args );
 			$formatter->display_items( $items );
@@ -341,7 +357,7 @@ private function do_request( $method, $route, $assoc_args ) {
 					}
 				}
 			}
-			return array( $response->status_code, json_decode( $response->body, true ), $response->headers );
+			return array( $response->status_code, json_decode( $response->body, true ), $response->headers->getAll() );
 		}
 		WP_CLI::error( 'Invalid scope for REST command.' );
 	}

diff --git a/inc/Runner.php b/inc/Runner.php
@@ -219,7 +219,9 @@ private static function register_route_commands( $rest_command, $route, $route_d
 						'ids',
 						'yaml',
 						'count',
+						'headers',
 						'body',
+						'envelope',
 					),
 				);
 			}
-Original file line number
+Diff line change
@@ Expand Up @@
     						'ids',
     						'yaml',
     						'count',
+    						'headers',
     						'body',
+    						'envelope',
     					),
     				);
     			}
@@ Expand Down @@