semantic_extraction 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Vannoy
+
+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.rdoc

@@ -0,0 +1,37 @@
+= semantic_extraction
+
+Extract meaningful information from unstructured text with Ruby.
+
+Using a variety of APIs (Yahoo Term Extractor and Alchemy are currently supported), semantic_extraction can automatically return a collection of keywords for an arbitrary block of text. If you use Alchemy, it can also return named entities.
+
+== The APIs in use
+
+* [Yahoo Term Extractor](http://developer.yahoo.com/search/content/V1/termExtraction.html)
+
+* [Alchemy API](http://www.alchemyapi.com/api/)
+
+== Upcoming To-Dos
+
+* Add support for [OpenCalais](http://www.opencalais.com/documentation/opencalais-documentation)
+
+* Flesh out the rest of the Alchemy API
+
+* Make it possible to dynamically pick with API to use (so its possible to use multiple APIs in the same app)
+
+* Make it less fugly.
+
+* Tests, tests and more tests.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Chris Vannoy. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "semantic_extraction"
+    gem.summary = %Q{Extract meaningful information from unstructured text with Ruby}
+    gem.description = %Q{Using a variety of APIs (Yahoo term Extractor and Alchemy are currently supported), semantic_extraction can automatically return a collection of keywords for an arbitrary block of text. If using Alchemy, it can also return named entities.}
+    gem.email = "chris@chrisvannoy.com"
+    gem.homepage = "http://github.com/dummied/semantic_extraction"
+    gem.authors = ["Chris Vannoy"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_dependency "ruby_tubesday"
+    gem.add_dependency "nokogiri"
+    gem.add_dependency "extlib"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "semantic_extraction #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/semantic_extraction/extractors/alchemy.rb

@@ -0,0 +1,41 @@
+module SemanticExtraction
+  class Alchemy
+    STARTER = "http://access.alchemyapi.com/calls/"
+        
+    def self.find_keywords(text)
+      prefix = (SemanticExtraction.is_url?(text) ? "url" : "text")
+      endpoint = (prefix == "url" ? "URL" : "Text") + "GetKeywords"
+      url = STARTER + prefix + "/" + endpoint
+      raw = SemanticExtraction.post(url, text, prefix, SemanticExtraction::ALCHEMY_API_KEY)
+      h = Nokogiri::XML(raw)
+      if (h/"keywords keyword")
+        keywords = []
+        (h/"keywords keyword").each do |p|
+          keywords << p.text
+        end
+      end
+      return keywords
+    end
+    
+    def self.find_entities(text)
+      prefix = (SemanticExtraction.is_url?(text) ? "url" : "text")
+      endpoint = (prefix == "url" ? "URL" : "Text") + "GetRankedNamedEntities"
+      url = STARTER + prefix + "/" + endpoint
+      raw = SemanticExtraction.post(url, text, prefix, SemanticExtraction::ALCHEMY_API_KEY)
+      h = Nokogiri::XML(raw)
+      if (h/"entities entity")
+        entities = []
+        (h/"entities entity").each do |p|
+          hashie = Hash.from_xml(p.to_s)["entity"]
+          typer = hashie.delete("type")
+          if typer
+            hashie["entity_type"] = typer
+          end
+          entities << OpenStruct.new(hashie)
+        end
+      end
+      return entities
+    end
+
+  end
+end

data/lib/semantic_extraction/extractors/yahoo.rb

@@ -0,0 +1,19 @@
+module SemanticExtraction
+  class Yahoo
+    STARTER = "http://api.search.yahoo.com/ContentAnalysisService/V1/termExtraction"
+        
+    def self.find_keywords(text)
+      prefix = 'context'
+      raw = SemanticExtraction.post(STARTER, text, prefix, SemanticExtraction::YAHOO_API_KEY, :appid)
+      h = Nokogiri::XML(raw)
+      if (h/"Result")
+        keywords = []
+        (h/"Result").each do |p|
+          keywords << p.text
+        end
+      end
+      return keywords
+    end
+
+  end
+end

data/lib/semantic_extraction.rb

@@ -0,0 +1,73 @@
+require 'ruby_tubesday'
+require 'nokogiri'
+require 'extlib'
+require 'ostruct'
+
+module SemanticExtraction
+  
+  # We'll automatically require any extractors in the ./semantic_extraction/extractors directory.
+  # And, yes, I know there has to be a better way to handle this. Let me know before I get fed up and Google furiously.  
+  Dir.entries("./semantic_extraction/extractors").each_with_index do |p, index|
+    unless [0,1].include? index
+      require "./semantic_extraction/extractors/" + p.sub(".rb", "")
+    end
+  end
+  
+  # Thrown when you're lacking an api key for the particular api you're using.
+  class MissingApiKey < StandardError; end
+  
+  # Thrown when the api you're using doesn't support the method you're attempting.
+  # This will become more important when we start mapping out all of the other features in the Alchemy API
+  class NotSupportedExtraction < StandardError; end
+  
+  # By default, we assume you want to use Alchemy.
+  # To override, just set SemanticExtraction::PREFERRED_EXTRACTOR somewhere.
+  def self.preferred_extractor
+    defined?(PREFERRED_EXTRACTOR) ? PREFERRED_EXTRACTOR : "alchemy"
+  end
+  
+  HTTP = RubyTubesday.new
+  
+  # Will return an array of keywords gleaned from the text you pass in.
+  # Both Yahoo and Alchemy will handle a block of text, but Alchemy can also handle a plain URL.  
+  def self.find_keywords(text)
+    klass = SemanticExtraction.const_get(self.preferred_extractor.capitalize)
+    if klass.respond_to?(:find_keywords) && defined?(self.preferred_extractor.upcase + "_API_KEY")
+      return klass.find_keywords(text)
+    elsif !klass.respond_to?(:find_keywords)
+      raise NotSupportedExtraction
+    else
+      raise MissingApiKey
+    end
+  end
+  
+  # Will return an array of OpenStruct representing the named entities from the text.
+  # At the moment, Alchemy is the only one to support this.
+  # Down the road, we'll add in OpenCalais and others.
+  def self.find_entities(text)
+    klass = SemanticExtraction.const_get(self.preferred_extractor.capitalize)
+    if klass.respond_to?(:find_entities) && defined?(self.preferred_extractor.upcase + "_API_Key")
+      return klass.find_entities(text)
+    elsif !klass.respond_to?(:find_entities)
+      raise NotSupportedExtraction
+    else
+      raise MissingApiKey
+    end
+  end
+  
+  # Posts the url to the API.
+  def self.post(url, target, calling_param, api_key, api_param="apikey".to_sym)
+    HTTP.post(url, :params => {calling_param => target, api_param => api_key} )
+  end
+  
+  # Checks to see if a string is a URL.
+  # This is really dumb at the moment, and will likely be refactored in future releases.
+  def self.is_url?(link)
+    if link[0..3] == "http"
+      return true
+    else
+      return false
+    end
+  end
+  
+end

data/semantic_extraction.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{semantic_extraction}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Vannoy"]
+  s.date = %q{2010-03-10}
+  s.description = %q{Using a variety of APIs (Yahoo term Extractor and Alchemy are currently supported), semantic_extraction can automatically return a collection of keywords for an arbitrary block of text. If using Alchemy, it can also return named entities.}
+  s.email = %q{chris@chrisvannoy.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/semantic_extraction.rb",
+     "lib/semantic_extraction/extractors/alchemy.rb",
+     "lib/semantic_extraction/extractors/yahoo.rb",
+     "semantic_extraction.gemspec",
+     "test/helper.rb",
+     "test/test_semantic_extraction.rb"
+  ]
+  s.homepage = %q{http://github.com/dummied/semantic_extraction}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Extract meaningful information from unstructured text with Ruby}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_semantic_extraction.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<ruby_tubesday>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<extlib>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<ruby_tubesday>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<extlib>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<ruby_tubesday>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<extlib>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'semantic_extraction'
+
+class Test::Unit::TestCase
+end

data/test/test_semantic_extraction.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSemanticExtraction < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: semantic_extraction
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Vannoy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby_tubesday
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Using a variety of APIs (Yahoo term Extractor and Alchemy are currently supported), semantic_extraction can automatically return a collection of keywords for an arbitrary block of text. If using Alchemy, it can also return named entities.
+email: chris@chrisvannoy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/semantic_extraction.rb
+- lib/semantic_extraction/extractors/alchemy.rb
+- lib/semantic_extraction/extractors/yahoo.rb
+- semantic_extraction.gemspec
+- test/helper.rb
+- test/test_semantic_extraction.rb
+has_rdoc: true
+homepage: http://github.com/dummied/semantic_extraction
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Extract meaningful information from unstructured text with Ruby
+test_files: 
+- test/helper.rb
+- test/test_semantic_extraction.rb