dancroak-twitter-search 0.5 → 0.5.1

data/README.markdown

@@ -10,7 +10,7 @@ Install the gem.
 
 Require the gem.
 
-    require 'twitter-search'
+    require 'twitter_search'
 
 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.
 

data/Rakefile

@@ -0,0 +1,71 @@
+require 'rake'
+require 'rake/testtask'
+require 'date'
+ 
+test_files_pattern = 'test/rails_root/test/{unit,functional,other}/**/*_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
+ 
+spec = Gem::Specification.new do |s|
+  s.name = "twitter-search"
+  s.summary = "Ruby client for Twitter Search."
+  s.email = "dcroak@thoughtbot.com"
+  s.homepage = "http://github.com/dancroak/twitter-search"
+  s.description = "Ruby client for Twitter Search."
+  s.authors = ["Dustin Sallings", "Dan Croak"]
+  s.files = FileList["[A-Z]*", "{lib,test}/**/*"]
+  s.add_dependency('json', '>= 1.1.2')
+end
+ 
+begin
+  require 'rubygems'
+  require 'jeweler'
+  Jeweler.gemspec = spec
+rescue LoadError 
+  puts "Jeweler not available. sudo gem install technicalpickles-jeweler --source=http://gems.github.com"
+end
+
+require File.expand_path('lib/twitter_search', File.dirname(__FILE__))
+require 'rubygems'
+require 'yaml'
+
+namespace :yaml do
+  desc "Write Twitter Search results to yaml file so API is not hit every test."
+  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'
+    write_yaml :tweets => {:q => '"happy hour"'},                      :file => 'happy_hour_exact'  
+    write_yaml :tweets => {:q => 'obama OR hillary'},                  :file => 'obama_or_hillary'
+    write_yaml :tweets => {:q => 'beer -root'},                        :file => 'beer_minus_root'
+    write_yaml :tweets => {:q => '#haiku'},                            :file => 'hashtag_haiku'
+    write_yaml :tweets => {:q => 'from:alexiskold'},                   :file => 'from_alexiskold'
+    write_yaml :tweets => {:q => 'to:techcrunch'},                     :file => 'to_techcrunch'
+    write_yaml :tweets => {:q => '@mashable'},                         :file => 'reference_mashable'
+    write_yaml :tweets => {:q => '"happy hour" near:"san francisco"'}, :file => 'happy_hour_near_sf'
+    write_yaml :tweets => {:q => 'near:NYC within:15mi'},              :file => 'within_15mi_nyc'
+    write_yaml :tweets => {:q => 'superhero since:2008-05-01'},        :file => 'superhero_since'
+    write_yaml :tweets => {:q => 'ftw until:2008-05-03'},              :file => 'ftw_until'
+    write_yaml :tweets => {:q => 'movie -scary :)'},                   :file => 'movie_positive_tude'
+    write_yaml :tweets => {:q => 'flight :('},                         :file => 'flight_negative_tude'
+    write_yaml :tweets => {:q => 'traffic ?'},                         :file => 'traffic_question'
+    write_yaml :tweets => {:q => 'hilarious filter:links'},            :file => 'hilarious_links'
+    write_yaml :tweets => {:q => 'congratulations', :lang => 'en'},    :file => 'english'
+    write_yaml :tweets => {:q => 'با', :lang => 'ar'},                 :file => 'arabic'
+    write_yaml :tweets => {:q => 'Boston Celtics', :rpp => '30'},      :file => 'results_per_page'
+  end
+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.puts tweets.to_yaml
+  end
+end

data/TODO.markdown

@@ -0,0 +1,7 @@
+Add tests for:
+
+* since_id: returns tweets with status ids greater than the given id.
+* geocode: returns tweets by users located within a given radius of the given latitude/longitude, where the user's location is taken from their Twitter profile.
+* show_user: when "true", adds "<user>:" to the beginning of the tweet. This is useful for readers that do not display Atom's author field. The default is "false".
+* callback: if supplied, the response will use the JSONP format with a callback of the given name. E.g., http://search.twitter.com/search.json?callback=foo&q=twitter
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+patch: 1
+major: 0
+minor: 5

data/lib/twitter_search.rb

@@ -34,6 +34,10 @@ module TwitterSearch
     def size
       @results.size
     end
+    
+    def [](index)
+      @results[index]
+    end
   end
 
   class Client

data/test/test_helper.rb

@@ -0,0 +1,40 @@
+require File.expand_path('../lib/twitter_search', File.dirname(__FILE__))
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'yaml'
+
+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
+  
+end

data/test/twitter_search_test.rb

@@ -0,0 +1,307 @@
+# coding: utf-8
+
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class TwitterSearchTest < Test::Unit::TestCase # :nodoc:
+
+  context "@client.query 'Obama'" do
+    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
+  end
+  
+  context "@client.query 'twitter search'" do
+    setup do
+      @tweets = read_yaml :file => 'twitter_search'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing both "twitter" and "search"' do
+      assert @tweets.all?{ |t| t.text =~ /twitter/i && t.text =~ /search/i }
+    end
+  end
+  
+  context "@client.query :q => 'twitter search'" do
+    setup do
+      @tweets = read_yaml :file => 'twitter_search_and'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing both "twitter" and "search"' do
+      assert @tweets.all?{ |t| t.text =~ /twitter/i && t.text =~ /search/i }
+    end
+  end
+  
+  # TWITTER SEARCH OPERATORS
+  
+  context '@client.query :q => \'"happy hour"\'' do
+    setup do
+      @tweets = read_yaml :file => 'happy_hour_exact'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing the exact phrase "happy hour"' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing either "obama" or "hillary" (or both)' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing "beer" but not "root"' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing the hashtag "haiku"' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets sent from person "alexiskold"' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets sent to person "techcrunch"' do
+      assert @tweets.all?{ |t| t.text =~ /^@techcrunch/i }
+    end
+  end
+  
+  context "@client.query :q => '@mashable'" do
+    setup do
+      @tweets = read_yaml :file => 'reference_mashable'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets referencing person "mashable"' do
+      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'
+    end
+    
+    # The Twitter Search API makes you use the geocode parameter for location searching
+    should 'not find tweets using the near operator' do
+      assert ! @tweets.any?
+    end
+  end
+  
+  context "@client.query :q => 'near:NYC within:15mi'" do
+    setup do
+      @tweets = read_yaml :file => 'within_15mi_nyc'
+    end
+    
+    # The Twitter Search API makes you use the geocode parameter for location searching
+    should 'not find tweets using the near operator' do
+      assert ! @tweets.any?
+    end
+  end
+  
+  context "@client.query :q => 'superhero since:2008-05-01'" do
+    setup do
+      @tweets = read_yaml :file => 'superhero_since'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing "superhero" and sent since date "2008-05-01" (year-month-day)' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing "ftw" and sent up to date "2008-05-03"' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing "movie", but not "scary", and with a positive attitude' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing "flight" and with a negative attitude' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing "traffic" and asking a question' do
+      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'
+    end
+    
+    should_have_default_search_behaviors
+    
+    should 'find tweets containing "hilarious" and linking to URLs' do
+      assert @tweets.all?{ |t| t.text =~ /hilarious/i && hyperlinks?(t.text) }
+    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
+
+  # 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')
+    end
+    
+    def negative_attitude?(str)
+      str.include?(':(') || str.include?('=(') || str.include?(':-(') || str.include?(':P')
+    end
+    
+    def hyperlinks?(str)
+      str.include?('http://') || str.include?('https://')
+    end
+  
+    def read_yaml(opts = {})
+      return if opts[:file].nil?
+      YAML.load_file File.join(File.dirname(__FILE__), 'yaml', "#{opts[:file]}.yaml") 
+    end
+  
+end