<!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>[7882] sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-genderize-client.php: WordCamp Utilities: Add an API client for Genderize.io</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 { white-space: pre-line; 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/7882">7882</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/7882","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coreymckrill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-11-22 04:14:48 +0000 (Thu, 22 Nov 2018)</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'>WordCamp Utilities: Add an API client for Genderize.io</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclassgenderizeclientphp">sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-genderize-client.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentmupluginsutilitiesclassgenderizeclientphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-genderize-client.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-genderize-client.php (rev 0)
+++ sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/utilities/class-genderize-client.php 2018-11-22 04:14:48 UTC (rev 7882)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,343 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+namespace WordCamp\Utilities;
+defined( 'WPINC' ) || die();
+
+use WP_Error;
+use GP_Locales;
+
+/**
+ * Class Genderize_Client
+ *
+ * @package WordCamp\Utilities
+ */
+class Genderize_Client extends API_Client {
+
+ const CACHE_KEY = 'genderize_cached_data';
+
+ /**
+ * @var string The base URL for the API endpoints.
+ */
+ protected $api_base = 'https://api.genderize.io/';
+
+ /**
+ * @var string The API key.
+ */
+ protected $api_key = '';
+
+ /**
+ * @var array|null Data retrieved from the cache.
+ */
+ protected $cache = null;
+
+ /**
+ * Additional client parameters.
+ *
+ * @var array
+ */
+ public $options = array();
+
+ /**
+ * Genderize_Client constructor.
+ *
+ * @param string $api_key The API key for authenticating with Genderize.io.
+ * @param array $options {
+ * Optional. Additional client parameters.
+ *
+ * @type bool $reset_cache True to delete the entire cache.
+ * }
+ */
+ public function __construct( $api_key = '', array $options = [] ) {
+ parent::__construct( [
+ 'breaking_response_codes' => [ 401, 402, 404, 422, 429 ],
+ ] );
+
+ // Report-specific options.
+ $this->options = wp_parse_args( $options, array(
+ 'reset_cache' => false,
+ ) );
+
+ if ( $api_key ) {
+ $this->api_key = $api_key;
+ } elseif ( defined( 'GENDERIZE_IO_API_KEY' ) ) {
+ $this->api_key = GENDERIZE_IO_API_KEY;
+ } else {
+ $this->error->add(
+ 'api_key_undefined',
+ 'The Genderize.io API Key is undefined.'
+ );
+ }
+
+ if ( true === $this->options->reset_cache ) {
+ $this->cache = [];
+ $this->save_cached_data();
+ }
+ }
+
+ /**
+ * Get gender data for a list of names, based on the locale.
+ *
+ * @param array $names
+ * @param string $locale
+ *
+ * @return array
+ */
+ public function get_gender_data( array $names, $locale ) {
+ // Bail if there are errors.
+ if ( ! empty( $this->error->get_error_messages() ) ) {
+ return [];
+ }
+
+ $data = [];
+ $needs_update = [];
+
+ $names = array_unique( array_map( 'strtolower', $names ) );
+ $lang_code = $this->get_lang_code_from_locale( $locale );
+
+ foreach ( $names as $name ) {
+ $item = $this->get_cache_item( $name, $lang_code );
+
+ if ( false === $item ) {
+ $needs_update[] = $name;
+ continue;
+ }
+
+ $data[ $name ] = $item;
+ }
+
+ if ( ! empty( $needs_update ) ) {
+ $updates = $this->send_chunked_request( $needs_update, $lang_code );
+
+ // Bail if any errors were returned from the API.
+ if ( ! empty( $this->error->get_error_messages() ) ) {
+ return [];
+ }
+
+ foreach ( $updates as $update ) {
+ $updated_name = $this->update_cache_item( $update, $lang_code );
+ $data[ $updated_name ] = $update;
+ }
+
+ $this->save_cached_data();
+ }
+
+ return $data;
+ }
+
+ /**
+ * Get an array of cached gender data.
+ *
+ * @return array
+ */
+ protected function get_cached_data() {
+ if ( is_null( $this->cache ) ) {
+ $this->cache = get_option( self::CACHE_KEY, [] );
+ }
+
+ return $this->cache;
+ }
+
+ /**
+ * Save gender data back to the database.
+ *
+ * @return bool
+ */
+ protected function save_cached_data() {
+ if ( is_null( $this->cache ) ) {
+ return false;
+ }
+
+ return update_option( self::CACHE_KEY, $this->cache, false );
+ }
+
+ /**
+ * Retrieve gender data for a particular name from the instance cache.
+ *
+ * @param string $name
+ * @param string $lang_code
+ *
+ * @return array|bool An array of gender data, or false if it's not in the cache or it's expired.
+ */
+ protected function get_cache_item( $name, $lang_code ) {
+ $cache = $this->get_cached_data();
+ $name = strtolower( $name );
+
+ if ( empty( $cache[ $lang_code ][ $name ] ) ) {
+ return false;
+ }
+
+ $item = $cache[ $lang_code ][ $name ];
+
+ if ( $this->is_cache_item_expired( $item ) ) {
+ return false;
+ }
+
+ return $cache[ $lang_code ][ $name ];
+ }
+
+ /**
+ * Update the gender data for a particular name in the instance cache.
+ *
+ * Note that this does not save the data to the database. Use save_cached_data() for this after making a batch
+ * of updates.
+ *
+ * @param array $data
+ * @param string $lang_code
+ *
+ * @return string The name for which data was updated.
+ */
+ protected function update_cache_item( $data, $lang_code ) {
+ $this->get_cached_data();
+
+ if ( empty( $this->cache[ $lang_code ] ) ) {
+ $this->cache[ $lang_code ] = [];
+ }
+
+ $name = strtolower( $data['name'] );
+ unset( $data['name'] );
+
+ $this->cache[ $lang_code ][ $name ] = $data;
+
+ return $name;
+ }
+
+ /**
+ * Check the timestamp of the gender data for an item to see if it's expired.
+ *
+ * @param array $item
+ *
+ * @return bool True if it is expired.
+ */
+ protected function is_cache_item_expired( $item ) {
+ $lifespan = MONTH_IN_SECONDS * 6;
+ $now = time();
+
+ if ( empty( $item['timestamp'] ) || $now - $item['timestamp'] > $lifespan ) {
+ return true;
+ }
+
+ return false;
+ }
+
+ /**
+ * Query the Genderize API about a list of names.
+ *
+ * Submit requests in batches of 10 names, and collect all of the response data in one array. Normalize
+ * the data and insert a timestamp for each item for returning.
+ *
+ * @param array $names
+ * @param string $lang_code
+ *
+ * @return array
+ */
+ protected function send_chunked_request( array $names, $lang_code ) {
+ $data = [];
+ $chunks = array_chunk( $names, 10 );
+
+ foreach ( $chunks as $chunk ) {
+ $url = add_query_arg( [
+ 'name' => $chunk,
+ 'apikey' => $this->api_key,
+ 'language_id' => $lang_code,
+ ], $this->api_base );
+
+ $response = $this->tenacious_remote_get( $url );
+
+ if ( 200 === wp_remote_retrieve_response_code( $response ) ) {
+ $body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+ if ( is_array( $body ) ) {
+ $data = array_merge( $data, $body );
+ } else {
+ $this->error->add(
+ 'unexpected_response_data',
+ 'The API response did not provide the expected data format.',
+ $response
+ );
+ break;
+ }
+ } else {
+ $this->handle_error_response( $response );
+ break;
+ }
+ }
+
+ $data = array_map( [ $this, 'normalize_data_item_from_api' ], $data );
+
+ return $data;
+ }
+
+ /**
+ * Handle API responses containing errors.
+ *
+ * @param array|WP_Error $response
+ *
+ * @return void
+ */
+ public function handle_error_response( $response ) {
+ if ( parent::handle_error_response( $response ) ) {
+ return;
+ }
+
+ $response_code = wp_remote_retrieve_response_code( $response );
+ $data = json_decode( wp_remote_retrieve_body( $response ), true );
+
+ if ( isset( $data['error'] ) ) {
+ $this->error->add( "error_{$response_code}", $data['error'] );
+ } elseif ( $response_code ) {
+ $this->error->add(
+ 'http_response_code',
+ sprintf( 'HTTP Status: %d', absint( $response_code ) )
+ );
+ } else {
+ $this->error->add( 'unknown_error', 'There was an unknown error.' );
+ }
+ }
+
+ /**
+ * Get the ISO 639-1 language code from a WordPress locale.
+ *
+ * @param string $locale
+ *
+ * @return string
+ */
+ protected function get_lang_code_from_locale( $locale ) {
+ if ( ! is_readable( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
+ $this->error->add(
+ 'locale_data_unavailable',
+ 'Cannot find the locale data from Jetpack.'
+ );
+
+ return 'en';
+ }
+
+ require_once( JETPACK__GLOTPRESS_LOCALES_PATH );
+
+ $glotpress_locale = GP_Locales::by_field( 'wp_locale', $locale ?: 'en_US' );
+
+ return $glotpress_locale->lang_code_iso_639_1;
+ }
+
+ /**
+ * Normalize the gender data provided by the API.
+ *
+ * @param array $item
+ *
+ * @return array
+ */
+ protected function normalize_data_item_from_api( $item ) {
+ $defaults = [
+ 'name' => '',
+ 'gender' => '',
+ 'probability' => floatval( 0 ),
+ 'timestamp' => time(),
+ ];
+
+ // Use shortcode_atts instead of wp_parse_args so that extra item parameters are removed.
+ $item = shortcode_atts( $defaults, $item );
+
+ $item['probability'] = floatval( $item['probability'] );
+
+ return $item;
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>