aylien_text_api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe9d4f356602fc1b9f1d70d21c187c775ef0d50b
-  data.tar.gz: ea0e0d0ab966b97b8a62a582d18d926f574bf106
+  metadata.gz: f5ca9194dc31a1cff562728d3898aefd4b0d0b72
+  data.tar.gz: 0de02e92c4d55f1f84324d4ab5b694377ffaed8e
 SHA512:
-  metadata.gz: 4f711cf5448383799904b579971ab911109e90099d70ff5927e25f2a000cf298dcd790a7604823fae1b1dfb4ebc674074d1ae9b2680eedf0661acb7d92763988
-  data.tar.gz: 4fb437af83e64299b2129b007524056442680b923c027839f1b187e59709c13e9a7dce0244ad1a9c43c8b6b5938e52d4d036ef558d7936e3c179ca5832cd6092
+  metadata.gz: 02f89349fa72450dea8c2f20113cdf71a9f8447d26479f6131837b2c0d06da8549ecc947f24c8a46c050602860460c2d9fdc8d85639a207868a36ed2ddbe871d
+  data.tar.gz: b0cbfc361ca4f8d3cf21deb8beee50b4080a9e1aa61f2cac388571b9a2beb48e167fab62188d7be3e07e223f25b10b76e4009f360aab43f6c907d4cbde3570f3

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    aylien_text_api (0.3.0)
+    aylien_text_api (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.6)
+    addressable (2.3.8)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
-    minitest (5.4.3)
-    rake (10.4.0)
+    minitest (5.8.0)
+    rake (10.4.2)
     safe_yaml (1.0.4)
     vcr (2.9.3)
-    webmock (1.20.4)
+    webmock (1.21.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
 
@@ -28,4 +28,4 @@ DEPENDENCIES
   webmock (~> 1.20)
 
 BUNDLED WITH
-   1.10.5
+   1.10.6

data/lib/aylien_text_api/client.rb

@@ -31,14 +31,6 @@ module AylienTextApi
       Configuration::VALID_CONFIG_KEYS.each do |key|
         send("#{key}=", merged_options[key])
       end
-
-      Configuration::ENDPOINTS.keys.each do |endpoint|
-        self.class.send(:define_method, "#{endpoint}!") do |value=nil, params={}|
-          endpoint, params, config = common_endpoint(value, params, 
-            Configuration::ENDPOINTS[endpoint])
-          Connection.new(endpoint, params, config).request!
-        end
-      end
     end
 
     # Extracts the main body of article, including embedded media such as
@@ -59,7 +51,45 @@ module AylienTextApi
         Configuration::ENDPOINTS[:extract])
       Connection.new(endpoint, params, config).request
     end
+    
+    # Like extract, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def extract!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:extract])
+      Connection.new(endpoint, params, config).request!
+    end
 
+    # Classifies a piece of text according to a defined taxonomy.
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The classify 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://docs.aylien.com/docs/classify_by_taxonomy for more information
+    #   on the data returned.
+    #
+    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
+    end
+    
+    # Like classify_by_taxonomy, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    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!
+    end
+    
     # Classifies a piece of text according to IPTC NewsCode standard.
     #
     # @param [String] value (nil) URL or Text
@@ -79,6 +109,15 @@ module AylienTextApi
         Configuration::ENDPOINTS[:classify])
       Connection.new(endpoint, params, config).request
     end
+    
+    # Like classify, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def classify!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:classify])
+      Connection.new(endpoint, params, config).request!
+    end
 
     # Extracts named entities mentioned in a document, disambiguates
     # and cross-links them to DBPedia and Linked Data entities, along with
@@ -101,6 +140,15 @@ module AylienTextApi
         Configuration::ENDPOINTS[:concepts])
       Connection.new(endpoint, params, config).request
     end
+    
+    # Like concepts, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def concepts!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:concepts])
+      Connection.new(endpoint, params, config).request!
+    end
 
     # Suggests hashtags describing the document.
     #
@@ -121,6 +169,15 @@ module AylienTextApi
         Configuration::ENDPOINTS[:hashtags])
       Connection.new(endpoint, params, config).request
     end
+    
+    # Like hashtags, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def hashtags!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:hashtags])
+      Connection.new(endpoint, params, config).request!
+    end
 
     # Extracts named entities (people, organizations and locations) and
     # values (URLs, emails, telephone numbers, currency amounts and percentages)
@@ -143,7 +200,16 @@ module AylienTextApi
         Configuration::ENDPOINTS[:entities])
       Connection.new(endpoint, params, config).request
     end
-
+    
+    # Like entities, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def entities!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:entities])
+      Connection.new(endpoint, params, config).request!
+    end
+    
     # Detects the main language a document is written in and returns it
     # in ISO 639-1 format.
     #
@@ -161,7 +227,16 @@ module AylienTextApi
         Configuration::ENDPOINTS[:language])
       Connection.new(endpoint, params, config).request
     end
-
+    
+    # Like language, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def language!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:language])
+      Connection.new(endpoint, params, config).request!
+    end
+    
     # Detects sentiment of a document in terms of
     # polarity ("positive" or "negative") and
     # subjectivity ("subjective" or "objective").
@@ -182,7 +257,15 @@ module AylienTextApi
         Configuration::ENDPOINTS[:sentiment])
       Connection.new(endpoint, params, config).request
     end
-
+    
+    # Like sentiment, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def sentiment!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:sentiment])
+      Connection.new(endpoint, params, config).request!
+    end
     # Summarizes an article into a few key sentences.
     #
     # @param [String] value (nil) URL or Text
@@ -212,7 +295,16 @@ module AylienTextApi
         Configuration::ENDPOINTS[:summarize])
       Connection.new(endpoint, params, config).request
     end
-
+    
+    # Like summarize, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def summarize!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:summarize])
+      Connection.new(endpoint, params, config).request!
+    end
+    
     # Returns phrases related to the provided unigram, or bigram.
     #
     # @param [String] value (nil) URL or Text
@@ -231,6 +323,15 @@ module AylienTextApi
       Connection.new(endpoint, params, config).request
     end
     
+    # Like 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.new(endpoint, params, config).request!
+    end
+    
     # Return Microformats.
     #
     # @param [String] value (nil) URL
@@ -250,6 +351,15 @@ module AylienTextApi
       Connection.new(endpoint, params, config).request
     end
     
+    # Like 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.new(endpoint, params, config).request!
+    end
+    
     # Return Unsupervised Classify.
     #
     # @param [String] value (nil) URL or Text
@@ -270,6 +380,15 @@ module AylienTextApi
       Connection.new(endpoint, params, config).request
     end
     
+    # Like 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.new(endpoint, params, config).request!
+    end
+    
     # Runs multiple analysis operations in one API call.
     #
     # @param [String] value (nil) URL or Text
@@ -288,6 +407,14 @@ module AylienTextApi
       Connection.new(endpoint, params, config).request
     end
     
+    # Like combined, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    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
@@ -302,6 +429,15 @@ module AylienTextApi
         Configuration::ENDPOINTS[:image_tags])
       Connection.new(endpoint, params, config).request
     end
+    
+    # Like image_tags, but calls request! so an exception is raised 
+    # if the request fails.
+    #
+    def image_tags!(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, 
+        Configuration::ENDPOINTS[:image_tags])
+      Connection.new(endpoint, params, config).request!
+    end
 
     private
 
@@ -324,6 +460,18 @@ module AylienTextApi
           params[:text] = value
         end
       end
+      
+      if endpoint == Configuration::ENDPOINTS[:classify_by_taxonomy]
+        if params[:taxonomy] && !params[:taxonomy].empty?
+          endpoint = Configuration::ENDPOINTS[:classify_by_taxonomy]
+            .gsub(/\:taxonomy/, params[:taxonomy])
+        else
+          error_message = "Invalid taxonomy. Taxonomy can't be blank."
+          error = AylienTextApi::Error::InvalidInput.new(error_message)
+          raise error
+        end
+      end
+      
       config = {}
       Configuration::VALID_CONFIG_KEYS.each do |key|
         config[key] = send(key)

data/lib/aylien_text_api/configuration.rb

@@ -28,6 +28,7 @@ module AylienTextApi
     ENDPOINTS = {
       extract:  'extract',
       classify: 'classify',
+      classify_by_taxonomy: 'classify/:taxonomy',
       concepts: 'concepts',
       entities: 'entities',
       hashtags: 'hashtags',

data/lib/aylien_text_api/error.rb

@@ -16,7 +16,10 @@ module AylienTextApi
   class Error < StandardError
     # Raised when Aylien Text API returns a 4xx HTTP status code
     ClientError = Class.new(self)
-
+    
+    # Raised when Aylien Text API input is invalid 
+    InvalidInput = Class.new(ClientError)
+    
     # Raised when Aylien Text API returns the HTTP status code 400
     BadRequest = Class.new(ClientError)
 
@@ -68,7 +71,7 @@ module AylienTextApi
       500 => AylienTextApi::Error::InternalServerError,
       502 => AylienTextApi::Error::BadGateway,
       503 => AylienTextApi::Error::ServiceUnavailable,
-      504 => AylienTextApi::Error::GatewayTimeout,
+      504 => AylienTextApi::Error::GatewayTimeout
     }
 
     class << self

data/lib/aylien_text_api/version.rb

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

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

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/classify/iab-qag
+    body:
+      encoding: US-ASCII
+      string: text=CCTV+footage+shows+the+moment+a+suicide+car+bomber+detonates%0A++++++a+device+in+Beirut+on+Tuesday.+The+incident+took+place+in+an+area%0A++++++of+support+for+Hezbollah+and+left+four+people+dead+with+many+more+wounded.%0A++++++A+group+calling+itself+the+al-Nusra+Front+in+Lebanon+has+claimed%0A++++++responsibility+for+the+attack+saying+it+was+in+retaliation+for%0A++++++Hezbollah%27s+military+support+of+president+Bashar+al-Assad%27s+forces+in+Syria&taxonomy=iab-qag
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.4.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Server:
+      - openresty/1.7.7.2
+      Date:
+      - Thu, 17 Sep 2015 11:17:32 GMT
+      Content-Type:
+      - text/plain; charset=us-ascii
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Authentication parameters missing
+    http_version: 
+  recorded_at: Thu, 17 Sep 2015 11:17:32 GMT
+recorded_with: VCR 2.9.3

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

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/classify/iab-qag
+    body:
+      encoding: US-ASCII
+      string: wrong_param=CCTV+footage+shows+the+moment+a+suicide+car+bomber+detonates%0A++++++a+device+in+Beirut+on+Tuesday.+The+incident+took+place+in+an+area%0A++++++of+support+for+Hezbollah+and+left+four+people+dead+with+many+more+wounded.%0A++++++A+group+calling+itself+the+al-Nusra+Front+in+Lebanon+has+claimed%0A++++++responsibility+for+the+attack+saying+it+was+in+retaliation+for%0A++++++Hezbollah%27s+military+support+of+president+Bashar+al-Assad%27s+forces+in+Syria&taxonomy=iab-qag
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.4.0
+      Content-Type:
+      - application/x-www-form-urlencoded
+      X-Aylien-Textapi-Application-Id:
+      - "<PASSWORD>"
+      X-Aylien-Textapi-Application-Key:
+      - "<PASSWORD>"
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - openresty/1.7.7.2
+      Date:
+      - Thu, 17 Sep 2015 11:17:30 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '219'
+      Connection:
+      - keep-alive
+      X-Ratelimit-Limit:
+      - '207000'
+      X-Ratelimit-Remaining:
+      - '206407'
+      X-Ratelimit-Reset:
+      - '1442534400'
+    body:
+      encoding: UTF-8
+      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: Thu, 17 Sep 2015 11:17:31 GMT
+recorded_with: VCR 2.9.3