topsy 0.1.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.yardoc/checksums

@@ -0,0 +1,2 @@
+lib/topsy/search_counts.rb 090ef89faf0383ab602f30becc24a972b39bb2f8
+lib/topsy/client.rb 78127632ba582b2e5bfbd3947ca662de0c95bbc1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wynn Netherland
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,34 @@
+# Topsy
+
+Simple Ruby wrapper for the Topsy.com Otter API.
+
+## Installation
+
+    sudo gem install topsy
+
+## Usage
+
+    # Fetch search results for the query "gemcutter"
+    results = Topsy.search("gemcutter")
+    
+    # Fetch search counts for the query "gemcutter"
+    counts = Topsy.search_count("gemcutter")
+    counts.this_week
+    => 19
+    
+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.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Wynn Netherland. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "topsy"
+    gem.summary = %Q{Ruby wrapper for the Topsy otterapi}
+    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.add_dependency('hashie', '~> 0.1.3')
+    gem.add_dependency('httparty', '~> 0.4.5')
+
+    gem.add_development_dependency('thoughtbot-shoulda', '>= 2.10.1')
+    gem.add_development_dependency('jnunemaker-matchy', '0.4.0')
+    gem.add_development_dependency('mocha', '0.9.4')
+    gem.add_development_dependency('fakeweb', '>= 1.2.5')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/changelog.markdown

@@ -0,0 +1,5 @@
+# Changelog
+
+# 0.1.0 January 1, 2010
+
+  * Initial version

data/lib/topsy.rb

@@ -0,0 +1,174 @@
+require 'rubygems'
+
+gem 'hashie', '~> 0.1.3'
+require 'hashie'
+
+gem 'httparty', '~> 0.4.5'
+require 'httparty'
+
+directory = File.expand_path(File.dirname(__FILE__))
+
+Hash.send :include, Hashie::HashExtensions
+
+
+module Topsy
+  class TopsyError < StandardError
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+      super
+    end
+  end
+
+  class RateLimitExceeded < StandardError; end
+  class Unauthorized      < StandardError; end
+  class General           < TopsyError; end
+
+  class Unavailable   < StandardError; end
+  class InformTopsy < StandardError; end
+  class NotFound      < StandardError; end
+  
+  # Returns profile information for an author (a twitter profile indexed by Topsy). The response contains the name, description (biography) and the influence level of the author
+  #
+  # @param [String] url URL string for the author.
+  # @return [Hashie::Mash]
+  def self.author_info(url)
+    Topsy::Client.new.author_info(url)
+  end
+  
+  
+  # Returns list of authors that talk about the query. The list is sorted by frequency of posts and the influence of authors.
+  #
+  # @param [String] q the search query string
+  # @param [Hash] options method options
+  # @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]
+  def self.author_search(q, options={})
+    Topsy::Client.new.author_search(q, options)
+  end
+  
+  # Returns list of URLs posted by an author
+  #
+  # @param [String] url URL string for the author.
+  # @param [Hash] options method options
+  # @option options [String] :contains Query string to filter results
+  # @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]
+  def self.link_posts(url, options={})
+    Topsy::Client.new.link_posts(url, options={})
+  end
+  
+  # Returns count of links posted by an author. This is the efficient, count-only version of /linkposts
+  #
+  # @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]
+  def self.link_post_count(url, options={})
+    Topsy::Client.new.link_post_count(url, options={})
+  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.
+  #
+  # @param [String] q the search query string
+  # @param [Hash] options method options
+  # @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]
+  def self.profile_search(q, options={})
+    Topsy::Client.new.profile_search(q, options)
+  end
+  
+  # Returns list of URLs related to a given URL
+  #
+  # @param [String] url URL string for the author.
+  # @param [Hash] options method options
+  # @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]
+  def self.related(url, options={})
+    Topsy::Client.new.related(url, options)
+  end
+  
+  # Returns list of results for a query.
+  #
+  # @param [String] q the search query string
+  # @param [Hash] options method options
+  # @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]
+  def self.search(q, options={})
+    Topsy::Client.new.search(q, options)
+  end
+  
+  # Returns count of results for a search query.
+  #
+  # @param [String] q the search query string
+  # @return [Topsy::SearchCounts]
+  def self.search_count(q)
+    Topsy::Client.new.search_count(q)
+  end
+  
+  # Returns counts of tweets for a URL
+  #
+  # @param [String] url the url to look up
+  # @param [Hash] options method options
+  # @option options [String] :contains Query string to filter results
+  # @return [Hashie::Mash]
+  def self.stats(url, options={})
+    Topsy::Client.new.stats(url, options)
+  end
+  
+  # Returns list of tags for a URL.
+  #
+  # @param [String] url the search query string
+  # @param [Hash] options method options
+  # @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]
+  def self.tags(url, options={})
+    Topsy::Client.new.tags(url, options)
+  end
+  
+  # Returns list of tweets (trackbacks) that mention the query URL, most recent first.
+  #
+  # @param [String] url URL string for the author.
+  # @param [Hash] options method options
+  # @option options [String] :contains Query string to filter results
+  # @option options [Boolean] :infonly filters trackbacks to influential only (default 0)
+  # @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]
+  def self.trackbacks(url, options={})
+    Topsy::Client.new.trackbacks(url, options)
+  end
+  
+  
+  # Returns list of trending terms
+  #
+  # @param [Hash] options method options
+  # @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]
+  def self.trending(options={})
+    Topsy::Client.new.trending(options)
+  end
+  
+  # Returns info about a URL
+  #
+  # @param [String] url the url to look up
+  # @return [Hashie::Mash]
+  def self.url_info(url)
+    Topsy::Client.new.url_info(url)
+  end
+
+  
+end
+
+require File.join(directory, 'topsy', 'search_counts')
+require File.join(directory, 'topsy', 'client')

data/lib/topsy/client.rb

@@ -0,0 +1,180 @@
+module Topsy
+  class Client
+    include HTTParty
+    format :json
+    base_uri "http://otter.topsy.com"
+    
+    # Returns Profile information for an author (a twitter profile indexed by Topsy). The response contains the name, description (biography) and the influence level of the author
+    #
+    # @param [String] url URL string for the author.
+    # @return [Hashie::Mash]
+    def author_info(url)
+      handle_response(self.class.get("/authorinfo.json", :query => {:url => url}))
+    end
+
+    # Returns list of authors that talk about the query. The list is sorted by frequency of posts and the influence of authors.
+    #
+    # @param [String] q the search query string
+    # @param [Hash] options method options
+    # @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]
+    def author_search(q, options={})
+      handle_response(self.class.get("/authorsearch.json", :query => {:q => q}.merge(options)))
+    end
+    
+    # Returns list of URLs posted by an author
+    #
+    # @param [String] url URL string for the author.
+    # @param [Hash] options method options
+    # @option options [String] :contains Query string to filter results
+    # @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]
+    def link_posts(url, options={})
+      query = {:url => url}
+      query.merge!(options)
+      handle_response(self.class.get("/linkposts.json", :query => query))
+    end
+    
+    # Returns count of links posted by an author. This is the efficient, count-only version of /linkposts
+    #
+    # @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]
+    def link_post_count(url, options={})
+      handle_response(self.class.get("/linkpostcount.json", :query => {:url => url}.merge(options)))
+    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.
+    #
+    # @param [String] q the search query string
+    # @param [Hash] options method options
+    # @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]
+    def profile_search(q, options={})
+      handle_response(self.class.get("/profilesearch.json", :query => {:q => q}.merge(options)))
+    end
+    
+    # Returns list of URLs related to a given URL
+    #
+    # @param [String] url URL string for the author.
+    # @param [Hash] options method options
+    # @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]
+    def related(url, options={})
+      handle_response(self.class.get("/related.json", :query => {:url => url}.merge(options)))
+    end
+    
+    # Returns list of results for a query.
+    #
+    # @param [String] q the search query string
+    # @param [Hash] options method options
+    # @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]
+    def search(q, options={})
+      handle_response(self.class.get("/search.json", :query => {:q => q}.merge(options)))
+    end
+
+    # Returns count of results for a search query.
+    #
+    # @param [String] q the search query string
+    # @return [Topsy::SearchCounts]
+    def search_count(q)
+      counts = handle_response(self.class.get("/searchcount.json", :query => {:q => q}))
+      Topsy::SearchCounts.new(counts)
+    end
+    
+    # Returns counts of tweets for a URL
+    #
+    # @param [String] url the url to look up
+    # @param [Hash] options method options
+    # @option options [String] :contains Query string to filter results
+    # @return [Hashie::Mash]
+    def stats(url, options={})
+      query = {:url => url}
+      query.merge!(options)
+      handle_response(self.class.get("/stats.json", :query => query))
+    end
+    
+    # Returns list of tags for a URL.
+    #
+    # @param [String] url the search query string
+    # @param [Hash] options method options
+    # @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]
+    def tags(url, options={})
+      handle_response(self.class.get("/tags.json", :query => {:url => url}.merge(options)))
+    end
+    
+    # Returns list of tweets (trackbacks) that mention the query URL, most recent first.
+    #
+    # @param [String] url URL string for the author.
+    # @param [Hash] options method options
+    # @option options [String] :contains Query string to filter results
+    # @option options [Boolean] :infonly filters trackbacks to influential only (default 0)
+    # @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]
+    def trackbacks(url, options={})
+      results = handle_response(self.class.get("/trackbacks.json", :query => {:url => url}.merge(options)))
+      results.list.each do |trackback|
+        trackback.date = Time.at(trackback.date)
+      end
+      results
+    end
+    
+    # Returns list of trending terms
+    #
+    # @param [Hash] options method options
+    # @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]
+    def trending(options={})
+      handle_response(self.class.get("/trending.json", :query => options))
+    end
+    
+    # Returns info about a URL
+    #
+    # @param [String] url the url to look up
+    # @return [Hashie::Mash]
+    def url_info(url)
+      handle_response(self.class.get("/urlinfo.json", :query => {:url => url}))
+    end
+
+    private
+
+      def handle_response(response)
+        raise_errors(response)
+        mashup(response)
+      end
+
+      def raise_errors(response)
+        code = response.code.to_i
+        case code
+        when 400
+          raise Topsy::General.new("Parameter check failed. This error indicates that a required parameter is missing or a parameter has a value that is out of bounds.")
+        when 403
+          raise Topsy::Unauthorized.new
+        when 404
+          raise Topsy::NotFound.new
+        when 500
+          raise Topsy::InformTopsy.new
+        when 503
+          raise Topsy::Unavailable.new
+        end
+      end
+
+      def mashup(response)
+        Hashie::Mash.new(response).response
+      end
+
+  end
+end