rcarver-twitter 0.5.4

data/History

@@ -0,0 +1,154 @@
+0.5.3 - April 10, 2009
+* 1 minor fix
+  * Twitter API assumed follow true whether true or false. Now only sending follow along to request if follow is true for calls to friendship_create.
+
+0.5.2 - April 8, 2009
+* 4 minor fixes
+  * added mash as an install dependency, forgot it initially
+  * fixed that search wasn't taking into account a bunch of options duh!
+  * fixed some missing vars and stuff in exception raising
+  * added development dependencies to rake file to make that more explicit (technomancy)
+  * lame workaround for Mash#hash that allows using return objects in sets and such (technomancy)
+
+0.5.1 - April 5, 2009
+* 1 minor change
+  * Added data error hash returned from twitter to a few of the exceptions to help with debugging
+  * Fixed friendship_exists?. Was throwing mash stringify keys error because it was returning true or false instead of hash or array.
+  
+0.5.0 - April 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
+  
+0.4.2 - February 10, 2009
+* 1 minor enhancement
+  * Adding the Social Graph API methods (Josh Owens)
+  
+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
+
+0.3.6 - August 11, 2008
+			* Fixed a few more methods that required post.
+			* Refactored the remaining methods that were not using #request to use it.
+
+0.3.5 - August 4, 2008
+			* Removed sqlite-ruby 1.2.2 as a dependency due to install issues on linux
+			
+0.3.4 - August 3, 2008
+			* Added search support
+			
+0.3.3 - August 3, 2008
+			* Now has option for host when initializing to support identi.ca (Dustin Sallings)
+			* Twitter changed a bunch of methods to POST only so I updated those to now work
+			
+0.3.2 - July 26, 2008
+			* added the CLI gems as dependencies for now until I separate out the CLI from the API wrapper
+			* cleaner CLI errors for no active account or no accounts at all
+			* remove sets a new active account if there are none
+			* added username and password optional arguments to add
+			* added import attempt on install and on anything that uses #current_account helper
+			
+0.3.1 - July 23, 2008
+			* added open to CLI twitter open jnunemaker would open default browser to http://twitter.com/jnunemaker
+			* added -f to timeline and replies which ignores the since_id and shows all results
+			* added clear_config to remove all cached since id's and such
+			* Majorly pimped the output of timelines and replies.
+			
+0.3.0 - July 22, 2008
+			* complete rewrite of CLI. Now supports multiple accounts and changing between them.
+			* added source, truncated, in_reply_to_status_id, in_reply_to_user_id, and favorited to Twitter::Status
+			* added protected to Twitter::User
+			* d CLI method now takes standard input like post
+			* Rewrote several methods that had since parameter to now use a hash instead. This makes it more flexible as API updates.
+			* Rewrote the methods that took lite or since as an argument to instead take a hash.
+			* added Twitter::Base#friendship_exists?
+			* added Twitter::Base#update_location
+			* added Twitter::Base#update_delivery_device
+			* added Twitter::Base#favorites
+			* added Twitter::Base#create_favorite
+			* added Twitter::Base#destroy_favorite
+			* added Twitter::Base#block
+			* added Twitter::Base#unblock
+			
+			BACKWORDS COMPATIBILITY BREAK: 
+			Any method that you have using lite or since as an argument 
+			will no longer work with this version. Simply change to a 
+			hash and you'll be fine. For example:
+			
+			friends(true) would now be friends(:lite => true)
+			
+0.2.7 - June 29, 2008
+			* added #rate_limit_status (Daniel Morrison)
+			* added source parameter option to Base#post 
+			* added twittergem as source when posting from command line
+			* Twitter::RateExceeded raised when you hit your limit (Jim O'Leary)
+			* Twitter::Unavailable raised when twitter returns 503
+			* Twitter::CantConnect is now more descriptive as to what is the problem when it is raised during a request
+			* quoting your message when using twitter post on the command line is now optional (Benoit Caccinolo)
+			* aliased post to p on command line so it's shorter (Benoit Caccinolo)
+			* unescaped html and added some color in command line view (Miles Z. Sterrett)
+			* added gemspec (technoweenie, Miles Z. Sterrett)
+			* Fixed stack trace error on first command line operation (Matt Rose)
+0.2.6 - April 2, 2008
+			* found a more simple way of doing stdin without any extra gem dependencies
+0.2.5 - April 2, 2008
+			* Command line interface can now use stdin for posting (ideas and example code from Jeremy Friesen)
+					$ twitter post 'test without stdin' # => twitters: test without stdin
+					$ echo 'test with stdin' | twitter post 'and an argv[1]' # => twitters: test with stdin and an argv[1]
+					$ echo 'test with stdin without any argv[1]' | twitter post # => twitters: test with stdin without any argv[1]
+0.2.4 - Mar 31, 2008
+			* Added lite option to friends and followers, which doesn't include the user's current status (Daniel Morrison)
+			* Updated since option to use HTTP header, and added the option on timeline() and replies(). (Daniel Morrison)
+0.2.3 - Jan 16, 2008
+			* added d to command line interface twitter d jnunemaker 'hola' (Humbucker)
+			* added progress dots when posting for confirmation when twitter is running slow (Hendy Irawan)
+0.2.2 - added leave and follow which are new twitter api methods for turning notifications on and off
+0.2.0 - Aug 4, 2007
+			* added sent_messages
+			* alias direct_messages to received_messages
+			* added create_friendship
+			* added destroy_friendship
+			* added featured to retrieve the featured twitter users
+			* added replies
+			* added destroy to destroy a status by id
+			* added status to find a status by id
+			* added active support as an extra dependency
+			* implemented d method to send direct messages (jnewland)
+			* fixed since argument in direct_messages method (jnewland)
+0.1.1 - May 20, 2007
+			* hpricot 0.5+ now supported; just a bug fix (Ryan Waldron is the man!)
+0.1.0 - March 31, 2007
+			* added d method for creating direct messages (waiting for it to work as documented)
+			* added featured method for getting featured users statuses (waiting for it to work as documented)
+			* added direct_messages method
+			* added friends_for method
+			* added a few tests
+			* removed relative_created_at as it is deprecated
+			* separated out the call method into call, request and parse methods
+0.0.5 - just a bit of code cleanup
+0.0.4 - added :location, :description, :url, :profile_image_url to user class (Alex Payne)
+0.0.3 - added a bit more informative message when things go wrong
+0.0.2 - added the command line options i forgot to add (friend and follower); improved some docs
+0.0.1 - initial release

data/License

@@ -0,0 +1,20 @@
+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:
+
+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.

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

@@ -0,0 +1,103 @@
+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('extlib')
+    gem.add_dependency('httparty', '>= 0.4.2')
+    
+    gem.add_development_dependency('thoughtbot-shoulda')
+    gem.add_development_dependency('jeremymcanally-matchy')
+    gem.add_development_dependency('mocha')
+    gem.add_development_dependency('fakeweb')
+    gem.add_development_dependency('extlib')
+  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:website", "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/rdoc"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+      
+      task :website 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 = 'website'
+        
+        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: 4

data/examples/connect.rb

@@ -0,0 +1,30 @@
+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'])
+  twitter = Twitter::Base.new(oauth)
+  pp twitter.friends_timeline
+  
+elsif config['rtoken'] && config['rsecret']  
+  oauth.authorize_from_request(config['rtoken'], config['rsecret'])
+  twitter = Twitter::Base.new(oauth)
+  pp twitter.friends_timeline
+  
+  config.update({
+    'atoken'  => oauth.access_token.token,
+    'asecret' => oauth.access_token.secret,
+  }).delete('rtoken', 'rsecret')
+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/friendship_existance.rb

@@ -0,0 +1,13 @@
+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)
+
+puts client.friendship_exists?('jnunemaker', 'orderedlist')
+puts client.friendship_exists?('jnunemaker', 'biz')

data/examples/helpers/config_store.rb

@@ -0,0 +1,38 @@
+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 delete(*keys)
+    keys.each { |key| @config.delete(key) }
+    save
+    self
+  end
+  
+  def update(c={})
+    @config.merge!(c)
+    save
+    self
+  end
+  
+  def save
+    File.open(file, 'w') { |f| f.write(YAML.dump(@config)) }
+    self
+  end
+end

data/examples/search.rb

@@ -0,0 +1,15 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
+require 'pp'
+
+search = Twitter::Search.new.from('jnunemaker')
+
+puts '*'*50, 'First Run', '*'*50
+search.each { |result| pp result }
+
+puts '*'*50, 'Second Run', '*'*50
+search.each { |result| pp result }
+
+puts '*'*50, 'Parameter Check', '*'*50
+pp Twitter::Search.new('#austineats').fetch().results.first
+pp Twitter::Search.new('#austineats').page(2).fetch().results.first
+pp Twitter::Search.new('#austineats').since(1412737343).fetch().results.first

data/examples/timeline.rb

@@ -0,0 +1,19 @@
+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.friends_timeline
+puts '*'*50
+
+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')

data/lib/twitter/base.rb

@@ -0,0 +1,163 @@
+module Twitter
+  class Base
+    extend Forwardable
+    
+    def_delegators :@client, :get, :post
+    
+    def initialize(oauth)
+      @client = oauth.access_token
+    end
+    
+    # Options: since_id, max_id, count, page, since
+    def friends_timeline(query={})
+      perform_get('/statuses/friends_timeline.json', :query => query)
+    end
+    
+    # Options: id, user_id, screen_name, since_id, max_id, page, since
+    def user_timeline(query={})
+      perform_get('/statuses/user_timeline.json', :query => query)
+    end
+    
+    def status(id)
+      perform_get("/statuses/show/#{id}.json")
+    end
+    
+    # Options: in_reply_to_status_id
+    def update(status, query={})
+      perform_post("/statuses/update.json", :body => {:status => status}.merge(query))
+    end
+    
+    # Options: since_id, max_id, since, page
+    def replies(query={})
+      perform_get('/statuses/replies.json', :query => query)
+    end
+    
+    def status_destroy(id)
+      perform_post("/statuses/destroy/#{id}.json")
+    end
+    
+    # Options: id, user_id, screen_name, page
+    def friends(query={})
+      perform_get('/statuses/friends.json', :query => query)
+    end
+    
+    # Options: id, user_id, screen_name, page
+    def followers(query={})
+      perform_get('/statuses/followers.json', :query => query)
+    end
+    
+    def user(id)
+      perform_get("/users/show/#{id}.json")
+    end
+    
+    # Options: since, since_id, page
+    def direct_messages(query={})
+      perform_get("/direct_messages.json", :query => query)
+    end
+    
+    # Options: since, since_id, page
+    def direct_messages_sent(query={})
+      perform_get("/direct_messages/sent.json", :query => query)
+    end
+    
+    def direct_message_create(user, text)
+      perform_post("/direct_messages/new.json", :body => {:user => user, :text => text})
+    end
+    
+    def direct_message_destroy(id)
+      perform_post("/direct_messages/destroy/#{id}.json")
+    end
+    
+    def friendship_create(id, follow=false)
+      body = {}
+      body.merge!(:follow => follow) if follow
+      perform_post("/friendships/create/#{id}.json", :body => body)
+    end
+    
+    def friendship_destroy(id)
+      perform_post("/friendships/destroy/#{id}.json")
+    end
+    
+    def friendship_exists?(a, b)
+      perform_get("/friendships/exists.json", :query => {:user_a => a, :user_b => b})
+    end
+    
+    # Options: id, user_id, screen_name
+    def friend_ids(query={})
+      perform_get("/friends/ids.json", :query => query)
+    end
+    
+    # Options: id, user_id, screen_name
+    def friend_ids(query={})
+      perform_get("/followers/ids.json", :query => query)
+    end
+    
+    def verify_credentials
+      perform_get("/account/verify_credentials.json")
+    end
+    
+    # Device must be sms, im or none
+    def update_delivery_device(device)
+      perform_post('/account/update_delivery_device.json', :body => {:device => device})
+    end
+    
+    # One or more of the following must be present:
+    #   profile_background_color, profile_text_color, profile_link_color, 
+    #   profile_sidebar_fill_color, profile_sidebar_border_color
+    def update_profile_colors(colors={})
+      perform_post('/account/update_profile_colors.json', :body => colors)
+    end
+    
+    def rate_limit_status
+      perform_get('/account/rate_limit_status.json')
+    end
+    
+    # One or more of the following must be present:
+    #   name, email, url, location, description
+    def update_profile(body={})
+      perform_post('/account/update_profile.json', :body => body)
+    end
+    
+    # Options: id, page
+    def favorites(query={})
+      perform_get('/favorites.json', :query => query)
+    end
+    
+    def favorite_create(id)
+      perform_post("/favorites/create/#{id}.json")
+    end
+    
+    def favorite_destroy(id)
+      perform_post("/favorites/destroy/#{id}.json")
+    end
+    
+    def enable_notifications(id)
+      perform_post("/notifications/follow/#{id}.json")
+    end
+    
+    def disable_notifications(id)
+      perform_post("/notifications/leave/#{id}.json")
+    end
+    
+    def block(id)
+      perform_post("/blocks/create/#{id}.json")
+    end
+    
+    def unblock(id)
+      perform_post("/blocks/destroy/#{id}.json")
+    end
+    
+    def help
+      perform_get('/help/test.json')
+    end
+    
+    private
+      def perform_get(path, options={})
+        Twitter::Request.get(self, path, options)
+      end
+      
+      def perform_post(path, options={})
+        Twitter::Request.post(self, path, options)
+      end
+  end
+end

data/lib/twitter/oauth.rb

@@ -0,0 +1,31 @@
+module Twitter
+  class OAuth
+    attr_reader :ctoken, :csecret
+    
+    def initialize(ctoken, csecret)
+      @ctoken, @csecret = ctoken, csecret
+    end
+    
+    def consumer
+      @consumer ||= ::OAuth::Consumer.new(@ctoken, @csecret, {:site => 'http://twitter.com'})
+    end
+    
+    def request_token
+      @request_token ||= consumer.get_request_token
+    end
+    
+    def authorize_from_request(rtoken, rsecret)
+      request_token = ::OAuth::RequestToken.new(consumer, rtoken, rsecret)
+      access_token = request_token.get_access_token
+      @atoken, @asecret = access_token.token, access_token.secret
+    end
+    
+    def access_token
+      @access_token ||= ::OAuth::AccessToken.new(consumer, @atoken, @asecret)
+    end
+    
+    def authorize_from_access(atoken, asecret)
+      @atoken, @asecret = atoken, asecret
+    end
+  end
+end