look-twitter-search 0.5.4 → 0.5.6

data/CHANGELOG.textile

@@ -0,0 +1,16 @@
+h2. 0.5.5 (May 18, 2009)
+
+* raise error when query contains :near or :within:. (Dan Croak)
+
+h2. 0.5.4 (May 16, 2009)
+
+* Fixed bug in Twitter trends. (Dan Croak)
+* Refactored test suite. Now organized by function, uses redgreen, began moving toward using JSON instead of YAML for fixtures. (Dan Croak)
+* Exposed Shoulda Macros to apps that want to use them. (Dan Croak)
+
+h2. 0.5.3 (May 15, 2009)
+
+* Added Twitter trends. (Matt Sanford)
+* Added overdue attribution for Luke Francl, Matt Sanford, Alejandro Crosa, Danny Burkes, Don Brown, & HotFusionMan.
+* Added CHANGELOG. (Dan Croak)
+

data/README.markdown

@@ -14,8 +14,10 @@ Require the gem.
 
 Set up a TwitterSearch::Client. Name your client (a.k.a. 'user agent') to something meaningful, such as your app's name. This helps Twitter Search answer any questions about your use of the API.
 
-	@client = TwitterSearch::Client.new 'politweets'
-	
+    @client = TwitterSearch::Client.new 'politweets'
+
+### Search
+
 Request tweets by calling the query method of your client. It takes either a String or a Hash of arguments.
 
     @tweets = @client.query 'twitter search'
@@ -26,6 +28,16 @@ The String form uses the default Twitter Search behavior, which in this example
 
 Use the Twitter Search API's query operators with the :q key to access a variety of behavior.
 
+### Trends
+
+Request the current trending topics by calling the trends method of your client. It takes an optional Hash of arguments.
+
+    @trends = @client.trends
+
+The only supported option currently is exclude_hashtags to return trends that are not hashtags only.
+
+    @trends = @client.trends :exclude_hashtags => true
+
 ## Search Operators
 
 The following operator examples find tweets...
@@ -66,14 +78,14 @@ Alter the number of Tweets returned per page with the :rpp key. Stick with 10, 1
 
 * Searching for a positive attitude :) returns tweets containing the text :), =), :D, and :-)
 
-## Authors
+## Contributors
 
-Written by Dustin Sallings (dustin@spy.net), forked by Dan Croak (dcroak@thoughtbot.com).
+Dustin Sallings, Dan Croak, Luke Francl, Matt Sanford, Alejandro Crosa, Danny Burkes, Don Brown, & HotFusionMan.
 
 ## Resources
 
-* [Official Twitter Search API](http://search.twitter.com/api)
+* [Official Twitter Search API](http://apiwiki.twitter.com/Twitter-API-Documentation)
 
 ## License
 
-MIT License, same terms as Ruby.
+MIT License, same terms as Ruby.

data/Rakefile

@@ -1,25 +1,25 @@
 require 'rake'
 require 'rake/testtask'
- 
-test_files_pattern = 'test/twitter_search_test.rb'
+
+test_files_pattern = 'test/*_test.rb'
 Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.pattern = test_files_pattern
   t.verbose = false
 end
- 
+
 desc "Run the test suite"
 task :default => :test
- 
+
 gem_spec = Gem::Specification.new do |gem_spec|
   gem_spec.name        = "twitter-search"
-  gem_spec.version     = "0.5.2"
-  gem_spec.summary     = "Ruby client for Twitter Search."
+  gem_spec.version     = "0.5.6"
+  gem_spec.summary     = "Ruby client for Twitter Search. Includes trends."
   gem_spec.email       = "dcroak@thoughtbot.com"
   gem_spec.homepage    = "http://github.com/dancroak/twitter-search"
   gem_spec.description = "Ruby client for Twitter Search."
-  gem_spec.authors     = ["Dustin Sallings", "Dan Croak"]
-  gem_spec.files       = FileList["[A-Z]*", "{generators,lib,shoulda_macros,rails}/**/*"]
+  gem_spec.authors     = ["Dustin Sallings", "Dan Croak", "Luke Francl", "Matt Sanford", "Alejandro Crosa", "Danny Burkes", "Don Brown", "HotFusionMan"]
+  gem_spec.files       = FileList["[A-Z]*", "{lib,shoulda_macros}/**/*"]
   gem_spec.add_dependency('json', '>= 1.1.2')
 end
 
@@ -36,7 +36,7 @@ require 'yaml'
 
 namespace :yaml do
   desc "Write Twitter Search results to yaml file so API is not hit every test."
-  task :write do    
+  task :write do
     write_yaml :tweets => 'Obama',                                     :file => 'obama'
     write_yaml :tweets => 'twitter search',                            :file => 'twitter_search'
     write_yaml :tweets => {:q => 'twitter search'},                    :file => 'twitter_search_and'
@@ -64,7 +64,7 @@ end
 def write_yaml(opts = {})
   @client = TwitterSearch::Client.new 'twitter-search'
   tweets  = @client.query(opts[:tweets])
-  File.open(File.join(File.dirname(__FILE__), 'test', 'yaml', "#{opts[:file]}.yaml"), 'w+') do |file| 
+  File.open(File.join(File.dirname(__FILE__), 'test', 'yaml', "#{opts[:file]}.yaml"), 'w+') do |file|
     file.puts tweets.to_yaml
   end
-end
+end

data/lib/trends.rb

@@ -0,0 +1,36 @@
+module TwitterSearch
+  class Trend
+    VARS = [ :query, :name ]
+    attr_reader *VARS
+    attr_reader :exclude_hashtags
+
+    def initialize(opts)
+      @exclude_hashtags = !!opts['exclude_hashtags']
+      VARS.each { |each| instance_variable_set "@#{each}", opts[each.to_s] }
+    end
+  end
+
+  class Trends
+    VARS = [:date]
+    attr_reader *VARS
+
+    include Enumerable
+
+    def initialize(opts)
+      @trends = opts['trends'].values.first.collect { |each| Trend.new(each) }
+      VARS.each { |each| instance_variable_set "@#{each}", opts[each.to_s] }
+    end
+
+    def each(&block)
+      @trends.each(&block)
+    end
+
+    def size
+      @trends.size
+    end
+
+    def [](index)
+      @trends[index]
+    end
+  end
+end

data/lib/tweets.rb

@@ -0,0 +1,45 @@
+module TwitterSearch
+  class Tweet
+    VARS = [:text, :from_user, :to_user, :to_user_id, :id, :iso_language_code, :from_user_id, :created_at, :profile_image_url, :source ]
+    attr_reader *VARS
+    attr_reader :language
+
+    def initialize(opts)
+      @language = opts['iso_language_code']
+      VARS.each { |each| instance_variable_set "@#{each}", opts[each.to_s] }
+    end
+  end
+
+  class Tweets
+    VARS = [:since_id, :max_id, :results_per_page, :page, :query, :next_page]
+    attr_reader *VARS
+
+    include Enumerable
+
+    def initialize(opts)
+      @results = opts['results'].collect { |each| Tweet.new(each) }
+      VARS.each { |each| instance_variable_set "@#{each}", opts[each.to_s] }
+    end
+
+    def each(&block)
+      @results.each(&block)
+    end
+
+    def size
+      @results.size
+    end
+
+    def [](index)
+      @results[index]
+    end
+
+    def has_next_page?
+      ! @next_page.nil?
+    end
+
+    def get_next_page
+      client = Client.new
+      return client.query( CGI.parse( @next_page[1..-1] ) )
+    end
+  end
+end

data/lib/twitter_search.rb

@@ -3,99 +3,96 @@ require 'net/http'
 require 'json'
 require 'cgi'
 
-module TwitterSearch
+require File.join(File.dirname(__FILE__), 'tweets')
+require File.join(File.dirname(__FILE__), 'trends')
 
-  class Tweet
-    VARS = [:text, :from_user, :to_user, :to_user_id, :id, :iso_language_code, :from_user_id, :created_at, :profile_image_url, :source ]
-    attr_reader *VARS
-    attr_reader :language
-    
-    def initialize(opts)
-      @language = opts['iso_language_code']
-      VARS.each { |each| instance_variable_set "@#{each}", opts[each.to_s] }
-    end
+module TwitterSearch
+  class SearchOperatorError < ArgumentError
   end
-
-  class Tweets
-    VARS = [:since_id, :max_id, :results_per_page, :page, :query, :next_page]
-    attr_reader *VARS
-
-    include Enumerable
-
-    def initialize(opts)
-      @results = opts['results'].collect { |each| Tweet.new(each) }
-      VARS.each { |each| instance_variable_set "@#{each}", opts[each.to_s] }
-    end
-
-    def each(&block)
-      @results.each(&block)
-    end
-
-    def size
-      @results.size
-    end
-    
-    def [](index)
-      @results[index]
-    end
-
-    def has_next_page?
-      ! @next_page.nil?
-    end
-
-    def get_next_page
-      client = Client.new
-      return client.query( CGI.parse( @next_page[1..-1] ) )
-    end
+  class SearchServerError < RuntimeError
   end
 
   class Client
-    TWITTER_API_URL = 'http://search.twitter.com/search.json'
-    TWITTER_API_DEFAULT_TIMEOUT = 5
-    
+    TWITTER_SEARCH_API_URL = 'http://search.twitter.com/search.json'
+    TWITTER_TRENDS_API_URL = 'http://search.twitter.com/trends/current.json'
+    DEFAULT_TIMEOUT = 5
+
     attr_accessor :agent
     attr_accessor :timeout
-    
-    def initialize(agent = 'twitter-search', timeout = TWITTER_API_DEFAULT_TIMEOUT)
+
+    def initialize(agent = 'twitter-search', timeout = DEFAULT_TIMEOUT)
       @agent = agent
       @timeout = timeout
     end
-    
+
     def headers
       { "Content-Type" => 'application/json',
         "User-Agent"   => @agent }
     end
-    
+
     def query(opts = {})
-      url       = URI.parse(TWITTER_API_URL)
+      url       = URI.parse(TWITTER_SEARCH_API_URL)
       url.query = sanitize_query(opts)
 
+      ensure_no_location_operators(url.query)
+
       req  = Net::HTTP::Get.new(url.path)
       http = Net::HTTP.new(url.host, url.port)
       http.read_timeout = timeout
+
+      res = http.start { |http|
+        http.get("#{url.path}?#{url.query}", headers)
+      }
+      
+      if res.code == '404'
+        raise TwitterSearch::SearchServerError, "Twitter responded with a 404 for your query. It is likely too complicated to process."
+      end
+      
+      json = res.body
       
+      Tweets.new JSON.parse(json)
+    end
+
+    def trends(opts = {})
+      url = URI.parse(TWITTER_TRENDS_API_URL)
+      if opts['exclude_hashtags']
+        url.query = sanitize_query_hash({ :exclude_hashtags => opts['exclude_hashtags'] })
+      end
+
+      req  = Net::HTTP::Get.new(url.path)
+      http = Net::HTTP.new(url.host, url.port)
+      http.read_timeout = timeout
+
       json = http.start { |http|
         http.get("#{url.path}?#{url.query}", headers)
       }.body
-      Tweets.new JSON.parse(json)
+      
+      Trends.new JSON.parse(json)
     end
 
     private
 
       def sanitize_query(opts)
         if opts.is_a? String
-          "q=#{CGI.escape(opts)}" 
+          "q=#{CGI.escape(opts)}"
         elsif opts.is_a? Hash
           "#{sanitize_query_hash(opts)}"
         end
       end
 
       def sanitize_query_hash(query_hash)
-        query_hash.collect { |key, value| 
-          "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}" 
+        query_hash.collect { |key, value|
+          "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
         }.join('&')
       end
-  
-  end
 
+      def ensure_no_location_operators(query_string)
+        if query_string.include?("near%3A") ||
+           query_string.include?("within%3A")
+          raise TwitterSearch::SearchOperatorError,
+            "near: and within: are available from the Twitter Search web interface, but not the API. The API requires the geocode parameter. See dancroak/twitter-search README."
+        end
+      end
+
+  end
 end

data/shoulda_macros/twitter_search.rb

@@ -0,0 +1,36 @@
+module TwitterSearch
+  module Shoulda
+    def should_have_default_search_behaviors
+      should_find_tweets
+      should_have_text_for_all_tweets
+      should_return_page 1
+      should_return_tweets_in_sets_of 15
+    end
+
+    def should_find_tweets
+      should 'find tweets' do
+        assert @tweets.any?
+      end
+    end
+
+    def should_have_text_for_all_tweets
+      should 'have text for all tweets' do
+        assert @tweets.all? { |tweet| tweet.text.size > 0 }
+      end
+    end
+
+    def should_return_page(number)
+      should "return page #{number}" do
+        assert_equal number, @tweets.page
+      end
+    end
+
+    def should_return_tweets_in_sets_of(number)
+      should "return tweets in sets of #{number}" do
+        assert_equal number, @tweets.results_per_page
+      end
+    end
+  end
+end
+
+Test::Unit::TestCase.extend(TwitterSearch::Shoulda)

metadata

@@ -1,16 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: look-twitter-search
 version: !ruby/object:Gem::Version 
-  version: 0.5.4
+  version: 0.5.6
 platform: ruby
 authors: 
 - Dustin Sallings
 - Dan Croak
+- Luke Francl
+- Matt Sanford
+- Alejandro Crosa
+- Danny Burkes
+- Don Brown
+- HotFusionMan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-02-03 21:00:00 -08:00
+date: 2009-05-17 21:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,11 +38,15 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- CHANGELOG.textile
 - Rakefile
 - README.markdown
 - TODO.markdown
+- lib/trends.rb
+- lib/tweets.rb
 - lib/twitter_search.rb
-has_rdoc: false
+- shoulda_macros/twitter_search.rb
+has_rdoc: true
 homepage: http://github.com/dancroak/twitter-search
 post_install_message: 
 rdoc_options: []
@@ -60,7 +70,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
-summary: Ruby client for Twitter Search.
+specification_version: 3
+summary: Ruby client for Twitter Search. Includes trends.
 test_files: []