aylien_text_api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5ca9194dc31a1cff562728d3898aefd4b0d0b72
-  data.tar.gz: 0de02e92c4d55f1f84324d4ab5b694377ffaed8e
+  metadata.gz: 32241b5e504b3607cd03ba3ce52b6ff041293fe5
+  data.tar.gz: d9afa0e66071345e5bf7ccfa8f4a846ead1fd01f
 SHA512:
-  metadata.gz: 02f89349fa72450dea8c2f20113cdf71a9f8447d26479f6131837b2c0d06da8549ecc947f24c8a46c050602860460c2d9fdc8d85639a207868a36ed2ddbe871d
-  data.tar.gz: b0cbfc361ca4f8d3cf21deb8beee50b4080a9e1aa61f2cac388571b9a2beb48e167fab62188d7be3e07e223f25b10b76e4009f360aab43f6c907d4cbde3570f3
+  metadata.gz: aea76530a27c218f2056f63da306f87bdb6583e8edbd6313242a2099f51da29c83c57bc426daafe3d40e1a014034c7f6230e53fe839d7196c182bb5cc2ee5dcc
+  data.tar.gz: 94bdff655d8b484500462919017f69a1ce84c4f480c89afb654130aeff638c22ee1b43a275f7ce360f5f8d9b05e3829ae17dc40ca33c162bfe036f089f0d327e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    aylien_text_api (0.4.0)
+    aylien_text_api (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/aylien_text_api/client.rb

@@ -49,7 +49,8 @@ module AylienTextApi
     def extract(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:extract])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like extract, but calls request! so an exception is raised 
@@ -58,10 +59,11 @@ module AylienTextApi
     def extract!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:extract])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
 
-    # Classifies a piece of text according to a defined taxonomy.
+    # Classifies a piece of text according to the specified taxonomy.
     #
     # @param [String] value (nil) URL or Text
     # @param [Hash] params The classify endpoint options
@@ -78,7 +80,8 @@ module AylienTextApi
     def classify_by_taxonomy(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:classify_by_taxonomy])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like classify_by_taxonomy, but calls request! so an exception is raised 
@@ -87,7 +90,8 @@ module AylienTextApi
     def classify_by_taxonomy!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:classify_by_taxonomy])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     
     # Classifies a piece of text according to IPTC NewsCode standard.
@@ -107,7 +111,8 @@ module AylienTextApi
     def classify(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:classify])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like classify, but calls request! so an exception is raised 
@@ -116,7 +121,8 @@ module AylienTextApi
     def classify!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:classify])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
 
     # Extracts named entities mentioned in a document, disambiguates
@@ -138,7 +144,8 @@ module AylienTextApi
     def concepts(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:concepts])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like concepts, but calls request! so an exception is raised 
@@ -147,7 +154,8 @@ module AylienTextApi
     def concepts!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:concepts])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
 
     # Suggests hashtags describing the document.
@@ -167,7 +175,8 @@ module AylienTextApi
     def hashtags(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:hashtags])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like hashtags, but calls request! so an exception is raised 
@@ -176,7 +185,8 @@ module AylienTextApi
     def hashtags!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:hashtags])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
 
     # Extracts named entities (people, organizations and locations) and
@@ -198,7 +208,8 @@ module AylienTextApi
     def entities(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:entities])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like entities, but calls request! so an exception is raised 
@@ -207,7 +218,8 @@ module AylienTextApi
     def entities!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:entities])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     
     # Detects the main language a document is written in and returns it
@@ -225,7 +237,8 @@ module AylienTextApi
     def language(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:language])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like language, but calls request! so an exception is raised 
@@ -234,7 +247,8 @@ module AylienTextApi
     def language!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:language])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     
     # Detects sentiment of a document in terms of
@@ -255,7 +269,8 @@ module AylienTextApi
     def sentiment(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:sentiment])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like sentiment, but calls request! so an exception is raised 
@@ -264,7 +279,8 @@ module AylienTextApi
     def sentiment!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:sentiment])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     # Summarizes an article into a few key sentences.
     #
@@ -293,7 +309,8 @@ module AylienTextApi
     def summarize(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:summarize])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like summarize, but calls request! so an exception is raised 
@@ -302,7 +319,8 @@ module AylienTextApi
     def summarize!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:summarize])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     
     # Returns phrases related to the provided unigram, or bigram.
@@ -320,7 +338,8 @@ module AylienTextApi
     def related(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:related])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like related, but calls request! so an exception is raised 
@@ -329,7 +348,8 @@ module AylienTextApi
     def related!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:related])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     
     # Return Microformats.
@@ -348,7 +368,8 @@ module AylienTextApi
     def microformats(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:microformats])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like microformats, but calls request! so an exception is raised 
@@ -357,7 +378,8 @@ module AylienTextApi
     def microformats!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:microformats])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     
     # Return Unsupervised Classify.
@@ -377,7 +399,8 @@ module AylienTextApi
     def unsupervised_classify(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:unsupervised_classify])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like unsupervised_classify, but calls request! so an exception is raised 
@@ -386,7 +409,8 @@ module AylienTextApi
     def unsupervised_classify!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:unsupervised_classify])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
     
     # Runs multiple analysis operations in one API call.
@@ -404,7 +428,8 @@ module AylienTextApi
     def combined(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:combined])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like combined, but calls request! so an exception is raised 
@@ -413,8 +438,10 @@ module AylienTextApi
     def combined!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:combined])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
+    
     # Assigns relevant tags to an image.
     #
     # @param [String] value (nil) URL
@@ -427,7 +454,8 @@ module AylienTextApi
     def image_tags(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:image_tags])
-      Connection.new(endpoint, params, config).request
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request
     end
     
     # Like image_tags, but calls request! so an exception is raised 
@@ -436,9 +464,22 @@ module AylienTextApi
     def image_tags!(value=nil, params={})
       endpoint, params, config = common_endpoint(value, params, 
         Configuration::ENDPOINTS[:image_tags])
-      Connection.new(endpoint, params, config).request!
+      @connection = Connection.new(endpoint, params, config)
+      @connection.request!
     end
-
+    
+    # Returns current client's rate limit values. If it gets failed,
+    # nil will be returned.
+    # 
+    # @return [Hash, nil] A hash of result. See
+    #   http://docs.aylien.com/docs/rate-limits for more information
+    #   on the data returned.
+    def rate_limits
+      self.language text: "Hello world!" unless defined?(@connection)
+      
+      (@connection || {}).rate_limits
+    end
+    
     private
 
     def validate_uri(value)

data/lib/aylien_text_api/connection.rb

@@ -19,6 +19,8 @@ require 'net/http'
 
 module AylienTextApi
   class Connection
+    attr_reader :rate_limits
+    
     def initialize(endpoint, params, config)
       @config = config
       @uri = URI.join(@config[:base_uri], endpoint)
@@ -41,6 +43,11 @@ module AylienTextApi
       Net::HTTP.start(@uri.host, @uri.port, use_ssl: (@uri.scheme == 'https')) do |http|
         response = http.request(@request)
         if response.kind_of?(Net::HTTPSuccess)
+          @rate_limits = {
+            limit: response["X-RateLimit-Limit"],
+            remaining: response["X-RateLimit-Remaining"],
+            reset: response["X-RateLimit-Reset"]
+          }
           JSON.parse(response.body, :symbolize_names => true)
         else
           klass = AylienTextApi::Error::ERRORS[response.code.to_i]

data/lib/aylien_text_api/version.rb

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

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

@@ -21,9 +21,9 @@ http_interactions:
       message: Forbidden
     headers:
       Server:
-      - openresty/1.7.7.2
+      - openresty/1.9.3.2
       Date:
-      - Thu, 17 Sep 2015 11:17:32 GMT
+      - Fri, 22 Jan 2016 13:17:57 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: Thu, 17 Sep 2015 11:17:32 GMT
+  recorded_at: Fri, 22 Jan 2016 13:17:57 GMT
 recorded_with: VCR 2.9.3

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

@@ -25,9 +25,9 @@ http_interactions:
       message: Bad Request
     headers:
       Server:
-      - openresty/1.7.7.2
+      - openresty/1.9.3.2
       Date:
-      - Thu, 17 Sep 2015 11:17:30 GMT
+      - Fri, 22 Jan 2016 13:18:01 GMT
       Content-Type:
       - application/json;charset=UTF-8
       Content-Length:
@@ -37,9 +37,9 @@ http_interactions:
       X-Ratelimit-Limit:
       - '207000'
       X-Ratelimit-Remaining:
-      - '206407'
+      - '206338'
       X-Ratelimit-Reset:
-      - '1442534400'
+      - '1453507200'
     body:
       encoding: UTF-8
       string: |-
@@ -53,5 +53,5 @@ http_interactions:
           }]
         }
     http_version: 
-  recorded_at: Thu, 17 Sep 2015 11:17:31 GMT
+  recorded_at: Fri, 22 Jan 2016 13:18:01 GMT
 recorded_with: VCR 2.9.3

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

@@ -25,9 +25,9 @@ http_interactions:
       message: Not Found
     headers:
       Server:
-      - openresty/1.7.7.2
+      - openresty/1.9.3.2
       Date:
-      - Thu, 17 Sep 2015 11:17:31 GMT
+      - Fri, 22 Jan 2016 13:17:57 GMT
       Content-Type:
       - text/plain;charset=UTF-8
       Content-Length:
@@ -37,12 +37,12 @@ http_interactions:
       X-Ratelimit-Limit:
       - '207000'
       X-Ratelimit-Remaining:
-      - '206406'
+      - '206351'
       X-Ratelimit-Reset:
-      - '1442534400'
+      - '1453507200'
     body:
       encoding: UTF-8
       string: The requested resource could not be found.
     http_version: 
-  recorded_at: Thu, 17 Sep 2015 11:17:31 GMT
+  recorded_at: Fri, 22 Jan 2016 13:17:57 GMT
 recorded_with: VCR 2.9.3

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

@@ -25,9 +25,9 @@ http_interactions:
       message: OK
     headers:
       Server:
-      - openresty/1.7.7.2
+      - openresty/1.9.3.2
       Date:
-      - Thu, 17 Sep 2015 11:17:31 GMT
+      - Fri, 22 Jan 2016 13:18:02 GMT
       Content-Type:
       - application/json;charset=UTF-8
       Content-Length:
@@ -37,9 +37,9 @@ http_interactions:
       X-Ratelimit-Limit:
       - '207000'
       X-Ratelimit-Remaining:
-      - '206405'
+      - '206337'
       X-Ratelimit-Reset:
-      - '1442534400'
+      - '1453507200'
     body:
       encoding: UTF-8
       string: |-
@@ -71,5 +71,5 @@ http_interactions:
           }]
         }
     http_version: 
-  recorded_at: Thu, 17 Sep 2015 11:17:31 GMT
+  recorded_at: Fri, 22 Jan 2016 13:18:02 GMT
 recorded_with: VCR 2.9.3

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

@@ -25,9 +25,9 @@ http_interactions:
       message: Forbidden
     headers:
       Server:
-      - openresty/1.7.7.2
+      - openresty/1.9.3.2
       Date:
-      - Thu, 17 Sep 2015 11:17:30 GMT
+      - Fri, 22 Jan 2016 13:17:59 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: Thu, 17 Sep 2015 11:17:30 GMT
+  recorded_at: Fri, 22 Jan 2016 13:17:59 GMT
 recorded_with: VCR 2.9.3