<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[5033] sites/trunk/api.wordpress.org/public_html/events/1.0/index.php: Events API: Modularize controller logic to faciliate automated tests</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/5033">5033</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/5033","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-03-01 23:13:13 +0000 (Wed, 01 Mar 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Events API: Modularize controller logic to faciliate automated tests
This allows the upcoming test suite to bypass undesired runtime behavior like outputting a JSON response. It also makes the code easier to read and maintain.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkapiwordpressorgpublic_htmlevents10indexphp">sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkapiwordpressorgpublic_htmlevents10indexphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/api.wordpress.org/public_html/events/1.0/index.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-03-01 23:04:36 UTC (rev 5032)
+++ sites/trunk/api.wordpress.org/public_html/events/1.0/index.php 2017-03-01 23:13:13 UTC (rev 5033)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,72 +1,137 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$base_dir = dirname( dirname(__DIR__ ) );
-require( $base_dir . '/init.php' );
-require( $base_dir . '/includes/hyperdb/bb-10-hyper-db.php' );
-include( $base_dir . '/includes/object-cache.php' );
-include( $base_dir . '/includes/wp-json-encode.php' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+namespace Dotorg\API\Events;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-wp_cache_init();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Main entry point
+ */
+function main() {
+ global $cache_group, $cache_life;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$cache_group = 'events';
-$cache_life = 12 * 60 * 60;
-$ttl = 12 * 60 * 60; // Time the client should cache the document.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ bootstrap();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$location_args = array();
-// If a precise location is known, use a GET request. The values here should come from the `location` key of the result of a POST request.
-if ( isset( $_GET['latitude'] ) ) {
- $location_args['latitude'] = $_GET['latitude'];
- $location_args['longitude'] = $_GET['longitude'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The test suite just needs the functions defined and doesn't want any headers or output
+ if ( defined( 'RUNNING_TESTS' ) && RUNNING_TESTS ) {
+ return;
+ }
+
+ wp_cache_init();
+
+ $cache_group = 'events';
+ $cache_life = 12 * 60 * 60;
+ $ttl = 12 * 60 * 60; // Time the client should cache the document.
+ $location_args = parse_request();
+ $location = get_location( $location_args );
+ $response = build_response( $location );
+
+ send_response( $response, $ttl );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-if ( isset( $_GET['country'] ) ) {
- $location_args['country'] = $_GET['country'];
-}
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// If a precide location is not known, create a POST request with a bunch of data which can be used to determine a precise location for future GET requests.
-if ( isset( $_POST['location_data'] ) ) {
- $location_args = $_POST['location_data'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Include dependencies
+ */
+function bootstrap() {
+ $base_dir = dirname( dirname(__DIR__ ) );
+
+ require( $base_dir . '/init.php' );
+ require( $base_dir . '/includes/hyperdb/bb-10-hyper-db.php' );
+ include( $base_dir . '/includes/object-cache.php' );
+ include( $base_dir . '/includes/wp-json-encode.php' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Simplified parameters for lookup by location (city) name, with optional timezone and locale params for extra context.
-if ( isset( $_REQUEST['location'] ) )
- $location_args['location_name'] = $_REQUEST['location'];
-if ( isset( $_REQUEST['timezone'] ) && !isset( $location_args['timezone'] ) )
- $location_args['timezone'] = $_REQUEST['timezone'];
-if ( isset( $_REQUEST['locale'] ) && !isset( $location_args['locale'] ) )
- $location_args['locale'] = $_REQUEST['locale'];
-if ( isset( $_REQUEST['ip'] ) && !isset( $location_args['ip'] ) )
- $location_args['ip'] = $_REQUEST['ip'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Parse and normalize the client's request
+ *
+ * @return array
+ */
+function parse_request() {
+ $location_args = array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$location = get_location( $location_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If a precise location is known, use a GET request. The values here should come from the `location` key of the result of a POST request.
+ if ( isset( $_GET['latitude'] ) ) {
+ $location_args['latitude'] = $_GET['latitude'];
+ $location_args['longitude'] = $_GET['longitude'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-if ( false === $location ) {
- // No location was determined for the request. Bail with an error.
- $events = array();
- $error = 'no_location_available';
-} else {
- $event_args = array();
- if ( isset( $_REQUEST['number'] ) ) {
- $event_args['number'] = $_REQUEST['number'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $_GET['country'] ) ) {
+ $location_args['country'] = $_GET['country'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !empty( $location['latitude'] ) ) {
- $event_args['nearby'] = array(
- 'latitude' => $location['latitude'],
- 'longitude' => $location['longitude'],
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // If a precise location is not known, create a POST request with a bunch of data which can be used to determine a precise location for future GET requests.
+ if ( isset( $_POST['location_data'] ) ) {
+ $location_args = $_POST['location_data'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !empty( $location['country'] ) ) {
- $event_args['country'] = $location['country'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Simplified parameters for lookup by location (city) name, with optional timezone and locale params for extra context.
+ if ( isset( $_REQUEST['location'] ) ) {
+ $location_args['location_name'] = $_REQUEST['location'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $events = get_events( $event_args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $_REQUEST['timezone'] ) && ! isset( $location_args['timezone'] ) ) {
+ $location_args['timezone'] = $_REQUEST['timezone'];
+ }
+
+ if ( isset( $_REQUEST['locale'] ) && ! isset( $location_args['locale'] ) ) {
+ $location_args['locale'] = $_REQUEST['locale'];
+ }
+
+ if ( isset( $_REQUEST['ip'] ) && ! isset( $location_args['ip'] ) ) {
+ $location_args['ip'] = $_REQUEST['ip'];
+ }
+
+ return $location_args;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-header( 'Expires: ' . gmdate( 'r', time() + $ttl ) );
-header( 'Access-Control-Allow-Origin: *' );
-header( 'Content-Type: application/json; charset=UTF-8' );
-echo wp_json_encode( compact( 'error', 'location', 'events', 'ttl' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Build the API's response to the client's request
+ *
+ * @param array $location
+ *
+ * @return array
+ */
+function build_response( $location ) {
+ if ( false === $location ) {
+ // No location was determined for the request. Bail with an error.
+ $events = array();
+ $error = 'no_location_available';
+ } else {
+ $event_args = array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $_REQUEST['number'] ) ) {
+ $event_args['number'] = $_REQUEST['number'];
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! empty( $location['latitude'] ) ) {
+ $event_args['nearby'] = array(
+ 'latitude' => $location['latitude'],
+ 'longitude' => $location['longitude'],
+ );
+ }
+
+ if ( ! empty( $location['country'] ) ) {
+ $event_args['country'] = $location['country'];
+ }
+
+ $events = get_events( $event_args );
+ }
+
+ return compact( 'error', 'location', 'events', 'ttl' );
+}
+
+/**
+ * Send the API's response to the client's request
+ *
+ * @param array $response
+ * @param int $ttl
+ */
+function send_response( $response, $ttl ) {
+ header( 'Expires: ' . gmdate( 'r', time() + $ttl ) );
+ header( 'Access-Control-Allow-Origin: *' );
+ header( 'Content-Type: application/json; charset=UTF-8' );
+
+ echo wp_json_encode( $response );
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function guess_location_from_geonames( $location_name, $timezone, $country ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px"> // Look for a location that matches the name.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -319,6 +384,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+main();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> CREATE TABLE `wporg_events` (
</span><span class="cx" style="display: block; padding: 0 10px"> `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
</span></span></pre>
</div>
</div>
</body>
</html>