RubyGems - joevandyk-evri - Versions diffs - 0.03 → 0.07 - Mend

joevandyk-evri 0.03 → 0.07

Files changed (16) hide show

data/Manifest.txt CHANGED Viewed

@@ -4,12 +4,18 @@ README.txt
 Rakefile
 TODO
 evri-api.gemspec
+index.html
 lib/evri.rb
 lib/evri/entity.rb
 lib/evri/media.rb
 lib/evri/relation.rb
+lib/evri/urls.rb
 lib/evri/zeitgeist.rb
+lib/traverse.rb
+t.rb
+test/barack.txt
 test/test_entity.rb
 test/test_evri.rb
 test/test_media.rb
+test/test_traverse.rb
 test/test_zeitgeist.rb

data/README.txt CHANGED Viewed

@@ -6,17 +6,16 @@
 A beautiful API that wraps the RESTful services provided by evri.com.
-== FEATURES/PROBLEMS:
-None yet.
 == SYNOPSIS:
-None yet.
+  obama = Evri::Entity.search("Barack Obama").first
+  obama.relationships
+  obama.images
+  obama.articles
 == REQUIREMENTS:
-none yet.
+json
 == INSTALL:

data/Rakefile CHANGED Viewed

@@ -5,6 +5,7 @@ require 'hoe'
 require './lib/evri.rb'
 Hoe.new('evri', Evri::VERSION) do |p|
+  p.rubyforge_name = 'evri-api'
   p.developer('Joe Van Dyk', 'joe@@fixieconsulting.com')
   p.extra_deps = [:json]
   p.extra_dev_deps = [:mocha]
@@ -18,4 +19,10 @@ task :github do
   `rake debug_gem | sed 1d > evri-api.gemspec`
 end
+task :make_index_html do
+  sh "scp index.html joevandyk@rubyforge.org:/var/www/gforge-projects/evri-api"
+end
+task :publish_docs => :make_index_html
 # vim: syntax=Ruby

data/evri-api.gemspec CHANGED Viewed

@@ -1,22 +1,22 @@
 Gem::Specification.new do |s|
   s.name = %q{evri}
-  s.version = "0.03"
+  s.version = "0.07"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joe Van Dyk"]
-  s.date = %q{2008-10-27}
+  s.date = %q{2008-11-06}
   s.description = %q{A beautiful API that wraps the RESTful services provided by evri.com.}
   s.email = ["joe@@fixieconsulting.com"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
-  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "TODO", "evri-api.gemspec", "lib/evri.rb", "lib/evri/entity.rb", "lib/evri/media.rb", "lib/evri/relation.rb", "lib/evri/zeitgeist.rb", "test/test_entity.rb", "test/test_evri.rb", "test/test_media.rb", "test/test_zeitgeist.rb"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt", "test/barack.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "TODO", "evri-api.gemspec", "index.html", "lib/evri.rb", "lib/evri/entity.rb", "lib/evri/media.rb", "lib/evri/relation.rb", "lib/evri/urls.rb", "lib/evri/zeitgeist.rb", "lib/traverse.rb", "t.rb", "test/barack.txt", "test/test_entity.rb", "test/test_evri.rb", "test/test_media.rb", "test/test_traverse.rb", "test/test_zeitgeist.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/joevandyk/evri-api}
   s.rdoc_options = ["--main", "README.txt"]
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{evri}
+  s.rubyforge_project = %q{evri-api}
   s.rubygems_version = %q{1.2.0}
   s.summary = %q{A beautiful API that wraps the RESTful services provided by evri.com.}
-  s.test_files = ["test/test_media.rb", "test/test_zeitgeist.rb", "test/test_entity.rb", "test/test_evri.rb"]
+  s.test_files = ["test/test_entity.rb", "test/test_evri.rb", "test/test_zeitgeist.rb", "test/test_media.rb", "test/test_traverse.rb"]
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -25,15 +25,15 @@ Gem::Specification.new do |s|
     if current_version >= 3 then
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0"])
-      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.2"])
     else
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0"])
-      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.2"])
     end
   else
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0"])
-    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.2"])
   end
 end

data/index.html ADDED Viewed

@@ -0,0 +1,6 @@
+<html>
+  <body>
+    <h1> Evri Page </h1>
+    <p> Welcome, Dude.  <a href="/evri">Here is the API</a>.</p>
+  </body>
+</html>

data/lib/evri.rb CHANGED Viewed

@@ -1,4 +1,3 @@
-$: << File.dirname(__FILE__)
 require 'uri'
 require 'net/http'
@@ -16,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.
@@ -24,7 +25,7 @@ module Evri
   # Raised whenever the entity you are searching for cannot be found.
   class EntityNotFound < Error; end
-  VERSION     = "0.03"
+  VERSION     = "0.07"
   @@api_host    = "api.evri.com"
   @@source_host  = @@api_host
   @@source_url   = nil
@@ -57,77 +58,28 @@ module Evri
   # Parses JSON data
   def self.parse_json json
     begin
-      JSON.parse(json)
+      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
-    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/lib/evri/entity.rb CHANGED Viewed

@@ -1,52 +1,70 @@
 module Evri
   # Represents an Evri Entity.
   class Entity
-    attr_reader :properties
+    attr_reader :properties, :source_url
-    # Finds a specific entity, given an ID.
+    # Finds a specific Entity, given an ID.  An Entity is a person, company, product, etc.
+    #
+    # IDs look like <tt>/person/barack-obama-0x16f69</tt> or <tt>product/forgetting-sarah-marshall-0x1e0d1</tt>
+    #   Entity.find "/person/barack-obama-0x16f69"
     def self.find id
+      raise "Must provide an id" unless id
       @entended_properties = true
       @results ||= {}
-      id = "/" + id unless id =~ /\A\//
+      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
-    # Searches for an exact match.
+    # Searches for an exact match.  It will return an array of Entities.
+    #  Entity.search "Barack Obama"
+    #  Entity.search "Forgetting Sarah Marshall"
     def self.search name
-      create_from_jsons do
-        Evri.query(:type => :search, :query => name)
+      create_many do
+        Evri.query(:type => :search, :query => name)["entities/entity"]
       end
     end
     # Searches for a partial match.  i.e. 'ob' will return 'Obama'.
+    #
+    #   Entity.search_by_prefix("oba")
+    #
+    # will likely return an Entity representing Barack Obama.
     def self.search_by_prefix prefix
-      create_from_jsons do
-        Evri.query(:type => :prefix, :query => prefix)
+      create_many do
+        Evri.query(:type => :prefix, :query => prefix)["entities/entity"]
       end
     end
-    # Given a :uri and :text options, return the related entities.
+    # Returns Entities that the given +:uri+ option mentions.
+    #
+    #   Entity.from_media :uri => "http://www.evri.com/rd/servlet/RequestDispatcherServlet?req=cl&url=http%3A%2F%2Ffeeds.feedburner.com%2F%7Er%2Fvariety%2Fnews%2Ftv%2F%7E3%2F434927667%2FVR1117994787"
+    #
+    # If Evri doesn't know about the given +:uri+ option, you can pass in a
+    # +:text+ option.
+    #
+    #   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.evri.com/rd/servlet/RequestDispatcherServlet?req=cl&url=http%3A%2F%2Ffeeds.feedburner.com%2F%7Er%2Fvariety%2Fnews%2Ftv%2F%7E3%2F434927667%2FVR1117994787"
+    #   Evri.from_media :uri => uri, :text => text
     def self.from_media options={}
       uri, text = options[:uri], options[:text]
       raise ArgumentError, "Must specify URI via the :uri option" unless uri
       raise ArgumentError, "Must specify some text via the :text option" unless text
-      json = Evri.parse_json(Evri.query(:type => :from_media, :uri => uri, :text => text))
-      json["graph"]["entities"].map do |e, entity_json|
-        Entity.new entity_json
+      create_many do
+        json = Evri.query(:type => :from_media, :uri => uri, :text => text)
+        json["graph/entities/entity"]
       end
     end
-    # Returns where the information for this entity came from.
-    def source_url
-      @source_url
-    end
     # Returns information about an entity.
-    # i.e obama.info(:birth_date)
+    #
+    #   obama.info(:birth_date)
+    #
+    # If +:options+ is nil, will return all the available information.
     def info option=nil
       @properties ||= {}
       if defined?(@extended_properties)
@@ -62,46 +80,48 @@ module Evri
       end
     end
-    def to_s
+    def to_s # :nodoc:
       "#{name} (#{ id })"
     end
-    def inspect
+    def inspect # :nodoc:
       "#<Evri::Entity:#{to_s}>"
     end
-    # Returns the name of the entity
+    # Returns the name of the entity.
     def name
-      @parsed_json["name"]["$"] || @parsed_json["name"]
+      @parsed_json["name"]
     end
-    def initialize json
+    def initialize json # :nodoc:
       @parsed_json  = json
       @relations    = []
       @source_url = Evri.source_url
-      if json["properties"]
+      if json and json["properties"]
         set_properties json["properties"]
       end
     end
-    def == b
+    def == b # :nodoc:
       self.id == b.id
     end
     # Returns the Evri URI of the entity
     def href
-      @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"]
+      @parsed_json[:targetHref]
     end
     # Returns relationships for the entity
+    #
+    #   obama.relations
     def relations options={}
       from_domains = nil
       if options[:from]
@@ -112,16 +132,19 @@ module Evri
         end
       end
       json = Evri.query(:type => :relations, :query => id, :from_domains => from_domains)
-      Evri.parse_json(json)["relations"].each do |type, relation_json|
-        next if type != 'relation'
-        relation_json.each do |r|
-          @relations << Relation.new(r)
-        end
+      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|
@@ -136,21 +159,10 @@ module Evri
           verb_value = value
         end
       end
-      @entities = []
       json = Evri.query(:type => :related_by, :media => media, :query => id, :uri => uri, :entity => entity, :verb => verb, :value => verb_value)
-      Evri.parse_json(json)["relations"].each do |type, relation_json|
-        next if type != 'relation'
-        relation_json["targets"].each do |type, r|
-          r.each do |entity|
-            if entity.class == Hash
-              if entity["@href"]
-                @entities << Entity.new(entity)
-              end
-            end
-          end
-        end
+      Entity.create_many do
+        json["relations/relation/targets/entity"]
       end
-      @entities
     end
     # Returns images relating to the current entity
@@ -166,12 +178,9 @@ module Evri
         end
       end
-      json = Evri.parse_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 = Evri.query(:type => :related_medias, :query => href, :entities => entity_uris, :media => 'image')
+      json["mediaResult/imageList/image"].each do |media_json|
+        medias << Image.new(media_json)
       end
       medias
     end
@@ -190,11 +199,9 @@ module Evri
       end
       type = options[:type] ? options[:type] : nil
-      json = Evri.parse_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 = Evri.query(:type => :related_medias, :query => href, :entities => entity_uris, :media => type)
+      json["mediaResult/articleList/article"].each do |media_json|
+        medias << Article.new(media_json)
       end
       medias
     end
@@ -202,37 +209,31 @@ 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 Evri.parse_json(json)["entity"]
+        Entity.new json["entity"]
       rescue Evri::Error => e
         raise Evri::EntityNotFound.new(e.message)
       end
     end
-    def self.create_from_jsons jsons=nil, &block
+    def self.create_many jsons=nil, &block
       jsons = block.call if block
-      result = []
-      Evri.parse_json(jsons)["entities"].each  do |type, entity|
-        if entity.class == Array
-          entity.each do |e|
-            result << Entity.new(e)
-          end
-        else
-          result << Entity.new(entity)
-        end
+      return [] unless jsons
+      if jsons.multiple?
+        jsons.map { |e| Entity.new e }
+      else
+        [Entity.new(jsons)]
       end
-      result
     end
     def set_properties json
       @properties = {}
-      json["property"].each do |prop|
-        if prop.class == Array
-          @properties[prop.first.to_sym] = prop.last["$"]
-        else
-          @properties[prop["name"]["$"].to_sym] = prop["value"]["$"]
+      return unless json[:property]
+      json[:property].each do |prop|
+        unless prop[:name].empty?
+          @properties[prop[:name].to_sym] = prop[:value]
         end
       end
     end

data/lib/evri/media.rb CHANGED Viewed

@@ -1,3 +1,5 @@
+require 'date'
 module Evri
   class Media
   end
@@ -5,42 +7,42 @@ module Evri
   # Represents an Article.
   class Article < Media
     attr_accessor :title, :href, :uri, :author, :published_at, :content
-    def initialize json
-      @title        = json["title"]["$"]
-      @author       = json["author"]["$"]
-      @content      = json["content"] ? json["content"]["$"] : "No content provided"
-      @published_at = json["published"]["$"]
-      @href         = Evri.api_host + json["link"]["@href"]
-      @uri          = json["link"]["@hostName"] + json["link"]["@path"]
+    def initialize json # :nodoc:
+      @title        = json[:title]
+      @author       = json[:author]
+      @content      = (json[:content] || "No content provided")
+      @published_at = json[:published]
+      @href         = Evri.api_host + json[:link][:href]
+      @uri          = json[:link][:hostName] + json[:link][:path]
     end
   end
   # Represents an Image.
   class Image < Media
     attr_accessor :size, :title, :article_href, :mime_type, :thumbnail, :date, :content, :width, :url, :click_url, :height
-    def initialize json
-      @title    = json["title"]
-      @width    = json["@width"]
-      @height   = json["@height"]
-      @url      = json["@url"]
-      @size      = json["size"]
-      @title      = json["title"]
-      @article_href      = json["articleHref"]["$"]
-      @mime_type      = json["mimeType"]
-      @date      = Date.parse(json["date"]["$"])
-      @content  = json["content"]["$"]
-      @click_url  = json["clickUrl"]["$"]
-      @thumbnail = Thumbnail.new(json["thumbnail"])
+    def initialize json # :nodoc:
+      @title    = json[:title]
+      @width    = json[:width]
+      @height   = json[:height]
+      @url      = json[:url]
+      @size      = json[:size]
+      @title      = json[:title]
+      @article_href      = json[:articleHref]
+      @mime_type      = json[:mimeType]
+      @date      = Date.parse(json[:date])
+      @content  = json[:content]
+      @click_url  = json[:clickUrl]
+      @thumbnail = Thumbnail.new(json[:thumbnail])
     end
     # Represents an Thumbnail for an Image.
     class Thumbnail
       attr_accessor :size, :width, :height, :url
-      def initialize json
-        @size    = json["size"]
-        @width    = json["@width"]
-        @height   = json["@height"]
-        @url      = json["@url"]
+      def initialize json # :nodoc:
+        @size    = json[:size]
+        @width    = json[:width]
+        @height   = json[:height]
+        @url      = json[:url]
       end
     end
   end

data/lib/evri/relation.rb CHANGED Viewed

@@ -2,20 +2,21 @@ module Evri
   # Represents a relation.
   class Relation
     attr_accessor :name, :href, :type
-    def initialize json
-      @name = json["name"]["$"]
-      @href = json["@href"]
-      @type = json["type"]["$"]
+    def initialize json # :nodoc:
+      @name = json[:name]
+      @href = json[:href]
+      @type = json[:type]
       @entities = []
     end
     # Returns the entities in this relation.
     def entities
       return @entities unless @entities.empty?
-      json = JSON.parse(Evri.query(:type => :uri, :query => @href))
-      json["relations"]["relation"]["targets"]["entity"].each do |entity_json|
-        @entities << Entity.new(entity_json)
-      end
+      json = Evri.query(:type => :uri, :query => @href)
+      @entities =
+        Entity.create_many do
+          json["relations/relation/targets/entity"]
+        end
       @entities
     end
   end

data/lib/evri/urls.rb ADDED Viewed

@@ -0,0 +1,67 @@
+module Evri
+  module URLs
+    # FIXME This is ugly and should be changed.
+    # Given a set of options, builds a path and query string that we will be requesting.
+    # :type is the name of the type of query you are done.
+    # :query (should be renamed) is the thing you are looking for
+    # :entity is an entity that  ..
+    def self.generate options = {} #:nodoc:
+      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?
+      return [path, query]
+    end
+    def self.escape text
+      text ? CGI.escape(text.to_s) : ''
+    end
+  end
+end

data/lib/evri/zeitgeist.rb CHANGED Viewed

@@ -3,13 +3,10 @@ module Evri
   #
   # To access the information, combine a TREND with a TYPE to form a class method.
   #
-  # i.e.
+  #   Zeitgeist.all_chemical
+  #   Zeitgeist.falling_person
+  #   Zeitgeist.popular_organization
   #
-  # * Zeitgeist.all_chemical
-  # * Zeitgeist.falling_person
-  # * Zeitgeist.popular_organization
-  #
-  # etc
   class Zeitgeist
     TYPES   = %w( animal backterium chemical concept disorder event location organization person plant product virus )
@@ -19,9 +16,9 @@ module Evri
       TYPES.each do |et|
         eval %(
           def self.#{t}_#{et}
-            json =  Evri.parse_json(Evri.query :type => :zeitgeist, :query => "#{et}/#{t}")
-            json["zeitgeist"]["#{t}"]["entities"]["entity"].map do |entity_json|
-              Entity.new(entity_json)
+            json =  Evri.query :type => :zeitgeist, :query => "#{et}/#{t}"
+            Entity.create_many do
+              json["zeitgeist/#{t}/entities/entity"]
             end
           end
         )

data/lib/traverse.rb ADDED Viewed

@@ -0,0 +1,65 @@
+class Traverse
+  include Enumerable
+  attr_reader :json
+  def each
+    @json.each { |j| yield Traverse.new(j) }
+  end
+  def multiple?
+    @json.class == Array
+  end
+  def initialize json
+    @json = json
+  end
+  def size
+    @json.size
+  end
+  def blank?
+    size == 0
+  end
+  alias empty? blank?
+  # TODO clean this crap up
+  def [] value
+    value = value.to_s
+    if values = value.split("/") and values.size > 1
+      str = values.map { |v| "['#{v}']" }.join
+      code = "self#{str}"
+      return eval(code)
+    end
+    result =
+      if @json.class == Array
+        @json.find do |key|
+          if key.class == Array
+            if key.first.class == Array
+              if key.first.first == "$"
+                key.first.last == value
+              end
+            elsif key.first.class == String
+              key.first == value
+            end
+          end
+        end
+      else
+        @json[value] || @json["@#{value}"]
+      end
+    if result
+      if result.class == Hash
+        result = result["$"] || result
+      end
+    end
+    if result.class == Hash || result.class == Array
+      result = Traverse.new(result)
+    else
+      result
+    end
+    return result if result
+    return Traverse.new([])
+  end
+end

data/test/barack.txt ADDED Viewed

@@ -0,0 +1,307 @@
+{
+  "entity": {
+    "name": {
+      "$": "Barack Obama"
+    },
+    "@href": "\/person\/barack-obama-0x16f69",
+    "@inOntology": "true",
+    "@id": "94057",
+    "type": {
+      "$": "PERSON"
+    },
+    "links": {
+    },
+    "@score": "0.0",
+    "properties": {
+      "property": [
+        {
+          "name": {
+            "$": "birthplace"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Honolulu, Hawaii"
+          }
+        },
+        {
+          "name": {
+            "$": "occupation"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Attorney"
+          }
+        },
+        {
+          "name": {
+            "$": "source_url"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "http:\/\/en.wikipedia.org\/wiki\/Barack_Obama"
+          }
+        },
+        {
+          "name": {
+            "$": "residence"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Kenwood, Chicago, Illinois"
+          }
+        },
+        {
+          "name": {
+            "$": "full_title"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "President-elect of the United States"
+          }
+        },
+        {
+          "name": {
+            "$": "name"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Obama, Barack Hussein"
+          }
+        },
+        {
+          "name": {
+            "$": "birth_name"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Barack Hussein Obama II"
+          }
+        },
+        {
+          "name": {
+            "$": "birth_date"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "1961-08-04 00:00:00.0"
+          }
+        },
+        {
+          "name": {
+            "$": "birthplace"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Honolulu, Hawaii, U.S.A."
+          }
+        },
+        {
+          "name": {
+            "$": "name"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Obama, Barack, Jr."
+          }
+        },
+        {
+          "name": {
+            "$": "university_attended"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Columbia University"
+          }
+        },
+        {
+          "name": {
+            "$": "vice_president"
+          },
+          "@provenance": "8",
+          "@linkObjectName": "Joe Biden",
+          "value": {
+            "$": "Joe Biden (elect)"
+          },
+          "@linkHref": "\/person\/joe-biden-0x2d99a",
+          "@linkInOntology": "true"
+        },
+        {
+          "name": {
+            "$": "name"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Barack Obama"
+          }
+        },
+        {
+          "name": {
+            "$": "wikipedia_paragraph"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Barack Hussein Obama II (pronounced: \/b\u0259\u02c8r\u0251\u02d0k h\u028a\u02c8se\u026an o\u028a\u02c8b\u0251\u02d0m\u0259\/; born August 4, 1961) is the President-elect of the United States of America and the junior United States Senator from Illinois. His inauguration into office as the forty-fourth President of the United States is scheduled for January 20, 2009. Obama is the first African American to be elected President of the United States, and was the first to be nominated for President by a major political party. Obama is also the first candidate born in Hawaii to have been nominated and subsequently elected president.\n\nA graduate of Columbia University and Harvard Law School, he became the first African American to serve as president of the Harvard Law Review. Obama worked as a community organizer and practiced as a civil rights attorney before serving three terms in the Illinois Senate from 1997 to 2004. He taught constitutional law at the University of Chicago Law School from 1992 to 2004. Following an unsuccessful bid for a seat in the U.S. House of Representatives in 2000, he announced his campaign for the U.S. Senate in January 2003. After a primary victory in March 2004, Obama delivered the keynote address at the Democratic National Convention in July 2004. He was elected to the Senate in November 2004 with 70 percent of the vote."
+          }
+        },
+        {
+          "name": {
+            "$": "children"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Malia Ann, Sasha"
+          }
+        },
+        {
+          "name": {
+            "$": "university_attended"
+          },
+          "@provenance": "8",
+          "@linkObjectName": "Occidental College",
+          "value": {
+            "$": "Occidental College"
+          },
+          "@linkHref": "\/organization\/occidental-college-0xbd22f",
+          "@linkInOntology": "true"
+        },
+        {
+          "name": {
+            "$": "university_attended"
+          },
+          "@provenance": "8",
+          "@linkObjectName": "Harvard Law School",
+          "value": {
+            "$": "Harvard Law School"
+          },
+          "@linkHref": "\/organization\/harvard-law-school-0xd826a",
+          "@linkInOntology": "true"
+        },
+        {
+          "name": {
+            "$": "religion"
+          },
+          "@provenance": "8",
+          "@linkObjectName": "United Church of Christ",
+          "value": {
+            "$": "United Church of Christ"
+          },
+          "@linkHref": "\/organization\/united-church-of-christ-0x12af2d",
+          "@linkInOntology": "true"
+        },
+        {
+          "name": {
+            "$": "political_party"
+          },
+          "@provenance": "8",
+          "@linkObjectName": "Democratic Party",
+          "value": {
+            "$": "Democratic Party"
+          },
+          "@linkHref": "\/organization\/democratic-party-0x3e58b",
+          "@linkInOntology": "true"
+        },
+        {
+          "name": {
+            "$": "occupation"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Politician"
+          }
+        },
+        {
+          "name": {
+            "$": "spouse"
+          },
+          "@provenance": "8",
+          "@linkObjectName": "Michelle Obama",
+          "value": {
+            "$": "Michelle Obama"
+          },
+          "@linkHref": "\/person\/michelle-obama-0x4c6e8",
+          "@linkInOntology": "true"
+        },
+        {
+          "name": {
+            "$": "represent_political"
+          },
+          "@groupNum": "2",
+          "@provenance": "8",
+          "@linkObjectName": "Illinois",
+          "value": {
+            "$": "Illinois"
+          },
+          "@linkHref": "\/location\/illinois-0x319c2",
+          "@linkInOntology": "true"
+        },
+        {
+          "name": {
+            "$": "official_website"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "Office of the President-Elect"
+          }
+        },
+        {
+          "name": {
+            "$": "birth_date"
+          },
+          "@provenance": "8",
+          "value": {
+            "$": "1961-08-04 00:00:00.0"
+          }
+        }
+      ]
+    },
+    "facets": {
+      "facet": [
+        {
+          "name": {
+            "$": "Author"
+          },
+          "relations": {
+          },
+          "properties": {
+          }
+        },
+        {
+          "name": {
+            "$": "Lawyer"
+          },
+          "relations": {
+          },
+          "properties": {
+          }
+        },
+        {
+          "name": {
+            "$": "U.S. Politician"
+          },
+          "relations": {
+          },
+          "properties": {
+          }
+        },
+        {
+          "name": {
+            "$": "Academic"
+          },
+          "relations": {
+          },
+          "properties": {
+          }
+        }
+      ]
+    }
+  }
+}

data/test/test_entity.rb CHANGED Viewed

@@ -1,6 +1,7 @@
 require 'test/unit'
 require 'lib/evri'
 require 'mocha'
+require 'pp'
 class TestEntity < Test::Unit::TestCase
   BARACK_ID   = "/person/barack-obama-0x16f69"
@@ -32,6 +33,7 @@ class TestEntity < Test::Unit::TestCase
   end
   def test_failed_search_returns_empty_array
+    # p Evri::Entity.search("asdfasdfasdfasdfjlskdjflkasdjfkljasdklfjkladsjfklajsdl;kfjlaksdjfadklsjfkladsjlfkjasdfkljas#")
     assert Evri::Entity.search("asdfasdfasdfasdfjlskdjflkasdjfkljasdklfjkladsjfklajsdl;kfjlaksdjfadklsjfkladsjlfkjasdfkljas#").empty?
   end
@@ -59,8 +61,8 @@ class TestEntity < Test::Unit::TestCase
   end
   def test_properties_from_related_by
-    loaded_entity = @obama.related_by(:verb => :kill).first
-    assert loaded_entity.info(:name)
+    joe = @obama.related_by(:verb => :kill).find { |e| e.name == "Joe Biden" }
+    assert joe.info(:name)
   end
   def test_relations
@@ -140,5 +142,11 @@ class TestEntity < Test::Unit::TestCase
     dreamworks = Evri::Entity.find "/organization/dreamworks-0x3c510"
     entities = Evri::Entity.from_media(:uri => uri, :text => "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"
+    movie = Evri::Entity.find "/product/forgetting-sarah-marshall-0x1e0d1"
+    entities = Evri::Entity.from_media(:uri => uri, :text => text)
+    assert entities.include?(movie)
   end
 end

data/test/test_traverse.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require 'pp'
+require 'test/unit'
+require 'lib/evri'
+require 'mocha'
+class TestTraverse < Test::Unit::TestCase
+  def setup
+    @json = JSON.parse(File.read("test/barack.txt"))
+  end
+  def test_go
+    result = Traverse.new(@json)["entity"]
+    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]
+    assert result[:facets][:facet].find { |f| f[:name] == "Author" }
+    assert result[:properties][:property].size > 20
+    # Get the properties and their values
+    result[:properties][:property].map do |property|
+      "#{ property[:name] } => #{ property[:value] }"
+    end
+    assert_equal result["properties/property"].size, result[:properties][:property].size
+    assert result["does/not/exist"].blank?
+  end
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: joevandyk-evri
 version: !ruby/object:Gem::Version
-  version: "0.03"
+  version: "0.07"
 platform: ruby
 authors:
 - Joe Van Dyk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2008-10-27 00:00:00 -07:00
+date: 2008-11-06 00:00:00 -08:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -37,7 +37,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.8.2
     version:
 description: A beautiful API that wraps the RESTful services provided by evri.com.
 email:
@@ -50,6 +50,7 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
+- test/barack.txt
 files:
 - History.txt
 - Manifest.txt
@@ -57,14 +58,20 @@ files:
 - Rakefile
 - TODO
 - evri-api.gemspec
+- index.html
 - lib/evri.rb
 - lib/evri/entity.rb
 - lib/evri/media.rb
 - lib/evri/relation.rb
+- lib/evri/urls.rb
 - lib/evri/zeitgeist.rb
+- lib/traverse.rb
+- t.rb
+- test/barack.txt
 - test/test_entity.rb
 - test/test_evri.rb
 - test/test_media.rb
+- test/test_traverse.rb
 - test/test_zeitgeist.rb
 has_rdoc: true
 homepage: http://github.com/joevandyk/evri-api
@@ -88,13 +95,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version:
 requirements: []
-rubyforge_project: evri
+rubyforge_project: evri-api
 rubygems_version: 1.2.0
 signing_key:
 specification_version: 2
 summary: A beautiful API that wraps the RESTful services provided by evri.com.
 test_files:
-- test/test_media.rb
-- test/test_zeitgeist.rb
 - test/test_entity.rb
 - test/test_evri.rb
+- test/test_zeitgeist.rb
+- test/test_media.rb
+- test/test_traverse.rb