dancroak-twitter-search 0.5.7 → 0.5.8

data/CHANGELOG.textile

@@ -1,3 +1,14 @@
+h2. 0.5.8 (June 30, 2009)
+
+* subclass Tweets and Trends from Array. (Dan Croak)
+* change test suite to use cURL'd JSON fixtures & Fakeweb for just HTTP calls
+for more surgical tests. (Dan Croak)
+
+h2. 0.5.7 (June 30, 2009)
+
+* improved Fakeweb usage. (Matt Jankowski)
+* account for possible 403 response, plus user-friendly message. (Matt Jankowski)
+
 h2. 0.5.6 (June 6, 2009)
 
 * When Twitter returns a 404, raise a TwitterSearch::SearchServerError instead

data/README.markdown

@@ -14,17 +14,17 @@ 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('thunderthimble')
 
 ### 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'
+    tweets = client.query('twitter search')
 
 The String form uses the default Twitter Search behavior, which in this example finds tweets containing both "twitter" and "search". It is identical to the more verbose, explicit version:
 
-    @tweets = @client.query :q => 'twitter search'
+    tweets = client.query(:q => 'twitter search')
 
 Use the Twitter Search API's query operators with the :q key to access a variety of behavior.
 
@@ -32,11 +32,11 @@ Use the Twitter Search API's query operators with the :q key to access a variety
 
 Request the current trending topics by calling the trends method of your client. It takes an optional Hash of arguments.
 
-    @trends = @client.trends
+    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
+    trends = client.trends(:exclude_hashtags => true)
 
 ## Search Operators
 
@@ -61,26 +61,47 @@ The following operator examples find tweets...
 
 The Twitter Search API supports foreign languages, accessible via the :lang key. Use the [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) codes as the value:
 
-    @tweets = @client.query :q => 'programmé', :lang => 'fr'
+    tweets = client.query(:q => 'programmé', :lang => 'fr')
 
 ### Pagination
 
 Alter the number of Tweets returned per page with the :rpp key. Stick with 10, 15, 20, 25, 30, or 50.
 
-    @tweets = @client.query :q => 'Boston Celtics', :rpp => '30'
+    tweets = client.query(:q => 'Boston Celtics', :rpp => '30')
 
 ## Gotchas
 
 * Searches are case-insenstive.
 * The "near" operator available in the Twitter Search web interface is not available via the API. You must geocode before making your Twitter Search API call, and use the :geocode key in your request using the pattern lat,lngmi or lat,lngkm:
 
-        @tweets = @client.query :q => 'Pearl Jam', :geocode => '43.4411,-70.9846mi'
+    tweets = client.query(:q => 'Pearl Jam', :geocode => '43.4411,-70.9846mi')
 
 * Searching for a positive attitude :) returns tweets containing the text :), =), :D, and :-)
 
+## Contributing
+
+Get the source and clone it.
+
+The test suite uses JSON fixtures which were created from cURL. Usage example:
+
+    query   = { :q => 'rails training' }
+    fake_query(query, 'rails_training.json')
+    @tweets = TwitterSearch::Client.new.query(query)
+
+Then you assert any necessary expectations on @tweets.
+
+To create your own JSON fixtures, first get the CGI escaped querystring in irb:
+
+    require 'lib/twitter_search'
+    TwitterSearch::Client.new.sanitize_query({ :q => 'rails training' })
+
+Then take the output and append it to a simple cURL, sending the output into your new file:
+
+    curl -i 'http://search.twitter.com/search.json?q=rails+training' > test/json/rails_training.json
+
 ## Contributors
 
-Dustin Sallings, Dan Croak, Luke Francl, Matt Sanford, Alejandro Crosa, Danny Burkes, Don Brown, & HotFusionMan.
+Dustin Sallings, Dan Croak, Luke Francl, Matt Jankowski, Matt Sanford, Alejandro Crosa, Danny Burkes, Don Brown, & HotFusionMan.
 
 ## Resources
 

data/Rakefile

@@ -13,12 +13,12 @@ task :default => :test
 
 gem_spec = Gem::Specification.new do |gem_spec|
   gem_spec.name        = "twitter-search"
-  gem_spec.version     = "0.5.7"
+  gem_spec.version     = "0.5.8"
   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.authors     = ["Dustin Sallings", "Dan Croak", "Luke Francl", "Matt Jankowski", "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

data/lib/trends.rb

@@ -1,6 +1,6 @@
 module TwitterSearch
   class Trend
-    VARS = [ :query, :name ]
+    VARS = [:query, :name]
     attr_reader *VARS
     attr_reader :exclude_hashtags
 
@@ -10,27 +10,15 @@ module TwitterSearch
     end
   end
 
-  class Trends
+  class Trends < Array
     VARS = [:date]
     attr_reader *VARS
 
-    include Enumerable
-
     def initialize(opts)
-      @trends = opts['trends'].values.first.collect { |each| Trend.new(each) }
+      trends = opts('trends').delete
+      trends = trends.values.first.collect { |each| Trend.new(each) }
+      super(trends)
       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

@@ -10,29 +10,17 @@ module TwitterSearch
     end
   end
 
-  class Tweets
+  class Tweets < Array
     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) }
+      results = opts.delete('results') || []
+      results.collect! { |each| Tweet.new(each) }
+      super(results)
       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

data/lib/twitter_search.rb

@@ -21,7 +21,7 @@ module TwitterSearch
     attr_accessor :timeout
 
     def initialize(agent = 'twitter-search', timeout = DEFAULT_TIMEOUT)
-      @agent = agent
+      @agent   = agent
       @timeout = timeout
     end
 
@@ -43,19 +43,20 @@ module TwitterSearch
       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."
+        raise TwitterSearch::SearchServerError,
+              "Twitter responded with a 404 for your query."
       end
 
-      json = res.body
-
+      json        = res.body
       parsed_json = JSON.parse(json)
-      
+
       if parsed_json['error']
-        raise TwitterSearch::SearchServerError, "Twitter responded with an error body: #{parsed_json['error']}"
+        raise TwitterSearch::SearchServerError,
+              "Twitter responded with an error body: #{parsed_json['error']}"
       end
-  
+
       Tweets.new parsed_json
     end
 
@@ -72,33 +73,31 @@ module TwitterSearch
       json = http.start { |http|
         http.get("#{url.path}?#{url.query}", headers)
       }.body
-      
+
       Trends.new JSON.parse(json)
     end
 
-    private
-
-      def sanitize_query(opts)
-        if opts.is_a? String
-          "q=#{CGI.escape(opts)}"
-        elsif opts.is_a? Hash
-          "#{sanitize_query_hash(opts)}"
-        end
+    def sanitize_query(opts)
+      if opts.is_a? String
+        "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)}"
-        }.join('&')
-      end
+    def sanitize_query_hash(query_hash)
+      query_hash.collect { |key, value|
+        "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"
+      }.join('&')
+    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
+    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

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dancroak-twitter-search
 version: !ruby/object:Gem::Version 
-  version: 0.5.7
+  version: 0.5.8
 platform: ruby
 authors: 
 - Dustin Sallings
 - Dan Croak
 - Luke Francl
+- Matt Jankowski
 - Matt Sanford
 - Alejandro Crosa
 - Danny Burkes