calais 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,11 @@
+== 0.0.2
+
+* cleanup in the specs
+* cleaner parsing
+* location of named entities
+* more data in relationships
+* moved Names and Relationships
+
 == 0.0.1
 
 * Access to Calais's Enlighten action

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Abhay Kumar info@opensynapse.net
+
+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/Manifest.txt

@@ -1,9 +1,12 @@
 History.txt
+MIT-LICENSE
 Manifest.txt
 README.txt
 Rakefile
 lib/calais.rb
 lib/calais/client.rb
+lib/calais/name.rb
+lib/calais/relationship.rb
 lib/calais/response.rb
 spec/calais_spec.rb
 spec/fixtures/.gitignore

data/README.txt

@@ -30,7 +30,7 @@ This will return an object containing the RDF representation of the text, the na
 
 == Install
 
-TODO
+You can install the Calais gem via Rubygems (gem install calais) or by building from source.
 
 == Authors
 

data/lib/calais.rb

@@ -43,5 +43,5 @@ module Calais
 end
 
 module Calais
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/calais/name.rb

@@ -0,0 +1,13 @@
+module Calais
+  class Name
+    attr_accessor :name, :type, :hash, :locations
+    
+    def initialize(args={})
+      args.each {|k,v| send("#{k}=", v)}
+    end
+    
+    def self.find_in_names(hash, names)
+      names.select {|name| name.hash == hash }.first
+    end
+  end
+end

data/lib/calais/relationship.rb

@@ -0,0 +1,9 @@
+module Calais
+  class Relationship
+    attr_accessor :type, :hash, :metadata, :locations
+    
+    def initialize(args={})
+      args.each {|k,v| send("#{k}=", v)}
+    end
+  end
+end

data/lib/calais/response.rb

@@ -8,38 +8,14 @@ module Calais
       @relationships = []
 
       parse_rdf(raw)
-      parse_names
-      parse_relationships
-    end
-    
-    def to_dot
-      used = []
-      id = @hpricot.at("rdf:Description//c:document//..").attributes["c:externalID"]
-      
-      dot = "digraph \"#{id}\"\n"
-      dot += "{\n"
-      dot += "\tgraph [rankdir=LR, overlap=false];\n"
-      dot += "\tnode [shape = circle];"
+      return if @error
 
-      @relationships.each do |rel|
-        dot += "\t\"#{rel.actor.name}\" -> \"#{rel.target.name}\""
-        dot += " ["
-        dot += "label=\""
-        dot += "#{rel.metadata} " if rel.metadata
-        dot += "(#{rel.type})"
-        dot += "\"];\n"
-        used |= [rel.actor.hash, rel.target.hash]
-      end
-      
-      @names.each do |name|
-        dot += "\t\"#{name.name}\";\n" unless used.include?(name.hash)
-      end
-      dot += "}\n"
-      
-      f = File.open("#{id}.dot", 'w')
-      f.puts dot
-      f.close
-      
+      h_doc = Hpricot.XML(@rdf)
+      document_node = h_doc.root.search("//rdf:Description//c:document//..").remove.first
+      signature_node = h_doc.root.search("//rdf:Description//c:signature//..").remove.first
+      language_node = h_doc.root.search("//rdf:Description//c:lang//..").remove.first
+      h_doc = parse_names(h_doc)
+      h_doc = parse_relationships(h_doc)
     end
     
     private
@@ -49,59 +25,72 @@ module Calais
         @error = Hpricot.XML(response).at("/Error/Exception").inner_html rescue @error
       end
       
-      def parse_names
-        @names = @hpricot.root.search("rdf:Description//c:name//..").map do |ele|
-          Calais::Response::Name.new(
-            :name => ele.at("c:name").inner_html,
-            :hash => ele.attributes["rdf:about"].split('/').last,
-            :type => ele.at("rdf:type").attributes["rdf:resource"].split('/').last
-          )
-        end unless @error
-      end
-      
-      def parse_relationships
-        doc = Hpricot.XML(@rdf)
-        doc.search("rdf:Description//c:docId//..").remove
-        doc.search("rdf:Description//c:document//..").remove
-        doc.search("rdf:Description//c:name//..").remove
-        
-        @relationships = doc.root.search("rdf:Description").map do |ele|
-          relationship = ele.at("rdf:type")
-          actor = relationship.next_sibling
-          metadata = actor.next_sibling.attributes["rdf:resource"] ? nil : actor.next_sibling.inner_html.strip
-          target = metadata ? actor.next_sibling.next_sibling : actor.next_sibling
+      def parse_names(doc)
+        name_elements = doc.root.search("//rdf:Description//c:name//..")
+        @names = name_elements.map do |ele|
+          name = ele.at("c:name").inner_html
+          type = ele.at("rdf:type").attributes["rdf:resource"].split("/").last
+          hash = ele.attributes["rdf:about"].split("/").last
           
-          actor_name = actor ? Name.find_in_names(actor.attributes["rdf:resource"].split('/').last, @names) : nil
-          target_name = target ? Name.find_in_names(target.attributes["rdf:resource"].split('/').last, @names) :  nil
-
-          Calais::Response::Relationship.new(
-            :type => relationship.attributes["rdf:resource"].split('/').last,
-            :actor => actor_name,
-            :target => target_name,
-            :metadata => metadata
+          detection_nodes = doc.root.search("//rdf:Description//c:subject//..").collect! do |ele|
+            ele unless ele.at("c:subject").attributes["rdf:resource"].match(hash).nil?
+          end.compact
+          
+          locations = detection_nodes.map do |ele|
+            start = ele.at("c:offset").inner_html.to_i
+            Range.new(start, start+ele.at("c:length").inner_html.to_i)
+          end
+          
+          detection_nodes.remove
+          
+          Name.new(
+            :name => name,
+            :hash => hash,
+            :type => type,
+            :locations => locations
           )
         end
-      end
-    
-    class Name
-      include Comparable
-      attr_accessor :name, :type, :hash
-      
-      def initialize(args={})
-        args.each {|k,v| send("#{k}=", v)}
+        name_elements.remove
+        
+        doc
       end
       
-      def self.find_in_names(hash, names)
-        names.select {|name| name.hash == hash }.first
-      end
-    end
-    
-    class Relationship
-      attr_accessor :type, :actor, :target, :metadata
-      
-      def initialize(args={})
-        args.each {|k,v| send("#{k}=", v)}
+      def parse_relationships(doc)
+        relationship_elements = doc.root.search("rdf:Description")
+        @relationships = relationship_elements.map do |ele|
+          next if ele.at("c:docId")
+
+          hash = ele.attributes["rdf:about"].split("/").last
+          type = ele.at("rdf:type").attributes["rdf:resource"].split("/").last
+          metadata = {}
+          ele.children.each do |child|
+            next if child.comment? || child.name == "rdf:type"
+            
+            value = if child.attributes["rdf:resource"]
+                Name.find_in_names(child.attributes["rdf:resource"].split("/").last, @names) rescue nil
+              else
+                child.inner_html.strip
+              end
+            metadata[child.name.split(":").last] = value
+          end
+          
+          locations = doc.root.search("//rdf:Description//c:docId//..").collect! do |ele|
+            ele unless ele.at("c:subject").attributes["rdf:resource"].match(hash).nil?
+          end.compact.map do |ele|
+            start = ele.at("c:offset").inner_html.to_i
+            Range.new(start, start+ele.at("c:length").inner_html.to_i)
+          end
+          
+          Relationship.new(
+            :type => type,
+            :hash => hash,
+            :metadata => metadata,
+            :locations => locations
+          )
+        end.compact
+        relationship_elements.remove
+        
+        doc
       end
-    end
   end
 end

data/spec/calais_spec.rb

@@ -36,17 +36,25 @@ describe Calais::Client, ".new" do
 end
 
 describe Calais, ".process_document" do
+  before(:all) { @response = Calais.process_document(:content => SAMPLE_DOCUMENT, :content_type => :xml, :license_id => LICENSE_ID) }
+
   it "returns a Calais::Response" do
-    response = Calais.process_document(:content => SAMPLE_DOCUMENT, :content_type => :xml, :license_id => LICENSE_ID)
-    response.should_not be_nil
-    response.should be_a_kind_of(Calais::Response)
+    @response.should_not be_nil
+    @response.should be_a_kind_of(Calais::Response)
   end
-
-  it "returns a Calais::Response (with relationships)" do
-    response = Calais.process_document(:content => File.read(File.join(File.dirname(__FILE__), 'fixtures', 'bicycles_austrailia.xml')), :content_type => :xml, :license_id => LICENSE_ID)
-    response.should_not be_nil
-    response.should be_a_kind_of(Calais::Response)
+  
+  it "returns names" do
+    @response.names.should_not be_nil
+    @response.names.should_not be_empty
+    @response.names.map {|n| n.name }.sort.should  == ["Australia", "Australia", "Cycling Promotion Fund", "Ian Christie", "car manufacturers", "car market", "car sales", "company car"]
   end
+  
+  it "returns relationships" do
+    @response.relationships.should_not be_nil
+    @response.relationships.should_not be_empty
+    @response.relationships.map {|r| r.type }.should == ["PersonProfessional"]
+  end
+
 end
 
 describe Calais::Client, ".call" do
@@ -67,6 +75,6 @@ describe Calais::Client, ".params_xml" do
   it "returns an xml encoded string" do
     client = Calais::Client.new(:content => SAMPLE_DOCUMENT, :content_type => :xml, :license_id => LICENSE_ID)
     client.send("params_xml").should_not be_nil
-    client.send("params_xml").should == %[<c:params xmlns:c=\"http://s.opencalais.com/1/pred/\" xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"><c:processingDirectives c:contentType=\"TEXT/XML\" c:outputFormat=\"XML/RDF\"></c:processingDirectives><c:userDirectives c:allowDistribution=\"false\" c:allowSearch=\"false\" c:externalID=\"dc68d5a382724c2238d9f22ba9c0b4d2581569d8\" c:submitter=\"calais.rb\"></c:userDirectives><c:externalMetadata></c:externalMetadata></c:params>]
+    client.send("params_xml").should == %[<c:params xmlns:c=\"http://s.opencalais.com/1/pred/\" xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"><c:processingDirectives c:contentType=\"TEXT/XML\" c:outputFormat=\"XML/RDF\"></c:processingDirectives><c:userDirectives c:allowDistribution=\"false\" c:allowSearch=\"false\" c:externalID=\"4a661f3cd285d43fa4df971e14e623eb51748e27\" c:submitter=\"calais.rb\"></c:userDirectives><c:externalMetadata></c:externalMetadata></c:params>]
   end
 end

data/spec/helper.rb

@@ -4,5 +4,5 @@ require 'yaml'
 
 require File.dirname(__FILE__) + '/../lib/calais'
 
-SAMPLE_DOCUMENT = File.read(File.join(File.dirname(__FILE__), 'fixtures/slovenia_euro.xml'))
+SAMPLE_DOCUMENT = File.read(File.join(File.dirname(__FILE__), 'fixtures/bicycles_austrailia.xml'))
 LICENSE_ID = YAML.load(File.read(File.join(File.dirname(__FILE__), 'fixtures/calais.yml')))['key']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: calais
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Abhay Kumar
@@ -30,7 +30,7 @@ cert_chain:
   +keKvrmaTOJ7CQ==
   -----END CERTIFICATE-----
 
-date: 2008-02-02 00:00:00 -08:00
+date: 2008-02-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,11 +54,14 @@ extra_rdoc_files:
 - README.txt
 files: 
 - History.txt
+- MIT-LICENSE
 - Manifest.txt
 - README.txt
 - Rakefile
 - lib/calais.rb
 - lib/calais/client.rb
+- lib/calais/name.rb
+- lib/calais/relationship.rb
 - lib/calais/response.rb
 - spec/calais_spec.rb
 - spec/fixtures/.gitignore