Changeset 6078

Timestamp:

11/06/2017 09:03:28 PM (7 years ago)

Author:

iandunn

Message:

Events: Add regional WordCamps to the Core widget for extra promotion.

Location:

sites/trunk/api.wordpress.org/public_html/events/1.0

Files:

• index.php (modified) (2 diffs)
• tests/test-index.php (modified) (2 diffs)

sites/trunk/api.wordpress.org/public_html/events/1.0/index.php

@@ -148 +148 @@
 
         $events = get_events( $event_args );
+        $events = add_regional_wordcamps( $events, $_SERVER['HTTP_USER_AGENT'] );
 
         /*
@@ -785 +786 @@
 
 /**
+ * Add regional WordCamps to the Events Widget in Core for extra promotion.
+ *
+ * @param array  $local_events
+ * @param string $user_agent
+ *
+ * @return array
+ */
+function add_regional_wordcamps( $local_events, $user_agent ) {
+    $time = time();
+    $regional_wordcamps = array();
+
+    /*
+     * Limit effects to the Events Widget in Core.
+     * Otherwise this would return unexpected results to other clients.
+     *
+     * This is the closest we can get to detecting Core, so it'll still distort results for any
+     * plugins that are fetching events with `wp_remote_get()`.
+     */
+    if ( false === strpos( $user_agent, 'WordPress/' ) ) {
+        return $local_events;
+    }
+
+    if ( $time <= strtotime( 'December 2nd, 2017' ) ) {
+        $regional_wordcamps[] = array(
+            'type'       => 'wordcamp',
+            'title'      => 'WordCamp US',
+            'url'        => 'https://2017.us.wordcamp.org/',
+            'meetup'     => '',
+            'meetup_url' => '',
+            'date'       => '2017-12-01 00:00:00',
+
+            'location' => array(
+                'location'  => 'Nashville, TN, USA',
+                'country'   => 'US',
+                'latitude'  => 36.1566085,
+                'longitude' => -86.7784909,
+            )
+        );
+    }
+
+    if ( $time >= strtotime( 'May 14th, 2018' ) && $time <= strtotime( 'June 15th, 2018' ) ) {
+        $regional_wordcamps[] = array(
+            'type'       => 'wordcamp',
+            'title'      => 'WordCamp Europe',
+            'url'        => 'https://2018.europe.wordcamp.org/',
+            'meetup'     => '',
+            'meetup_url' => '',
+            'date'       => '2018-06-14 00:00:00',
+
+            'location' => array(
+                'location'  => 'Belgrade, Serbia',
+                'country'   => 'RS',
+                'latitude'  => 44.808497,
+                'longitude' => 20.432285,
+            )
+        );
+    }
+
+    /**
+     * Remove duplicates events.
+     * Favor the regional event since it'll be pinned to the top.
+     */
+    foreach ( $regional_wordcamps as $regional_event ) {
+        foreach ( $local_events as $local_key => $local_event ) {
+            if ( parse_url( $regional_event['url'], PHP_URL_HOST ) === parse_url( $local_event['url'], PHP_URL_HOST ) ) {
+                unset( $local_events[ $local_key ] );
+            }
+        }
+    }
+
+    return array_merge( $regional_wordcamps, $local_events );
+}
+
+/**
  * Create a bounded latitude/longitude box of x KM around specific coordinates.
  *

sites/trunk/api.wordpress.org/public_html/events/1.0/tests/test-index.php

@@ -20 +20 @@
     $tests_failed += test_get_location();
     $tests_failed += test_get_events();
+    $tests_failed += test_add_regional_wordcamps();
     $tests_failed += test_build_response();
     $query_count  = count( $wpdb->queries );
@@ -1019 +1020 @@
 
 /**
+ * Test `add_regional_events()`
+ *
+ * @return int
+ */
+function test_add_regional_wordcamps() {
+    $failed = 0;
+
+    $local_events = get_events( array(
+        'number' => '5',
+        'nearby' => array(
+            'latitude'  => '-33.849951',
+            'longitude' => '18.426246',
+        ),
+    ) );
+
+    // Make sure there's at least one event, otherwise there could be false positives.
+    if ( ! $local_events ) {
+        $local_events[] = array( 'title' => 'Mock Event' );
+    }
+
+    printf( "\n\nRunning %d add_regional_wordcamps() tests\n", 2 );
+
+    // Test that no changes were made if the user agent isn't Core.
+    $events_no_user_agent = add_regional_wordcamps( $local_events, '' );
+
+    if ( $events_no_user_agent !== $local_events ) {
+        $failed++;
+        output_results( 'no-user-agent', false, $local_events, $events_no_user_agent );
+    }
+
+    /*
+     * Test that local events were unharmed if the user agent is Core.
+     *
+     * There isn't an easy way to mock time(), so this doesn't test that the events were added
+     * correctly. It just makes sure that local events weren't removed.
+     */
+    $events_core_user_agent = add_regional_wordcamps( $local_events, 'WordPress/4.9; https://example.org' );
+
+    if (
+        count( $events_core_user_agent ) < count( $local_events ) ||
+        ! in_array( $local_events[0], $events_core_user_agent, true )
+    ) {
+        $failed++;
+        output_results( 'core-user-agent', false, 'local events were not affected', $events_core_user_agent );
+    }
+
+    return $failed;
+}
+
+/**
  * Stub to simulate cache misses, so that the tests always get fresh results
  *