jnunemaker-twitter 0.4.0 → 0.4.1

data/History

@@ -1,3 +1,12 @@
+0.4.1 - January 1, 2009
+* 4 minor enhancements and 2 bug fixes:
+  * Added better exception handling (Billy Gray)
+  * Added page to search (Michael Ivey)
+  * Adding an option to display tweets on CLI in reverse order (oldest first). (Cameron Booth)
+  * Added in_reply_to_status_id option for replying to statuses (anthonycrumley)
+  * Fixed a bug where the @config was improperly set (K. Adam Christensen)
+  * Fix verify_credentials to include a format (breaks in laconica). (dustin)
+  
 0.4.0 - December 23, 2008
 * 3 major changes
   * Removed active support as dependency

data/Manifest

@@ -29,6 +29,8 @@ lib/twitter/direct_message.rb
 lib/twitter/easy_class_maker.rb
 lib/twitter/rate_limit_status.rb
 lib/twitter/search.rb
+lib/twitter/search_result.rb
+lib/twitter/search_result_info.rb
 lib/twitter/status.rb
 lib/twitter/user.rb
 lib/twitter/version.rb
@@ -45,8 +47,11 @@ spec/fixtures/friends.xml
 spec/fixtures/friends_for.xml
 spec/fixtures/friends_lite.xml
 spec/fixtures/friends_timeline.xml
+spec/fixtures/friendship_already_exists.xml
+spec/fixtures/friendship_created.xml
 spec/fixtures/public_timeline.xml
 spec/fixtures/rate_limit_status.xml
+spec/fixtures/search_result_info.yml
 spec/fixtures/search_results.json
 spec/fixtures/status.xml
 spec/fixtures/user.xml

data/examples/search.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
 
 Twitter::Search.new('httparty').each { |r| puts r.inspect,'' }
+Twitter::Search.new('httparty').page(2).each { |r| puts r.inspect, '' }
 
 # search = Twitter::Search.new
 # search.from('jnunemaker').to('oaknd1').each { |r| puts r.inspect, '' }

data/lib/twitter/base.rb

@@ -12,8 +12,10 @@ module Twitter
     # Identi.ca example:
     #   Twitter.new('email/username', 'password', :api_host => 'identi.ca/api')
     def initialize(email, password, options={})
-      @config, @config[:email], @config[:password] = {}, email, password
       @api_host = options.delete(:api_host) || 'twitter.com'
+      @config, @config[:email], @config[:password] = options, email, password
+      @proxy_host = options[:proxy_host]
+      @proxy_port = options[:proxy_port]
     end
     
     # Returns an array of statuses for a timeline; Defaults to your friends timeline.
@@ -159,6 +161,7 @@ module Twitter
     def post(status, options={})
       form_data = {'status' => status}
       form_data.merge!({'source' => options[:source]}) if options[:source]
+      form_data.merge!({'in_reply_to_status_id' => options[:in_reply_to_status_id]}) if options[:in_reply_to_status_id]
       Status.new_from_xml(request('statuses/update.xml', :auth => true, :method => :post, :form_data => form_data))
     end
     alias :update :post
@@ -166,7 +169,7 @@ module Twitter
     # Verifies the credentials for the auth user.
     #   raises Twitter::CantConnect on failure.
     def verify_credentials
-      request('account/verify_credentials', :auth => true)
+      request('account/verify_credentials.xml', :auth => true)
     end
     
     private      
@@ -191,22 +194,11 @@ module Twitter
         request(build_path("statuses/#{method.to_s}.xml", args), options)
       end
       
-      # Makes a request to twitter.
-      def request(path, options={})
-        options = {
-          :headers => { "User-Agent" => @config[:email] },
-          :method => :get,
-        }.merge(options)
-        
-        unless options[:since].nil?
-          since = options[:since].kind_of?(Date) ? options[:since].strftime('%a, %d-%b-%y %T GMT') : options[:since].to_s  
-          options[:headers]["If-Modified-Since"] = since
-        end
-        
+      def response(path, options={})
         uri = URI.parse("http://#{@api_host}")
         
         begin
-          response = Net::HTTP::Proxy(options[:proxy_host], options[:proxy_port]).start(uri.host, uri.port) do |http|
+          response = Net::HTTP::Proxy(@proxy_host, @proxy_port).start(uri.host, uri.port) do |http|
             klass = Net::HTTP.const_get options[:method].to_s.downcase.capitalize
             req = klass.new("#{uri.path}/#{path}", options[:headers])
             req.basic_auth(@config[:email], @config[:password]) if options[:auth]
@@ -218,7 +210,24 @@ module Twitter
         rescue => error
           raise CantConnect, error.message
         end
+      end
+      
+      # Makes a request to twitter.
+      def request(path, options={})
+        options = {
+          :headers => { "User-Agent" => @config[:email] },
+          :method => :get,
+        }.merge(options)
+        
+        unless options[:since].nil?
+          since = options[:since].kind_of?(Date) ? options[:since].strftime('%a, %d-%b-%y %T GMT') : options[:since].to_s  
+          options[:headers]["If-Modified-Since"] = since
+        end
         
+        handle_response!(response(path, options))
+      end
+      
+      def handle_response!(response)
         if %w[200 304].include?(response.code)
           response = parse(response.body)
           raise RateExceeded if (response/:hash/:error).text =~ /Rate limit exceeded/
@@ -227,10 +236,15 @@ module Twitter
           raise Unavailable, response.message
         elsif response.code == '401'
           raise CantConnect, 'Authentication failed. Check your username and password'
+        elsif response.code == '403'
+          error_message = (parse(response.body)/:hash/:error).text
+          raise CantFindUsers, error_message  if error_message =~ /Could not find both specified users/
+          raise AlreadyFollowing, error_message if error_message =~ /already on your list/
+          raise CantFollowUser, "Response code #{response.code}: #{response.message} #{error_message}"
         else
           raise CantConnect, "Twitter is returning a #{response.code}: #{response.message}"
         end
-      end      
+      end
     
       # Given a path and a hash, build a full path with the hash turned into a query string
       def build_path(path, options)
@@ -253,4 +267,4 @@ module Twitter
         Hpricot.XML(response || '')
       end
   end
-end
+end

data/lib/twitter/cli/helpers.rb

@@ -8,13 +8,15 @@ module Twitter
         options = {
           :cache        => false,
           :since_prefix => '',
-          :empty_msg    => 'Nothing new since your last check.'
+          :empty_msg    => 'Nothing new since your last check.',
+          :reverse      => false
         }.merge(options)
         
         if collection.size > 0
           justify   = collection.collect { |s| s.user.screen_name }.max { |a,b| a.length <=> b.length }.length rescue 0
           indention = ' ' * (justify + 3)
           say("\n#{indention}#{collection.size} new tweet(s) found.\n\n")
+          collection.reverse! if options[:reverse]
           collection.each do |s|
             Tweet.create_from_tweet(current_account, s) if options[:cache]
             
@@ -33,7 +35,7 @@ module Twitter
             say "#{CGI::unescapeHTML(formatted_name)}: #{CGI::unescapeHTML(formatted_msg)}\n#{indention}#{formatted_time}\n\n"
           end
           
-          Configuration["#{options[:since_prefix]}_since_id"] = collection.first.id
+          Configuration["#{options[:since_prefix]}_since_id"] = options[:reverse] ? collection.last.id : collection.first.id
         else
           say(options[:empty_msg])
         end

data/lib/twitter/cli.rb

@@ -179,7 +179,7 @@ Main {
         end
         post_thread.join
         progress_thread.join
-        say "Got it! New twitter created at: #{status.created_at}\n"
+        say "Got it! New tweet created at: #{status.created_at}\n"
       end
     end
   end
@@ -217,7 +217,7 @@ Main {
   end
   
   mode 'follow' do
-    description "Allows you to turn on notifications for a user"
+    description "Allows you to add notifications for a user (aka Follow Them)"
     argument('username') {
       required
       description 'username or id of twitterrer to follow'
@@ -277,21 +277,25 @@ Main {
     option('force', 'f') {
       description "Ignore since_id and show first page of results even if there aren't new ones"
     }
+    option('reverse', 'r') {
+      description 'Reverse the output so the oldest tweets are at the top'
+    }
     
     def run
       do_work do
         timeline = params['timeline'].value == 'me' ? 'user' : params['timeline'].value
         options, since_id = {}, Configuration["#{timeline}_since_id"]
         options[:since_id] = since_id if !since_id.nil? && !params['force'].given?
+        reverse = params['reverse'].given? ? true : false
         cache = [:friends, :user].include?(timeline)
         collection = base.timeline(timeline.to_sym, options)
-        output_tweets(collection, {:cache => cache, :since_prefix => timeline})
+        output_tweets(collection, {:cache => cache, :since_prefix => timeline, :reverse => reverse})
       end
     end
   end
   
   mode 'replies' do
-    description 'Allows you to view all @replies at you'
+    description 'Allows you to view all @replies sent to you'
     option('force', 'f') {
       description "Ignore since_id and show first page of replies even if there aren't new ones"
     }

data/lib/twitter/search.rb

@@ -59,6 +59,12 @@ module Twitter
       self
     end
     
+    # Which page of results to fetch
+    def page(num)
+      @query[:page] = num
+      self
+    end
+    
     # Only searches tweets since a given id. 
     # Recommended to use this when possible.
     def since(since_id)
@@ -83,7 +89,7 @@ module Twitter
     # If you want to get results do something other than iterate over them.
     def fetch
       @query[:q] = @query[:q].join(' ')
-      self.class.get('/search.json', {:query => @query})
+      SearchResultInfo.new_from_hash(self.class.get('/search.json', {:query => @query}))
     end
     
     def each
@@ -91,4 +97,5 @@ module Twitter
       @result['results'].each { |r| yield r }
     end
   end
-end
+end
+

data/lib/twitter/version.rb

@@ -1,3 +1,3 @@
 module Twitter #:nodoc:
-  Version = '0.4.0'
+  Version = '0.4.1'
 end

data/lib/twitter.rb

@@ -15,6 +15,8 @@ require 'twitter/search'
 require 'twitter/status'
 require 'twitter/direct_message'
 require 'twitter/rate_limit_status'
+require 'twitter/search_result_info'
+require 'twitter/search_result'
 
 module Twitter
   class Unavailable < StandardError; end
@@ -22,6 +24,9 @@ module Twitter
   class BadResponse < StandardError; end
   class UnknownTimeline < ArgumentError; end
   class RateExceeded < StandardError; end
+  class CantFindUsers < ArgumentError; end
+  class AlreadyFollowing < StandardError; end
+  class CantFollowUser < StandardError; end
 
   SourceName = 'twittergem'
 end

data/spec/base_spec.rb

@@ -16,7 +16,11 @@ describe "Twitter::Base" do
       lambda { @base.timeline(:fakeyoutey) }.should raise_error(Twitter::UnknownTimeline)
     end
     
-    it "should default to friends timeline"
+    it "should default to friends timeline" do
+      @base.should_receive(:call).with("friends_timeline", {:auth=>true, :args=>{}, :since=>nil})
+      @base.should_receive(:statuses)
+      @base.timeline
+    end
     
     it "should be able to retrieve friends timeline" do
       data = open(File.dirname(__FILE__) + '/fixtures/friends_timeline.xml').read
@@ -65,6 +69,20 @@ describe "Twitter::Base" do
       timeline.size.should == 29
       timeline.first.name.should == 'Blaine Cook'
     end
+    
+    it "should be able to create a friendship" do
+      data = open(File.dirname(__FILE__) + '/fixtures/friendship_created.xml').read
+      @base.should_receive(:request).and_return(Hpricot::XML(data))
+      user = @base.create_friendship('jnunemaker')
+    end
+    
+    it "should bomb if friendship already exists" do
+      data = open(File.dirname(__FILE__) + '/fixtures/friendship_already_exists.xml').read
+      response = Net::HTTPForbidden.new("1.1", '403', '')
+      response.stub!(:body).and_return(data)
+      @base.should_receive(:response).and_return(response)
+      lambda { @base.create_friendship('billymeltdown') }.should raise_error(Twitter::AlreadyFollowing)
+    end
   end
   
   it "should be able to get single status" do
@@ -106,4 +124,4 @@ describe "Twitter::Base" do
       @base.rate_limit_status.remaining_hits.should == 5
     end
   end
-end
+end

data/spec/cli/helper_spec.rb

@@ -35,7 +35,15 @@ describe Twitter::CLI::Helpers do
     end
     
     specify "should properly format" do
-      output_tweets(@collection)
+      stdout_for {
+        output_tweets(@collection)
+      }.should match(/with a few words[\w\W]*with a\./)
+    end
+    
+    specify 'should format in reverse' do
+      stdout_for {
+        output_tweets(@collection, :reverse => true)
+      }.should match(/with a\.[\w\W]*with a few words/)
     end
   end
 end

data/spec/search_spec.rb

@@ -49,6 +49,10 @@ describe Twitter::Search do
     @search.per_page(25).query[:rpp].should == 25
   end
   
+  it "should be able to specify the page number" do
+    @search.page(20).query[:page].should == 20
+  end
+  
   it "should be able to specify only returning results greater than an id" do
     @search.since(1234).query[:since_id].should == 1234
   end
@@ -73,7 +77,7 @@ describe Twitter::Search do
   
   describe "fetching" do
     before do
-      @response = open(File.dirname(__FILE__) + '/fixtures/friends_timeline.xml').read
+      @response = YAML.load_file(File.dirname(__FILE__) + '/fixtures/search_result_info.yml')
       @search.class.stub!(:get).and_return(@response)
     end
     
@@ -81,6 +85,13 @@ describe Twitter::Search do
       @search.class.should_receive(:get).and_return(@response)
       @search.from('jnunemaker').fetch().should == @response
     end
+    
+    it "should support dot notation" do
+      @search.class.should_receive(:get).and_return(@response)
+      info = @search.from('httparty').fetch()
+      info["max_id"].should == info.max_id
+      info["results"].first["text"].should == info.results.first.text
+    end
   end
   
   it "should be able to iterate over results" do

data/spec/spec_helper.rb

@@ -9,4 +9,15 @@ end
 dir = File.dirname(__FILE__)
 
 $:.unshift(File.join(dir, '/../lib/'))
-require dir + '/../lib/twitter'
+require dir + '/../lib/twitter'
+
+    
+def stdout_for(&block)
+  # Inspired by http://www.ruby-forum.com/topic/58647
+  old_stdout = $stdout
+  $stdout = StringIO.new
+  yield
+  output = $stdout.string
+  $stdout = old_stdout
+  output
+end

data/twitter.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twitter}
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Nunemaker"]
-  s.date = %q{2008-12-23}
+  s.date = %q{2009-01-05}
   s.default_executable = %q{twitter}
   s.description = %q{a command line interface for twitter, also a library which wraps the twitter api}
   s.email = %q{nunemaker@gmail.com}
   s.executables = ["twitter"]
   s.extra_rdoc_files = ["bin/twitter", "lib/twitter/base.rb", "lib/twitter/cli/config.rb", "lib/twitter/cli/helpers.rb", "lib/twitter/cli/migrations/20080722194500_create_accounts.rb", "lib/twitter/cli/migrations/20080722194508_create_tweets.rb", "lib/twitter/cli/migrations/20080722214605_add_account_id_to_tweets.rb", "lib/twitter/cli/migrations/20080722214606_create_configurations.rb", "lib/twitter/cli/models/account.rb", "lib/twitter/cli/models/configuration.rb", "lib/twitter/cli/models/tweet.rb", "lib/twitter/cli.rb", "lib/twitter/direct_message.rb", "lib/twitter/easy_class_maker.rb", "lib/twitter/rate_limit_status.rb", "lib/twitter/search.rb", "lib/twitter/status.rb", "lib/twitter/user.rb", "lib/twitter/version.rb", "lib/twitter.rb", "README"]
-  s.files = ["bin/twitter", "examples/blocks.rb", "examples/direct_messages.rb", "examples/favorites.rb", "examples/friends_followers.rb", "examples/friendships.rb", "examples/identica_timeline.rb", "examples/location.rb", "examples/posting.rb", "examples/replies.rb", "examples/search.rb", "examples/sent_messages.rb", "examples/timeline.rb", "examples/twitter.rb", "examples/verify_credentials.rb", "History", "lib/twitter/base.rb", "lib/twitter/cli/config.rb", "lib/twitter/cli/helpers.rb", "lib/twitter/cli/migrations/20080722194500_create_accounts.rb", "lib/twitter/cli/migrations/20080722194508_create_tweets.rb", "lib/twitter/cli/migrations/20080722214605_add_account_id_to_tweets.rb", "lib/twitter/cli/migrations/20080722214606_create_configurations.rb", "lib/twitter/cli/models/account.rb", "lib/twitter/cli/models/configuration.rb", "lib/twitter/cli/models/tweet.rb", "lib/twitter/cli.rb", "lib/twitter/direct_message.rb", "lib/twitter/easy_class_maker.rb", "lib/twitter/rate_limit_status.rb", "lib/twitter/search.rb", "lib/twitter/status.rb", "lib/twitter/user.rb", "lib/twitter/version.rb", "lib/twitter.rb", "License", "Manifest", "Rakefile", "README", "spec/base_spec.rb", "spec/cli/helper_spec.rb", "spec/direct_message_spec.rb", "spec/fixtures/followers.xml", "spec/fixtures/friends.xml", "spec/fixtures/friends_for.xml", "spec/fixtures/friends_lite.xml", "spec/fixtures/friends_timeline.xml", "spec/fixtures/public_timeline.xml", "spec/fixtures/rate_limit_status.xml", "spec/fixtures/search_results.json", "spec/fixtures/status.xml", "spec/fixtures/user.xml", "spec/fixtures/user_timeline.xml", "spec/search_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/status_spec.rb", "spec/user_spec.rb", "website/css/common.css", "website/images/terminal_output.png", "website/index.html", "twitter.gemspec"]
+  s.files = ["bin/twitter", "examples/blocks.rb", "examples/direct_messages.rb", "examples/favorites.rb", "examples/friends_followers.rb", "examples/friendships.rb", "examples/identica_timeline.rb", "examples/location.rb", "examples/posting.rb", "examples/replies.rb", "examples/search.rb", "examples/sent_messages.rb", "examples/timeline.rb", "examples/twitter.rb", "examples/verify_credentials.rb", "History", "lib/twitter/base.rb", "lib/twitter/cli/config.rb", "lib/twitter/cli/helpers.rb", "lib/twitter/cli/migrations/20080722194500_create_accounts.rb", "lib/twitter/cli/migrations/20080722194508_create_tweets.rb", "lib/twitter/cli/migrations/20080722214605_add_account_id_to_tweets.rb", "lib/twitter/cli/migrations/20080722214606_create_configurations.rb", "lib/twitter/cli/models/account.rb", "lib/twitter/cli/models/configuration.rb", "lib/twitter/cli/models/tweet.rb", "lib/twitter/cli.rb", "lib/twitter/direct_message.rb", "lib/twitter/easy_class_maker.rb", "lib/twitter/rate_limit_status.rb", "lib/twitter/search.rb", "lib/twitter/status.rb", "lib/twitter/user.rb", "lib/twitter/version.rb", "lib/twitter.rb", "License", "Manifest", "Rakefile", "README", "spec/base_spec.rb", "spec/cli/helper_spec.rb", "spec/direct_message_spec.rb", "spec/fixtures/followers.xml", "spec/fixtures/friends.xml", "spec/fixtures/friends_for.xml", "spec/fixtures/friends_lite.xml", "spec/fixtures/friends_timeline.xml", "spec/fixtures/public_timeline.xml", "spec/fixtures/rate_limit_status.xml", "spec/fixtures/search_results.json", "spec/fixtures/status.xml", "spec/fixtures/user.xml", "spec/fixtures/user_timeline.xml", "spec/search_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/status_spec.rb", "spec/user_spec.rb", "twitter.gemspec", "website/css/common.css", "website/images/terminal_output.png", "website/index.html"]
   s.has_rdoc = true
   s.homepage = %q{http://twitter.rubyforge.org}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Twitter", "--main", "README"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jnunemaker-twitter
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - John Nunemaker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-23 00:00:00 -08:00
+date: 2009-01-05 00:00:00 -08:00
 default_executable: twitter
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -135,10 +135,10 @@ files:
 - spec/spec_helper.rb
 - spec/status_spec.rb
 - spec/user_spec.rb
+- twitter.gemspec
 - website/css/common.css
 - website/images/terminal_output.png
 - website/index.html
-- twitter.gemspec
 has_rdoc: true
 homepage: http://twitter.rubyforge.org
 post_install_message: