aylien_text_api 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 09993e8546c5922ae46dd06032296cecf47f37b7
-  data.tar.gz: 898af691bf87d6db20eb28fd0dfea314b63de681
+SHA256:
+  metadata.gz: 4a3b0fc823371783b3b294300d906988df2fec190a09e919d4bc9d399f07a8e6
+  data.tar.gz: 50ffab1f2e1f025131e34fc5d5606acdc5924dea77f7e8fae7754420985d4e00
 SHA512:
-  metadata.gz: f4621c72ee93f2170b6f3852b6db64ac31c8ec5a05319774d97847e3bee607d275b7b1d4d67a5cc55c30702093596e5ebc038111a8b6fcc86226a7c38fc37455
-  data.tar.gz: a0be785b22f55687fb1e33c15ee639dd5abf02e2948e66fa5bfc1a5d5297be3269f9e584abbb69c569cc76cd17ac548c8953a50513ecd7adb0595bd79e59a463
+  metadata.gz: 39bbd804b19d4441e4b417e1f72d532b8c0c60b72651a947cd805948ddbb29f07aa04c5f15e324638bb21d3f557ac3047b1934441ee72e0e5a0592d1d9188779
+  data.tar.gz: efd1038da6269bc13909969409c933d66ca9fedad7248bfe635ace65b6c49a55148d57cbbe01ee440a4756ab83a0617d2d97064917b73e0fe14625370225505e

data/.gitignore

@@ -2,4 +2,7 @@ config/app_config.yml
 doc/
 .yardoc/
 *.gem
+.idea
+*.iml
+.bundle
 Gemfile.lock

data/README.md

@@ -1,18 +1,18 @@
-About
+AYLIEN Text API (Ruby)
 =====
 [![Gem Version](https://badge.fury.io/rb/aylien_text_api.svg)](http://badge.fury.io/rb/aylien_text_api)
 
 This is the Ruby client library for AYLIEN's APIs. If you haven't already done so, you will need to [sign up](https://developer.aylien.com/signup).
 
 
-Installation
-============
+## Installation
+
     gem install aylien_text_api
 
 See the [Developers Guide](http://docs.aylien.com/docs/ruby-sdk) for additional documentation.
 
-Configuration
-=============
+## Configuration
+
 Aylien Text API needs app_id and app_key which you can get it from [Text API website](https://developer.aylien.com/signup).
 
 You can pass configuration options as a block to AylienTextApi.configure.
@@ -35,8 +35,8 @@ require 'aylien_text_api'
 client = AylienTextApi::Client.new(app_id: "YOUR APP ID", app_key: "YOUR APP KEY")
 ````
 
-Examples
-=====
+## Examples
+
 After configuring a client, you can do the following things:
 
 ````ruby
@@ -50,7 +50,7 @@ client.extract url: "http://techcrunch.com/2014/02/27/aylien-launches-text-analy
 #  }
 ````
 
-If any errors happen during the call, nil will be returned. If destructive methods are used, an exception corresponding to the error will be returned.
+If any errors happen during the call, `nil` will be returned. If destructive methods are used, an exception corresponding to the error will be returned.
 
 ````ruby
 client.classify! url: "http://www.bbc.com/sport/0/football/25912393"
@@ -60,11 +60,13 @@ client.classify! url: "http://www.bbc.com/sport/0/football/25912393"
 # }
 ````
 
-Third Party Libraries and Dependencies
-======================================
+## Third Party Libraries and Dependencies
+
 For development you will also need the following libraries:
 
 * rake
 * minitest
 * vcr
 * webmock
+
+To install the dependencies, make sure you have `bundle` installed, then run `bundle install --path=vendor/bundle`. Then, run `bundle exec rake test` to run tests.

data/aylien_text_api.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.name        = "aylien_text_api"
   s.version     = AylienTextApi::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Aylien Inc.", "Hamed Ramezanian"]
+  s.authors     = ["Aylien Inc."]
   s.license     = 'Apache-2.0'
-  s.email       = ["support@aylien.com", "hamed.r.nik@gmail.com"]
+  s.email       = ["support@aylien.com"]
   s.homepage    = "https://github.com/AYLIEN/aylien_textapi_ruby"
   s.summary     = %q{AYLIEN Text Analysis API is a package of Natural Language Processing and Machine Learning-powered tools for analyzing and extracting various kinds of information from text and images.}
   s.description = %q{AYLIEN Text Analysis API is a package of Natural Language Processing and Machine Learning-powered tools for analyzing and extracting various kinds of information from text and images.}
@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake', '~> 10.4'
   s.add_development_dependency 'minitest', '~> 5.4'
   s.add_development_dependency 'vcr', '~> 2.9'
-  s.add_development_dependency 'webmock', '~> 1.20'
+  s.add_development_dependency 'webmock', '~> 2.3.2'
 end

data/lib/aylien_text_api/client.rb

@@ -222,6 +222,35 @@ module AylienTextApi
       @connection = Connection.new(endpoint, params, config)
       @connection.request!
     end
+
+    # Extracts named entities (people, organizations and locations) and
+    # applies a sentiment analysis to them
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The entities endpoint options
+    # @option params [String] :url The URL
+    # @option params [String] :text Text
+    #
+    # @return [Hash, nil] A hash of result. See
+    #   http://docs.aylien.com/docs/elsa for more information
+    #   on the data returned.
+    #
+    def elsa(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:elsa])
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
+    end
+    
+    # Same as elsa, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def elsa!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:elsa])
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
+    end
     
     # Detects the main language a document is written in and returns it
     # in ISO 639-1 format.
@@ -323,97 +352,7 @@ module AylienTextApi
       @connection = Connection.new(endpoint, params, config)
       @connection.request!
     end
-    
-    # Returns phrases related to the provided unigram, or bigram.
-    #
-    # @param [String] value (nil) URL or Text
-    # @param [Hash] params The related endpoint options
-    # @option params [String] :phrase Phrase
-    # @option params [Integer] :count (20) Number of phrases to return.
-    #   Max is 100.
-    #
-    # @return [Hash, nil] A hash of result. See
-    #   http://docs.aylien.com/docs/related for more information
-    #   on the data returned.
-    #
-    def related(value=nil, params={})
-      endpoint, params, config = common_endpoint(value, params, 
-        Configuration::ENDPOINTS[:related])
-      @connection = Connection.new(endpoint, params, config)
-      @connection.request
-    end
-    
-    # Same as related, but calls request! so an exception is raised 
-    # if the request fails.
-    #
-    def related!(value=nil, params={})
-      endpoint, params, config = common_endpoint(value, params, 
-        Configuration::ENDPOINTS[:related])
-      @connection = Connection.new(endpoint, params, config)
-      @connection.request!
-    end
-    
-    # Return Microformats.
-    #
-    # @param [String] value (nil) URL
-    # @param [Hash] params The microformats endpoint options
-    # @option params [String] :url The URL
-    # @option params [String] :language ('en') Language of text.
-    #   Valid options are en, de, fr, es, it, pt, and auto.
-    #   If set to auto, it'll try to detect the language.
-    #
-    # @return [Hash, nil] A hash of result. See
-    #   http://docs.aylien.com/docs/microformats for more information
-    #   on the data returned.
-    #
-    def microformats(value=nil, params={})
-      endpoint, params, config = common_endpoint(value, params, 
-        Configuration::ENDPOINTS[:microformats])
-      @connection = Connection.new(endpoint, params, config)
-      @connection.request
-    end
-    
-    # Same as microformats, but calls request! so an exception is raised 
-    # if the request fails.
-    #
-    def microformats!(value=nil, params={})
-      endpoint, params, config = common_endpoint(value, params, 
-        Configuration::ENDPOINTS[:microformats])
-      @connection = Connection.new(endpoint, params, config)
-      @connection.request!
-    end
-    
-    # Return Unsupervised Classify.
-    #
-    # @param [String] value (nil) URL or Text
-    # @param [Hash] params The Unsupervised Classify endpoint options
-    # @option params [String] :url The URL
-    # @option params [String] :text Text
-    # @option params [Array<String>] :class Array of classes
-    # @option params [Integer] :number_of_concepts Number of intermediary 
-    #   common topics to consider when calculating semantic similarity
-    #
-    # @return [Hash, nil] A hash of result. See
-    #   http://docs.aylien.com/docs/classify-unsupervised for more information
-    #   on the data returned.
-    #
-    def unsupervised_classify(value=nil, params={})
-      endpoint, params, config = common_endpoint(value, params, 
-        Configuration::ENDPOINTS[:unsupervised_classify])
-      @connection = Connection.new(endpoint, params, config)
-      @connection.request
-    end
-    
-    # Same as unsupervised_classify, but calls request! so an exception is raised 
-    # if the request fails.
-    #
-    def unsupervised_classify!(value=nil, params={})
-      endpoint, params, config = common_endpoint(value, params, 
-        Configuration::ENDPOINTS[:unsupervised_classify])
-      @connection = Connection.new(endpoint, params, config)
-      @connection.request!
-    end
-    
+ 
     # Runs multiple analysis operations in one API call.
     #
     # @param [String] value (nil) URL or Text
@@ -528,8 +467,6 @@ module AylienTextApi
         value.strip!
         if validate_uri(value)
           params[:url] = value
-        elsif endpoint == Configuration::ENDPOINTS[:related]
-          params[:phrase] = value
         else
           params[:text] = value
         end

data/lib/aylien_text_api/configuration.rb

@@ -33,14 +33,12 @@ module AylienTextApi
       entities: 'entities',
       hashtags: 'hashtags',
       language: 'language',
-      related: 'related',
       sentiment: 'sentiment',
       summarize: 'summarize',
-      microformats: 'microformats',
-      unsupervised_classify: 'classify/unsupervised',
       image_tags: 'image-tags',
       combined: 'combined',
-      absa: 'absa/:domain'
+      absa: 'absa/:domain',
+      elsa: 'elsa'
     }
 
     # Build accessor methods for every config options so we can do this, for example:

data/lib/aylien_text_api/version.rb

@@ -13,5 +13,5 @@
 # limitations under the License.
 
 module AylienTextApi
-  VERSION = "0.7.0" unless defined? AylienTextApi::VERSION
+  VERSION = "0.8.0" unless defined? AylienTextApi::VERSION
 end

data/spec/fixtures/aylien_text_api/client/{microformats_with_invalid_client.yml → elsa_with_invalid_client.yml}

@@ -2,17 +2,17 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.aylien.com/api/v1/microformats
+    uri: https://api.aylien.com/api/v1/elsa
     body:
       encoding: US-ASCII
-      string: url=http%3A%2F%2Fcodepen.io%2Fanon%2Fpen%2FZYaKbz.html
+      string: text=Barack+Hussein+Obama+II+is+the+44th+and+current%0A++++++President+of+the+United+States%2C+and+the+first%0A++++++African+American+to+hold+the+office.
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.6.0
+      - Aylien Text API Ruby Gem 0.7.0
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -21,18 +21,20 @@ http_interactions:
       message: Forbidden
     headers:
       Server:
-      - openresty/1.9.3.2
+      - openresty/1.13.6.1
       Date:
-      - Thu, 28 Apr 2016 10:36:05 GMT
+      - Thu, 31 May 2018 11:03:08 GMT
       Content-Type:
       - text/plain; charset=us-ascii
       Transfer-Encoding:
       - chunked
-      Connection:
-      - keep-alive
+      Via:
+      - 1.1 google
+      Alt-Svc:
+      - clear
     body:
       encoding: UTF-8
       string: Authentication parameters missing
     http_version: 
-  recorded_at: Thu, 28 Apr 2016 10:36:05 GMT
+  recorded_at: Thu, 31 May 2018 11:03:09 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/aylien_text_api/client/{related_with_invalid_params.yml → elsa_with_invalid_params.yml}

@@ -2,17 +2,17 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.aylien.com/api/v1/related
+    uri: https://api.aylien.com/api/v1/elsa
     body:
       encoding: US-ASCII
-      string: wrong_param=android
+      string: wrong_param=Barack+Hussein+Obama+II+is+the+44th+and+current%0A++++++President+of+the+United+States%2C+and+the+first%0A++++++African+American+to+hold+the+office.
     headers:
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.6.0
+      - Aylien Text API Ruby Gem 0.7.0
       Content-Type:
       - application/x-www-form-urlencoded
       X-Aylien-Textapi-Application-Id:
@@ -22,41 +22,32 @@ http_interactions:
   response:
     status:
       code: 400
-      message: Bad Request
+      message: ''
     headers:
       Server:
-      - openresty/1.9.3.2
+      - openresty/1.13.6.1
       Date:
-      - Thu, 28 Apr 2016 10:44:40 GMT
+      - Thu, 31 May 2018 11:03:10 GMT
       Content-Type:
       - application/json;charset=UTF-8
       Content-Length:
-      - '360'
-      Connection:
-      - keep-alive
-      X-Ratelimit-Limit:
-      - '207000'
-      X-Ratelimit-Remaining:
-      - '173639'
-      X-Ratelimit-Reset:
-      - '1461888000'
+      - '219'
+      Via:
+      - 1.1 google
+      Alt-Svc:
+      - clear
     body:
       encoding: UTF-8
       string: |-
         {
-          "error": "requirement failed: Form field 'phrase' Required",
+          "error": "requirement failed: either text or url is required",
           "errors": [{
             "reason": "required",
-            "message": "Form field 'phrase' Required",
+            "message": "either text or url is required",
             "locationType": "parameter",
-            "location": "phrase"
-          }, {
-            "reason": "required",
-            "message": "Query parameter 'phrase' Required",
-            "locationType": "parameter",
-            "location": "phrase"
+            "location": "text"
           }]
         }
     http_version: 
-  recorded_at: Thu, 28 Apr 2016 10:44:40 GMT
+  recorded_at: Thu, 31 May 2018 11:03:10 GMT
 recorded_with: VCR 2.9.3

data/spec/fixtures/aylien_text_api/client/elsa_with_text.yml

@@ -0,0 +1,98 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/elsa
+    body:
+      encoding: US-ASCII
+      string: text=Barack+Hussein+Obama+II+is+the+44th+and+current%0A++++++President+of+the+United+States%2C+and+the+first%0A++++++African+American+to+hold+the+office.
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.7.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      X-Aylien-Textapi-Application-Id:
+      - "<PASSWORD>"
+      X-Aylien-Textapi-Application-Key:
+      - "<PASSWORD>"
+  response:
+    status:
+      code: 200
+      message: ''
+    headers:
+      Server:
+      - openresty/1.13.6.1
+      Date:
+      - Thu, 31 May 2018 11:03:11 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '1364'
+      X-Ratelimit-Limit:
+      - '400000'
+      X-Ratelimit-Remaining:
+      - '399991'
+      X-Ratelimit-Reset:
+      - '1527811200'
+      Access-Control-Allow-Origin:
+      - "*"
+      Via:
+      - 1.1 google
+      Alt-Svc:
+      - clear
+    body:
+      encoding: UTF-8
+      string: |-
+        {
+          "text": "Barack Hussein Obama II is the 44th and current\n      President of the United States, and the first\n      African American to hold the office.",
+          "entities": [{
+            "mentions": [{
+              "offset": 71,
+              "confidence": 1.0,
+              "text": "United States",
+              "sentiment": {
+                "polarity": "neutral",
+                "confidence": 0.48
+              }
+            }],
+            "overall_sentiment": {
+              "polarity": "neutral",
+              "confidence": 0.48
+            },
+            "type": "Location",
+            "links": [{
+              "uri": "http://dbpedia.org/resource/United_States",
+              "provider": "dbpedia",
+              "types": ["http://dbpedia.org/ontology/Country"],
+              "confidence": 28.15
+            }]
+          }, {
+            "mentions": [{
+              "offset": 0,
+              "confidence": 1.0,
+              "text": "Barack Hussein Obama II",
+              "sentiment": {
+                "polarity": "positive",
+                "confidence": 0.56
+              }
+            }],
+            "overall_sentiment": {
+              "polarity": "positive",
+              "confidence": 0.56
+            },
+            "type": "Person",
+            "links": [{
+              "uri": "http://dbpedia.org/resource/Barack_Obama",
+              "provider": "dbpedia",
+              "types": ["http://dbpedia.org/ontology/Person", "http://xmlns.com/foaf/0.1/Person", "http://dbpedia.org/ontology/Agent", "http://www.wikidata.org/entity/Q215627", "http://www.wikidata.org/entity/Q5", "http://schema.org/Person"],
+              "confidence": 0.91
+            }]
+          }]
+        }
+    http_version: 
+  recorded_at: Thu, 31 May 2018 11:03:11 GMT
+recorded_with: VCR 2.9.3