joevandyk-evri 0.01 → 0.03

data/Manifest.txt

@@ -3,6 +3,7 @@ Manifest.txt
 README.txt
 Rakefile
 TODO
+evri-api.gemspec
 lib/evri.rb
 lib/evri/entity.rb
 lib/evri/media.rb

data/Rakefile

@@ -6,6 +6,16 @@ require './lib/evri.rb'
 
 Hoe.new('evri', Evri::VERSION) do |p|
   p.developer('Joe Van Dyk', 'joe@@fixieconsulting.com')
+  p.extra_deps = [:json]
+  p.extra_dev_deps = [:mocha]
+end
+
+task :github do
+  data = `rake check_manifest | sed 1d`
+  IO.popen("patch -p0 Manifest.txt", "w") do |p|
+    p << data
+  end
+  `rake debug_gem | sed 1d > evri-api.gemspec`
 end
 
 # vim: syntax=Ruby

data/evri-api.gemspec

@@ -0,0 +1,39 @@
+Gem::Specification.new do |s|
+  s.name = %q{evri}
+  s.version = "0.03"
+
+  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.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.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.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"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    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"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

data/lib/evri/entity.rb

@@ -3,6 +3,7 @@ module Evri
   class Entity
     attr_reader :properties
 
+    # Finds a specific entity, given an ID.
     def self.find id
       @entended_properties = true
       @results ||= {}
@@ -13,18 +14,21 @@ module Evri
       end
     end
 
+    # Searches for an exact match.
     def self.search name
       create_from_jsons do
         Evri.query(:type => :search, :query => name)
       end
     end
 
+    # Searches for a partial match.  i.e. 'ob' will return '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.
     def self.from_media options={}
       uri, text = options[:uri], options[:text]
       raise ArgumentError, "Must specify URI via the :uri option" unless uri
@@ -36,10 +40,13 @@ module Evri
       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)
     def info option=nil
       @properties ||= {}
       if defined?(@extended_properties) 
@@ -56,9 +63,14 @@ module Evri
     end
 
     def to_s
-      "#{name} <#{ id }>"
+      "#{name} (#{ id })"
     end
 
+    def inspect
+      "#<Evri::Entity:#{to_s}>"
+    end
+
+    # Returns the name of the entity
     def name
       @parsed_json["name"]["$"] || @parsed_json["name"]
     end
@@ -76,6 +88,7 @@ module Evri
       self.id == b.id
     end
 
+    # Returns the Evri URI of the entity
     def href
       @parsed_json["@href"]
     end
@@ -83,10 +96,12 @@ module Evri
     alias id href
     alias uri href
 
+     # TODO
     def target_href
       @parsed_json["@targetHref"]
     end
 
+    # Returns relationships for the entity
     def relations options={}
       from_domains = nil
       if options[:from]
@@ -106,6 +121,7 @@ module Evri
       @relations
     end
 
+    # Returns which entities are related to the current entity
     def related_by  options={}
       media, verb, verb_value, entity, uri = nil, nil, nil, nil, nil
       options.each do |key, value|
@@ -137,6 +153,7 @@ module Evri
       @entities
     end
 
+    # Returns images relating to the current entity
     def images options={}
       medias = []
       if options[:entities]
@@ -159,6 +176,7 @@ module Evri
       medias
     end
 
+    # Returns articles relating to the current entity
     def articles options={}
       medias = []
       if options[:entities]

data/lib/evri/media.rb

@@ -2,6 +2,7 @@ module Evri
   class Media
   end
 
+  # Represents an Article.
   class Article < Media
     attr_accessor :title, :href, :uri, :author, :published_at, :content
     def initialize json
@@ -14,6 +15,7 @@ module Evri
     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
@@ -31,6 +33,7 @@ module Evri
       @thumbnail = Thumbnail.new(json["thumbnail"])
     end
 
+    # Represents an Thumbnail for an Image.
     class Thumbnail
       attr_accessor :size, :width, :height, :url
       def initialize json

data/lib/evri/relation.rb

@@ -1,4 +1,5 @@
 module Evri
+  # Represents a relation.
   class Relation
     attr_accessor :name, :href, :type
     def initialize json
@@ -8,6 +9,7 @@ module Evri
       @entities = []
     end
 
+    # Returns the entities in this relation.
     def entities
       return @entities unless @entities.empty?
       json = JSON.parse(Evri.query(:type => :uri, :query => @href))

data/lib/evri/zeitgeist.rb

@@ -1,10 +1,22 @@
 module Evri
+  # Returns information about a specific trend.
+  #
+  # 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
+  #
+  # etc
   class Zeitgeist
-    ENTITY_TYPES = %w( animal backterium checmical concept disorder event location organization person plant product virus )
-    TYPES        = %w( all popular rising falling )
 
-    TYPES.each do |t|
-      ENTITY_TYPES.each do |et|
+    TYPES   = %w( animal backterium chemical concept disorder event location organization person plant product virus )
+    TRENDS  = %w( all popular rising falling )
+
+    TRENDS.each do |t|
+      TYPES.each do |et|
         eval %(
           def self.#{t}_#{et}
             json =  Evri.parse_json(Evri.query :type => :zeitgeist, :query => "#{et}/#{t}")

data/lib/evri.rb

@@ -24,31 +24,37 @@ module Evri
   # Raised whenever the entity you are searching for cannot be found.
   class EntityNotFound < Error; end
 
-  VERSION     = "0.01"
+  VERSION     = "0.03"
   @@api_host    = "api.evri.com"
   @@source_host  = @@api_host
   @@source_url   = nil
 
+  # Sets the hostname for the Evri API.
   def self.api_host= host
     @@api_host = validate_host(host)
   end
 
+  # Returns the hostname for the Evri API.
   def self.api_host
     @@api_host
   end
 
+  # Returns the source host for the Evri API
   def self.source_host
     @@source_host
   end
 
+  # Returns the source host for the Evri API
   def self.source_host= host
     @@source_host = validate_host(host)
   end
 
+  # Returns the source url for the Evri API
   def self.source_url
     @@source_url
   end
 
+  # Parses JSON data
   def self.parse_json json
     begin
       JSON.parse(json)
@@ -119,6 +125,7 @@ module Evri
     response.body
   end
 
+  # Escapes CGI text
   def self.escape text
     text ? CGI.escape(text.to_s) : ''
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: joevandyk-evri
 version: !ruby/object:Gem::Version 
-  version: "0.01"
+  version: "0.03"
 platform: ruby
 authors: 
 - Joe Van Dyk
@@ -12,6 +12,24 @@ cert_chain: []
 date: 2008-10-27 00:00:00 -07:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   version_requirement: 
@@ -38,6 +56,7 @@ files:
 - README.txt
 - Rakefile
 - TODO
+- evri-api.gemspec
 - lib/evri.rb
 - lib/evri/entity.rb
 - lib/evri/media.rb