Merge branch 'develop'

Chris Park · Chris Park · commit 6fa52315a212 · 2017-06-14T12:36:56.000Z
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
   "name": "rosette/api",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "Rosette API PHP client SDK",
   "license": "Apache",
   "keywords": [
diff --git a/examples/README.md b/examples/README.md
@@ -3,36 +3,41 @@ PHP Examples
 
 These examples are scripts that can be run independently to demonstrate the Rosette API functionality.
 
-You can now run your desired _endpoint_.php file to see it in action.  Before running the examples 
+You can now run your desired _endpoint_.php file to see it in action.  Before running the examples
 for the first time:
-1. cd examples
-2. composer update
+
+1. ```cd examples```
+2. ```composer update```
+3. The examples are dual purpose in that they're used to test both source and packagist. In order to meet that requirement, the examples expect the vendor directory to be at the same level as examples/.
+```cp -r ./vendor/. ../vendor``` or you can edit the example to reference the vendor directory that is in the examples directory.
 
 For example, run `php categories.php` if you want to see the categories functionality demonstrated.
 
 All files require you to input your Rosette API User Key after `--key` to run.
-For example: `php ping.php --key 1234567890`  
-All also allow you to input your own service URL if applicable.  
+For example: `php ping.php --key 1234567890`
+All also allow you to input your own service URL if applicable.
 For example: `php ping.php --key 1234567890 --url http://www.myurl.com`
 
 
 Each example, when run, prints its output to the console.
 
-| File Name                     | What it does                                          | 
-| -------------                 |-------------                                        | 
-| categories.php                    | Gets the category of a document at a URL              | 
-| entities.php                      | Gets the entities from a piece of text                | 
-| info.php                          | Gets information about Rosette API                    | 
-| language.php                      | Gets the language of a piece of text                  | 
-| matched-name.php                  | Gets the similarity score of two names                | 
-| morphology_complete.php               | Gets the complete morphological analysis of a piece of text| 
-| morphology_compound-components.php    | Gets the de-compounded words from a piece of text     | 
-| morphology_han-readings.php           | Gets the Chinese words from a piece of text           | 
-| morphology_lemmas.php                 | Gets the lemmas of words from a piece of text         | 
-| morphology_parts-of-speech.php        | Gets the part-of-speech tags for words in a piece of text | 
-| ping.php                          | Pings the Rosette API to check for reachability       | 
+| File Name                     | What it does                                          |
+| -------------                 |-------------                                        |
+| categories.php                    | Gets the category of a document at a URL              |
+| entities.php                      | Gets the entities from a piece of text                |
+| info.php                          | Gets information about Rosette API                    |
+| language.php                      | Gets the language of a piece of text                  |
+| morphology_complete.php               | Gets the complete morphological analysis of a piece of text|
+| morphology_compound-components.php    | Gets the de-compounded words from a piece of text     |
+| morphology_han-readings.php           | Gets the Chinese words from a piece of text           |
+| morphology_lemmas.php                 | Gets the lemmas of words from a piece of text         |
+| morphology_parts-of-speech.php        | Gets the part-of-speech tags for words in a piece of text |
+| name_deduplication.php               | Fuzzy deduplication of a list of names  |
+| name_translation.php               | Translates a name from one language to another        |
+| name_similarity.php                  | Gets the similarity score of two names                |
+| ping.php                          | Pings the Rosette API to check for reachability       |
 | sentences.php                     | Gets the sentences from a piece of text               |
-| sentiment.php                     | Gets the sentiment of a local file                    | 
-| tokens.php                        | Gets the tokens (words) from a piece of text          | 
-| translated-name.php               | Translates a name from one language to another        |
+| sentiment.php                     | Gets the sentiment of a local file                    |
+| tokens.php                        | Gets the tokens (words) from a piece of text          |
+| transliteration.php               | Transliterates content |
 
diff --git a/examples/composer.json b/examples/composer.json
@@ -1,5 +1,6 @@
 {
     "require": {
+        "rmccue/requests": ">1.0",
         "rosette/api": ">=1.0"
     }
 }
diff --git a/examples/docker/Dockerfile b/examples/docker/Dockerfile
@@ -1,19 +1,39 @@
-FROM php:5.5-cli
+FROM phusion/baseimage
 MAINTAINER Fiona Hasanaj
+ENV TZ=America/New_York
+ENV LANGUAGE=php
 
 # install necessary software
-RUN apt-get -y update && apt-get install -y vim  && apt-get install -y git
+
+RUN apt-get -y update && apt-get install -y \
+    git \
+    language-pack-en-base \
+    libxslt1-dev \
+    python-software-properties \
+    vim \
+    wget
+
+RUN LC_ALL=en_US.UTF-8 add-apt-repository ppa:ondrej/php
+RUN apt-get -y update && apt-get install -y \
+    php-dev \
+    php-cli \
+    php-curl \
+    libapache2-mod-php
+
+
+RUN echo "memory_limit=-1" >> /etc/php/7.1/cli/php.ini && \
+    echo "date.timezone=America/New_York" >> /etc/php/7.1/cli/php.ini
+
+RUN wget -O /usr/local/bin/composer https://getcomposer.org/composer.phar && \
+    chmod +x /usr/local/bin/composer && composer self-update
 
 # install mbstring
-RUN docker-php-ext-install mbstring
+# RUN docker-php-ext-install mbstring
 
 COPY run_php.sh /php/examples/run_php.sh
 RUN chmod 755 /php/examples/run_php.sh
 WORKDIR /php/examples
 
-# install composer.phar
-RUN curl -sS https://getcomposer.org/installer | php && mv composer.phar /usr/local/bin/composer && composer require "rosette/api: ~1.0.0"
-
 # allow interactive bash inside docker container
 CMD ./run_php.sh $API_KEY $ALT_URL
 
diff --git a/examples/docker/README.md b/examples/docker/README.md
@@ -5,7 +5,7 @@
 To simplify the running of the PHP examples, the Dockerfile will build an image and install the latest rosette-api library.
 
 ### Basic Usage
-Build the docker image, e.g. `docker build -t basistech/php:1.1 .`
+Build the docker image, e.g. `docker build -t basistech/php .`
 
 Run an example as `docker run -e API_KEY=api-key -v "path-to-example-source:/source" basistech/php:1.1`
 
diff --git a/examples/docker/run_php.sh b/examples/docker/run_php.sh
@@ -89,6 +89,8 @@ validateURL
 
 #Copy the examples from the mounted content in /source to current WORKDIR
 cp /source/examples/*.* .
+composer install 
+cp -r ./vendor/. ../vendor
 
 #Run the examples
 if [ ! -z ${API_KEY} ]; then
diff --git a/examples/name_deduplication.php b/examples/name_deduplication.php
@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * Example code to call Rosette API to deduplicate a list of names.
+ **/
+require_once dirname(__FILE__) . '/../vendor/autoload.php';
+use rosette\api\Api;
+use rosette\api\Name;
+use rosette\api\NameDeduplicationParameters;
+use rosette\api\RosetteException;
+
+$options = getopt(null, array('key:', 'url::'));
+if (!isset($options['key'])) {
+    echo 'Usage: php ' . __FILE__ . " --key <api_key> --url=<alternate_url>\n";
+    exit();
+}
+$name_dedupe_data = "John Smith,Johnathon Smith,Fred Jones";
+
+$dedup_array = array();
+$threshold = 0.75;
+foreach (explode(',', $name_dedupe_data) as $name) {
+    array_push($dedup_array, new Name($name));
+}
+$api = isset($options['url']) ? new Api($options['key'], $options['url']) : new Api($options['key']);
+$params = new NameDeduplicationParameters($dedup_array, $threshold);
+
+try {
+    $result = $api->nameDeduplication($params);
+    var_dump($result);
+} catch (RosetteException $e) {
+    error_log($e);
+}
diff --git a/examples/syntax_dependencies.php b/examples/syntax_dependencies.php
@@ -18,7 +18,6 @@
 $params = new DocumentParameters();
 $content = $syntax_dependencies_data;
 $params->set('content', $content);
-$params->set('genre', 'social-media');
 
 try {
     $result = $api->syntaxDependencies($params, false);
diff --git a/examples/transliteration.php b/examples/transliteration.php
@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * Example code to call Rosette API to transliterate content.
+ **/
+require_once dirname(__FILE__) . '/../vendor/autoload.php';
+use rosette\api\Api;
+use rosette\api\DocumentParameters;
+use rosette\api\RosetteException;
+
+$options = getopt(null, array('key:', 'url::'));
+if (!isset($options['key'])) {
+    echo 'Usage: php ' . __FILE__ . " --key <api_key> --url=<alternate_url>\n";
+    exit();
+}
+$transliteration_data = "معمر محمد أبو منيار القذاف";
+$api = isset($options['url']) ? new Api($options['key'], $options['url']) : new Api($options['key']);
+$params = new DocumentParameters();
+$params->set('content', $transliteration_data);
+
+try {
+    $result = $api->transliteration($params);
+    var_dump($result);
+} catch (RosetteException $e) {
+    error_log($e);
+}
diff --git a/source/rosette/api/Api.php b/source/rosette/api/Api.php
@@ -38,7 +38,7 @@ class Api
      *
      * @var string
      */
-    private static $binding_version = '1.5.0';
+    private static $binding_version = '1.7.0';
 
     /**
      * User key (required for Rosette API).
@@ -126,7 +126,7 @@ public function __construct($user_key, $service_url = 'https://api.rosette.com/r
         $this->url_params = array();
         $this->customHeaders = array();
     }
-    
+
     /**
      * Sets on override Request for mocking purposes
      *
@@ -365,7 +365,7 @@ public function getResponseHeader()
     {
         return $this->request->getResponseHeader();
     }
-     
+
     /** Internal operations processor for most of the endpoints.
      *
      * @param $parameters
@@ -650,6 +650,20 @@ public function nameSimilarity($nameSimilarityParams)
         return $this->callEndpoint($nameSimilarityParams, 'name-similarity');
     }
 
+    /**
+     * Calls the name deduplication endpoint.
+     *
+     * @param $nameDeduplicationParams
+     *
+     * @return mixed
+     *
+     * @throws RosetteException
+     */
+    public function nameDeduplication($nameDeduplicationParams)
+    {
+        return $this->callEndpoint($nameDeduplicationParams, 'name-deduplication');
+    }
+
     /**
      * Calls the relationships endpoint.
      *
@@ -691,4 +705,18 @@ public function syntaxDependencies($params)
     {
         return $this->callEndpoint($params, 'syntax/dependencies');
     }
+
+    /**
+    * Calls the transliteration endpoint
+    *
+    * @param $params
+    *
+    * @return mixed
+    *
+    * @throws RosetteException
+    */
+    public function transliteration($params)
+    {
+        return $this->callEndpoint($params, 'transliteration');
+    }
 }
diff --git a/source/rosette/api/NameDeduplicationParameters.php b/source/rosette/api/NameDeduplicationParameters.php
@@ -0,0 +1,65 @@
+<?php
+
+/**
+ * class NameDeduplicationParameters.
+ *
+ * Parameters that are necessary for name deduplication operations.
+ *
+ * @copyright 2017-2018 Basis Technology Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and limitations under the License.
+ **/
+namespace rosette\api;
+
+/**
+ * Class NameDeduplicationParameters.
+ */
+class NameDeduplicationParameters extends RosetteParamsSetBase
+{
+    /**
+     * @var array list of Name objects
+     */
+    public $names;
+    /**
+     * @var float threshold 0 - 1 range for cluster size. Can be null to use default.
+     */
+    public $threshold;
+    /**
+     * constructor.
+     *
+     * @param array - list of Name objects
+     * @param float - threshold value used for cluster sizing
+     */
+    public function __construct($names, $threshold = null)
+    {
+        $this->names = $names;
+        $this->threshold = $threshold;
+    }
+
+    /**
+     * Validates parameters.
+     *
+     * @throws RosetteException
+     */
+    public function validate()
+    {
+        if (empty($this->names)) {
+            throw new RosetteException(
+                sprintf('Required name deduplication parameter not supplied: names'),
+                RosetteException::$BAD_REQUEST_FORMAT
+            );
+        }
+        if ($this->threshold != null && ($this->threshold <= 0 || $this->threshold >= 1.0)) {
+            throw new RosetteException(
+                sprintf("Threshold must be in the range of 0 to 1.0"),
+                RosetteException::$BAD_REQUEST_FORMAT
+            );
+        }
+    }
+}
diff --git a/spec/rosette/api/ApiSpec.php b/spec/rosette/api/ApiSpec.php
@@ -167,7 +167,7 @@ public function it_calls_the_sentiment_endpoint($params, $request)
         $this->setMockRequest($request);
         $this->sentiment($params)->shouldHaveKeyWithValue('name', 'Rosette API');
     }
-    
+
     public function it_calls_using_multipart($params, $request)
     {
         $params->beADoubleOf('\rosette\api\DocumentParameters');
@@ -199,6 +199,16 @@ public function it_calls_the_name_similarity_endpoint($params, $request)
         $this->setMockRequest($request);
         $this->nameSimilarity($params)->shouldHaveKeyWithValue('name', 'Rosette API');
     }
+    public function it_calls_the_name_deduplication_endpoint($params, $request)
+    {
+        $params->beADoubleOf('\rosette\api\NameDeduplicationParameters');
+        $request->beADoubleOf('rosette\api\RosetteRequest');
+        $request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
+        $request->getResponseCode()->willReturn(200);
+        $request->getResponse()->willReturn([ 'name' => 'Rosette API']);
+        $this->setMockRequest($request);
+        $this->nameDeduplication($params)->shouldHaveKeyWithValue('name', 'Rosette API');
+    }
     public function it_calls_the_relationships_endpoint($params, $request)
     {
         $params->beADoubleOf('\rosette\api\DocumentParameters');
@@ -232,6 +242,16 @@ public function it_calls_the_syntax_dependencies_endpoint($params, $request)
         $this->setMockRequest($request);
         $this->syntaxDependencies($params)->shouldHaveKeyWithValue('name', 'Rosette API');
     }
+    public function it_calls_the_transliteration_endpoint($params, $request)
+    {
+        $params->beADoubleOf('\rosette\api\DocumentParameters');
+        $request->beADoubleOf('rosette\api\RosetteRequest');
+        $request->makeRequest(Argument::any(), Argument::any(), Argument::any(), Argument::any(), Argument::any())->willReturn(true);
+        $request->getResponseCode()->willReturn(200);
+        $request->getResponse()->willReturn([ 'name' => 'Rosette API']);
+        $this->setMockRequest($request);
+        $this->transliteration($params)->shouldHaveKeyWithValue('name', 'Rosette API');
+    }
     public function it_fails_with_non_200_response($params, $request)
     {
         $params->beADoubleOf('\rosette\api\DocumentParameters');
diff --git a/spec/rosette/api/NameDeduplicationParametersSpec.php b/spec/rosette/api/NameDeduplicationParametersSpec.php

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "rosette/api",`
`3`		`- "version": "1.5.0",`
	`3`	`+ "version": "1.7.0",`
`4`	`4`	`"description": "Rosette API PHP client SDK",`
`5`	`5`	`"license": "Apache",`
`6`	`6`	`"keywords": [`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"require": {`
	`3`	`+ "rmccue/requests": ">1.0",`
`3`	`4`	`"rosette/api": ">=1.0"`
`4`	`5`	`}`
`5`	`6`	`}`