jnunemaker-twitter 0.4.4 → 0.5.0

data/History

@@ -1,3 +1,10 @@
+0.5.0 - March 3, 2009
+* 1 major rewrite for OAuth
+  * Backwards compatibility thrown to the wind
+  * Proxy no longer supported (someone please add it back in, I never use proxies)
+  * Identica support killed with an axe (nothing against them but I don't use it)
+  * CLI shot to death (will be reborn at a later date using oauth and its own gem)
+
 0.4.3 - February 21, 2009
 * 1 minor enhancement
   * verify_credentials now returns a Twitter::User rather than an hpricot doc

data/License

@@ -1,19 +1,20 @@
-Copyright (c) 2007 John Nunemaker
+Copyright (c) 2009 John Nunemaker
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Notes

@@ -0,0 +1,33 @@
+*****************************************************************
+* From Twitter API Docs, so I don't have to keep going to them. *
+*****************************************************************
+
+http://apiwiki.twitter.com/REST+API+Documentation
+
+200 OK: everything went awesome.
+304 Not Modified: there was no new data to return.
+400 Bad Request: your request is invalid, and we'll return an error message that tells you why. This is the status code returned if you've exceeded the rate limit (see below). 
+401 Not Authorized: either you need to provide authentication credentials, or the credentials provided aren't valid.
+403 Forbidden: we understand your request, but are refusing to fulfill it.  An accompanying error message should explain why.
+404 Not Found: either you're requesting an invalid URI or the resource in question doesn't exist (ex: no such user). 
+500 Internal Server Error: we did something wrong.  Please post to the group about it and the Twitter team will investigate.
+502 Bad Gateway: returned if Twitter is down or being upgraded.
+503 Service Unavailable: the Twitter servers are up, but are overloaded with requests.  Try again later.
+
+**********
+* Errors *
+**********
+
+<?xml version="1.0" encoding="UTF-8"?>
+<hash>
+  <request>/direct_messages/destroy/456.xml</request>
+  <error>No direct message with that ID found.</error>
+</hash>
+
+**********************
+* Rate Limit Headers *
+**********************
+
+X-RateLimit-Limit the current limit in effect
+X-RateLimit-Remaining the number of hits remaining before you are rate limited
+X-RateLimit-Reset the time the current rate limiting period ends (in epoch time, number of seconds since 1970-01-01 00:00:00)

data/README.rdoc

@@ -0,0 +1,9 @@
+= twitter
+
+The ruby twitter gem. The gem heard round the world and famous on the streets. Haha.
+
+For now this is just an API wrapper. The command line interface is temporarily dead until I have time to make it work with oauth. At that point, I'll make it a new gem twitter-cli or something and it will depend on this gem to work. That will keep the separation of the api wrapper and cli and fix a lot of dependency issues.
+
+== Copyright
+
+Copyright (c) 2009 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -1,42 +1,84 @@
-ProjectName = 'twitter'
-WebsitePath = "jnunemaker@rubyforge.org:/var/www/gforge-projects/#{ProjectName}"
-
-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
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name              = "twitter"
+    gem.summary           = %Q{wrapper for the twitter api (oauth only)}
+    gem.email             = "nunemaker@gmail.com"
+    gem.homepage          = "http://github.com/jnunemaker/twitter"
+    gem.authors           = ["John Nunemaker"]
+    gem.rubyforge_project = "twitter"
+    gem.files             = FileList["[A-Z]*", "{examples,lib,test}/**/*"]
+    
+    gem.add_dependency('oauth')
+    gem.add_dependency('httparty', '>= 0.4.2')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "twitter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+    
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+    
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/twitter/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 5
+:patch: 0

data/examples/connect.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
+require File.join(File.dirname(__FILE__), 'helpers', 'config_store')
+require 'pp'
+
+config = ConfigStore.new("#{ENV['HOME']}/.twitter")
+oauth = Twitter::OAuth.new(config['token'], config['secret'])
+
+if config['atoken'] && config['asecret']
+  oauth.authorize_from_access(config['atoken'], config['asecret'])
+  # puts oauth.access_token.get("/statuses/friends_timeline.json")
+  twitter = Twitter::Base.new(oauth)
+  pp twitter.friends_timeline
+  
+elsif config['rtoken'] && config['rsecret']  
+  oauth.authorize_from_request(config['rtoken'], config['rsecret'])
+  puts oauth.access_token.get("/statuses/friends_timeline.json")
+  
+  config.update({
+    'atoken'  => oauth.access_token.token,
+    'asecret' => oauth.access_token.secret,
+    'rtoken'  => nil,
+    'rsecret' => nil,
+  })
+else
+  config.update({
+    'rtoken'  => oauth.request_token.token,
+    'rsecret' => oauth.request_token.secret,
+  })
+  
+  # authorize in browser
+  %x(open #{oauth.request_token.authorize_url})
+end

data/examples/helpers/config_store.rb

@@ -0,0 +1,30 @@
+class ConfigStore
+  attr_reader :file
+  
+  def initialize(file)
+    @file = file
+  end
+  
+  def load
+    @config ||= YAML::load(open(file))
+    self
+  end
+  
+  def [](key)
+    load
+    @config[key]
+  end
+  
+  def []=(key, value)
+    @config[key] = value
+  end
+  
+  def update(c={})
+    @config.merge!(c)
+    save
+  end
+  
+  def save
+    File.open(file, 'w') { |f| f.write(YAML.dump(@config)) }
+  end
+end

data/examples/search.rb

@@ -1,18 +1,10 @@
-require 'rubygems'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
+require 'pp'
 
-Twitter::Search.new('httparty').each { |r| puts r.inspect,'' }
-Twitter::Search.new('httparty').page(2).each { |r| puts r.inspect, '' }
+search = Twitter::Search.new.from('jnunemaker')
 
-# search = Twitter::Search.new
-# search.from('jnunemaker').to('oaknd1').each { |r| puts r.inspect, '' }
-# pp search.result
-# search.clear
+puts '*'*50, 'First Run', '*'*50
+search.each { |result| pp result }
 
-# search.from('jnunemaker').to('oaknd1').since(814529437).containing('milk').each { |r| puts r.inspect, '' }
-# search.clear
-# 
-# search.geocode('40.757929', '-73.985506', '50mi').containing('holland').each { |r| puts r.inspect, '' }
-# search.clear
-
-# pp search.from('jnunemaker').fetch()
+puts '*'*50, 'Second Run', '*'*50
+search.each { |result| pp result }

data/examples/timeline.rb

@@ -1,34 +1,19 @@
-require 'rubygems'
-require 'activesupport'
 require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
-config = YAML::load(open(ENV['HOME'] + '/.twitter'))
+require File.join(File.dirname(__FILE__), 'helpers', 'config_store')
+require 'pp'
 
-twitter = Twitter::Base.new(config['email'], config['password'])
+config = ConfigStore.new("#{ENV['HOME']}/.twitter")
 
-puts 'SINCE'
-twitter.timeline(:user, :since => Time.now - 1.day).each do |s|
-  puts "- #{s.text}"
-end
-puts
-puts
+oauth = Twitter::OAuth.new(config['token'], config['secret'])
+oauth.authorize_from_access(config['atoken'], config['asecret'])
 
-puts 'SINCE_ID'
-twitter.timeline(:user, :since_id => 865547074).each do |s|
-  puts "- #{s.text}"
-end
-puts
-puts
+client = Twitter::Base.new(oauth)
 
-puts 'COUNT'
-twitter.timeline(:user, :count => 1).each do |s|
-  puts "- #{s.text}"
-end
-puts
-puts
+pp client.friends_timeline
+puts '*'*50
 
-puts 'PAGE'
-twitter.timeline(:user, :page => 1).each do |s|
-  puts "- #{s.text}"
-end
-puts
-puts
+pp client.user_timeline
+puts '*'*50
+
+pp client.replies
+puts '*'*50

data/examples/update.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
+require File.join(File.dirname(__FILE__), 'helpers', 'config_store')
+require 'pp'
+
+config = ConfigStore.new("#{ENV['HOME']}/.twitter")
+
+oauth = Twitter::OAuth.new(config['token'], config['secret'])
+oauth.authorize_from_access(config['atoken'], config['asecret'])
+
+client = Twitter::Base.new(oauth)
+pp client.update('This is an update from the twitter gem')