dschn-twitter 0.3.7.2 → 0.4.1

data/{History.txt → History}

@@ -1,3 +1,19 @@
+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
+  * Removed CLI dependencies from install dependency list
+      (they are now only installed by you manually)
+  * Switched to echoe for gem managment
+      
 0.3.7 - August 26, 2008
 			* Fixed source param not getting through
 

data/{Manifest.txt → Manifest}

@@ -1,11 +1,4 @@
-History.txt
-License.txt
-Manifest.txt
-README.txt
-Rakefile
 bin/twitter
-config/hoe.rb
-config/requirements.rb
 examples/blocks.rb
 examples/direct_messages.rb
 examples/favorites.rb
@@ -20,9 +13,8 @@ examples/sent_messages.rb
 examples/timeline.rb
 examples/twitter.rb
 examples/verify_credentials.rb
-lib/twitter.rb
+History
 lib/twitter/base.rb
-lib/twitter/cli.rb
 lib/twitter/cli/config.rb
 lib/twitter/cli/helpers.rb
 lib/twitter/cli/migrations/20080722194500_create_accounts.rb
@@ -32,17 +24,21 @@ 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/search_result.rb
+lib/twitter/search_result_info.rb
 lib/twitter/status.rb
 lib/twitter/user.rb
 lib/twitter/version.rb
-script/destroy
-script/generate
-script/txt2html
-setup.rb
+lib/twitter.rb
+License
+Manifest
+Rakefile
+README
 spec/base_spec.rb
 spec/cli/helper_spec.rb
 spec/direct_message_spec.rb
@@ -51,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
@@ -62,9 +61,6 @@ spec/spec.opts
 spec/spec_helper.rb
 spec/status_spec.rb
 spec/user_spec.rb
-tasks/deployment.rake
-tasks/environment.rake
-tasks/website.rake
 twitter.gemspec
 website/css/common.css
 website/images/terminal_output.png

data/Rakefile

@@ -1,4 +1,42 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
+ProjectName = 'twitter'
+WebsitePath = "jnunemaker@rubyforge.org:/var/www/gforge-projects/#{ProjectName}"
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'spec/rake/spectask'
+require "lib/#{ProjectName}/version"
+
+Echoe.new(ProjectName, Twitter::Version) do |p|
+  p.description     = "a command line interface for twitter, also a library which wraps the twitter api"
+  p.url             = "http://#{ProjectName}.rubyforge.org"
+  p.author          = "John Nunemaker"
+  p.email           = "nunemaker@gmail.com"
+  p.extra_deps      = [['hpricot', '>= 0.6'], ['activesupport', '>= 2.1'], ['httparty', '>= 0.2.4']]
+  p.need_tar_gz     = false
+  p.docs_host       = WebsitePath
+end
+
+desc 'Upload website files to rubyforge'
+task :website do
+  sh %{rsync -av website/ #{WebsitePath}}
+  Rake::Task['website_docs'].invoke
+end
+
+task :website_docs do
+  Rake::Task['redocs'].invoke
+  sh %{rsync -av doc/ #{WebsitePath}/docs}
+end
+
+desc 'Preps the gem for a new release'
+task :prepare do
+  %w[manifest build_gemspec].each do |task|
+    Rake::Task[task].invoke
+  end
+end
+
+Rake::Task[:default].prerequisites.clear
+task :default => :spec
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/bin/twitter

@@ -10,6 +10,5 @@ if ARGV[0] && ARGV[0] == 'd' && !STDIN.tty?
   ARGV[2] = "#{STDIN.read}#{ARGV[2]}"
 end
 
-$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-require 'twitter'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'twitter'))
 require 'twitter/cli'

data/examples/direct_messages.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'activesupport'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
 config = YAML::load(open(ENV['HOME'] + '/.twitter'))
 

data/examples/favorites.rb

@@ -4,13 +4,13 @@ config = YAML::load(open(ENV['HOME'] + '/.twitter'))
 
 twitter = Twitter::Base.new(config['email'], config['password'])
 
-puts 'FAVORITES'
-twitter.favorites.each { |f| puts f.text }
+puts 'CREATE'
+puts twitter.create_favorite(865416114).text
 puts
 puts
 
-puts 'CREATE'
-puts twitter.create_favorite(865416114).text
+puts 'FAVORITES'
+twitter.favorites.each { |f| puts f.text }
 puts
 puts
 

data/examples/replies.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'activesupport'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
 config = YAML::load(open(ENV['HOME'] + '/.twitter'))
 

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/examples/sent_messages.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'activesupport'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
 config = YAML::load(open(ENV['HOME'] + '/.twitter'))
 

data/examples/timeline.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'activesupport'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
 config = YAML::load(open(ENV['HOME'] + '/.twitter'))
 

data/lib/twitter/base.rb

@@ -12,16 +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'
-    end
-    
-    def timeout=(time)
-      @config[:timeout] = time
-    end
-    
-    def timeout
-      @config[:timeout]
+      @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.
@@ -167,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
@@ -174,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      
@@ -192,41 +187,47 @@ module Twitter
       # 
       # ie: call(:public_timeline, :auth => false)
       def call(method, options={})
-        options.reverse_merge!({ :auth => true, :args => {} })
+        options = { :auth => true, :args => {} }.merge(options)
         # Following line needed as lite=false doesn't work in the API: http://tinyurl.com/yo3h5d
         options[:args].delete(:lite) unless options[:args][:lite]
         args = options.delete(:args)
         request(build_path("statuses/#{method.to_s}.xml", args), options)
       end
       
-      # Makes a request to twitter.
-      def request(path, options={})
-        options.reverse_merge!({
-          :headers => { "User-Agent" => @config[:email] },
-          :method => :get
-        })
-        unless options[:since].blank?
-          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.start(uri.host, 80) 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]
             if options[:method].to_s == 'post' && options[:form_data]
               req.set_form_data(options[:form_data])
             end
-            http.read_timeout = @config[:timeout] if @config[:timeout]
             http.request(req)
           end
         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/
@@ -237,14 +238,23 @@ 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)
-        path += "?#{options.to_query}" unless options.blank?
+        unless options.nil?
+          query = options.inject('') { |str, h| str += "#{CGI.escape(h[0].to_s)}=#{CGI.escape(h[1].to_s)}&"; str }
+          path += "?#{query}"
+        end
+        
         path
       end
 
@@ -259,4 +269,4 @@ module Twitter
         Hpricot.XML(response || '')
       end
   end
-end
+end

data/lib/twitter/cli/helpers.rb

@@ -5,25 +5,37 @@ module Twitter
       class NoAccounts < StandardError; end
       
       def output_tweets(collection, options={})
-        options.reverse_merge!({
+        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]
+            
             occurred_at    = Time.parse(s.created_at).strftime('On %b %d at %l:%M%P')
             formatted_time = '-' * occurred_at.length + "\n#{indention}#{occurred_at}"
             formatted_name = s.user.screen_name.rjust(justify + 1)
             formatted_msg  = ''
-            s.text.split(' ').in_groups_of(6, false) { |row| formatted_msg += row.join(' ') + "\n#{indention}" }
-            say "#{CGI::unescapeHTML(formatted_name)}: #{CGI::unescapeHTML(formatted_msg)}#{formatted_time}\n\n"
+            
+            s.text.split(' ').each_with_index do |word, idx|
+              formatted_msg += "#{word} "
+              
+              sixth_word = idx != 0 && idx % 6 == 0
+              formatted_msg += "\n#{indention}" if sixth_word
+            end
+            
+            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
@@ -35,7 +47,7 @@ module Twitter
       
       def current_account
         @current_account ||= Account.active        
-        raise Account.count == 0 ? NoAccounts : NoActiveAccount if @current_account.blank?
+        raise Account.count == 0 ? NoAccounts : NoActiveAccount if @current_account.nil?
         @current_account
       end
       
@@ -44,7 +56,7 @@ module Twitter
         if File.exists?(tweet_file)
           say '.twitter file found, attempting import...'
           config = YAML::load(File.read(tweet_file))
-          if !config['email'].blank? && !config['password'].blank?
+          if !config['email'].nil? && !config['password'].nil?
             Account.add(:username => config['email'], :password => config['password'])
             say 'Account imported'
             block.call if block_given?

data/lib/twitter/cli.rb

@@ -1,8 +1,10 @@
 require 'rubygems'
+
 gem 'main', '>= 2.8.2'
 gem 'highline', '>= 1.4.0'
-gem 'activerecord', '>= 2.1'
+gem 'activerecord', '= 2.2.2'
 gem 'sqlite3-ruby', '>= 1.2.1'
+
 require 'main'
 require 'highline/import'
 require 'activerecord'
@@ -177,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
@@ -215,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'
@@ -275,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.blank? && !params['force'].given?
+        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"
     }
@@ -297,7 +303,7 @@ Main {
     def run
       do_work do
         options, since_id = {}, Configuration["replies_since_id"]
-        options[:since_id] = since_id if !since_id.blank? && !params['force'].given?
+        options[:since_id] = since_id if !since_id.nil? && !params['force'].given?
         collection = base.replies(options)
         output_tweets(collection, {:since_prefix => 'replies'})
       end

data/lib/twitter/search.rb

@@ -11,7 +11,7 @@ module Twitter
     
     def initialize(q=nil)
       clear
-      containing(q) unless q.blank?
+      containing(q) if q && q.strip != ''
     end
     
     def from(user)
@@ -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,9 +1,3 @@
 module Twitter #:nodoc:
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 3
-    TINY  = 7
-
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
+  Version = '0.4.1'
 end

data/lib/twitter.rb

@@ -1,6 +1,12 @@
-%w(uri cgi net/http yaml rubygems hpricot active_support).each { |f| require f }
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'yaml'
+require 'time'
+require 'rubygems'
+require 'hpricot'
 
-$:.unshift(File.join(File.dirname(__FILE__)))
+$:.unshift(File.dirname(__FILE__))
 require 'twitter/version'
 require 'twitter/easy_class_maker'
 require 'twitter/base'
@@ -9,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
@@ -16,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

@@ -8,6 +8,10 @@ def say(str)
   puts str
 end
 
+class Tweet < OpenStruct
+  attr_accessor :id
+end
+
 describe Twitter::CLI::Helpers do
   include Twitter::CLI::Helpers
   
@@ -15,21 +19,31 @@ describe Twitter::CLI::Helpers do
     before do
       Configuration.stub!(:[]=).and_return(true)
       @collection = [
-        OpenStruct.new(
-          :text => 'This is my long message that I want to see formatted ooooh so pretty with a few words on each line so it is easy to scan.',
+        Tweet.new(
+          :id         => 1,
+          :text       => 'This is my long message that I want to see formatted ooooh so pretty with a few words on each line so it is easy to scan.',
           :created_at => Time.mktime(2008, 5, 1, 10, 15, 00).strftime('%Y-%m-%d %H:%M:%S'),
-          :user => OpenStruct.new(:screen_name => 'jnunemaker')
+          :user       => OpenStruct.new(:screen_name => 'jnunemaker')
         ),
-        OpenStruct.new(
-          :text => 'This is my long message that I want to see formatted ooooh so pretty with a.',
+        Tweet.new(
+          :id         => 2,
+          :text       => 'This is my long message that I want to see formatted ooooh so pretty with a.',
           :created_at => Time.mktime(2008, 4, 1, 10, 15, 00).strftime('%Y-%m-%d %H:%M:%S'),
-          :user => OpenStruct.new(:screen_name => 'danielmorrison')
+          :user       => OpenStruct.new(:screen_name => 'danielmorrison')
         )
       ]
     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