topsy 0.1.0 → 0.2.0

data/.gitignore

@@ -1,3 +1,7 @@
+## Aptana
+.project
+.loadpath
+
 ## MAC OS
 .DS_Store
 

data/.yardoc/checksums

@@ -1,2 +1,14 @@
-lib/topsy/search_counts.rb 090ef89faf0383ab602f30becc24a972b39bb2f8
-lib/topsy/client.rb 78127632ba582b2e5bfbd3947ca662de0c95bbc1
+lib/topsy/stats.rb 05ef28e762c722c8f36b442135be3993baf3ac70
+lib/topsy/tweet.rb 1e4c3636eed383c6d6e49d8c2d3bf95435996f79
+lib/topsy/url_info.rb 376a55884265d9ebb82983b91b7fd8ce932295e6
+lib/topsy/trend.rb 7785325ff539149177c80d2e079d0e896eb2d169
+lib/topsy/tag.rb 5cb4a51fa515e534153bc657d1bbbf94e52465b1
+lib/topsy/rate_limit_info.rb 4021ddd156d6b1eb16a1ebcdb2c93febcba2f91a
+lib/topsy/linkpost_count.rb c867399d0400150cf7762d6cd28c111d2dba74ba
+lib/topsy/target.rb f8c86f4793c7e9326c76108374d73eeff351478a
+lib/topsy/search_counts.rb 7160dc24af26870d278a392faf8c9ab2c3938f70
+lib/topsy/link_search_result.rb 4b16323121503d2c7d999584ec1d8c90554e5100
+lib/topsy/linkpost.rb 57b39e2fd1905456ba4a2f9db07f662625b7e32d
+lib/topsy/client.rb 196b9ee3a51b517c9defdea44ff7655a187822cd
+lib/topsy/author.rb 4ccffe22f3d11d12f929fb893302cf732366ad9f
+lib/topsy/page.rb a4f3a25ad9d81578f87b41da3307149c931d508b

data/README.markdown

@@ -1,20 +1,85 @@
 # Topsy
 
-Simple Ruby wrapper for the Topsy.com Otter API.
+Simple Ruby wrapper for the [Topsy.com](http://topsy.com) Otter API. Topsy is a search engine powered by tweets.
 
 ## Installation
 
+Topsy is hosted on Gemcutter, so:
+
+    gem install gemcutter # if necessary
+    gem tumble # if necessary
     sudo gem install topsy
 
 ## Usage
+    >> Topsy.author_info('http://twitter.com/barackobama')
+    => <#Topsy::Author description="44th President of the United States" influence_level=10 name="Barack Obama" nick="barackobama" topsy_author_url="http://topsy.com/twitter/barackobama" type="twitter" url="http://twitter.com/barackobama">
+
+    >> Topsy.author_search('programming')
+    => <#Topsy::Page list=[<#Topsy::Author descript ... ] page=1 perpage=15 topsy_trackback_url=nil total=97229 window=nil>
+    
+    >> Topsy.author_search('programming', :perpage => 2, :page => 1)
+    => <#Topsy::Page list=[<#Topsy::Author description="Most ... ] page=1 perpage=2 topsy_trackback_url=nil total=100685 window=nil>
+    
+    >> Topsy.link_posts('http://twitter.com/barackobama', :perpage => 2, :page => 2)
+    => <#Topsy::Page list=[<#Topsy::Linkpost content="An important reminder ... ] page=2 perpage=2 topsy_trackback_url=nil total=402 window=nil>
+
+    >> Topsy.link_posts('http://twitter.com/barackobama')
+    => <#Topsy::Page list=[<#Topsy::Linkpost content="An important reminder about health reform on the @Whit... ] page=1 perpage=10 topsy_trackback_url=nil total=402 window=nil>
+    
+    >> Topsy.link_post_count('http://twitter.com/barackobama')
+    => <#Topsy::LinkpostCount all=402 contains=0>
+
+    >> Topsy.url_info('http://etagwerker.com')
+    => <#Topsy::UrlInfo description="" description_attribution="" oneforty="just finished installing wordpress in a linux .." url="http://etagwerker.com/"> 
+    
+    >> Topsy.stats('http://www.google.com')
+    => <#Topsy::Stats all=29869 contains=0 influential=2023 topsy_trackback_url="http://topsy.com/tb/www.google.com/">
+
+    >> Topsy.search('rock')
+    => <#Topsy::Page list=[<#Topsy::LinkSearchResult content="Why 30 Rock is a Rip-Off of The Muppet Show - http://is.gd/15KJZ" .. ]  page=1 perpage=10 topsy_trackback_url=nil total=714429 window="a"> 
+    
+    >> Topsy.search('rock', :perpage => 2, :page => 3)
+    => <#Topsy::Page list=[<#Topsy::LinkSearchResult content="Just released! Beatles Rock Band opening cinematic. Amaz ..." ] page=3 perpage=2 topsy_trackback_url=nil total=714429 window="a">
+    
+    >> Topsy.search('rock', :perpage => 2, :page => 3, :window => 'd')
+    => <#Topsy::Page list=[<#Topsy::LinkSearchResult content="Be a Google Wave Rock Star http://ff.im/-dPdGL" highlight="Be a .. "] page=3 perpage=2 topsy_trackback_url=nil total=6064 window="d">
+    
+    >> Topsy.search_count('rock')
+    => <#Topsy::SearchCounts a=5191790 d=7601 h=206 m=216179 w=45462>
+    
+    >> Topsy.profile_search('Hacker+Rubyist')
+    => <#Topsy::Page list=[<#Topsy::Author description="Hacker; Rubyist; Bit Poet" influence_level=4 name="Ben Bleythi ...">] page=1 perpage=10 topsy_trackback_url=nil total=5 window=nil>
+     
+    >> Topsy.profile_search('Hacker+Rubyist', :perpage => 1, :page => 2)
+    => <#Topsy::Page list=[<#Topsy::Author description="Rubyist, hacker, gamer (video, board and role-playing)... ">] page=2 perpage=1 topsy_trackback_url=nil total=5 window=nil>
+    
+    >> Topsy.related('http://www.twitter.com')
+    => <#Topsy::Page list=[<#Topsy::LinkSearchResult title="New Twitter Feature: Body Counts | Danger Room ... ">] page=1 perpage=10 topsy_trackback_url=nil total=4458 window=nil>
+     
+    >> Topsy.tags('http://twitter.com')
+    => <#Topsy::Page list=[<#Topsy::Tag name="current" url="http://topsy.com/s?q=current">, <#Topsy::Tag name="twe ... ">] page=1 perpage=10 topsy_trackback_url=nil total=1885 window=nil>
+    
+    >> Topsy.trending
+    => <#Topsy::Page list=[<#Topsy::Trend term="u s reopens embassy in yemen" url="http://topsy.com/s?q=u+s%20r ... ">] page=1 perpage=10 topsy_trackback_url=nil total=1434 window=nil>
+    
+    >> Topsy.trending(:page => 3, :perpage => 2)
+    => <#Topsy::Page list=[<#Topsy::Trend term="droid vs iphone" url="http://topsy.com/s?q=droid+vs%20iphone" ... ">] page=3 perpage=2 topsy_trackback_url=nil total=1434 window=nil>
 
+    >> Topsy.trackbacks('http://twitter.com', :perpage => 2, :page => 2)
+    => <#Topsy::Page list=[<#Topsy::Tweet author=<#Topsy::Author influence_level=8 name="tama" photo_url="http://a3.twimg .. ">] page=2 perpage=2 topsy_trackback_url="http://topsy.com/tb/twitter.com/" total=39705 window=nil>
+    
+    >> Topsy.trackbacks('http://twitter.com', :perpage => 2, :page => 2, :contains => 'mashable')
+    => <#Topsy::Page list=[<#Topsy::Tweet author=<#Topsy::Author name="Hannah Grosvenor" photo_url="http://a1.t. ... >] page=2 perpage=2 topsy_trackback_url="http://topsy.com/tb/twitter.com/" total=41 window=nil>
+    
     # Fetch search results for the query "gemcutter"
-    results = Topsy.search("gemcutter")
+    >> results = Topsy.search("gemcutter")
+    => <#Topsy::Page list=[<#Topsy::LinkSearchResult content="New design ... ]>
     
     # Fetch search counts for the query "gemcutter"
-    counts = Topsy.search_count("gemcutter")
-    counts.this_week
-    => 19
+    >> counts = Topsy.search_count("gemcutter")
+    => <#Topsy::SearchCounts a=773 d=6 h=0 m=103 w=24>
+    >> counts.this_week
+    => 24
     
 Check the [full gem documentation](http://yardoc.org/docs/pengwynn-topsy) and [API docs](http://code.google.com/p/otterapi/wiki/Resources) for more info.
 
@@ -31,4 +96,4 @@ Check the [full gem documentation](http://yardoc.org/docs/pengwynn-topsy) and [A
 
 ## Copyright
 
-Copyright (c) 2010 Wynn Netherland. See LICENSE for details.
+Copyright (c) 2010 [Wynn Netherland](http://wynnnetherland.com). See LICENSE for details.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.description = %Q{Ruby wrapper for the Topsy otterapi}
     gem.email = "wynn.netherland@gmail.com"
     gem.homepage = "http://github.com/pengwynn/topsy"
-    gem.authors = ["Wynn Netherland"]
+    gem.authors = ["Wynn Netherland", "Ernesto Tagwerker"]
     
     gem.add_dependency('hashie', '~> 0.1.3')
     gem.add_dependency('httparty', '~> 0.4.5')

data/TODO

@@ -0,0 +1,7 @@
+# Topsy
+
+Here is the TODO list for the topsy gem. 
+
+## Add tests for pagination of queries
+## Make windows for queries easier to understand (eg. :window => :day, or :window => :year, or :window => :month)
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/doc/Topsy/Author.html

@@ -0,0 +1,201 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=UTF-8" />
+<title>Class: Topsy::Author</title>
+<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '..';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (A)</a> &raquo; 
+    <a href="../Topsy.html" title="Topsy">Topsy</a>
+     &raquo; 
+    <span class="title">Author</span>
+  
+</div>
+
+      <div id="search">
+  <a id="class_list_link" href="#">Namespace List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+
+      <div class="clear"></div>
+    </div>
+    
+    <iframe id="search_frame"></iframe>
+    
+    <div id="content"><h1>Class: Topsy::Author 
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Hashie::Mash</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">Hashie::Mash</li>
+          
+            <li class="next">Topsy::Author</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/topsy/author.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+  
+
+  <h2>Instance Method Summary</h2>
+
+  <ul class="summary">
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"></span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"></span>
+  
+</li>
+
+    
+  </ul>
+
+  
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="to_s-instance_method">
+  
+    - (<tt>Object</tt>) <strong>to_s</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+15
+16
+17</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/topsy/author.rb', line 15</span>
+
+<span class='def def kw'>def</span> <span class='to_s identifier id'>to_s</span>
+  <span class='dstring node'>&quot;Topsy Author: #{name}, @#{nick}, #{topsy_author_url}&quot;</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <p class="signature " id="type-instance_method">
+  
+    - (<tt>Object</tt>) <strong>type</strong> 
+  
+
+  
+</p><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/topsy/author.rb', line 19</span>
+
+<span class='def def kw'>def</span> <span class='type identifier id'>type</span>
+  <span class='self self kw'>self</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span>
+<span class='end end kw'>end</span>
+</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+    
+    <div id="footer">
+  Generated on Wed Jan  6 10:31:55 2010 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+  0.5.2 (ruby-1.8.6).
+</div>
+
+  </body>
+</html>