Switch Idea Hub module REST routes to actually use Idea Hub API

Now that the Idea Hub API client library code is available, Site Kit should actually start using the API.

---

Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

• The Idea_Hub class should have its REST data points that are intended to proxy through requests to the Idea Hub API updated to actually use the API. The necessary PHP client service classes are included in Site Kit via #3517.
  • The class needs to implement the setup_services method, to bootstrap a single ideahub service, which should be this class.
  • The get_datapoint_definitions method needs to be modified to reference the new ideahub service for all data points that use the API (GET:new-ideas, GET:saved-ideas, POST:update-idea-state).
  • The three above endpoints need to be connected to the respective Idea Hub API endpoint:
    • For GET:new-ideas and GET:saved-ideas, remove the hard-coded return values and instead use https://github.com/googleapis/google-api-php-client-services/blob/master/src/Google/Service/Ideahub/Resource/PlatformsPropertiesIdeas.php, passing sitekit for platform and the URL-encoded current site’s URL (“reference site URL”) for property. In order to only return new ideas, the filter option needs to be used, passing a string “saved(false)”. In order to only return saved ideas, the filter option needs to be used, passing a string “saved(true)”.
    • For POST:update-idea-state, use https://github.com/googleapis/google-api-php-client-services/blob/master/src/Google/Service/Ideahub/Resource/PlatformsPropertiesIdeaStates.php, passing platform and property as mentioned above and the received idea name as the “ideaState” placeholder in the path. The data point should expect a single variable ideaState which needs to be an object / associative array with name (idea name string, also used in the path as mentioned right above), saved (boolean) and dismissed (boolean) fields.

Implementation Brief

• Add a protected function setup_services to the Idea_Hub class that creates a new instance of Google_Service_Ideahubto be used in the instance ofIdea_Hub`.
• Modidy the existing get_datapoint_definitions in the Idea_Hub class so that the following point to array( 'service' => 'ideahub' ):
  • GET:new-ideas
  • GET:saved-ideas
  • POST:update-idea-state
• See ACs for the implementation of each endpoint, as the ACs outline the implementation quite well.

Test Coverage

• Existing tests should pass, but no new tests needed.

Visual Regression Changes

• N/A

QA Brief

• Activate Idea Hub module
• Set the custom site URL setting in the Site Kit developer settings to https://www.elasticpress.io/
• Go to the dashboard and verify that you see new ideas
• Also check that you can create a draft post using a new idea and that idea won’t re-appear in the new ideas list once you refresh the dashboard page.

Changelog entry

• Update Idea Hub to use the production API.

[felixarntz]

@eugene-manuilov Just two tiny updates here:

1. Based on a few updates from the API team, it looks like the value we need to pass for the platform is “sitekit” instead of “SITEKIT” what I had in the ACs earlier. If one doesn’t work, please try out the other, just to make sure 😃
2. The value passed for property needs to be URL-encoded since it is a URL which is part of a regular URL path. That probably would have come up during the implementation anyway, but I just updated the ACs to clarify.

[felixarntz]

@eugene-manuilov Per our Slack conversation, I’ve reduced the scope of this issue to no longer include any changes to POST:update-idea-state. This is now broken out into #3747.