aylien_text_api 0.0.1

data/lib/aylien_text_api/configuration.rb

@@ -0,0 +1,57 @@
+# Copyright 2014 Aylien, Inc. All Rights Reserved.
+#
+# 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
+#
+# 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.
+
+module AylienTextApi
+  module Configuration
+    VALID_CONNECTION_KEYS = [:base_uri, :user_agent, :method].freeze
+    VALID_OPTIONS_KEYS    = [:app_id, :app_key].freeze
+    VALID_CONFIG_KEYS     = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_BASE_URI    = 'https://api.aylien.com/api/v1/'.freeze
+    DEFAULT_METHOD      = :post
+    DEFAULT_USER_AGENT  = "Aylien Text API Ruby Gem #{AylienTextApi::VERSION}".freeze
+
+    DEFAULT_APP_ID       = nil
+    DEFAULT_APP_KEY      = nil
+
+    ENDPOINTS = [:extract, :classify, :concepts, :entities, :hashtags,
+      :language, :related, :sentiment, :summarize]
+
+    # Build accessor methods for every config options so we can do this, for example:
+    #   AylienTextApi.method = :get
+    attr_accessor *VALID_CONFIG_KEYS
+
+    # Make sure we have the default values set when we get 'extended'
+    def self.extended(base)
+      base.reset
+    end
+
+    def reset
+      self.base_uri    = DEFAULT_BASE_URI
+      self.method      = DEFAULT_METHOD
+      self.user_agent  = DEFAULT_USER_AGENT
+
+      self.app_id     = DEFAULT_APP_ID
+      self.app_key    = DEFAULT_APP_KEY
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      Hash[ * VALID_CONFIG_KEYS.map { |key| [key, send(key)] }.flatten ]
+    end
+  end # Configuration
+end

data/lib/aylien_text_api/connection.rb

@@ -0,0 +1,71 @@
+# Copyright 2014 Aylien, Inc. All Rights Reserved.
+#
+# 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
+#
+# 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.
+
+require 'json'
+require 'logger'
+require 'uri'
+require 'net/http'
+
+module AylienTextApi
+  class Connection
+    def initialize(endpoint, params, config)
+      @config = config
+      @uri = URI.join(@config[:base_uri], endpoint.to_s)
+      @params = params
+      compile_request_params
+    end
+
+    def request
+      begin
+        request!
+      rescue => e
+        logger = Logger.new(STDOUT)
+        logger.level = Logger::ERROR
+        logger.info(e)
+        nil
+      end
+    end
+
+    def request!
+      Net::HTTP.start(@uri.host, @uri.port, use_ssl: (@uri.scheme == 'https')) do |http|
+        response = http.request(@request)
+        if response.kind_of?(Net::HTTPSuccess)
+          JSON.parse(response.body, :symbolize_names => true)
+        else
+          klass = AylienTextApi::Error::ERRORS[response.code.to_i]
+          error = klass.nil? ? AylienTextApi::Error.new(response.body) : klass.from_response(response)
+          raise error
+        end
+      end
+    end
+
+    private
+
+    def compile_request_params
+      if @config[:method] == :post
+        request = Net::HTTP::Post.new(@uri.request_uri)
+        request.set_form_data(@params)
+      elsif @config[:method] == :get
+        @uri.query = URI.encode_www_form(@params)
+        request = Net::HTTP::Get.new(@uri.request_uri)
+      end
+
+      request['app_id'] = @config[:app_id]
+      request['app_key'] = @config[:app_key]
+      request['user-agent'] = @config[:user_agent]
+
+      @request = request
+    end
+  end
+end

data/lib/aylien_text_api/error.rb

@@ -0,0 +1,110 @@
+# Copyright 2014 Aylien, Inc. All Rights Reserved.
+#
+# 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
+#
+# 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.
+
+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 returns the HTTP status code 400
+    BadRequest = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns the HTTP status code 401
+    Unauthorized = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns the HTTP status code 402
+    PaymentRequired = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns the HTTP status code 403
+    Forbidden = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns the HTTP status code 404
+    NotFound = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns the HTTP status code 406
+    NotAcceptable = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns the HTTP status code 422
+    UnprocessableEntity = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns the HTTP status code 429
+    TooManyRequests = Class.new(ClientError)
+
+    # Raised when Aylien Text API returns a 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # Raised when Aylien Text API returns the HTTP status code 500
+    InternalServerError = Class.new(ServerError)
+
+    # Raised when Aylien Text API returns the HTTP status code 502
+    BadGateway = Class.new(ServerError)
+
+    # Raised when Aylien Text API returns the HTTP status code 503
+    ServiceUnavailable = Class.new(ServerError)
+
+    # Raised when Aylien Text API returns the HTTP status code 504
+    GatewayTimeout = Class.new(ServerError)
+
+    ERRORS = {
+      400 => AylienTextApi::Error::BadRequest,
+      401 => AylienTextApi::Error::Unauthorized,
+      402 => AylienTextApi::Error::PaymentRequired,
+      403 => AylienTextApi::Error::Forbidden,
+      404 => AylienTextApi::Error::NotFound,
+      406 => AylienTextApi::Error::NotAcceptable,
+      422 => AylienTextApi::Error::UnprocessableEntity,
+      429 => AylienTextApi::Error::TooManyRequests,
+      500 => AylienTextApi::Error::InternalServerError,
+      502 => AylienTextApi::Error::BadGateway,
+      503 => AylienTextApi::Error::ServiceUnavailable,
+      504 => AylienTextApi::Error::GatewayTimeout,
+    }
+
+    class << self
+      # Create a new error from an HTTP response
+      #
+      # @param response [HTTP::Response]
+      # @return [AylienTextApi::Error]
+      def from_response(response)
+        body = if response["Content-Type"].include?('json')
+          JSON.parse(response.body, :symbolize_names => true)
+        else
+          response.body
+        end
+        message = parse_error(body)
+        new(message)
+      end
+
+    private
+
+      def parse_error(body)
+        if body.nil? || body.empty?
+          ''
+        elsif body.is_a?(Hash) && body[:error]
+          body[:error]
+        else
+          body
+        end
+      end
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @return [AylienTextApi::Error]
+    def initialize(message = '')
+      super(message)
+    end
+  end
+end

data/lib/aylien_text_api/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2014 Aylien, Inc. All Rights Reserved.
+#
+# 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
+#
+# 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.
+
+module AylienTextApi
+  VERSION = "0.0.1" unless defined? AylienTextApi::VERSION
+end

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

@@ -0,0 +1,36 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/classify
+    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
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Server:
+      - openresty/1.5.12.1
+      Date:
+      - Tue, 02 Dec 2014 18:15:50 GMT
+      Content-Type:
+      - text/plain; charset=us-ascii
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: Authentication parameters missing
+    http_version: 
+  recorded_at: Tue, 02 Dec 2014 18:14:48 GMT
+recorded_with: VCR 2.9.3

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

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/classify
+    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
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      App-Id:
+      - <PASSWORD>
+      App-Key:
+      - <PASSWORD>
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - openresty/1.5.12.1
+      Date:
+      - Tue, 02 Dec 2014 18:15:48 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '70'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! '{"error" : "requirement failed: you must either provide url or text."}'
+    http_version: 
+  recorded_at: Tue, 02 Dec 2014 18:14:45 GMT
+recorded_with: VCR 2.9.3

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

@@ -0,0 +1,48 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/classify
+    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
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      App-Id:
+      - <PASSWORD>
+      App-Key:
+      - <PASSWORD>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - openresty/1.5.12.1
+      Date:
+      - Tue, 02 Dec 2014 18:15:51 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '605'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"text\": \"CCTV footage shows the moment a suicide car bomber
+        detonates\\n      a device in Beirut on Tuesday. The incident took place in
+        an area\\n      of support for Hezbollah and left four people dead with many
+        more wounded.\\n      A group calling itself the al-Nusra Front in Lebanon
+        has claimed\\n      responsibility for the attack saying it was in retaliation
+        for\\n      Hezbollah's military support of president Bashar al-Assad's forces
+        in Syria\",\n  \"language\": \"en\",\n  \"categories\": [{\n    \"label\":
+        \"defence - biological and chemical weapons\",\n    \"code\": \"11001007\",\n
+        \   \"confidence\": 1.0\n  }]\n}"
+    http_version: 
+  recorded_at: Tue, 02 Dec 2014 18:14:48 GMT
+recorded_with: VCR 2.9.3

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

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/classify
+    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
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      App-Id:
+      - random_string
+      App-Key:
+      - random_string
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Server:
+      - openresty/1.5.12.1
+      Date:
+      - Tue, 02 Dec 2014 18:15:47 GMT
+      Content-Type:
+      - text/plain; charset=us-ascii
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: Authentication failed
+    http_version: 
+  recorded_at: Tue, 02 Dec 2014 18:14:44 GMT
+recorded_with: VCR 2.9.3

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

@@ -0,0 +1,98 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.aylien.com/api/v1/classify
+    body:
+      encoding: US-ASCII
+      string: url=http%3A%2F%2Ftechcrunch.com%2F2014%2F10%2F20%2Fthe-super-slim-kindle-voyage-is-a-great-travel-companion%2F
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Aylien Text API Ruby Gem 0.0.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      App-Id:
+      - <PASSWORD>
+      App-Key:
+      - <PASSWORD>
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - openresty/1.5.12.1
+      Date:
+      - Tue, 02 Dec 2014 18:15:53 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Content-Length:
+      - '4482'
+      Connection:
+      - keep-alive
+    body:
+      encoding: US-ASCII
+      string: ! "{\n  \"text\": \"The Super-Slim Kindle Voyage Is A Great Travel Companion\\nIn
+        1935, Sir Allen Lane and V. K. Krishna Menon founded Penguin Books, a company
+        dedicated to producing high-quality, small-format paperback books for the
+        world market. These small, well-made little books introduced some amazing
+        fiction, philosophy, classical thought and spiritualism to a hungry audience,
+        and the low price made it easy to build a library of amazing titles that could
+        fit into a milk crate. Penguin, it can be argued, brought about an intellectual
+        sea change, bringing us both the post-war writers of note and, in another
+        direction, the Beats and the spiritual riot of the 1960s.\\n\\nWhy was Penguin
+        so popular? And why is the 6-inch Kindle Voyage its emotional successor? Both
+        revolutionized the physical notion of books.\\n\\nIn Penguin\\u2019s case,
+        the medium was truly the message, and\\u00a0the writing inside the small,
+        pocketable books allowed for portability and encouraged collection. In the
+        Kindle Voyage\\u2019s case, Amazon has created a delightful travel companion.\\n\\nFirst,
+        let\\u2019s address the size. The $199 Voyage ($219 without ads and with 3G)
+        is about as big as a Penguin paperback and just a bit bigger (and thicker)
+        than a standard passport. It\\u2019s 7.6 mm thick and removed from its case
+        it looks about as substantial as a thin stack of paper.\\n\\nThe Voyage is
+        the Kindle distilled. Almost all of the features are there \\u2013 touchscreen,
+        bright white e-ink display, and even a special haptic feedback system that
+        allows you to \\u201cclick\\u201d left and right side buttons to turn pages.
+        You can also swipe the page left and right to move to the next page and small
+        dedicated spots above the longer touch-sensitive pads that go back one page.\\n\\nAmazon
+        sells an $45 folding case for the Voyage that opens up like a Moleskine reporter\\u2019s
+        notebook. It activates the Kindle upon opening and turns it off when closed.
+        Hidden magnets then allow you to turn the cover into a little stand for hands-free
+        reading.\\n\\nSo how does it work? In short, I love e-ink devices, and the
+        Voyage is the best of them. Because it lasts for weeks \\u2013 I haven\\u2019t
+        charged it in a full week of use \\u2013 you can stick it in a bag or backpack
+        and expect it to be ready to read. The bright backlit screen casts a gentle
+        glow that is reactive to outside light and makes reading pleasant without
+        the glare of LCD. As a dedicated e-reader, it is nearly perfect, and I rarely
+        say anything in CE is perfect.\\n\\nWho is this for? It\\u2019s for readers.
+        The Voyage doesn\\u2019t do much except display books and allow you to buy
+        them. You can download thousands of titles and not run out of space and, thanks
+        to new organizational systems, you can place books into folders and control
+        their placement on the device. But, again, it\\u2019s for readers. Don\\u2019t
+        expect to read email, browse the web, or control your home security system
+        from this device. It\\u2019s the e-reader perfected, however, and that means
+        a lot.\\n\\nI don\\u2019t know how much longer the market for dedicated e-readers
+        will exist, but I certainly appreciate Amazon\\u2019s dedication to the cause.
+        E-ink devices are special because they\\u2019re amazingly readable and light
+        and have great battery life. All of these aspects work in concert to offer
+        a reading experience akin to thumbing through a Penguin Classic.\\n\\nAgain,
+        this isn\\u2019t for everyone. It\\u2019s great for travel \\u2013 I took
+        it with me to Disrupt in Europe and have read it on planes for the past few
+        days \\u2013 and it\\u2019s great for people who don\\u2019t want a distracting
+        reading experience. It\\u2019s a great gateway tablet, for example, for folks
+        who don\\u2019t want a complex experience and instead just want to read. It\\u2019s
+        also far more comfortable on the eyes for night reading in bed and the text
+        can be modified for any eyes.\\n\\nAmazon is aiming for readers. It knows
+        that people love Kindles because they are pure products for reading. And the
+        Voyage is Amazon\\u2019s latest attempt at perfecting the e-book. Not unlike
+        Penguin, Amazon looked at the market and made a bold move. It\\u2019s paid
+        off and the resulting products \\u2013 the Fire like and this new Kindle \\u2013
+        are nearly perfect media consumption devices by a company that knows how to
+        sell.\",\n  \"language\": \"en\",\n  \"categories\": [{\n    \"label\": \"economy,
+        business and finance - computing and information technology\",\n    \"code\":
+        \"04003000\",\n    \"confidence\": 1.0\n  }]\n}"
+    http_version: 
+  recorded_at: Tue, 02 Dec 2014 18:14:50 GMT
+recorded_with: VCR 2.9.3