Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00%
0 / 79
0.00%
0 / 5
 CRAP
0.00%
0 / 1
Services_Controller
0.00%
0 / 77
0.00%
0 / 5
 90
0.00%
0 / 1
 __construct
0.00%
0 / 6
0.00%
0 / 1
 2
 register_routes
0.00%
0 / 12
0.00%
0 / 1
 2
 get_item_schema
0.00%
0 / 46
0.00%
0 / 1
 6
 get_items_permissions_check
0.00%
0 / 1
0.00%
0 / 1
 2
 get_items
0.00%
0 / 12
0.00%
0 / 1
 20
1<?php
2/**
3 * The Publicize services Controller class.
4 *
5 * @package automattic/jetpack-publicize
6 */
7
8namespace Automattic\Jetpack\Publicize\REST_API;
9
10use Automattic\Jetpack\Connection\Traits\WPCOM_REST_API_Proxy_Request;
11use Automattic\Jetpack\Publicize\Publicize_Utils;
12use Automattic\Jetpack\Publicize\Services;
13use WP_Error;
14use WP_REST_Request;
15use WP_REST_Response;
16use WP_REST_Server;
17
18if ( ! defined( 'ABSPATH' ) ) {
19    exit( 0 );
20}
21
22/**
23 * Services Controller class.
24 *
25 * @phan-constructor-used-for-side-effects
26 */
27class Services_Controller extends Base_Controller {
28
29    use WPCOM_REST_API_Proxy_Request;
30
31    /**
32     * Constructor.
33     */
34    public function __construct() {
35        parent::__construct();
36
37        $this->base_api_path = 'wpcom';
38        $this->version       = 'v2';
39
40        $this->namespace = "{$this->base_api_path}/{$this->version}";
41        $this->rest_base = 'publicize/services';
42
43        add_action( 'rest_api_init', array( $this, 'register_routes' ) );
44    }
45
46    /**
47     * Register the routes.
48     */
49    public function register_routes() {
50        register_rest_route(
51            $this->namespace,
52            '/' . $this->rest_base,
53            array(
54                array(
55                    'methods'             => WP_REST_Server::READABLE,
56                    'callback'            => array( $this, 'get_items' ),
57                    'permission_callback' => array( $this, 'get_items_permissions_check' ),
58                ),
59                'schema' => array( $this, 'get_public_item_schema' ),
60            )
61        );
62    }
63
64    /**
65     * Schema for the endpoint.
66     *
67     * @return array
68     */
69    public function get_item_schema() {
70        if ( $this->schema ) {
71            return $this->add_additional_fields_schema( $this->schema );
72        }
73        $schema = array(
74            '$schema'    => 'http://json-schema.org/draft-04/schema#',
75            'title'      => 'jetpack-publicize-service',
76            'type'       => 'object',
77            'properties' => array(
78                'id'          => array(
79                    'type'        => 'string',
80                    'description' => __( 'Alphanumeric slug for the service.', 'jetpack-publicize-pkg' ),
81                ),
82                'description' => array(
83                    'type'        => 'string',
84                    'description' => __( 'Description for the service.', 'jetpack-publicize-pkg' ),
85                ),
86                'label'       => array(
87                    'type'        => 'string',
88                    'description' => __( 'Human-readable label for the Jetpack Social service.', 'jetpack-publicize-pkg' ),
89                ),
90                'status'      => array(
91                    'type'        => 'string',
92                    'description' => __( 'Status of the service.', 'jetpack-publicize-pkg' ),
93                    'enum'        => array( null, 'ok', 'unsupported' ),
94                ),
95                'supports'    => array(
96                    'type'        => 'object',
97                    'description' => __( 'An object of features that the service supports.', 'jetpack-publicize-pkg' ),
98                    'properties'  => array(
99                        'additional_users'      => array(
100                            'type'        => 'boolean',
101                            'description' => __( 'Whether the service is supported for multiple additional user accounts.', 'jetpack-publicize-pkg' ),
102                        ),
103                        'additional_users_only' => array(
104                            'type'        => 'boolean',
105                            'description' => __( 'Whether the service supports only the additional users and not the main user account.', 'jetpack-publicize-pkg' ),
106                        ),
107                    ),
108                ),
109                'url'         => array(
110                    'type'        => 'string',
111                    'description' => __( 'URL to use for connecting an account for the service.', 'jetpack-publicize-pkg' ),
112                ),
113            ),
114        );
115
116        $this->schema = $schema;
117
118        return $this->add_additional_fields_schema( $schema );
119    }
120
121    /**
122     * Verify that the request has access to services list.
123     *
124     * @param WP_REST_Request $request Full details about the request.
125     * @return true|WP_Error
126     */
127    public function get_items_permissions_check( $request ) {// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
128        return $this->publicize_permissions_check();
129    }
130
131    /**
132     * Get list of Publicize services.
133     *
134     * @param WP_REST_Request $request Full details about the request.
135     *
136     * @return WP_REST_Response suitable for 1-page collection
137     */
138    public function get_items( $request ) {
139        if ( Publicize_Utils::is_wpcom() ) {
140
141            $items = array();
142
143            foreach ( Services::wpcom_get_all() as $item ) {
144                $data = $this->prepare_item_for_response( $item, $request );
145
146                $items[] = $this->prepare_response_for_collection( $data );
147            }
148        } else {
149            $items = $this->proxy_request_to_wpcom_as_user( $request );
150
151            if ( is_wp_error( $items ) ) {
152                return $items;
153            }
154        }
155
156        $response = rest_ensure_response( $items );
157        $response->header( 'X-WP-Total', (string) count( $items ) );
158        $response->header( 'X-WP-TotalPages', '1' );
159
160        return $response;
161    }
162}