dancroak-twitter-search 0.5.2 → 0.5.3

data/CHANGELOG.textile

@@ -0,0 +1,7 @@
+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,9 +78,9 @@ 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
 
@@ -76,4 +88,4 @@ Written by Dustin Sallings (dustin@spy.net), forked by Dan Croak (dcroak@thought
 
 ## License
 
-MIT License, same terms as Ruby.
+MIT License, same terms as Ruby.

data/Rakefile

@@ -1,24 +1,24 @@
 require 'rake'
 require 'rake/testtask'
- 
-test_files_pattern = 'test/twitter_search_test.rb'
+
+test_files_pattern = 'test/twitter_*_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.version     = "0.5.3"
   gem_spec.summary     = "Ruby client for Twitter Search."
   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.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.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'
@@ -67,4 +67,4 @@ def write_yaml(opts = {})
   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'].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,51 +3,22 @@ require 'net/http'
 require 'json'
 require 'cgi'
 
-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 ]
-    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
+require File.join(File.dirname(__FILE__), 'tweets')
+require File.join(File.dirname(__FILE__), 'trends')
 
-    def size
-      @results.size
-    end
-    
-    def [](index)
-      @results[index]
-    end
-  end
+module TwitterSearch
 
   class Client
-    TWITTER_API_URL = 'http://search.twitter.com/search.json'
+    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
     
     attr_accessor :agent
+    attr_accessor :timeout
     
-    def initialize(agent = 'twitter-search')
+    def initialize(agent = 'twitter-search', timeout = TWITTER_API_DEFAULT_TIMEOUT)
       @agent = agent
+      @timeout = timeout
     end
     
     def headers
@@ -55,14 +26,10 @@ module TwitterSearch
         "User-Agent"   => @agent }
     end
     
-    def timeout
-      TWITTER_API_DEFAULT_TIMEOUT
-    end
-    
     def query(opts = {})
-      url       = URI.parse(TWITTER_API_URL)
+      url       = URI.parse(TWITTER_SEARCH_API_URL)
       url.query = sanitize_query(opts)
-      
+
       req  = Net::HTTP::Get.new(url.path)
       http = Net::HTTP.new(url.host, url.port)
       http.read_timeout = timeout
@@ -72,6 +39,22 @@ module TwitterSearch
       }.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
+      Trends.new JSON.parse(json)
+    end
 
     private
 

metadata

@@ -1,16 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: dancroak-twitter-search
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: 0.5.3
 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-14 21:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,12 +38,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- CHANGELOG.textile
 - Rakefile
 - README.markdown
 - TODO.markdown
-- VERSION.yml
+- lib/trends.rb
+- lib/tweets.rb
 - lib/twitter_search.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/dancroak/twitter-search
 post_install_message: 
 rdoc_options: []
@@ -61,7 +69,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ruby client for Twitter Search.
 test_files: []