MIT-LICENSE @@ -1,4 +1,5 @@ == 0.0.1 -* Access to Open Calais's Enlighten action -* Single point of access to process a document +* Access to Calais's Enlighten action +* Single method to process a document + * Get relationships and names from a document History.txt @@ -1,19 +1,14 @@ -Calais - by Abhay Kumar - http://opensynapse.net +== Calais +A Ruby interface to the Open Calais Web Service (http://opencalais.com) -== DESCRIPTION: - -A Ruby interface to the Open Calais API (http://opencalais.com) - -== FEATURES/PROBLEMS: +== Features * Accepts documents in text/plain, text/xml and text/html format. * Basic access to the Open Calais API's Enlighten action. * Output is RDF representation of input document. * Single function ability to tag a document and receive a response in RDF format, names in the document, and their relationships. -== SYNOPSIS: +== Synopsis This is a very basic wrapper to the Open Calais API. It uses the POST endpoint and currently supports the Enlighten action. Here's a simple call: @@ -27,37 +22,18 @@ If you want to do something more fun like getting all sorts of fun information a This will return an object containing the RDF representation of the text, the names in the text, and any relationships that exist there. -== REQUIREMENTS: +== Requirements * Ruby 1.8.5 or better * Uses the following standard libraries: digest/sha1, net/http, yaml, cgi * Hpricot -== INSTALL: +== Install TODO -== LICENSE: - -(The MIT License) - -Copyright (c) 2008 Abhay Kumar - -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: +== Authors -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. +Abhay Kumar +http://opensynapse.net -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. README.txt @@ -9,10 +9,10 @@ require './lib/calais.rb' Hoe.new('calais', Calais::VERSION) do |p| p.rubyforge_name = 'calais' p.author = 'Abhay Kumar' + p.summary = 'A Ruby interface to the Calais Web Service' + p.description = p.paragraphs_of('README.txt', 1..9).join("\n\n") p.email = 'info@opensynapse.net' - p.summary = 'A Ruby library to access the OpenCalais service' - p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n") - p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1] + p.url = 'http://calais.rubyforge.org' p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n") p.remote_rdoc_dir = '' end Rakefile f3d15fee29e8c77c8f0851db89a8e0f5f965c986 Abhay Kumar abhay+git@opensynapse.net http://github.com/abhay/calais/commit/05f4ed919d884cdeb11702b04e2830d70caa4800 05f4ed919d884cdeb11702b04e2830d70caa4800 2008-02-02T21:35:04-08:00 2008-02-02T21:35:04-08:00 getting ready for release 3157a36947d510be7de65ba47a0b18a28ce5cb9c Abhay Kumar abhay+git@opensynapse.net