dancroak-twitter-search 0.5.3 → 0.5.5

data/CHANGELOG.textile

@@ -1,7 +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 overdue attribution for Luke Francl, Matt Sanford, Alejandro Crosa, Danny Burkes, Don Brown, & HotFusionMan.
 * Added CHANGELOG. (Dan Croak)
 

data/README.markdown

@@ -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
 

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake'
 require 'rake/testtask'
 
-test_files_pattern = 'test/twitter_*_test.rb'
+test_files_pattern = 'test/*_test.rb'
 Rake::TestTask.new do |t|
   t.libs << 'lib'
   t.pattern = test_files_pattern
@@ -13,13 +13,13 @@ task :default => :test
 
 gem_spec = Gem::Specification.new do |gem_spec|
   gem_spec.name        = "twitter-search"
-  gem_spec.version     = "0.5.3"
-  gem_spec.summary     = "Ruby client for Twitter Search."
+  gem_spec.version     = "0.5.5"
+  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", "Luke Francl", "Matt Sanford", "Alejandro Crosa", "Danny Burkes", "Don Brown", "HotFusionMan"]
-  gem_spec.files       = FileList["[A-Z]*", "{generators,lib,shoulda_macros,rails}/**/*"]
+  gem_spec.files       = FileList["[A-Z]*", "{lib,shoulda_macros}/**/*"]
   gem_spec.add_dependency('json', '>= 1.1.2')
 end
 
@@ -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

data/lib/trends.rb

@@ -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] }
@@ -17,7 +17,7 @@ module TwitterSearch
     include Enumerable
 
     def initialize(opts)
-      @trends = opts['trends'].first.collect { |each| Trend.new(each) }
+      @trends = opts['trends'].values.first.collect { |each| Trend.new(each) }
       VARS.each { |each| instance_variable_set "@#{each}", opts[each.to_s] }
     end
 
@@ -28,9 +28,9 @@ module TwitterSearch
     def size
       @trends.size
     end
-    
+
     def [](index)
       @trends[index]
     end
   end
-end
+end

data/lib/tweets.rb

@@ -3,7 +3,7 @@ module TwitterSearch
     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] }
@@ -28,7 +28,7 @@ module TwitterSearch
     def size
       @results.size
     end
-    
+
     def [](index)
       @results[index]
     end
@@ -42,4 +42,4 @@ module TwitterSearch
       return client.query( CGI.parse( @next_page[1..-1] ) )
     end
   end
-end
+end

data/lib/twitter_search.rb

@@ -7,41 +7,45 @@ require File.join(File.dirname(__FILE__), 'tweets')
 require File.join(File.dirname(__FILE__), 'trends')
 
 module TwitterSearch
+  class SearchOperatorError < ArgumentError
+  end
 
   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)
 
+      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
-      
+
       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 +53,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 +64,25 @@ 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
 
+      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,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dancroak-twitter-search
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.5.5
 platform: ruby
 authors: 
 - Dustin Sallings
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-14 21:00:00 -07:00
+date: 2009-05-17 21:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,6 +45,7 @@ files:
 - lib/trends.rb
 - lib/tweets.rb
 - lib/twitter_search.rb
+- shoulda_macros/twitter_search.rb
 has_rdoc: true
 homepage: http://github.com/dancroak/twitter-search
 post_install_message: 
@@ -70,6 +71,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: Ruby client for Twitter Search.
+summary: Ruby client for Twitter Search. Includes trends.
 test_files: []