aylien_text_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20ee124fe1cac32cfeb459fd4776bc76ac628e7b
-  data.tar.gz: d4b8551a7720dd1c18421f763c86234dcc23b83a
+  metadata.gz: fe9d4f356602fc1b9f1d70d21c187c775ef0d50b
+  data.tar.gz: ea0e0d0ab966b97b8a62a582d18d926f574bf106
 SHA512:
-  metadata.gz: db49a0f853a629237977c787c17b7adf1271ae0ab1dd613890793b9e269ae95a5abd7880a8c20fcdfdb0af2bd80ec829a57f39d72ea1a25b35f6f6af78274419
-  data.tar.gz: 09d540b49a58d8e3927090c63d508d360550456800919f991d32bf1025c772d4e5f22a01405c6650913cd48335920d233f59b410de0e2590ea8c58f777d02b8f
+  metadata.gz: 4f711cf5448383799904b579971ab911109e90099d70ff5927e25f2a000cf298dcd790a7604823fae1b1dfb4ebc674074d1ae9b2680eedf0661acb7d92763988
+  data.tar.gz: 4fb437af83e64299b2129b007524056442680b923c027839f1b187e59709c13e9a7dce0244ad1a9c43c8b6b5938e52d4d036ef558d7936e3c179ca5832cd6092

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aylien_text_api (0.2.0)
+    aylien_text_api (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -26,3 +26,6 @@ DEPENDENCIES
   rake (~> 10.4)
   vcr (~> 2.9)
   webmock (~> 1.20)
+
+BUNDLED WITH
+   1.10.5

data/README.md

@@ -9,7 +9,7 @@ Installation
 ============
     gem install aylien_text_api
 
-See the [Developers Guide](https://developer.aylien.com/docs) for additional documentation.
+See the [Developers Guide](http://docs.aylien.com/docs/ruby-sdk) for additional documentation.
 
 Configuration
 =============

data/aylien_text_api.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.license     = 'Apache License, Version 2.0'
   s.email       = ["hello@aylien.com", "hamed.r.nik@gmail.com"]
   s.homepage    = "https://github.com/AYLIEN/aylien_textapi_ruby"
-  s.summary     = %q{Aylien Text API is a package of nine different Natural Language Processing, Information Retrieval and Machine Learning APIs that can be quickly and easily adapted to your processes and applications.}
-  s.description = %q{Aylien Text API is a package of nine different Natural Language Processing, Information Retrieval and Machine Learning APIs that can be quickly and easily adapted to your processes and applications.}
+  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.}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/aylien_text_api/client.rb

@@ -51,7 +51,7 @@ module AylienTextApi
     #   Whether extract the best image of the article
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#extract for more information
+    #   http://docs.aylien.com/docs/extract for more information
     #   on the data returned.
     #
     def extract(value=nil, params={})
@@ -71,7 +71,7 @@ module AylienTextApi
     #   If set to auto, it'll try to detect the language.
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#classify for more information
+    #   http://docs.aylien.com/docs/classify for more information
     #   on the data returned.
     #
     def classify(value=nil, params={})
@@ -93,7 +93,7 @@ module AylienTextApi
     #   If set to auto, it'll try to detect the language.
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#concepts for more information
+    #   http://docs.aylien.com/docs/concepts for more information
     #   on the data returned.
     #
     def concepts(value=nil, params={})
@@ -113,7 +113,7 @@ module AylienTextApi
     #   If set to auto, it'll try to detect the language.
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#hashtags for more information
+    #   http://docs.aylien.com/docs/hashtags for more information
     #   on the data returned.
     #
     def hashtags(value=nil, params={})
@@ -130,9 +130,12 @@ module AylienTextApi
     # @param [Hash] params The entities endpoint options
     # @option params [String] :url The URL
     # @option params [String] :text Text
+    # @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://aylien.com/text-api-doc#entities for more information
+    #   http://docs.aylien.com/docs/entities for more information
     #   on the data returned.
     #
     def entities(value=nil, params={})
@@ -150,7 +153,7 @@ module AylienTextApi
     # @option params [String] :text Text
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#language for more information
+    #   http://docs.aylien.com/docs/language for more information
     #   on the data returned.
     #
     def language(value=nil, params={})
@@ -171,7 +174,7 @@ module AylienTextApi
     #   Valid options are tweet, and document.
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#sentiment for more information
+    #   http://docs.aylien.com/docs/sentiment for more information
     #   on the data returned.
     #
     def sentiment(value=nil, params={})
@@ -196,9 +199,12 @@ module AylienTextApi
     # @option params [Integer] :sentences_percentage Percentage of sentences
     #   to be returned. Only in default mode (not applicable to short mode).
     #   Possible range is 1-100.
+    # @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://aylien.com/text-api-doc#summarize for more information
+    #   http://docs.aylien.com/docs/summarize for more information
     #   on the data returned.
     #
     def summarize(value=nil, params={})
@@ -216,7 +222,7 @@ module AylienTextApi
     #   Max is 100.
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#related for more information
+    #   http://docs.aylien.com/docs/related for more information
     #   on the data returned.
     #
     def related(value=nil, params={})
@@ -230,9 +236,12 @@ module AylienTextApi
     # @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://aylien.com/text-api-doc#microformats for more information
+    #   http://docs.aylien.com/docs/microformats for more information
     #   on the data returned.
     #
     def microformats(value=nil, params={})
@@ -248,9 +257,11 @@ module AylienTextApi
     # @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://aylien.com/text-api-doc#unsupervised_classify for more information
+    #   http://docs.aylien.com/docs/classify-unsupervised for more information
     #   on the data returned.
     #
     def unsupervised_classify(value=nil, params={})
@@ -259,13 +270,31 @@ module AylienTextApi
       Connection.new(endpoint, params, config).request
     end
     
+    # Runs multiple analysis operations in one API call.
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The Combined endpoint options
+    # @option params [String] :url The URL
+    # @option params [String] :text Text
+    # @option params [Array<String>] :endpoint Array of endpoints
+    #
+    # @return [Hash, nil] A hash of result. See
+    #   http://docs.aylien.com/docs/combined for more information
+    #   on the data returned.
+    #
+    def combined(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:combined])
+      Connection.new(endpoint, params, config).request
+    end
+    
     # Assigns relevant tags to an image.
     #
     # @param [String] value (nil) URL
     # @option params [String] :url The URL
     #
     # @return [Hash, nil] A hash of result. See
-    #   http://aylien.com/text-api-doc#image_tags for more information
+    #   http://docs.aylien.com/docs/image-tags for more information
     #   on the data returned.
     #
     def image_tags(value=nil, params={})

data/lib/aylien_text_api/configuration.rb

@@ -37,7 +37,8 @@ module AylienTextApi
       summarize: 'summarize',
       microformats: 'microformats',
       unsupervised_classify: 'classify/unsupervised',
-      image_tags: 'image-tags'
+      image_tags: 'image-tags',
+      combined: 'combined'
     }
 
     # Build accessor methods for every config options so we can do this, for example:

data/lib/aylien_text_api/connection.rb

@@ -63,8 +63,8 @@ module AylienTextApi
         request = Net::HTTP::Get.new(@uri.request_uri)
       end
 
-      request['app_id'] = @config[:app_id]
-      request['app_key'] = @config[:app_key]
+      request['X-AYLIEN-TextAPI-Application-ID'] = @config[:app_id]
+      request['X-AYLIEN-TextAPI-Application-Key'] = @config[:app_key]
       request['user-agent'] = @config[:user_agent]
 
       @request = request

data/lib/aylien_text_api/version.rb

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

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

@@ -12,7 +12,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.2.0
+      - Aylien Text API Ruby Gem 0.3.0
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -23,7 +23,7 @@ http_interactions:
       Server:
       - openresty/1.7.7.2
       Date:
-      - Mon, 16 Mar 2015 14:32:56 GMT
+      - Thu, 06 Aug 2015 16:59:18 GMT
       Content-Type:
       - text/plain; charset=us-ascii
       Transfer-Encoding:
@@ -34,5 +34,5 @@ http_interactions:
       encoding: UTF-8
       string: Authentication parameters missing
     http_version: 
-  recorded_at: Mon, 16 Mar 2015 14:32:56 GMT
+  recorded_at: Thu, 06 Aug 2015 16:59:18 GMT
 recorded_with: VCR 2.9.3

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

@@ -12,12 +12,12 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.2.0
+      - Aylien Text API Ruby Gem 0.3.0
       Content-Type:
       - application/x-www-form-urlencoded
-      App-Id:
+      X-Aylien-Textapi-Application-Id:
       - "<PASSWORD>"
-      App-Key:
+      X-Aylien-Textapi-Application-Key:
       - "<PASSWORD>"
   response:
     status:
@@ -27,22 +27,31 @@ http_interactions:
       Server:
       - openresty/1.7.7.2
       Date:
-      - Mon, 16 Mar 2015 14:32:52 GMT
+      - Thu, 06 Aug 2015 16:59:18 GMT
       Content-Type:
       - application/json;charset=UTF-8
       Content-Length:
-      - '70'
+      - '219'
       Connection:
       - keep-alive
       X-Ratelimit-Limit:
       - '207000'
       X-Ratelimit-Remaining:
-      - '205606'
+      - '206166'
       X-Ratelimit-Reset:
-      - '1426550400'
+      - '1438905600'
     body:
       encoding: UTF-8
-      string: '{"error" : "requirement failed: you must either provide url or text."}'
+      string: |-
+        {
+          "error": "requirement failed: either text or url is required",
+          "errors": [{
+            "reason": "required",
+            "message": "either text or url is required",
+            "locationType": "parameter",
+            "location": "text"
+          }]
+        }
     http_version: 
-  recorded_at: Mon, 16 Mar 2015 14:32:52 GMT
+  recorded_at: Thu, 06 Aug 2015 16:59:18 GMT
 recorded_with: VCR 2.9.3

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

@@ -12,12 +12,12 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.2.0
+      - Aylien Text API Ruby Gem 0.3.0
       Content-Type:
       - application/x-www-form-urlencoded
-      App-Id:
+      X-Aylien-Textapi-Application-Id:
       - "<PASSWORD>"
-      App-Key:
+      X-Aylien-Textapi-Application-Key:
       - "<PASSWORD>"
   response:
     status:
@@ -27,7 +27,7 @@ http_interactions:
       Server:
       - openresty/1.7.7.2
       Date:
-      - Mon, 16 Mar 2015 14:32:52 GMT
+      - Thu, 06 Aug 2015 16:59:19 GMT
       Content-Type:
       - application/json;charset=UTF-8
       Content-Length:
@@ -37,9 +37,9 @@ http_interactions:
       X-Ratelimit-Limit:
       - '207000'
       X-Ratelimit-Remaining:
-      - '205607'
+      - '206164'
       X-Ratelimit-Reset:
-      - '1426550400'
+      - '1438905600'
     body:
       encoding: UTF-8
       string: |-
@@ -53,5 +53,5 @@ http_interactions:
           }]
         }
     http_version: 
-  recorded_at: Mon, 16 Mar 2015 14:32:52 GMT
+  recorded_at: Thu, 06 Aug 2015 16:59:19 GMT
 recorded_with: VCR 2.9.3

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

@@ -12,12 +12,12 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.2.0
+      - Aylien Text API Ruby Gem 0.3.0
       Content-Type:
       - application/x-www-form-urlencoded
-      App-Id:
+      X-Aylien-Textapi-Application-Id:
       - random_string
-      App-Key:
+      X-Aylien-Textapi-Application-Key:
       - random_string
   response:
     status:
@@ -27,7 +27,7 @@ http_interactions:
       Server:
       - openresty/1.7.7.2
       Date:
-      - Mon, 16 Mar 2015 14:32:52 GMT
+      - Thu, 06 Aug 2015 16:59:17 GMT
       Content-Type:
       - text/plain; charset=us-ascii
       Transfer-Encoding:
@@ -38,5 +38,5 @@ http_interactions:
       encoding: UTF-8
       string: Authentication failed
     http_version: 
-  recorded_at: Mon, 16 Mar 2015 14:32:52 GMT
+  recorded_at: Thu, 06 Aug 2015 16:59:17 GMT
 recorded_with: VCR 2.9.3

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

@@ -12,12 +12,12 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.2.0
+      - Aylien Text API Ruby Gem 0.3.0
       Content-Type:
       - application/x-www-form-urlencoded
-      App-Id:
+      X-Aylien-Textapi-Application-Id:
       - "<PASSWORD>"
-      App-Key:
+      X-Aylien-Textapi-Application-Key:
       - "<PASSWORD>"
   response:
     status:
@@ -27,7 +27,7 @@ http_interactions:
       Server:
       - openresty/1.7.7.2
       Date:
-      - Mon, 16 Mar 2015 14:32:55 GMT
+      - Thu, 06 Aug 2015 16:59:17 GMT
       Content-Type:
       - application/json;charset=UTF-8
       Content-Length:
@@ -37,9 +37,9 @@ http_interactions:
       X-Ratelimit-Limit:
       - '207000'
       X-Ratelimit-Remaining:
-      - '205603'
+      - '206167'
       X-Ratelimit-Reset:
-      - '1426550400'
+      - '1438905600'
     body:
       encoding: ASCII-8BIT
       string: !binary |-
@@ -142,5 +142,5 @@ http_interactions:
         aG5vbG9neSIsCiAgICAiY29kZSI6ICIwNDAwMzAwMCIsCiAgICAiY29uZmlk
         ZW5jZSI6IDEuMAogIH1dCn0=
     http_version: 
-  recorded_at: Mon, 16 Mar 2015 14:32:55 GMT
+  recorded_at: Thu, 06 Aug 2015 16:59:17 GMT
 recorded_with: VCR 2.9.3

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

@@ -12,12 +12,12 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - Aylien Text API Ruby Gem 0.2.0
+      - Aylien Text API Ruby Gem 0.3.0
       Content-Type:
       - application/x-www-form-urlencoded
-      App-Id:
+      X-Aylien-Textapi-Application-Id:
       - "<PASSWORD>"
-      App-Key:
+      X-Aylien-Textapi-Application-Key:
       - "<PASSWORD>"
   response:
     status:
@@ -27,7 +27,7 @@ http_interactions:
       Server:
       - openresty/1.7.7.2
       Date:
-      - Mon, 16 Mar 2015 14:32:54 GMT
+      - Thu, 06 Aug 2015 16:59:19 GMT
       Content-Type:
       - application/json;charset=UTF-8
       Content-Length:
@@ -37,9 +37,9 @@ http_interactions:
       X-Ratelimit-Limit:
       - '207000'
       X-Ratelimit-Remaining:
-      - '205604'
+      - '206165'
       X-Ratelimit-Reset:
-      - '1426550400'
+      - '1438905600'
     body:
       encoding: UTF-8
       string: |-
@@ -53,5 +53,5 @@ http_interactions:
           }]
         }
     http_version: 
-  recorded_at: Mon, 16 Mar 2015 14:32:54 GMT
+  recorded_at: Thu, 06 Aug 2015 16:59:19 GMT
 recorded_with: VCR 2.9.3