evri 0.05 → 0.06

data/lib/evri/entity.rb

@@ -1,7 +1,7 @@
 module Evri
   # Represents an Evri Entity.
   class Entity
-    attr_reader :properties
+    attr_reader :properties, :source_url
 
     # Finds a specific Entity, given an ID.  An Entity is a person, company, product, etc.
     # 
@@ -13,7 +13,7 @@ module Evri
       @results ||= {}
       id = "/" + id 
       return @results[id] if @results[id]
-      @results[id] = create_from_json do 
+      @results[id] = create_one do 
         Evri.query(:type => :uri, :query => id) 
       end
     end
@@ -22,8 +22,8 @@ module Evri
     #  Entity.search "Barack Obama"
     #  Entity.search "Forgetting Sarah Marshall"
     def self.search name
-      create_from_jsons do
-        Evri.query(:type => :search, :query => name)[:entities][:entity]
+      create_many do
+        Evri.query(:type => :search, :query => name)["entities/entity"]
       end
     end
 
@@ -33,8 +33,8 @@ module Evri
     #
     # will likely return an Entity representing Barack Obama.
     def self.search_by_prefix prefix
-      create_from_jsons do
-        Evri.query(:type => :prefix, :query => prefix)[:entities][:entity]
+      create_many do
+        Evri.query(:type => :prefix, :query => prefix)["entities/entity"]
       end
     end
 
@@ -53,16 +53,12 @@ module Evri
       raise ArgumentError, "Must specify URI via the :uri option" unless uri
       raise ArgumentError, "Must specify some text via the :text option" unless text
 
-      create_from_jsons do
+      create_many do
         json = Evri.query(:type => :from_media, :uri => uri, :text => text)
-        json[:graph][:entities][:entity]
+        json["graph/entities/entity"]
       end
     end
 
-    # Returns the URL where the information for this entity came from.
-    def source_url
-      @source_url
-    end
 
     # Returns information about an entity.
     #
@@ -112,14 +108,13 @@ module Evri
 
     # Returns the Evri URI of the entity
     def href
-      #p @parsed_json if !@parsed_json[:href]
       @parsed_json[:href] || target_href
     end
 
     alias id href
     alias uri href
 
-     # TODO
+     # TODO document this
     def target_href
       @parsed_json[:targetHref]
     end
@@ -137,13 +132,19 @@ module Evri
         end
       end
       json = Evri.query(:type => :relations, :query => id, :from_domains => from_domains)
-      json["relations"]["relation"].each do |json|
+      json["relations/relation"].each do |json|
         @relations << Relation.new(json)
       end
       @relations
     end
 
-    # Returns which entities are related to the current entity
+    # Returns which entities are related to the current entity.  
+    # You can pass in :entity, :uri, or a <insert description of verbs, etc>.  You can also specify the type of result to return (image, video, etc).
+    # 
+    #   @obama.related_by(:verb => :kill)      # Returns the entities that are related to Obama by the verb 'kill'
+    #   @obama.related_by(:entity => @mccain)  # Returns the entities that are related to Obama by McCain
+    #   @obama.related_by(:uri => "http://cnn.com/article/here") # Returns the entities that are related to Obama by the given URI
+    #   @obama.related_by(:facet => "politician", :entity => @mccain) 
     def related_by  options={}
       media, verb, verb_value, entity, uri = nil, nil, nil, nil, nil
       options.each do |key, value|
@@ -159,8 +160,8 @@ module Evri
         end
       end
       json = Evri.query(:type => :related_by, :media => media, :query => id, :uri => uri, :entity => entity, :verb => verb, :value => verb_value)
-      Entity.create_from_jsons do
-        json[:relations][:relation][:targets][:entity]
+      Entity.create_many do
+        json["relations/relation/targets/entity"]
       end
     end
 
@@ -178,11 +179,8 @@ module Evri
       end
 
       json = Evri.query(:type => :related_medias, :query => href, :entities => entity_uris, :media => 'image')
-      # TODO handle images here
-      if json["mediaResult"]["imageList"]
-        json["mediaResult"]["imageList"]["image"].each do |media_json|
-          medias << Image.new(media_json)
-        end
+      json["mediaResult/imageList/image"].each do |media_json|
+        medias << Image.new(media_json)
       end
       medias
     end
@@ -202,10 +200,8 @@ module Evri
 
       type = options[:type] ? options[:type] : nil
       json = Evri.query(:type => :related_medias, :query => href, :entities => entity_uris, :media => type)
-      if json["mediaResult"]["articleList"]
-        json["mediaResult"]["articleList"]["article"].each do |media_json|
-          medias << Article.new(media_json)
-        end
+      json["mediaResult/articleList/article"].each do |media_json|
+        medias << Article.new(media_json)
       end
       medias
     end
@@ -213,7 +209,7 @@ module Evri
 
     private
 
-    def self.create_from_json json=nil, &block
+    def self.create_one json=nil, &block
       begin
         json = block.call if block
         Entity.new json["entity"]
@@ -222,7 +218,7 @@ module Evri
       end
     end
     
-    def self.create_from_jsons jsons=nil, &block
+    def self.create_many jsons=nil, &block
       jsons = block.call if block
       return [] unless jsons
       if jsons.multiple?
@@ -236,7 +232,7 @@ module Evri
       @properties = {}
       return unless json[:property]
       json[:property].each do |prop|
-        if prop[:name]
+        unless prop[:name].empty?
           @properties[prop[:name].to_sym] = prop[:value]
         end
       end

data/lib/evri/relation.rb

@@ -14,8 +14,8 @@ module Evri
       return @entities unless @entities.empty?
       json = Evri.query(:type => :uri, :query => @href)
       @entities = 
-        Entity.create_from_jsons do
-          json["relations"]["relation"]["targets"]["entity"]
+        Entity.create_many do
+          json["relations/relation/targets/entity"]
         end
       @entities
     end

data/lib/evri/zeitgeist.rb

@@ -17,8 +17,8 @@ module Evri
         eval %(
           def self.#{t}_#{et}
             json =  Evri.query :type => :zeitgeist, :query => "#{et}/#{t}"
-            Entity.create_from_jsons do
-              json["zeitgeist"]["#{t}"]["entities"]["entity"]
+            Entity.create_many do
+              json["zeitgeist/#{t}/entities/entity"]
             end
           end
         )

data/lib/evri.rb

@@ -1,9 +1,7 @@
-$: << File.dirname(__FILE__) 
 
 require 'uri'
 require 'net/http'
 require 'cgi'
-require 'traverse'
 
 begin
   require 'rubygems' 
@@ -17,6 +15,8 @@ for file in Dir[File.join(File.dirname(__FILE__), 'evri', '*')]
   require file
 end
 
+require File.join(File.dirname(__FILE__), 'traverse')
+
 module Evri
 
   # A general error.
@@ -25,7 +25,7 @@ module Evri
   # Raised whenever the entity you are searching for cannot be found.
   class EntityNotFound < Error; end
 
-  VERSION     = "0.05"
+  VERSION     = "0.06"
   @@api_host    = "api.evri.com"
   @@source_host  = @@api_host
   @@source_url   = nil
@@ -60,75 +60,26 @@ module Evri
     begin
       Traverse.new JSON.parse(json)
     rescue JSON::ParserError => e
-      # puts "Error!"
-      # puts e.message
-      # puts json
       raise Error.new(e)
     end
   end
 
   # TODO Rewrite
+  # Build the path and query string, get a response from the api server, and parse the data.
+  # Not used by clients.  Maybe use :nodoc: here.
   def self.query options={}
-    query = ""
-    case options[:type]
-    when :uri
-      path = options[:query]
-    when :relations
-      path = options[:query] + "/relations"
-      if options[:from_domains]
-        query = "includeDomain=#{options[:from_domains]}"
-      end
-    when :related_by
-      if options[:uri]
-        path = options[:query] + "/related/entities"
-        query = "uri=#{escape(options[:uri])}"
-      else
-        path = options[:query] + "/relations"
-        if options[:verb]
-          path += "/#{options[:verb]}/#{escape(options[:value])}"
-          if options[:entity]
-            path += options[:entity].href
-          end
-        end
-        if options[:media]
-          query += "media=#{options[:media]}"
-        end
-      end
-    when :zeitgeist
-      path = "/zeitgeist/entities/" + options[:query]
-    when :related_medias
-      path = options[:query] + "/media/related"
-      if options[:entities]
-        query = options[:entities].map do |e|
-          "entityURI=#{e}&"
-        end
-        query = query.join
-      end
-      query += "type=#{options[:media]}" if options[:media]
-    when :from_media
-      path = "/media/entities"
-      query = "uri=#{escape(options[:uri])}&text=#{escape(options[:text])}"
-    when :search
-      path  = "/entities/find"
-      query = "name=#{escape(options[:query])}"
-    when :prefix
-      path  = "/entities/find"
-      query = "prefix=#{escape(options[:query])}"
-    else
-      raise ArgumentError, "unexpected type #{ options[:type] }"
-    end
-    query = nil if query.empty?
+    path, query = Evri::URLs.generate options
+
     uri   = URI::HTTP.build :host => self.api_host, :path => path + '.json', :query => query
-    # puts "getting #{ uri }"
     response = Net::HTTP.get_response(uri)
+
     raise Error.new("unexpected http response: #{ response.code }") unless response.code == "200"
+
+    # Remember the source URL for this request.
     @@source_url = @@source_host + uri.request_uri
-    parse_json(response.body)
-  end
 
-  # Escapes CGI text
-  def self.escape text
-    text ? CGI.escape(text.to_s) : ''
+    # Return the parsed JSON
+    parse_json(response.body)
   end
 
   private

data/test/test_entity.rb

@@ -141,8 +141,7 @@ class TestEntity < Test::Unit::TestCase
     uri = "http://www.reuters.com/article/industryNews/idUSTRE4981RO20081009"
     dreamworks = Evri::Entity.find "/organization/dreamworks-0x3c510"
     entities = Evri::Entity.from_media(:uri => uri, :text => "Dreamworks")
-    # TODO FIX
-    #assert entities.include?(dreamworks)
+    assert entities.include?(dreamworks)
 
     text = %(He starred in "Forgetting Sarah Marshall" and was picked as one of Variety's 10 comics to watch, but Russell Brand's latest performance is no laughing matter for the BBC.)
     uri = "http://www.variety.com/article/VR1117994787.html?categoryid=14&cs=1&nid=2565"

data/test/test_traverse.rb

@@ -1,19 +1,16 @@
 require 'pp'
 require 'test/unit'
 require 'lib/evri'
-require 'lib/traverse'
 require 'mocha'
 
 class TestTraverse < Test::Unit::TestCase
-  BARACK_ID   = "/person/barack-obama-0x16f69"
-
   def setup
-    @json = Evri.query(:type => :uri, :query => BARACK_ID)
+    @json = JSON.parse(File.read("test/barack.txt"))
   end
 
   def test_go
     result = Traverse.new(@json)["entity"]
-    assert_equal BARACK_ID,             result[:href] 
+    assert_equal "/person/barack-obama-0x16f69", result[:href] 
     assert_equal "Barack Obama",        result[:name]
     assert_equal "PERSON",              result["type"]
     assert_equal "Democratic Party",    result["properties"]["property"].find { |p| p[:name] == "political_party" }[:value]
@@ -25,9 +22,9 @@ class TestTraverse < Test::Unit::TestCase
       "#{ property[:name] } => #{ property[:value] }"
     end
 
-    #unless result["does"]["not"]["exist"].blank?
-      #raise "shouldn't get here"
-    #end
+    assert_equal result["properties/property"].size, result[:properties][:property].size
+
+    assert result["does/not/exist"].blank?
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: evri
 version: !ruby/object:Gem::Version 
-  version: "0.05"
+  version: "0.06"
 platform: ruby
 authors: 
 - Joe Van Dyk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-05 00:00:00 -08:00
+date: 2008-11-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency