test/json/trends.json @@ -84,7 +84,7 @@ Dustin Sallings, Dan Croak, Luke Francl, Matt Sanford, Alejandro Crosa, Danny Bu ## Resources -* [Official Twitter Search API](http://search.twitter.com/api) +* [Official Twitter Search API](http://apiwiki.twitter.com/Twitter-API-Documentation) ## License README.markdown @@ -3,7 +3,7 @@ module TwitterSearch 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] } @@ -28,9 +28,9 @@ module TwitterSearch def size @trends.size end - + def [](index) @trends[index] end end -end \ No newline at end of file +end lib/trends.rb @@ -7,25 +7,24 @@ require File.join(File.dirname(__FILE__), 'tweets') require File.join(File.dirname(__FILE__), 'trends') module TwitterSearch - class Client TWITTER_SEARCH_API_URL = 'http://search.twitter.com/search.json' TWITTER_TRENDS_API_URL = 'http://search.twitter.com/trends/current.json' - TWITTER_API_DEFAULT_TIMEOUT = 5 - + 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_SEARCH_API_URL) url.query = sanitize_query(opts) @@ -33,15 +32,15 @@ module TwitterSearch 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) end - + def trends(opts = {}) - url = URI.parse(TWITTER_TRENDS_API_URL) + url = URI.parse(TWITTER_TRENDS_API_URL) if opts['exclude_hashtags'] url.query = sanitize_query_hash({ :exclude_hashtags => opts['exclude_hashtags'] }) end @@ -49,7 +48,7 @@ module TwitterSearch 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 @@ -60,18 +59,18 @@ module TwitterSearch 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 end lib/twitter_search.rb @@ -4,42 +4,56 @@ require 'rubygems' require 'shoulda' require 'yaml' +class String + def /(other) + File.join(self, other) + end +end + +class File + def self.here + dirname(__FILE__) + end +end + class Test::Unit::TestCase - + def self.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 self.should_find_tweets should 'find tweets' do assert @tweets.any? end end - + def self.should_have_text_for_all_tweets should 'have text for all tweets' do assert @tweets.all? { |tweet| tweet.text.size > 0 } end end - + def self.should_return_page(number) should "return page #{number}" do assert_equal number, @tweets.page end end - + def self.should_return_tweets_in_sets_of(number) should "return tweets in sets of #{number}" do assert_equal number, @tweets.results_per_page end end - + def read_yaml(opts = {}) - return if opts[:file].nil? - YAML.load_file File.join(File.dirname(__FILE__), 'yaml', "#{opts[:file]}.yaml") + if opts[:file].nil? + raise ArgumentError + end + YAML.load_file(File.here / 'yaml' / "#{opts[:file]}.yaml") end - -end \ No newline at end of file + +end test/test_helper.rb @@ -13,9 +13,9 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: setup do @tweets = read_yaml :file => 'obama' end - + should_have_default_search_behaviors - + should 'find tweets containing the single word "Obama"' do assert @tweets.all? { |tweet| tweet.text =~ /obama/i } end @@ -46,7 +46,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: end # TWITTER SEARCH OPERATORS - + context '@client.query :q => \'"happy hour"\'' do setup do @tweets = read_yaml :file => 'happy_hour_exact' @@ -58,7 +58,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /happy hour/i } end end - + context "@client.query :q => 'obama OR hillary'" do setup do @tweets = read_yaml :file => 'obama_or_hillary' @@ -70,7 +70,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /obama/i || t.text =~ /hillary/i } end end - + context "@client.query :q => 'beer -root'" do setup do @tweets = read_yaml :file => 'beer_minus_root' @@ -82,7 +82,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /beer/i || t.text !~ /root/i } end end - + context "@client.query :q => '#haiku'" do setup do @tweets = read_yaml :file => 'hashtag_haiku' @@ -94,7 +94,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /#haiku/i } end end - + context "@client.query :q => 'from: alexiskold'" do setup do @tweets = read_yaml :file => 'from_alexiskold' @@ -106,7 +106,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.from_user == 'alexiskold' } end end - + context "@client.query :q => 'to:techcrunch'" do setup do @tweets = read_yaml :file => 'to_techcrunch' @@ -118,7 +118,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /^@techcrunch/i } end end - + context "@client.query :q => '@mashable'" do setup do @tweets = read_yaml :file => 'reference_mashable' @@ -130,7 +130,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /@mashable/i } end end - + context "@client.query :q => '\"happy hour\" near:\"san francisco\"'" do setup do @tweets = read_yaml :file => 'happy_hour_near_sf' @@ -141,7 +141,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert ! @tweets.any? end end - + context "@client.query :q => 'near:NYC within:15mi'" do setup do @tweets = read_yaml :file => 'within_15mi_nyc' @@ -152,7 +152,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert ! @tweets.any? end end - + context "@client.query :q => 'superhero since:2008-05-01'" do setup do @tweets = read_yaml :file => 'superhero_since' @@ -164,7 +164,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /superhero/i && convert_date(t.created_at) > DateTime.new(2008, 5, 1) } end end - + context "@client.query :q => 'ftw until:2008-05-03'" do setup do @tweets = read_yaml :file => 'ftw_until' @@ -176,7 +176,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /ftw/i && convert_date(t.created_at) < DateTime.new(2008, 5, 3, 11, 59) } end end - + context "@client.query :q => 'movie -scary :)'" do setup do @tweets = read_yaml :file => 'movie_positive_tude' @@ -188,7 +188,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /movie/i && t.text !~ /scary/i && positive_attitude?(t.text) } end end - + context "@client.query :q => 'flight :('" do setup do @tweets = read_yaml :file => 'flight_negative_tude' @@ -200,7 +200,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /flight/i && negative_attitude?(t.text) } end end - + context "@client.query :q => 'traffic ?'" do setup do @tweets = read_yaml :file => 'traffic_question' @@ -212,7 +212,7 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /traffic/i && t.text.include?('?') } end end - + context "@client.query :q => 'hilarious filter:links'" do setup do @tweets = read_yaml :file => 'hilarious_links' @@ -224,138 +224,134 @@ class TwitterSearchTest < Test::Unit::TestCase # :nodoc: assert @tweets.all?{ |t| t.text =~ /hilarious/i && hyperlinks?(t.text) } end end - + # USER AGENT - + context "A new Client instance" do setup do @client = TwitterSearch::Client.new end - + should 'respond to user agent' do assert_respond_to @client, :agent end - + should 'set a default user agent' do assert_equal @client.headers['User-Agent'], "twitter-search" assert_equal @client.agent, "twitter-search" end - + should 'set a default timeout for the http request' do - assert_equal @client.timeout, TwitterSearch::Client::TWITTER_API_DEFAULT_TIMEOUT + assert_equal @client.timeout, TwitterSearch::Client::DEFAULT_TIMEOUT end end - + # FOREIGN LANGUAGES - + context "@client.query :q => 'congratulations', :lang => 'en'" do setup do @tweets = read_yaml :file => 'english' end - + should_have_default_search_behaviors - + should 'find tweets containing "congratulations" and are in English' do assert @tweets.all?{ |t| t.text =~ /congratulation/i && t.language == 'en' } end end - + context "@client.query :q => 'با', :lang => 'ar'" do setup do @tweets = read_yaml :file => 'arabic' end - + should_have_default_search_behaviors - + should 'find tweets containing "با" and are in Arabic' do assert @tweets.all?{ |t| t.text.include?('با') && t.language == 'ar' } end end # PAGINATION - + context "@client.query :q => 'Boston Celtics', :rpp => '30'" do setup do @tweets = read_yaml :file => 'results_per_page' end - should_find_tweets should_have_text_for_all_tweets should_return_page 1 should_return_tweets_in_sets_of 30 end - context "@client.query :q => 'a Google(or is it Twitter)whack', :rpp => '2'" do + context "@client.query :q => 'a Google(or Twitter)whack', :rpp => '2'" do setup do @tweets = read_yaml :file => 'only_one_result' end should 'not be able to get next page of @tweets' do assert ! @tweets.has_next_page? - #assert_raise Exception, @tweets.next_page end end - context "@client.query :q => 'almost a Google(or is it Twitter)whack', :rpp => '1'" do + context "@client.query :q => 'almost Google(or Twitter)whack', :rpp => '1'" do setup do - @tweets = read_yaml :file => 'only_two_results' - @next_page_of_tweets = read_yaml :file => 'only_two_results_page_2' + @page_one = read_yaml :file => 'only_two_results' + @page_two = read_yaml :file => 'only_two_results_page_2' end should 'be able to get next page of @tweets' do - assert @tweets.has_next_page? + assert @page_one.has_next_page? FakeWeb.register_uri( :get, "#{TwitterSearch::Client::TWITTER_SEARCH_API_URL}?max_id=100&q=almost+a+Google%28or+is+it+Twitter%29whack&rpp=1&page=2", :string => '{"results":[{"text":"Boston Celtics-Los Angeles Lakers, Halftime http://tinyurl.com/673s24","from_user":"nbatube","id":858836387,"language":"en","created_at":"Tue, 15 Jul 2008 09:27:57 +0000"}],"since_id":0,"max_id":100,"results_per_page":1,"page":2,"query":"almost+a+Google%28or+is+it+Twitter%29whack"}' ) - next_page = @tweets.get_next_page - # It's hard to muck around with objects' .id fields in Ruby, so check other fields instead: - assert_equal @next_page_of_tweets[0].created_at, next_page[0].created_at - assert_equal @next_page_of_tweets[0].text, next_page[0].text + next_page = @page_one.get_next_page + assert_equal @page_two[0].created_at, next_page[0].created_at + assert_equal @page_two[0].text, next_page[0].text end end - # HELPERS - + context "@tweets[2]" do setup do @tweets = read_yaml :file => 'reference_mashable' end - + should_have_default_search_behaviors - + should 'return the third tweet' do assert_equal 859152168, @tweets[2].id end end protected - + def convert_date(date) date = date.split(' ') DateTime.new(date[3].to_i, convert_month(date[2]), date[1].to_i) end - + def convert_month(str) months = { 'Jan' => 1, 'Feb' => 2, 'Mar' => 3, 'Apr' => 4, 'May' => 5, 'Jun' => 6, 'Jul' => 7, 'Aug' => 8, 'Sep' => 9, 'Oct' => 10, 'Nov' => 11, 'Dec' => 12 } months[str] end - - def positive_attitude?(str) - str.include?(':)') || str.include?('=)') || str.include?(':-)') || str.include?(':D') + + def positive_attitude?(string) + [":)", "=)", ":-)", ":D"].any? { |emoticon| string.include?(emoticon) } end - - def negative_attitude?(str) - str.include?(':(') || str.include?('=(') || str.include?(':-(') || str.include?(':P') + + def negative_attitude?(string) + [":(", "=(", ":-(", ":P"].any? { |emoticon| string.include?(emoticon) } end - + def hyperlinks?(str) str.include?('http://') || str.include?('https://') end - + end test/twitter_search_test.rb @@ -9,9 +9,9 @@ class TwitterSearchTrendsTest < Test::Unit::TestCase # :nodoc: setup do @trends = read_yaml :file => 'trends' end - + should 'find a single trend' do assert_equal 1, @trends.size end end -end \ No newline at end of file +end test/twitter_search_trends_test.rb a05f81da006560970ec562be5011bfe4e5e002f0 Dan Croak dcroak@thoughtbot.com http://github.com/dancroak/twitter-search/commit/997c8ee60f8510f93e9dfc6e3cbfb909554da310 997c8ee60f8510f93e9dfc6e3cbfb909554da310 2009-05-16T10:25:54-07:00 2009-05-16T10:25:54-07:00 refactoring test suite 35a3e5da700fd03acaed253968480cb66b69ac3a Dan Croak dcroak@thoughtbot.com