RubyGems - alchemy-api-rb - Versions diffs - 0.1.0 - Mend

alchemy-api-rb 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (57) hide show

data/.gitignore +19 -0
data/Gemfile +4 -0
data/LICENSE +22 -0
data/README.md +80 -0
data/Rakefile +11 -0
data/alchemy-api-rb.gemspec +24 -0
data/lib/alchemy-api.rb +47 -0
data/lib/alchemy-api/author_extraction.rb +21 -0
data/lib/alchemy-api/base.rb +78 -0
data/lib/alchemy-api/concept_tagging.rb +16 -0
data/lib/alchemy-api/config.rb +34 -0
data/lib/alchemy-api/entity_extraction.rb +15 -0
data/lib/alchemy-api/keyword_extraction.rb +15 -0
data/lib/alchemy-api/language_detection.rb +17 -0
data/lib/alchemy-api/relation_extraction.rb +16 -0
data/lib/alchemy-api/sentiment_analysis.rb +16 -0
data/lib/alchemy-api/text_categorization.rb +21 -0
data/lib/alchemy-api/text_extraction.rb +19 -0
data/lib/alchemy-api/version.rb +3 -0
data/spec/alchemy_api_spec.rb +70 -0
data/spec/author_extraction_spec.rb +43 -0
data/spec/base_spec.rb +20 -0
data/spec/concept_tagging_spec.rb +44 -0
data/spec/entity_extraction_spec.rb +44 -0
data/spec/keyword_extraction_spec.rb +50 -0
data/spec/language_detection_spec.rb +43 -0
data/spec/relation_extraction_spec.rb +44 -0
data/spec/sentiment_analysis_spec.rb +43 -0
data/spec/spec_helper.rb +13 -0
data/spec/text_categorization_spec.rb +43 -0
data/spec/text_extraction_spec.rb +32 -0
data/spec/vcr_cassettes/author_basic_html_json_search.yml +46 -0
data/spec/vcr_cassettes/author_basic_url_json_search.yml +47 -0
data/spec/vcr_cassettes/category_basic_html_json_search.yml +43 -0
data/spec/vcr_cassettes/category_basic_text_json_search.yml +46 -0
data/spec/vcr_cassettes/category_basic_url_json_search.yml +46 -0
data/spec/vcr_cassettes/concept_basic_html_json_search.yml +54 -0
data/spec/vcr_cassettes/concept_basic_text_json_search.yml +55 -0
data/spec/vcr_cassettes/concept_basic_url_json_search.yml +75 -0
data/spec/vcr_cassettes/entity_basic_html_json_search.yml +61 -0
data/spec/vcr_cassettes/entity_basic_text_json_search.yml +60 -0
data/spec/vcr_cassettes/entity_basic_url_json_search.yml +71 -0
data/spec/vcr_cassettes/keyword_basic_html_json_search.yml +48 -0
data/spec/vcr_cassettes/keyword_basic_text_json_search.yml +48 -0
data/spec/vcr_cassettes/keyword_basic_url_json_search.yml +67 -0
data/spec/vcr_cassettes/language_basic_html_json_search.yml +49 -0
data/spec/vcr_cassettes/language_basic_text_json_search.yml +49 -0
data/spec/vcr_cassettes/language_basic_url_json_search.yml +49 -0
data/spec/vcr_cassettes/relation_basic_html_json_search.yml +53 -0
data/spec/vcr_cassettes/relation_basic_text_json_search.yml +53 -0
data/spec/vcr_cassettes/relation_basic_url_json_search.yml +58 -0
data/spec/vcr_cassettes/sentiment_basic_html_json_search.yml +48 -0
data/spec/vcr_cassettes/sentiment_basic_text_json_search.yml +48 -0
data/spec/vcr_cassettes/sentiment_basic_url_json_search.yml +48 -0
data/spec/vcr_cassettes/text_basic_html_json_search.yml +47 -0
data/spec/vcr_cassettes/text_basic_url_json_search.yml +47 -0
metadata +196 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.keys

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in alchemy-api-rb.gemspec
+gemspec

data/LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Allen
+MIT License
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md ADDED Viewed

@@ -0,0 +1,80 @@
+# AlchemyAPI
+This is a Ruby Client Library that provides access to the Alchemy text mining API. The initial version targets the following API's:
+* Keyword Extraction
+* Text Extraction
+* Entity Extraction
+* Sentiment Analysis
+* Concept Tagging
+* Text Categorization
+* Language Detection
+* Author Extraction
+Not yet implemented API's:
+* Content Scraping
+* Microformats
+* RSS / ATOM
+## Installation
+Add this line to your application's Gemfile:
+    gem 'alchemy-api-rb'
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install alchemy-api-rb
+## Usage
+Set your API Key in an initializer or something similar:
+    AlchemyAPI.key = "xxxxxxxxxxxxxxxxxx"
+You may set the key along with other config settings:
+    AlchemyAPI.configure do |config|
+      config.key = "xxxxxxxxxxxxxxxxxx"
+      config.output_mode = :xml # not yet supported
+    end
+Request keyword extraction for a string of text:
+    results = AlchemyAPI.search(:keyword_extraction, :text => "hello world")
+or
+    results = AlchemyAPI::KeywordExtraction.search(:url => "http://www.alchemyapi.com/")
+or
+    results = AlchemyAPI::KeywordExtraction.search(:html => "<html><body>lorem ipsum</body></html>")
+Results for keyword extraction are returned as a array of keywords:
+    [
+      {
+             "text" => "lorem ipsum",
+        "relevance" => "0.993164"
+      }
+    ]
+## TODO
+1. Add missing Alchmey API search modes
+2. Add the ability to search all supported API's in a single request?
+3. Add support for raw output (JSON, XML and RDF)?
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile ADDED Viewed

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+task :default => [:test]
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end

data/alchemy-api-rb.gemspec ADDED Viewed

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/alchemy-api/version', __FILE__)
+Gem::Specification.new do |gem|
+  gem.authors       = ["John Allen"]
+  gem.email         = ["john.allen@technekes.com"]
+  gem.description   = %q{Provides access to the Alchemy text mining API - http://www.alchemyapi.com/}
+  gem.summary       = %q{This is a ruby client library that provides access to the Alechemy text mining API. The initial version targets the keyword extraction api specificaly, with other implementations to follow.}
+  gem.homepage      = "https://github.com/technekes/alchemy-api-rb"
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "alchemy-api-rb"
+  gem.require_paths = ["lib"]
+  gem.version       = AlchemyAPI::VERSION
+  gem.add_dependency             'faraday',             '~> 0.8.1'
+  gem.add_development_dependency 'rake',                '~> 0.9.2'
+  gem.add_development_dependency 'turn',                '~> 0.9.5'
+  gem.add_development_dependency 'vcr',                 '~> 2.2.0'
+  gem.add_development_dependency 'fakeweb',             '~> 1.3.0'
+end

data/lib/alchemy-api.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require "alchemy-api/version"
+require "alchemy-api/config"
+require "alchemy-api/base"
+require "alchemy-api/keyword_extraction"
+require "alchemy-api/text_extraction"
+require "alchemy-api/entity_extraction"
+require "alchemy-api/sentiment_analysis"
+require "alchemy-api/relation_extraction"
+require "alchemy-api/concept_tagging"
+require "alchemy-api/text_categorization"
+require "alchemy-api/language_detection"
+require "alchemy-api/author_extraction"
+module AlchemyAPI
+  BASE_URL = "http://access.alchemyapi.com/calls/"
+  def self.config
+    Config
+  end
+  def self.configure
+    block_given? ? yield(Config) : Config
+  end
+  def self.key
+    Config.apikey
+  end
+  def self.key=(value)
+    Config.apikey = value
+  end
+  def self.search(mode, opts)
+    klass = Config.modes[mode]
+    raise InvalidAPIKey.new unless Config.apikey
+    raise InvalidSearchMode.new unless klass
+    klass.new.search(opts)
+  end
+  class UnknownError < StandardError; end
+  class MissingOptionsError < StandardError; end
+  class InvalidAPIKey < StandardError; end
+  class InvalidSearchMode < StandardError; end
+  class InvalidOutputMode < StandardError; end
+end

data/lib/alchemy-api/author_extraction.rb ADDED Viewed

@@ -0,0 +1,21 @@
+module AlchemyAPI
+  class AuthorExtraction < Base
+    Config.add_mode :author_extraction, self
+    def web_method
+      "#{method_prefix}GetAuthor"
+    end
+    private
+    def supported_search_types
+      [:html, :url]
+    end
+    def indexer
+      nil
+    end
+  end
+end

data/lib/alchemy-api/base.rb ADDED Viewed

@@ -0,0 +1,78 @@
+require 'json/ext'
+require 'faraday'
+module AlchemyAPI
+  class Base
+    attr_accessor :options, :response
+    def search(opts)
+      check_options(opts)
+      @response = connection.post(path, construct_body)
+      parsed_response
+    end
+    def parsed_response
+      case Config.output_mode
+      when :json
+        parsed = JSON.parse(@response.body)
+        indexer ? parsed[indexer] : parsed
+      when :xml
+      when :rdf
+        raise NotImplementedError.new
+      end
+    end
+    def merged_options(opts)
+      opts.merge(Config.default_options)
+    end
+    private
+    def check_options(opts)
+      @options = opts
+      raise MissingOptionsError.new unless options && options.keys
+      unless supported_search_types.include?(mode)
+        raise UnsupportedSearchMode.new
+      end
+    end
+    def connection
+      @connection ||= Faraday.new(url: BASE_URL)
+    end
+    def supported_search_types
+      [:text, :url, :html]
+    end
+    def mode
+      [:text, :url, :html].each do |type|
+        return type if options.keys && options.keys.include?(type)
+      end
+      raise MissingOptionsError.new
+    end
+    def method_prefix
+      case mode
+      when :text then "Text"
+      when :url then "URL"
+      when :html then "HTML"
+      end
+    end
+    def path
+      "#{mode}/#{web_method}"
+    end
+    def construct_body
+      body = { apikey: Config.apikey }.merge!(merged_options(options))
+      body.map { |e| e.join('=') }.join('&')
+    end
+  end
+end

data/lib/alchemy-api/concept_tagging.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module AlchemyAPI
+  class ConceptTagging < Base
+    Config.add_mode :concept_tagging, self
+    def web_method
+      "#{method_prefix}GetRankedConcepts"
+    end
+    private
+    def indexer
+      "concepts"
+    end
+  end
+end

data/lib/alchemy-api/config.rb ADDED Viewed

@@ -0,0 +1,34 @@
+module AlchemyAPI
+  class Config
+    class << self
+      attr_accessor :apikey
+      attr_accessor :modes
+    end
+    def self.add_mode(key, klass)
+      @modes = {} unless @modes
+      @modes[key] = klass
+    end
+    def self.default_options
+      {
+        :outputMode => output_mode
+      }
+    end
+    def self.output_mode
+      @output_mode || :json
+    end
+    def self.output_mode=(value)
+      raise InvalidOutputMode.new unless valid_output_modes.include?(value.to_s)
+      @output_mode = value
+    end
+    def self.valid_output_modes
+      ["xml", "json", "rdf", "rel-tag", "rel-tag-raw"]
+    end
+  end
+end

data/lib/alchemy-api/entity_extraction.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module AlchemyAPI
+  class EntityExtraction < Base
+    Config.add_mode :entity_extraction, self
+    def web_method
+      "#{method_prefix}GetRankedNamedEntities"
+    end
+    private
+    def indexer
+      "entities"
+    end
+  end
+end

data/lib/alchemy-api/keyword_extraction.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module AlchemyAPI
+  class KeywordExtraction < Base
+    Config.add_mode :keyword_extraction, self
+    def web_method
+      "#{method_prefix}GetRankedKeywords"
+    end
+    private
+    def indexer
+      "keywords"
+    end
+  end
+end

data/lib/alchemy-api/language_detection.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module AlchemyAPI
+  class LanguageDetection < Base
+    Config.add_mode :language_detection, self
+    def web_method
+      "#{method_prefix}GetLanguage"
+    end
+    private
+    def indexer
+      nil
+    end
+  end
+end

data/lib/alchemy-api/relation_extraction.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module AlchemyAPI
+  class RelationExtraction < Base
+    Config.add_mode :relation_extraction, self
+    def web_method
+      "#{method_prefix}GetRelations"
+    end
+    private
+    def indexer
+      "relations"
+    end
+  end
+end