calais 0.0.2 → 0.0.3

data/History.txt

@@ -1,3 +1,8 @@
+== 0.0.3
+
+* pluginized the library for Rails (via pius: http://gitorious.org/projects/calais-au-rails)
+* added helper methods name entity types from a response (recommendation by pius)
+
 == 0.0.2
 
 * cleanup in the specs

data/Manifest.txt

@@ -3,6 +3,7 @@ MIT-LICENSE
 Manifest.txt
 README.txt
 Rakefile
+init.rb
 lib/calais.rb
 lib/calais/client.rb
 lib/calais/name.rb

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/calais'

data/lib/calais.rb

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

data/lib/calais/name.rb

@@ -2,6 +2,20 @@ module Calais
   class Name
     attr_accessor :name, :type, :hash, :locations
     
+    TYPES = {
+      "cities"                => "City",
+      "companies"             => "Company",
+      "continents"            => "Continent",
+      "countries"             => "Country",
+      "industry_terms"        => "IndustryTerm",
+      "money_amounts"         => "MoneyAmount",
+      "organizations"         => "Organization",
+      "people"                => "Person",
+      "provinces_and_states"  => "ProvinceOrState",
+      "regions"               => "Region",
+      "urls"                  => "URL"
+    }
+    
     def initialize(args={})
       args.each {|k,v| send("#{k}=", v)}
     end

data/lib/calais/response.rb

@@ -18,6 +18,12 @@ module Calais
       h_doc = parse_relationships(h_doc)
     end
     
+    Name::TYPES.each_pair do |method_name, type|
+      define_method method_name.to_sym do
+        @names.map {|name| name if name.type == type }.compact
+      end
+    end
+    
     private
       def parse_rdf(raw)
         @rdf = CGI::unescapeHTML Hpricot.XML(raw).at("/string").inner_html

data/spec/calais_spec.rb

@@ -46,7 +46,7 @@ describe Calais, ".process_document" do
   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"]
+    @response.names.map {|n| n.name }.sort.should  == ["Australia", "Australia", "Cycling Promotion Fund", "Hobart", "Ian Christie", "Tasmania", "car manufacturers", "car market", "car sales", "company car"]
   end
   
   it "returns relationships" do
@@ -75,6 +75,44 @@ 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=\"4a661f3cd285d43fa4df971e14e623eb51748e27\" 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=\"f14fd3588ba6bfb91a9294240d2d081cfbdc079c\" c:submitter=\"calais.rb\"></c:userDirectives><c:externalMetadata></c:externalMetadata></c:params>]
   end
+end
+
+describe "a Calais response, @response" do
+  before(:all) do
+    @response = Calais.process_document(:content => SAMPLE_DOCUMENT, :content_type => :xml, :license_id => LICENSE_ID)
+  end
+  
+  it "returns a list of the people Calais identified (@response.people)" do
+    @response.people.should_not be_nil
+    @response.people.should have(1).people
+    @response.people.first.name.should == "Ian Christie"
+  end
+  
+  it "returns a list of the organizations Calais identified (@response.organizations)" do
+    @response.organizations.should_not be_nil
+    @response.should have(1).organizations
+    @response.organizations.first.name.should == "Cycling Promotion Fund"
+  end
+  
+  it "returns a list of the provinces and states Calais identified (@response.provinces_and_states)" do
+    @response.provinces_and_states.should_not be_nil
+    @response.should have(1).provinces_and_states
+    @response.provinces_and_states.first.name.should == "Tasmania"
+  end
+  
+  it "returns a list of the cities Calais identified (@response.cities)" do
+    @response.cities.should_not be_nil
+    @response.should have(1).cities
+    @response.cities.first.name.should == "Hobart"
+  end
+  
+  it "returns a list of the countries Calais identified (@response.countries)" do
+    @response.countries.should_not be_nil
+    @response.should have(1).countries
+    @response.countries.first.name.should == "Australia"
+  end
+  
+  
 end

data/spec/fixtures/bicycles_austrailia.xml

@@ -7,7 +7,7 @@ Bicycle sales in Australia have recorded record sales of 1,273,781 units for 200
 
 The Cycling Promotion Fund (CPF) spokesman Ian Christie said Australians were increasingly using bicycles as an alternative to cars. Sales rose nine percent in 2006 while the car market stalled. Mr Christie said people were looking to cut their fuel costs and improve their fitness.
 
-Mr Christie said organisations were beginning to supply bicycles as a company vehicle. "There is an emerging trend towards people using bikes as their official company-supplied vehicle in place of the traditional company car," he said.
+Mr Christie, a native of Hobart, Tasmania said organisations were beginning to supply bicycles as a company vehicle. "There is an emerging trend towards people using bikes as their official company-supplied vehicle in place of the traditional company car," he said.
 
 "Some of Australia's biggest corporations now have bicycle fleets, and when you add in government organisations, we now know of at least 50 organisations which operate fleets of bikes."
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: calais
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Abhay Kumar
@@ -58,6 +58,7 @@ files:
 - Manifest.txt
 - README.txt
 - Rakefile
+- init.rb
 - lib/calais.rb
 - lib/calais/client.rb
 - lib/calais/name.rb