topsy 0.1.0 → 0.2.0

data/lib/topsy/linkpost_count.rb

@@ -0,0 +1,15 @@
+# This is the linkpost_count class for the topsy library. 
+# A LinkpostCount has the following attributes:
+#        "contains" : 0,
+#        "all" : 46
+# 
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/linkpostcount
+#
+module Topsy
+  
+  class LinkpostCount < Hashie::Mash
+    def to_s
+      "Topsy LinkpostCount: #{all}"
+    end
+  end
+end

data/lib/topsy/page.rb

@@ -0,0 +1,40 @@
+# This is the page class for the topsy library. 
+# A Page has the following attributes:
+#      "page" : 1,
+#      "total" : "1139",
+#      "perpage" : 15,
+#      "list" : Array of Author instances 
+#
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/authorsearch
+#
+module Topsy
+  
+  class Page < Hashie::Dash
+    property :total
+    property :list
+    property :page
+    property :perpage
+    property :window
+    property :topsy_trackback_url
+    
+    def to_s
+      "Topsy Page: #{page} of #{total}, #{list.size} authors"
+    end
+
+    def initialize(content, klass)
+      @klass = klass
+      super(content)
+    end
+    
+    def list=(value)
+      result = []
+      if value
+        value.each{ |x| result << @klass.new(x) }
+        self[:list] = result  
+      else
+        self[:list] = value
+      end
+    end
+  end
+ 
+end

data/lib/topsy/rate_limit_info.rb

@@ -0,0 +1,18 @@
+module Topsy
+  
+  class RateLimitInfo < Hashie::Dash
+    
+    property :reset
+    property :limit
+    property :remaining
+    
+    def refresh_in_seconds
+      Time.at(reset) - Time.now
+    end
+    
+    def reset
+      Time.at(self[:reset]) unless self[:reset].respond_to?(:year)
+    end
+  end
+  
+end

data/lib/topsy/search_counts.rb

@@ -6,41 +6,20 @@ module Topsy
     property :m, :default => 0
     property :a, :default => 0
     
-    def last_hour
-      h
-    end
+    alias :hour :h
+    alias :this_hour :h
     
-    def this_hour
-      h
-    end
+    alias :today :d
     
-    def today
-      d
-    end
+    alias :week :w
+    alias :this_week :w
     
-    def last_week
-      w
-    end
+    alias :month :m
+    alias :this_month :m
     
-    def this_week
-      w
-    end
+    alias :overall :a
+    alias :all_time :a
     
-    def last_month
-      m
-    end
-    
-    def this_month
-      m
-    end
-    
-    def all_time
-      a
-    end
-    
-    def overall
-      a
-    end
     
   end
 end

data/lib/topsy/stats.rb

@@ -0,0 +1,18 @@
+# This is the stats class for the topsy library. 
+# A Stats instance has the following attributes:
+#      "topsy_trackback_url" : "http://topsy.com/tb/etagwerker.com/",
+#      "contains" : "1931",
+#      "influential" : "874",
+#      "all" : "1931"
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/stats
+#
+module Topsy
+  
+  class Stats < Hashie::Mash
+    
+    def to_s
+      "Topsy Stats: #{topsy_trackback_url}"
+    end
+    
+  end
+end

data/lib/topsy/tag.rb

@@ -0,0 +1,16 @@
+# This is the tag class for the topsy library. 
+# A Tag instance has the following attributes:
+#            "url" : "http://topsy.com/s?q=current",
+#            "name" : "current"
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/tags
+#
+module Topsy
+  
+  class Tag < Hashie::Mash
+    
+    def to_s
+      "Topsy Tag: #{name}"
+    end
+    
+  end
+end

data/lib/topsy/target.rb

@@ -0,0 +1,18 @@
+# This is the target class for the topsy library. 
+# A Target has the following attributes:
+#      "topsy_trackback_url" : "http://topsy.com/tb/my.barackobama.com/page/community/post/obamaforamerica/gGMPVm",
+#      "url" : "http://my.barackobama.com/page/community/post/obamaforamerica/gGMPVm",
+#      "trackback_total" : "43"
+# 
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/linkposts
+#
+module Topsy
+  
+  class Target < Hashie::Mash
+
+    def to_s
+      "Topsy Target: #{url}"
+    end
+    
+  end
+end

data/lib/topsy/trend.rb

@@ -0,0 +1,16 @@
+# This is the trend class for the topsy library. 
+# A Trend instance has the following attributes:
+#            "url" : "http://topsy.com/s?q=dominick",
+#            "term" : "dominick"
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/trending
+#
+module Topsy
+  
+  class Trend < Hashie::Mash
+    
+    def to_s
+      "Topsy Trend: #{term}"
+    end
+    
+  end
+end

data/lib/topsy/tweet.rb

@@ -0,0 +1,44 @@
+# This is the tweet class for the topsy library. 
+# A Tweet instance has the following attributes:
+#            "permalink_url" : "http://twitter.com/etagwerker/status/3565855201",
+#            "date" : "1251324809",
+#            "content" : "TOPSY - A search engine powered by tweets: http://topsy.com (this Search Engine can 
+#                        be powerful for sifting through Twitter- love it)!",
+#            "type" : "tweet",
+#            "author" : author instance
+#            "date_alpha" : "6 hours ago"
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/trackbacks
+#
+module Topsy
+  
+  class Tweet < Hashie::Dash
+    property :permalink_url
+    property :date
+    property :content
+    property :type
+    property :author
+    property :date_alpha
+    property :target
+    
+    def to_s
+      "Topsy Tweet: #{permalink_url}, #{content}"
+    end
+
+    def author=(value)
+      if value
+        self[:author] = Topsy::Author.new(value)  
+      else
+        self[:author] = value
+      end
+    end
+    
+    def target=(value)
+      if value
+        self[:target] = Topsy::Target.new(value)  
+      else
+        self[:target] = value
+      end
+    end
+    
+  end
+end

data/lib/topsy/url_info.rb

@@ -0,0 +1,21 @@
+# This is the url_info class for the topsy library. 
+# An UrlInfo has the following attributes:
+#      "topsy_trackback_url" : "http://topsy.com/tb/twitter.com/",
+#      "oneforty" : "Twitter: What are you doing? http://twurl.nl/pd8k44",
+#      "url" : "http://etagwerker.com/",
+#      "title" : "Tech Notes From The Trenches",
+#      "trackback_total" : "24152",
+#      "description" : "Social networking and microblogging service utilising instant messaging, SMS or a web interface.",
+#      "description_attribution" : "From DMOZ"
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources?tm=6#/urlinfo
+#
+module Topsy
+  
+  class UrlInfo < Hashie::Mash
+    
+    def to_s
+      "Topsy UrlInfo: #{url}, @#{topsy_trackback_url}, #{trackback_total} total"
+    end
+    
+  end
+end

data/lib/topsy.rb

@@ -45,9 +45,10 @@ module Topsy
   # @option options [String] :window Time window for results. (default: 'a') Options: auto - automatically pick the most recent and relevant window. h last hour, d last day, w last week, m last month, a all time
   # @option options [Integer] :page page number of the result set. (default: 1, max: 10)
   # @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)
-  # @return [Hashie::Mash]
+  # @return [Topsy::Page]
   def self.author_search(q, options={})
-    Topsy::Client.new.author_search(q, options)
+    result = Topsy::Client.new.author_search(q, options)
+    Topsy::Page.new(result, Topsy::Author)
   end
   
   # Returns list of URLs posted by an author
@@ -67,9 +68,10 @@ module Topsy
   # @param [String] url URL string for the author.
   # @param [Hash] options method options
   # @option options [String] :contains Query string to filter results
-  # @return [Hashie::Mash]
+  # @return [Topsy::LinkpostCount]
   def self.link_post_count(url, options={})
-    Topsy::Client.new.link_post_count(url, options={})
+    response = Topsy::Client.new.link_post_count(url, options={})
+    Topsy::LinkpostCount.new(response)
   end
   
   # Returns list list of author profiles that match the query. The query is matched against the nick, name and biography information and the results are sorted by closeness of match and the influence of authors.
@@ -166,9 +168,39 @@ module Topsy
   def self.url_info(url)
     Topsy::Client.new.url_info(url)
   end
+  
+  # Returns info about API rate limiting
+  #
+  # @return [RateLimitInfo]
+  def self.credit
+    Topsy::Client.new.credit
+  end
+  
+
+  def self.rate_limit
+    self.credit if @rate_limit_info.nil?
+    @rate_limit_info
+  end
+  
+  def self.rate_limit=(info)
+    @rate_limit_info = Topsy::RateLimitInfo.new(info)
+  end
 
   
 end
 
+require File.join(directory, 'topsy', 'rate_limit_info')
+require File.join(directory, 'topsy', 'author')
+require File.join(directory, 'topsy', 'linkpost')
+require File.join(directory, 'topsy', 'link_search_result')
+require File.join(directory, 'topsy', 'linkpost_count')
+require File.join(directory, 'topsy', 'page')
 require File.join(directory, 'topsy', 'search_counts')
+require File.join(directory, 'topsy', 'stats')
+require File.join(directory, 'topsy', 'target')
+require File.join(directory, 'topsy', 'tag')
+require File.join(directory, 'topsy', 'trend')
+require File.join(directory, 'topsy', 'tweet')
+require File.join(directory, 'topsy', 'url_info')
+
 require File.join(directory, 'topsy', 'client')

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/topsy.rb'}"
+puts "Loading topsy gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/fixtures/credit.json

@@ -0,0 +1,15 @@
+{
+    "request": {
+        "response_type": "json",
+        "resource": "credit",
+        "parameters": {},
+        "url": "http://button.topsy.com/credit.json"
+    },
+    "response": {
+        "remaining": 10000,
+        "reset": 1262707200,
+        "limit": 10000,
+        "refresh_in_secs": 1503
+    }
+}
+

data/test/fixtures/urlinfo.json

@@ -9,10 +9,10 @@
     },
     "response": {
         "oneforty": "trending topics -  -amp09 right up there past the president today! :) http://tiny.cc/3yNbv",
-        "description": "",
+        "description": "Social networking",
         "trackback_total": 39379,
         "topsy_trackback_url": "http://topsy.com/tb/twitter.com/",
-        "description_attribution": "",
+        "description_attribution": "From DMOZ",
         "url": "http://twitter.com/",
         "title": "trending topics -  -amp09 right up there past the president today! :)"
     }

data/test/helper.rb

@@ -32,11 +32,16 @@ def topsy_url(url)
   url =~ /^http/ ? url : "http://otter.topsy.com#{url}"
 end
 
-def stub_get(url, filename, status=nil)
-  options = {:body => fixture_file(filename)}
-  options.merge!({:status => status}) unless status.nil?
+def stub_get(url, filename, options={})
+  opts = {:body => fixture_file(filename)}.merge(options)
   
-  FakeWeb.register_uri(:get, topsy_url(url), options)
+  headers = {
+    'x-ratelimit-remaining' => '9998',
+    'x-ratelimit-limit' => '10000',
+    'x-ratelimit-reset' => '1262707200'
+  }
+  
+  FakeWeb.register_uri(:get, topsy_url(url), headers.merge(opts))
 end
 
 def stub_post(url, filename)

data/test/test_topsy.rb

@@ -4,95 +4,176 @@ class TestTopsy < Test::Unit::TestCase
   
   context "when hitting the Otter API" do
     
+    should "return rate limit information when calling credit" do
+      stub_get("/credit.json", "credit.json")
+      Topsy.rate_limit.limit.should == 10000
+      Topsy.rate_limit.remaining.should == 9998
+      Topsy.rate_limit.reset.should == Time.at(1262707200)
+    end
+    
+    should "return rate limit information with every request" do
+
+      # FakeWeb.register_uri(:get, "http://otter.topsy.com/authorinfo.json?url=http%3A%2F%2Ftwitter.com%2Fpengwynn", headers)
+      stub_get("/authorinfo.json?url=http%3A%2F%2Ftwitter.com%2Fpengwynn", "authorinfo.json")
+      
+      info = Topsy.author_info("http://twitter.com/pengwynn")
+      
+      Topsy.rate_limit.limit.should == 10000
+      Topsy.rate_limit.remaining.should == 9998
+      Topsy.rate_limit.reset.should == Time.at(1262707200)
+    end
+    
     should "return author info for a profile url" do
       stub_get("/authorinfo.json?url=http%3A%2F%2Ftwitter.com%2Fpengwynn", "authorinfo.json")
       info = Topsy.author_info("http://twitter.com/pengwynn")
+      info.class.should == Topsy::Author
       info.nick.should == 'pengwynn'
       info.influence_level.should == 10
+      assert info.description.include? "Ruby"
+      info.name.should == "Wynn Netherland"
+      info.url.should == "http://twitter.com/pengwynn"
+      info.topsy_author_url.should == "http://topsy.com/twitter/pengwynn"
+      info.type.should == 'twitter' 
     end
     
-    should "return search for authors" do
+    should "return a page with a list of authors for the search" do
       stub_get("/authorsearch.json?q=pengwynn", "authorsearch.json")
       results = Topsy.author_search("pengwynn")
+      results.class.should == Topsy::Page
       results.total.should == 491
+      results.list.first.class.should == Topsy::Author
       results.list.first.nick.should == 'bradleyjoyce'
     end
     
-    should "list of urls posted by an author" do
+    should "return a page with a list of urls posted by an author" do
       stub_get("/linkposts.json?url=http%3A%2F%2Ftwitter.com%2Fpengwynn", "linkposts.json")
       results = Topsy.link_posts("http://twitter.com/pengwynn")
+      results.class.should == Topsy::Page
       results.total.should == 1004
+      results.list.first.class.should == Topsy::Linkpost
       results.list.first.content.should == 'For auld lang syne, my dear: http://en.wikipedia.org/wiki/Auld_Lang_Syne#Lyrics'
+      results.list.first.permalink_url.should == 'http://twitter.com/pengwynn/status/7253938349'
+      results.list.first.target.class.should == Topsy::Target
+      results.list.first.date.should == 1262307998
+      results.list.first.date_alpha.should == '16 hours ago'
     end
     
     should "return count of links posted by an author" do
       stub_get("/linkpostcount.json?url=http%3A%2F%2Ftwitter.com%2Fpengwynn", "linkpostcount.json")
       counts = Topsy.link_post_count("http://twitter.com/pengwynn")
+      counts.class.should == Topsy::LinkpostCount
       counts.all.should == 1004
       counts.contains.should == 0
     end
     
-    should "return a list of author profiles that match the query." do
+    should "return a page with a list of authors that match the query." do
       stub_get("/profilesearch.json?q=pengwynn", "profilesearch.json")
       results = Topsy.profile_search("pengwynn")
+      results.class.should == Topsy::Page
       results.total.should == 1
+      results.list.first.class.should == Topsy::Author
       results.list.first.influence_level.should == 10
     end
     
-    should "return a list of URLs related to a given URL" do
+    should "return a page with a list of URLs related to a given URL" do
       stub_get("/related.json?url=http%3A%2F%2Fgemcutter.org", "related.json")
       results = Topsy.related("http://gemcutter.org")
+      results.class.should == Topsy::Page
       results.total.should == 17
+      results.list.first.class.should == Topsy::LinkSearchResult
       results.list.first.title.should == 'the update | gemcutter | awesome gem hosting'
+      results.list.first.trackback_total.should == 17
+      results.list.first.topsy_trackback_url.should == "http://topsy.com/tb/update.gemcutter.org/"
+      results.list.first.url.should == "http://update.gemcutter.org/"
     end
     
-    should "return a list of results for a query" do
+    should "return a page with a list of link search results for a query" do
       stub_get("/search.json?q=NYE", "search.json")
       results = Topsy.search("NYE")
+      results.class.should == Topsy::Page
       results.total.should == 117731
+      results.page.should == 1
+      results.perpage.should == 10
+      results.window.should == "a"
+      results.list.first.class.should == Topsy::LinkSearchResult
       results.list.first.score.should == 4.70643044
+      results.list.first.trackback_permalink.should == "http://twitter.com/spin/status/5164154014"
+      results.list.first.hits.should == 397
+      results.list.first.trackback_total.should == 2268
+      results.list.first.topsy_trackback_url.should == "http://topsy.com/trackback?url=http%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DXGK84Poeynk"
+      results.list.first.url.should == "http://www.youtube.com/watch?v=XGK84Poeynk"
+      results.list.first.content.should == "Science, autotuned, with Sagan, Bill Nye, Tyson, Feynman http://bit.ly/2tDk4y win!"
+      results.list.first.title.should == "YouTube - Symphony of Science - 'We Are All Connected' (ft. Sagan, Feynman, deGrasse Tyson & Bill Nye)"
+      results.list.first.highlight.should == "Science, autotuned, with Sagan, Bill <span class=\"highlight-term\">Nye</span>, Tyson, Feynman http://bit.ly/2tDk4y win! " 
     end
 
     should "return search counts for a term" do
       stub_get("/searchcount.json?q=Balloon%20Boy", "searchcount.json")
       counts = Topsy.search_count('Balloon Boy')
-      counts.last_hour.should == 0
-      counts.last_month.should == 3659
+      counts.class.should == Topsy::SearchCounts
+      counts.this_hour.should == 0
+      counts.this_month.should == 3659
       counts.all_time.should == 42289
     end
     
-    should "return count of tweets for a url" do
+    should "return a stats object for a url" do
       stub_get("/stats.json?url=http%3A%2F%2Fgithub.com%2Fpengwynn%2Flinkedin", "stats.json")
       stats = Topsy.stats("http://github.com/pengwynn/linkedin")
+      stats.class.should == Topsy::Stats
+      stats.topsy_trackback_url.should == "http://topsy.com/tb/github.com/pengwynn/linkedin"
+      stats.contains.should == 0
       stats.all.should == 11
       stats.influential.should == 3
     end
     
-    should "return a list of tags associated with a url" do
+    should "return a page with a list of tags associated with a url" do
       stub_get("/tags.json?url=http%3A%2F%2Fgemcutter.org", "tags.json")
       results = Topsy.tags("http://gemcutter.org")
+      results.class.should == Topsy::Page
       results.total.should == 9
+      results.list.first.class.should == Topsy::Tag
       assert results.list.map{|t| t.name}.include?("ruby")
+      results.list.first.url.should == "http://topsy.com/s?q=itunesu"
+      results.list.first.name.should == "itunesu"
     end
     
-    should "return a list of tweets (trackbacks) that mention the query URL" do
+    should "return a page with a list of tweets (trackbacks) that mention the query URL" do
       stub_get("/trackbacks.json?url=http%3A%2F%2Forrka.com", "trackbacks.json")
       results = Topsy.trackbacks("http://orrka.com")
+      results.class.should == Topsy::Page
       results.total.should == 3
+      results.list.first.class.should == Topsy::Tweet
       results.list.first.date.year.should == 2009
+      results.list.first.permalink_url.should == "http://twitter.com/orrka/status/6435248067"
+      results.list.first.date.should == Time.at(1260204073)
+      results.list.first.content.should == "Just added some portfolio entries to http://orrka.com/"
+      results.list.first.type.should == "tweet"
+      results.list.first.author.class.should == Topsy::Author
+      results.list.first.date_alpha.should == "25 days ago"
     end
     
-    should "return a list of trending terms" do
+    should "return a page with a list of trending terms" do
       stub_get("/trending.json", "trending.json")
       results = Topsy.trending
+      results.class.should == Topsy::Page
       results.total.should == 1379
+      results.list.first.class.should == Topsy::Trend
       assert results.list.map{|t| t.term}.flatten.include?("auld lang syne")
+      results.list.first.url.should == "http://topsy.com/s?q=photoshop+photoshop"
+      results.list.first.term.should == "photoshop photoshop"
     end
     
     should "return info about a url" do
       stub_get("/urlinfo.json?url=http%3A%2F%2Fwynnnetherland.com", 'urlinfo.json')
       results = Topsy.url_info('http://wynnnetherland.com')
+      results.class.should == Topsy::UrlInfo
       results.trackback_total.should == 39379
+      results.topsy_trackback_url.should == "http://topsy.com/tb/twitter.com/"
+      results.oneforty.should == "trending topics -  -amp09 right up there past the president today! :) http://tiny.cc/3yNbv"
+      results.url.should == "http://twitter.com/"
+      results.title.should == "trending topics -  -amp09 right up there past the president today! :)"
+      results.description.should == "Social networking"
+      results.description_attribution.should == "From DMOZ"
     end
   end