Changeset 5355

Timestamp:

04/17/2017 09:06:59 PM (9 years ago)

Author:

iandunn

Message:

Events: Add country names to descriptions

There are situations where it's helpful to give clients both the country name and country code, because they may have only passed one of them.

See ​https://github.com/coreymckrill/nearby-wordpress-events/issues/35

Location:

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

Files:

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

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

@@ -417 +417 @@
                         if ( ! $location && $guess ) {
                                 $location = array(
-                                        'country' => $guess,
+                                        'country'     => $guess['country_short'],
+                                        'description' => $guess['country_long'],
                                 );
                         }
@@ -462 +463 @@
  * @param string $location_name
  *
- * @return false|string false on failure; a country code on success
+ * @return false|array false on failure; an array with country details on success
  */
 function guess_location_from_country( $location_name ) {
         // Check if they entered only the country name, e.g. "Germany" or "New Zealand"
-        $country_code = get_country_code_from_name( $location_name );
+        $country             = get_country_from_name( $location_name );
         $location_word_count = str_word_count( $location_name );
         $location_name_parts = explode( ' ', $location_name );
-
-        // Check if they entered only the country code, e.g., "GB"
-        if ( ! $country_code ) {
-                $valid_country_codes = get_valid_country_codes();
-
-                if ( in_array( $location_name, $valid_country_codes, true ) ) {
-                        $country_code = $location_name;
-                }
-        }
+        $valid_country_codes = get_valid_country_codes();
 
         /*
          * Multi-word queries may contain cities, regions, and countries, so try to extract just the country
          */
-        if ( ! $country_code && $location_word_count >= 2 ) {
+        if ( ! $country && $location_word_count >= 2 ) {
                 // Catch input like "Vancouver Canada"
                 $country_id   = $location_name_parts[ $location_word_count - 1 ];
-                $country_code = get_country_code_from_name( $country_id );
-
-                // Catch input like "London GB"
-                if ( ! $country_code ) {
-                        if ( in_array( $country_id, $valid_country_codes, true ) ) {
-                                $country_code = $country_id;
-                        }
-                }
-        }
-
-        if ( ! $country_code && $location_word_count >= 3 ) {
+                $country      = get_country_from_name( $country_id );
+        }
+
+        if ( ! $country && $location_word_count >= 3 ) {
                 // Catch input like "Santiago De Los Caballeros, Dominican Republic"
                 $country_name = sprintf(
@@ -502 +488 @@
                         $location_name_parts[ $location_word_count - 1 ]
                 );
-                $country_code = get_country_code_from_name( $country_name );
-        }
-
-        if ( ! $country_code && $location_word_count >= 4 ) {
+                $country = get_country_from_name( $country_name );
+        }
+
+        if ( ! $country && $location_word_count >= 4 ) {
                 // Catch input like "Kaga-Bandoro, Central African Republic"
                 $country_name = sprintf(
@@ -513 +499 @@
                         $location_name_parts[ $location_word_count - 1 ]
                 );
-                $country_code = get_country_code_from_name( $country_name );
-        }
-
-        return $country_code;
+                $country = get_country_from_name( $country_name );
+        }
+
+        return $country;
 }
 
@@ -531 +517 @@
 
 /**
- * Get the country code that corresponds to the given country name
+ * Get the country that corresponds to the given country name
  *
  * @param string $country_name
  *
- * @return false|string false on failure; a country code on success
- */
-function get_country_code_from_name( $country_name ) {
+ * @return false|array false on failure; an array with country details on success
+ */
+function get_country_from_name( $country_name ) {
         global $wpdb;
 
-        $country_code = $wpdb->get_var( $wpdb->prepare( "
-                SELECT country_short
+        $country = $wpdb->get_row( $wpdb->prepare( "
+                SELECT country_short, country_long
                 FROM ip2location
-                WHERE country_long = %s
+                WHERE
+                        country_long  = %s OR
+                        country_short = %s
                 LIMIT 1",
+                $country_name,
                 $country_name
-        ) );
-
+        ), 'ARRAY_A' );
 
         // Convert all errors to boolean false for consistency
-        if ( empty( $country_code ) ) {
-                $country_code = false;
-        }
-
-        return $country_code;
+        if ( empty( $country ) ) {
+                $country = false;
+        }
+
+        return $country;
 }
 

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

@@ -124 +124 @@
                         ),
                         'expected' => array(
-                                'country' => 'AU'
+                                'country' => 'AU',
                         ),
                 ),
@@ -139 +139 @@
                         ),
                         'expected' => array(
-                                'country' => 'ID'
+                                'country' => 'ID',
+                                'description' => 'indonesia',
                         ),
                 ),
@@ -487 +488 @@
                         'expected' => array(
                                 'country' => 'CA',
+                                'description' => 'canada',
                         ),
                 ),
@@ -498 +500 @@
                         'expected' => array(
                                 'country' => 'DO',
+                                'description' => 'dominican republic',
                         ),
                 ),
@@ -509 +512 @@
                         'expected' => array(
                                 'country' => 'CF',
+                                'description' => 'central african republic',
                         ),
                 ),
@@ -520 +524 @@
                         'expected' => array(
                                 'country' => 'GB',
+                                'description' => 'united kingdom',
                         ),
                 ),
@@ -531 +536 @@
                         'expected' => array(
                                 'country' => 'BI',
+                                'description' => 'burundi',
                         ),
                 ),