topsy 0.6.0 → 1.0.0

data/lib/topsy.rb

@@ -2,212 +2,36 @@ require 'hashie'
 require 'httparty'
 
 directory = File.expand_path(File.dirname(__FILE__))
+Dir[directory + '/topsy/*.rb'].each{ |f| require f unless f =~ /version/ }
 
 Hash.send :include, Hashie::HashExtensions
 
 
 module Topsy
-  class TopsyError < StandardError
-    attr_reader :data
+  class << self
+    include Topsy::Configurable
 
-    def initialize(data)
-      @data = data
-      super
+    def client
+      @client = Topsy::Client.new(options) unless defined?(@client)
+      @client
     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 [Topsy::Author]
-  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 [Symbol] :window Time window for results. (default: :auto) Options: :auto - automatically pick the most recent and relevant window. :hour last hour, :day last day, :week last week, :month last month, :all 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 [Topsy::Page]
-  def self.experts(q, options={})
-    result = Topsy::Client.new.experts(q, options)
-    Topsy::Page.new(result, Topsy::Author)
-  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 [Topsy::Page]
-  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 [Topsy::LinkpostCount]
-  def self.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.
-  #
-  # @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 [Topsy::Page]
-  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 [Topsy::Page]
-  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 [Symbol] :window Time window for results. (default: :auto) Options: :auto - automatically pick the most recent and relevant window. :hour last hour, :day last day, :week last week, :month last month, :realtime, :all 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 [Topsy::Page]
-  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 data on the volume of tweets 
-  # 
-  # @param [String] the query
-  # @params [String] what is being counted - "target" (default) -  the number of unique links , or "citation" - cthe number of unique tweets about links
-  # @params [Integer] The number of seconds for each slice ( default: 86400 = 1 day )
-  # @params [Integer] The number of slices (default 30 = 1 month)
-  # @return [Topsy::SearchHistogram]
-  def self.search_histogram( query , count_method = "target" , slice = 86400 , period = 30 )
-    Topsy::Client.new.search_histogram( query , count_method , slice , period  )
-  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 [Topsy::Stats]
-  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 [Topsy::Page]
-  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 [Topsy::Page]
-  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 [Topsy::Page]
-  def self.trending(options={})
-    Topsy::Client.new.trending(options)
-  end
-  
-  # Returns info about a URL
-  #
-  # @param [String] url the url to look up
-  # @return [Topsy::UrlInfo]
-  def self.url_info(url)
-    Topsy::Client.new.url_info(url)
-  end
-  
-  # Returns info about API rate limiting
-  #
-  # @return [Topsy::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)
+    def rate_limit
+      self.credit if @rate_limit_info.nil?
+      @rate_limit_info
+    end
+    
+    def rate_limit=(info)
+      @rate_limit_info = Topsy::RateLimitInfo.new(info)
+    end  
+
+    def respond_to_missing?(method_name , include_private=false); client.respond_to?(method_name, include_private); end if RUBY_VERSION >= "1.9"
+    def respond_to?(method_name, include_private=false); client.respond_to?(method_name, include_private) || super; end if RUBY_VERSION < "1.9"
+
+private
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
   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', 'search_histogram')
-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/lib/topsy/client.rb

@@ -1,15 +1,35 @@
+require 'topsy/configurable'
 module Topsy
   class Client
     include HTTParty
     format :json
     base_uri "http://otter.topsy.com"
     @@windows = {:all => 'a', :week => 'w', :day => 'd', :month => 'm', :hour => 'h', :realtime => 'realtime'}
-    
+
+    # topsy client modules
+    include Topsy::Configurable
+
+    def get( path , opts = {} )
+      if @api_key.length > 0 
+        # Handle appending the api key
+        opts[:query] = {} unless opts.has_key?(:query)
+        opts[:query].merge!( { :apikey => options[:api_key] } )
+      end
+      self.class.get( path , opts )
+    end
+
+    def initialize( options = {} )
+      setup
+      Topsy::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || instance_variable_get(:"@#{key}"))
+      end
+    end
+
     # Returns info about API rate limiting
     #
     # @return [Topsy::RateLimitInfo]
     def credit
-      handle_response(self.class.get("/credit.json"))
+      handle_response(get("/credit.json"))
     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
@@ -17,7 +37,7 @@ module Topsy
     # @param [String] url URL string for the author.
     # @return [Topsy::Author]
     def author_info(url)
-      authorinfo = handle_response(self.class.get("/authorinfo.json", :query => {:url => url}))
+      authorinfo = handle_response(get("/authorinfo.json", :query => {:url => url}))
       Topsy::Author.new(authorinfo)
     end
 
@@ -31,7 +51,8 @@ module Topsy
     # @return [Hashie::Mash]
     def experts(q, options={})
       options = set_window_or_default(options)
-      handle_response(self.class.get("/experts.json", :query => {:q => q}.merge(options)))
+      result = handle_response(get("/experts.json", :query => {:q => q}.merge(options)))
+      Topsy::Page.new(result, Topsy::Author)
     end
     
     # Returns list of URLs posted by an author
@@ -43,7 +64,7 @@ module Topsy
     # @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)
     # @return [Topsy::Page]
     def link_posts(url, options={})
-      linkposts = handle_response(self.class.get("/linkposts.json", :query => {:url => url}.merge(options)))
+      linkposts = handle_response(get("/linkposts.json", :query => {:url => url}.merge(options)))
       Topsy::Page.new(linkposts,Topsy::Linkpost)
     end
     
@@ -54,7 +75,7 @@ module Topsy
     # @option options [String] :contains Query string to filter results
     # @return [Topsy::LinkpostCount]
     def link_post_count(url, options={})
-      count = handle_response(self.class.get("/linkpostcount.json", :query => {:url => url}.merge(options)))
+      count = handle_response(get("/linkpostcount.json", :query => {:url => url}.merge(options)))
       Topsy::LinkpostCount.new(count)
     end
 
@@ -66,7 +87,7 @@ module Topsy
     # @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)
     # @return [Topsy::Page]
     def related(url, options={})
-      response = handle_response(self.class.get("/related.json", :query => {:url => url}.merge(options)))
+      response = handle_response(get("/related.json", :query => {:url => url}.merge(options)))
       Topsy::Page.new(response,Topsy::LinkSearchResult)
     end
     
@@ -87,7 +108,7 @@ module Topsy
         q += " site:#{options.delete(:site)}" if options[:site]
       end
       options = set_window_or_default(options)
-      results = handle_response(self.class.get("/search.json", :query => {:q => q}.merge(options)))
+      results = handle_response(get("/search.json", :query => {:q => q}.merge(options)))
       Topsy::Page.new(results,Topsy::LinkSearchResult)
     end
 
@@ -96,7 +117,7 @@ module Topsy
     # @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}))
+      counts = handle_response(get("/searchcount.json", :query => {:q => q}))
       Topsy::SearchCounts.new(counts)
     end
 
@@ -107,8 +128,8 @@ module Topsy
     # @param [Integer] slice - 
     # @param [Integer] period -
     # 
-    def search_histogram( q , count_method , slice , period  )
-      response = handle_response(self.class.get("/searchhistogram.json" , :query => { :q => q , :slice => slice , :period => period , :count_method => count_method } ))
+    def search_histogram( q , count_method = 'target' , slice = 86400 , period = 30  )
+      response = handle_response(get("/searchhistogram.json" , :query => { :q => q , :slice => slice , :period => period , :count_method => count_method } ))
       Topsy::SearchHistogram.new(response)
     end
     
@@ -121,7 +142,7 @@ module Topsy
     def stats(url, options={})
       query = {:url => url}
       query.merge!(options)
-      response = handle_response(self.class.get("/stats.json", :query => query))
+      response = handle_response(get("/stats.json", :query => query))
       Topsy::Stats.new(response)
     end
     
@@ -133,7 +154,7 @@ module Topsy
     # @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)
     # @return [Topsy::Page]
     def tags(url, options={})
-      response = handle_response(self.class.get("/tags.json", :query => {:url => url}.merge(options)))
+      response = handle_response(get("/tags.json", :query => {:url => url}.merge(options)))
       Topsy::Page.new(response,Topsy::Tag)
     end
     
@@ -147,7 +168,7 @@ module Topsy
     # @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)
     # @return [Topsy::Page]
     def trackbacks(url, options={})
-      results = handle_response(self.class.get("/trackbacks.json", :query => {:url => url}.merge(options)))
+      results = handle_response(get("/trackbacks.json", :query => {:url => url}.merge(options)))
       results.list.each do |trackback|
         trackback.date = Time.at(trackback.date)
       end
@@ -161,7 +182,7 @@ module Topsy
     # @option options [Integer] :perpage limit number of results per page. (default: 10, max: 50)
     # @return [Topsy::Page]
     def trending(options={})
-      response = handle_response(self.class.get("/trending.json", :query => options))
+      response = handle_response(get("/trending.json", :query => options))
       Topsy::Page.new(response,Topsy::Trend)
     end
     
@@ -170,7 +191,7 @@ module Topsy
     # @param [String] url the url to look up
     # @return [Topsy::UrlInfo]
     def url_info(url)
-      response = handle_response(self.class.get("/urlinfo.json", :query => {:url => url}))
+      response = handle_response(get("/urlinfo.json", :query => {:url => url}))
       Topsy::UrlInfo.new(response)
     end
 

data/lib/topsy/configurable.rb

@@ -0,0 +1,43 @@
+require 'topsy/default'
+module Topsy
+  module Configurable
+    attr_writer :api_key
+
+    class << self
+
+      def keys
+        @keys ||= [
+          :api_key
+        ]
+      end
+
+    end
+    
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # @return [Fixnum]
+    def cache_key
+      options.hash
+    end
+
+    def reset!
+      Topsy::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Topsy::Default.options[key])
+      end
+      self
+    end
+    alias setup reset!
+
+  private
+
+    # @return [Hash]
+    def options
+      Hash[Topsy::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+
+  end
+end

data/lib/topsy/default.rb

@@ -0,0 +1,15 @@
+module Topsy
+  module Default
+    class << self
+      # @return [Hash]
+      def options
+        Hash[Topsy::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @return [String]
+      def api_key
+        ""
+      end
+    end
+  end
+end

data/lib/topsy/errors.rb

@@ -0,0 +1,18 @@
+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
+end

data/lib/topsy/version.rb

@@ -1,3 +1,3 @@
 module Topsy
-  VERSION = '0.6.0'
+  VERSION = '1.0.0'
 end

data/test/test_topsy.rb

@@ -2,6 +2,16 @@ require 'helper'
 
 class TestTopsy < Test::Unit::TestCase
   
+  context "when initializing Topsy client" do
+    context "with API key" do
+      should "append api_key to all requests" do
+        client = Topsy::Client.new( { :api_key => "abcdefg123456" } )
+        stub_get("/search.json?q=NYE&window=m&apikey=abcdefg123456", "search.json")
+        client.search("NYE", :window => :month)
+      end
+    end
+  end
+
   context "when hitting the Otter API" do
     
     should "return rate limit information when calling credit" do
@@ -12,8 +22,6 @@ class TestTopsy < Test::Unit::TestCase
     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")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: topsy
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -116,6 +116,9 @@ extra_rdoc_files: []
 files:
 - lib/topsy/author.rb
 - lib/topsy/client.rb
+- lib/topsy/configurable.rb
+- lib/topsy/default.rb
+- lib/topsy/errors.rb
 - lib/topsy/link_search_result.rb
 - lib/topsy/linkpost.rb
 - lib/topsy/linkpost_count.rb