topsy 0.5.1 → 0.6.0

data/lib/topsy.rb

@@ -110,6 +110,17 @@ module Topsy
   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
   #
@@ -191,6 +202,7 @@ 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')

data/lib/topsy/client.rb

@@ -99,6 +99,18 @@ module Topsy
       counts = handle_response(self.class.get("/searchcount.json", :query => {:q => q}))
       Topsy::SearchCounts.new(counts)
     end
+
+    # Returns mention count data for the given query
+    # 
+    # @param [String] q - The query.  Use site:domain.com to get domain counts and @username to get mention counts.
+    # @param [String] count_method - what is being counted - "target" (default) -  the number of unique links , or "citation" - cthe number of unique tweets about links
+    # @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 } ))
+      Topsy::SearchHistogram.new(response)
+    end
     
     # Returns counts of tweets for a URL
     #

data/lib/topsy/search_histogram.rb

@@ -0,0 +1,18 @@
+# This is the search_histogram class for the topsy library. 
+# A SearchHistogram has the following attributes:
+# 	"histogram":[21024,10386,7270,12722,15993,17522,10517,8899,10363,11491,11729,16262,12940,8800,7589,8275,8692,14924,25927,30728,24562,22369,19203,33483,15497,11527,11814,11893,13998,7268],
+# 	"period":30,
+# 	"count_method":"citation",
+# 	"slice":86400
+# According to the official Topsy doc: http://code.google.com/p/otterapi/wiki/Resources#/searchhistogram
+#
+module Topsy
+  
+  class SearchHistogram < Hashie::Mash
+    
+    def to_s
+      "Topsy SearchHistogram: #{histogram}, Period: #{period}, Count Method: #{count_method} , Slice: #{slice}"
+    end
+    
+  end
+end

data/lib/topsy/version.rb

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

data/test/test_topsy.rb

@@ -215,6 +215,40 @@ class TestTopsy < Test::Unit::TestCase
       results.description.should == "Social networking"
       results.description_attribution.should == "From DMOZ"
     end
+
+    context "#searchhistogram" do
+      context "citations" do
+        context "for domain" do
+          stub_get("/searchhistogram.json?q=site%3Abuzzfeed.com&slice=86400&period=30&count_method=citation", "searchhistogram-citation.json")
+          results = Topsy.search_histogram( 'site:buzzfeed.com' , "citation" , 86400 , 30 )
+          results.class.should == Topsy::SearchHistogram
+          results.period.should == 30
+          results.slice.should == 86400
+          results.count_method.should == "citation"
+          results.histogram.should == [21024,10386,7270,12722,15993,17522,10517,8899,10363,11491,11729,16262,12940,8800,7589,8275,8692,14924,25927,30728,24562,22369,19203,33483,15497,11527,11814,11893,13998,7268]
+        end
+
+        context "for user account" do
+          stub_get("/searchhistogram.json?q=%40garyvee&slice=86400&period=30&count_method=citation", "searchhistogram-mention-citation.json")
+          results = Topsy.search_histogram( '@garyvee' , "citation" , 86400 , 30 )
+          results.class.should == Topsy::SearchHistogram
+          results.period.should == 30
+          results.slice.should == 86400
+          results.count_method.should == "citation"
+          results.histogram.should == [69,77,279,117,143,186,123,49,75,75,173,167,58,42,46,40,64,186,94,166,96,146,106,51,42,101,89,69,209,78]
+        end
+
+        context "for keyword" do
+          stub_get("/searchhistogram.json?q=apple&slice=86400&period=30&count_method=citation", "searchhistogram-keyword-citation.json")
+          results = Topsy.search_histogram( 'apple' , "citation" , 86400 , 30 )
+          results.class.should == Topsy::SearchHistogram
+          results.period.should == 30
+          results.slice.should == 86400
+          results.count_method.should == "citation"
+          results.histogram.should == [249615,206548,161825,199043,267041,356657,303621,175584,166839,167086,197773,281216,234291,194937,162997,177703,167064,250086,300637,318948,361341,382810,254625,169622,203973,418762,550058,347752,370830,315412]
+        end
+      end
+    end
   end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: topsy
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2011-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70126709212440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70126709212440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70126709211980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70126709211980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70126709211440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: 2.11.3
   type: :development
   prerelease: false
-  version_requirements: *70126709211440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.3
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70126709210860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +70,15 @@ dependencies:
         version: 0.9.10
   type: :development
   prerelease: false
-  version_requirements: *70126709210860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.10
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70126709210340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +86,15 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *70126709210340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &70126709209660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,7 +102,12 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70126709209660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: Wrapper for the Topsy API
 email: wynn.netherland@gmail.com
 executables: []
@@ -92,6 +122,7 @@ files:
 - lib/topsy/page.rb
 - lib/topsy/rate_limit_info.rb
 - lib/topsy/search_counts.rb
+- lib/topsy/search_histogram.rb
 - lib/topsy/stats.rb
 - lib/topsy/tag.rb
 - lib/topsy/target.rb
@@ -122,10 +153,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Topsy API
 test_files:
 - test/helper.rb
 - test/test_topsy.rb
+has_rdoc: