evri 0.03 → 0.04

data/README.txt

@@ -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

@@ -19,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/lib/evri/entity.rb

@@ -3,7 +3,10 @@ module Evri
   class Entity
     attr_reader :properties
 
-    # 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
       @entended_properties = true
       @results ||= {}
@@ -14,7 +17,9 @@ module Evri
       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)
@@ -22,31 +27,47 @@ module Evri
     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)
       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|
+      json["graph"]["entities"]["entity"].map do |entity_json|
         Entity.new entity_json
       end
     end
 
-    # Returns where the information for this entity came from.
+    # Returns the URL 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) 
@@ -70,7 +91,7 @@ module Evri
       "#<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"]
     end
@@ -102,6 +123,8 @@ module Evri
     end
 
     # Returns relationships for the entity
+    #
+    #   obama.relations
     def relations options={}
       from_domains = nil
       if options[:from]

data/lib/evri/media.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module Evri
   class Media
   end

data/lib/evri.rb

@@ -24,7 +24,7 @@ module Evri
   # Raised whenever the entity you are searching for cannot be found.
   class EntityNotFound < Error; end
 
-  VERSION     = "0.03"
+  VERSION     = "0.04"
   @@api_host    = "api.evri.com"
   @@source_host  = @@api_host
   @@source_url   = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: evri
 version: !ruby/object:Gem::Version 
-  version: "0.03"
+  version: "0.04"
 platform: ruby
 authors: 
 - Joe Van Dyk