aylien_text_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 216b14bf8afcd4915cd06fd5435dd12bd6dfdb13
+  data.tar.gz: 7cc5feef68d09b68ed4324503be4a3a1549e95a7
+SHA512:
+  metadata.gz: b27a6c60c851ba8c45cadd4cdf4e1d960891ec01e3f7943a1f77550519cd01cdcdc7fbff759ec3d94a9eb33eb88bc56852befca4ac700bb4d02a10cdb8364e75
+  data.tar.gz: 429e9b058d371f4acbdc515c90b5d4a743aa5e23c40b8893e9453dcc5d80a48fbeac690cb9c2d7c5db066dd53d92fae7483dff933305eec3702671cec7fdf3e8

data/.gitignore

@@ -0,0 +1,3 @@
+config/app_config.yml
+doc/
+.yardoc/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    aylien_text_api (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    minitest (5.4.3)
+    rake (10.4.0)
+    safe_yaml (1.0.4)
+    vcr (2.9.3)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aylien_text_api!
+  minitest (~> 5.4)
+  rake (~> 10.4)
+  vcr (~> 2.9)
+  webmock (~> 1.20)

data/LICENSE

@@ -0,0 +1,13 @@
+ 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.

data/README.md

@@ -0,0 +1,67 @@
+About
+=====
+
+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
+============
+    gem install aylien_text_api
+
+See the [Developers Guide](https://developer.aylien.com/docs) for additional documentation.
+
+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::Client.new.
+
+````ruby
+require 'aylien_text_api'
+
+client = AylienTextApi::Client.new do |config|
+  config.app_id        =    "YOUR_APP_ID"
+  config.app_key       =    "YOUR_APP_KEY"
+end
+````
+
+or pass them as parameters to AylienTextApi::Client class.
+
+````ruby
+require 'aylien_text_api'
+
+client = AylienTextApi::Client.new(app_id: "YOUR APP ID", app_key: "YOUR APP KEY")
+````
+
+Examples
+=====
+After configuring a client, you can do the following things:
+
+````ruby
+client.extract url: "http://techcrunch.com/2014/02/27/aylien-launches-text-analysis-api-to-help-developers-extract-meaning-from-documents/"
+# => {
+  :title=>"Aylien Launches Text-Analysis API To Help Developers...",
+  :article=>"Working with text is often a messy business for...",
+  :image=>"", :author=>"Frederic Lardinois", :videos=>[],
+  :feeds=>["http://techcrunch.com/2014/02/27/aylien-...
+  }
+````
+
+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"
+# => {:text=>"Lionel Messi: Forward is not for sale, says...,
+ :language=>"en",
+ :categories=>[{:label=>"sport - soccer", :code=>"15054000", :confidence=>1.0}]
+ }
+````
+
+Third Party Libraries and Dependencies
+======================================
+For development you will also need the following libraries:
+
+* rake
+* minitest
+* vcr
+* webmock

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['spec/lib/aylien_text_api/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/aylien_text_api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "aylien_text_api/version"
+
+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.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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  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'
+end

data/config/app_config.yml.example

@@ -0,0 +1,7 @@
+text_api:
+  correct_keys:
+    app_id: YOUR APP_ID
+    app_key: YOUR APP_KEY
+  incorrect_keys:
+    app_id: random_string
+    app_key: random_string

data/lib/aylien_text_api.rb

@@ -0,0 +1,23 @@
+# 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 'aylien_text_api/version'
+require 'aylien_text_api/configuration'
+require 'aylien_text_api/error'
+require 'aylien_text_api/client'
+require 'aylien_text_api/connection'
+
+module AylienTextApi
+  extend Configuration
+end

data/lib/aylien_text_api/client.rb

@@ -0,0 +1,246 @@
+# 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
+  # The Client class is the main class for calling Text API endpoints
+  class Client
+    attr_accessor *Configuration::VALID_CONFIG_KEYS
+
+    # Creates an Client object.
+    # @param [Hash] options Configuration params
+    # @option options [String] :app_id The APP_ID
+    # @option options [String] :app_key The APP_KEY
+    # @option options [String] :base_uri ('https://api.aylien.com/api/v1/')
+    #   An URL that points to the Aylien Text API
+    # @option options [Symbol] :method (:post) Request method.
+    # @option options [String] :user_agent Request user-agent
+    def initialize(options={})
+      merged_options = AylienTextApi.options.merge(options)
+
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        send("#{key}=", merged_options[key])
+      end
+
+      Configuration::ENDPOINTS.each do |endpoint|
+        self.class.send(:define_method, "#{endpoint}!") do |value=nil, params={}|
+          endpoint, params, config = common_endpoint(value, params, endpoint)
+          Connection.new(endpoint, params, config).request!
+        end
+      end
+    end
+
+    # Extracts the main body of article, including embedded media such as
+    # images & videos from a URL and removes all the surrounding clutter.
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The extract endpoint options
+    # @option params [String] :url The URL
+    # @option params [Boolean] :best_image (false)
+    #   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
+    #   on the data returned.
+    #
+    def extract(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :extract)
+      Connection.new(endpoint, params, config).request
+    end
+
+    # Classifies a piece of text according to IPTC NewsCode standard.
+    #
+    # @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://aylien.com/text-api-doc#classify for more information
+    #   on the data returned.
+    #
+    def classify(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :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
+    # their semantic types (including DBPedia and schema.org).
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The concepts 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#concepts for more information
+    #   on the data returned.
+    #
+    def concepts(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :concepts)
+      Connection.new(endpoint, params, config).request
+    end
+
+    # Suggests hashtags describing the document.
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The hashtags 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#hashtags for more information
+    #   on the data returned.
+    #
+    def hashtags(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :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)
+    # mentioned in a body of text.
+    #
+    # @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://aylien.com/text-api-doc#entities for more information
+    #   on the data returned.
+    #
+    def entities(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :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.
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The language endpoint options
+    # @option params [String] :url The URL
+    # @option params [String] :text Text
+    #
+    # @return [Hash, nil] A hash of result. See
+    #   http://aylien.com/text-api-doc#language for more information
+    #   on the data returned.
+    #
+    def language(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :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").
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The sentiment endpoint options
+    # @option params [String] :url The URL
+    # @option params [String] :text Text
+    # @option params [String] :mode ('tweet') Analyze mode.
+    #   Valid options are tweet, and document.
+    #
+    # @return [Hash, nil] A hash of result. See
+    #   http://aylien.com/text-api-doc#sentiment for more information
+    #   on the data returned.
+    #
+    def sentiment(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :sentiment)
+      Connection.new(endpoint, params, config).request
+    end
+
+    # Summarizes an article into a few key sentences.
+    #
+    # @param [String] value (nil) URL or Text
+    # @param [Hash] params The summarize endpoint options
+    # @option params [String] :mode ('default') Analyze mode.
+    #   Valid options are default and short.
+    #   short mode produces shorter sentences.
+    # @option params [String] :url The URL
+    # @option params [String] :title Title
+    # @option params [String] :text Text
+    # @option params [Integer] :sentences_number (5) Number of sentences
+    #   to be returned. Only in default mode (not applicable to short mode).
+    #   Also has precedence over sentences_percentage.
+    # @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.
+    #
+    # @return [Hash, nil] A hash of result. See
+    #   http://aylien.com/text-api-doc#summarize for more information
+    #   on the data returned.
+    #
+    def summarize(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :summarize)
+      Connection.new(endpoint, params, config).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://aylien.com/text-api-doc#related for more information
+    #   on the data returned.
+    #
+    def related(value=nil, params={})
+      endpoint, params, config = common_endpoint(value, params, :related)
+      Connection.new(endpoint, params, config).request
+    end
+
+    private
+
+    def validate_uri(value)
+      value =~ /^(http|https):\/\/[a-z0-9]+([\-\.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?$/ix
+    end
+
+    def common_endpoint(value, params, endpoint)
+      if value.is_a?(Hash)
+        params = value
+        value = nil
+      end
+      if value && (!params[:url] || !params[:text] && !params[:title])
+        value.strip!
+        if validate_uri(value)
+          params[:url] = value
+        elsif endpoint == :related
+          params[:phrase] = value
+        else
+          params[:text] = value
+        end
+      end
+      config = {}
+      Configuration::VALID_CONFIG_KEYS.each do |key|
+        config[key] = send(key)
+      end
+      [endpoint, params, config]
+    end
+  end # Client
+end