dambalah-twitter4r 0.3.1

data/CHANGES

@@ -0,0 +1,124 @@
+= CHANGES
+
+Catalog(ue) of changes for Twitter4R 0.1.x releases including Retrospectiva ticket cross-reference numbers.  Refer to http://retro.tautology.net/projects/twitter4r/tickets for more information.
+
+== 0.3.1 Changes
+* Added URI.encode => CGI.escape fix
+* Added block methods
+* Added Twitter::Client#inspect method to XXXX out passwords
+* Minor refactoring of spec/spec_helper.rb 
+* Added support for :page, :lite and :since options for Twitter::User#followers, Twitter::Client#my([:friends|:followers]...) and Twitter::Client#user([:friends|:followers]...)calls
+* Added Twitter::Client.status(:replies) support
+
+
+== 0.3.0 Changes
+* Bunch of changes, but forgot to track them and too lazy to look through the SVN/Git logs.  Sorry.
+
+== 0.2.5 Changes
+
+=== 2007-09-23
+* Added paging support as per Sergio Santos' request (#36).
+
+== 0.2.4 Changes
+
+=== 2007-07-24
+* Fixed ActiveSupport +Time#to_s+ conflict such that integration with Rails is much less painful (#34)
+
+== 0.2.3 Changes
+
+=== 2007-07-22
+* Fixed defect #31 such that passing string screen name as for user argument is handled correctly.
+* Fixed #30 typo: respond_to -> respond_to?
+* Added relevant exception handling for #message(:post, ...) case (#32)
+* Add ability to pass in Twitter::User object to Twitter::Client#user(...) #33
+* Added stats Rake task
+* Updated RDoc for Twitter::Client#user to warn against using it to get followers of authenticated user and updated ArgumentError raising logic as per #29.
+
+== 0.2.2 Changes
+
+=== 2007-07-18
+* Fixed URI paths for user, messaging and friendship APIs (#25)
+* Added action checks for Twitter::Client methods: #user, #my, #message, #messages, #status, #timeline, #friend (#26)
+* Added 'source' configuration documentation. 
+* Added missing attributes for Twitter::User (#28)
+
+== 0.2.1 Changes
+
+=== 2007-07-17
+* Added 'source' feature and configurability.
+
+== 0.2.0 Changes
+
+=== 2007-07-08
+* Added featured users API as an "extra" (#19).
+* Productionized website for publishing.
+* Published Ruby Gem on Rubyforge.
+
+=== 2007-07-07
+* Refactored Twitter4R API to be more consistent, by grouping APIs (#6):
+  - Messaging APIs: direct_messages, new, destroy, replies
+  - Friendship APIs: create, destroy
+* Added following features (#7):
+  - Retrieving direct messages
+  - User APIs: friends, followers, show
+* Updated documentation and example code.
+
+=== 2007-07-06
+* Refactored Twitter4R API to be more consistent, by grouping APIs (#6):
+  - Status APIs: show, update, destroy
+  - User APIs: friends, followers, show
+* Added X-Twitter-Client HTTP headers and Twitter::Config options (#16)
+* Removed redundant feature (#8):
+  - Followers timeline
+* Refactored HTTP request/response code to DRY up code.
+* Fix REST error handling to use #is_a?(HTTPSuccess) instead of code in ['200', '201'] to determine REST error (#15).
+
+=== 2007-06-25
+* Updated example documentation (#14)
+* Refactored marshaling unmarshaling code (#13)
+
+=== 2007-06-20
+* Added proxy user/pass support.  Tested only via endo-testing.  (No system/integration testing behind real proxy as I do not have that environment).
+
+
+=== 2007-06-17
+* Refactored Twitter4R API to be more consistent, by grouping APIs (#6):
+  - Timeline APIs: public, friends, user
+
+=== 2007-06-13
+* Added RSpec Autotest integration
+* Fixed Twitter::Meta generation of spec for hash values
+* Added HTTP header to each request including generated User-Agent header
+* Added RCovMorpher and template to restyle RCov output upon release
+* Added Gemspec dependencies and requirements
+* Added default tidy YAML configuration file for RCovMorpher
+* Added Contributors list and updated external dependencies list to README
+* Removed shebang from examples
+
+=== 2007-06-12
+* Added proxy support as per Kaiichi Matsunaga submitted patch (#11).
+* Added SSL support (#12)
+
+=== 2007-05-19
+* Translated RSpec specifications from 0.8.2 compliant to 1.0.0 (#10)
+
+== 0.1.1 Changes
+
+=== 2007-06-25
+* Added SSL support (#12)
+* Added Proxy support (#11)
+
+== 0.1.0 Changes
+
+=== 2007-05-08
+* Added Google Analytics Javascript code to website pages (#5)
+
+=== 2007-05-07
+* Fixed errors in online sample code documentation and redeployed website (#2 and #3)
+* Created more consistent RDoc theme to go more with website home page (#4)
+
+=== 2007-05-06
+* Initial revision of codebase commited; includes:
+  - Achieved 80% Twitter API feature-completeness
+  - Attained 100% RSpec C0 code coverage
+  - Rake tasks for: RSpec, RCov, RDoc, Gem, Rubyforge Publishing, etc.

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2007 Susan Potter <me _at_ susanpotter _dot_ net>.
+
+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/README

@@ -0,0 +1,32 @@
+= Twitter4R
+
+* Project Website - http://twitter4r.rubyforge.org
+* Mailing List - http://groups.google.com/group/twitter4r-users
+
+== Developers
+* {Susan Potter}[http://SusanPotter.NET] <me at susanpotter dot net>
+
+== Contributors
+* Kaiichi Matsunaga <ma2 at lifemedia dot co dot jp> - proxy code suggestion
+* Sergio Santos <> - message paging code suggestion
+* Adam Stiles <adam at stilesoft dot com> - URI.encode => CGI.escape fix
+* Carl Crawley <cwcrawley at gmail dot com> - Friendship get => post fix
+
+== Description
+Twitter4R provides an object based API to query or update your Twitter account via pure Ruby.  It hides the ugly HTTP/REST code from your code.
+
+== External Dependencies
+* Ruby 1.8 (tested with 1.8.6)
+* RSpec gem 1.0.0+ (tested with 1.1.3)
+* JSON gem 0.4.3+ (tested with versions: 1.1.1 and 1.1.2)
+* jcode (for unicode support)
+
+== Usage Examples
+Twitter4R starting with version 0.1.1 and above is organized into seven parts:
+* {Configuration API}[link:files/examples/configure_rb.html]
+* {Friendship API}[link:files/examples/friendship_rb.html]
+* {Messaging API}[link:files/examples/messaging_rb.html]
+* {Model API}[link:files/examples/model_rb.html]
+* {Status API}[link:files/examples/status_rb.html]
+* {Timeline API}[link:files/examples/timeline_rb.html]
+* {User API}[link:files/examples/user_rb.html]

data/TODO

@@ -0,0 +1,9 @@
+
+0.3.1 TODO:
+* Add specs for :page, :lite and :since options support in Twitter::Client#my(...), Twitter::Client#user(....) and Twitter::User#followers calls
+* Add specs for Kernel#gem_present? extension
+* Add spec to test that warning is given to Rails 2.0+ users requiring 'twitter/rails'
+* Add specs for :replies support in Twitter::Client#status(...) and Twitter::Client#timeline_for(...)
+* Add RDoc for :replies support
+* Add better RDoc for Twitter::Client.account_info(:rate_limit_status)
+* Add specs for Twitter::Client.account_info(:rate_limit_status)

data/lib/twitter.rb

@@ -0,0 +1,31 @@
+# 
+
+module Twitter; end
+
+def require_local(suffix)
+  require(File.expand_path(File.join(File.dirname(__FILE__), suffix)))
+end
+
+# For better unicode support
+$KCODE = 'u'
+require 'jcode'
+
+# External requires
+require('yaml')
+require('date')
+require('time')
+require('net/https')
+require('uri')
+require('cgi')
+require('json')
+require('yaml')
+
+# Ordering matters...pay attention here!
+require_local('twitter/ext')
+require_local('twitter/version')
+require_local('twitter/meta')
+require_local('twitter/core')
+require_local('twitter/model')
+require_local('twitter/config')
+require_local('twitter/client')
+require_local('twitter/console')

data/lib/twitter/client.rb

@@ -0,0 +1,21 @@
+# client.rb contains the classes, methods and extends <tt>Twitter4R</tt> 
+# features to define client calls to the Twitter REST API.
+# 
+# See:
+# * <tt>Twitter::Client</tt>
+
+# Used to query or post to the Twitter REST API to simplify code.
+class Twitter::Client
+  include Twitter::ClassUtilMixin
+end
+
+require('twitter/client/base.rb')
+require('twitter/client/timeline.rb')
+require('twitter/client/status.rb')
+require('twitter/client/friendship.rb')
+require('twitter/client/messaging.rb')
+require('twitter/client/user.rb')
+require('twitter/client/auth.rb')
+require('twitter/client/favorites.rb')
+require('twitter/client/blocks.rb')
+require('twitter/client/account.rb')

data/lib/twitter/client/account.rb

@@ -0,0 +1,24 @@
+class Twitter::Client
+  @@ACCOUNT_URIS = {
+    :rate_limit_status => '/account/rate_limit_status',
+  }
+  
+	# Provides access to the Twitter rate limit status API.
+	# 
+	# You can find out information about your account status.  Currently the only 
+	# supported type of account status is the <tt>:rate_limit_status</tt> which 
+	# returns a <tt>Twitter::RateLimitStatus</tt> object.
+  # 
+	# Example:
+	#  account_status = client.account_info
+	#  puts account_status.remaining_hits
+	def account_info(type = :rate_limit_status)
+  	connection = create_http_connection
+  	connection.start do |connection|
+  	  response = http_connect do |conn|
+  	    create_http_get_request("#{@@ACCOUNT_URIS[type]}.json")
+  	  end
+  		bless_models(Twitter::RateLimitStatus.unmarshal(response.body))
+    end
+	end
+end

data/lib/twitter/client/auth.rb

@@ -0,0 +1,27 @@
+class Twitter::Client
+  @@AUTHENTICATION_URIS = {
+    :verify => '/account/verify_credentials',
+  }
+  
+	# Provides access to the Twitter verify credentials API.
+	# 
+	# You can verify Twitter user credentials with minimal overhead using this method.
+  # 
+	# Example:
+	#  client.authenticate?("osxisforlightweights", "l30p@rd_s^cks!")
+	def authenticate?(login, password)
+    verify_credentials(login, password)
+	end
+	
+private
+  def verify_credentials(username, passwd)
+  	connection = create_http_connection
+  	connection.start do |connection|
+  	  request = create_http_get_request("#{@@AUTHENTICATION_URIS[:verify]}.json")
+  		request.basic_auth(username, passwd)
+  		response = connection.request(request)
+  		response.is_a?(Net::HTTPSuccess) ? true : false
+    end
+  end
+end
+

data/lib/twitter/client/base.rb

@@ -0,0 +1,87 @@
+class Twitter::Client
+  alias :old_inspect :inspect
+  def inspect
+    s = old_inspect
+    s.gsub!(/@password=".*?"/, '@password="XXXX"')
+  end
+  protected
+    attr_accessor :login, :password
+    
+    # Returns the response of the HTTP connection.  
+    def http_connect(body = nil, require_auth = true, &block)
+    	require_block(block_given?)
+    	connection = create_http_connection
+    	connection.start do |connection|
+    		request = yield connection if block_given?
+    		request.basic_auth(@login, @password) if require_auth
+    		response = connection.request(request, body)
+    		handle_rest_response(response)
+    		response
+      end
+    end
+    
+    # "Blesses" model object with client information
+    def bless_model(model)
+    	model.bless(self) if model
+    end
+    
+    def bless_models(list)
+      return bless_model(list) if list.respond_to?(:client=)
+    	list.collect { |model| bless_model(model) } if list.respond_to?(:collect)
+    end
+    
+  private
+    @@http_header = nil
+    
+    def raise_rest_error(response, uri = nil)
+      raise Twitter::RESTError.new(:code => response.code, 
+                                   :message => response.message,
+                                   :uri => uri)        
+    end
+    
+    def handle_rest_response(response, uri = nil)
+      unless response.is_a?(Net::HTTPSuccess)
+        raise_rest_error(response, uri)
+      end
+    end
+    
+    def create_http_connection
+      conn = Net::HTTP.new(@@config.host, @@config.port, 
+                            @@config.proxy_host, @@config.proxy_port,
+                            @@config.proxy_user, @@config.proxy_pass)
+      if @@config.protocol == :ssl
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      conn
+    end
+
+    def http_header
+      # can cache this in class variable since all "variables" used to 
+      # create the contents of the HTTP header are determined by other 
+      # class variables that are not designed to change after instantiation.
+      @@http_header ||= { 
+      	'User-Agent' => "Twitter4R v#{Twitter::Version.to_version} [#{@@config.user_agent}]",
+      	'Accept' => 'text/x-json',
+      	'X-Twitter-Client' => @@config.application_name,
+      	'X-Twitter-Client-Version' => @@config.application_version,
+      	'X-Twitter-Client-URL' => @@config.application_url,
+      }
+      @@http_header
+    end
+    
+    def create_http_get_request(uri, params = {})
+    	path = (params.size > 0) ? "#{uri}?#{params.to_http_str}" : uri
+      Net::HTTP::Get.new(path, http_header)
+    end
+    
+    def create_http_post_request(uri)
+    	Net::HTTP::Post.new(uri, http_header)
+    end
+    
+    def create_http_delete_request(uri, params = {})
+    	path = (params.size > 0) ? "#{uri}?#{params.to_http_str}" : uri
+    	Net::HTTP::Delete.new(path, http_header)
+    end
+end
+

data/lib/twitter/client/blocks.rb

@@ -0,0 +1,35 @@
+class Twitter::Client
+  @@BLOCK_URIS = {
+    :add => '/blocks/create',
+    :remove => '/blocks/destroy',
+  }
+	
+  # Provides access to the Twitter Block API.
+  # 
+  # You can add and remove blocks to users using this method.
+  # 
+  # <tt>action</tt> can be any of the following values:
+  # * <tt>:add</tt> - to add a block, you would use this <tt>action</tt> value
+  # * <tt>:remove</tt> - to remove a block use this.
+  # 
+  # The <tt>value</tt> must be either the user screen name, integer unique user ID or Twitter::User 
+  # object representation.
+  # 
+  # Examples:
+  #  screen_name = 'dictionary'
+  #  client.block(:add, 'dictionary')
+  #  client.block(:remove, 'dictionary')
+  #  id = 1260061
+  #  client.block(:add, id)
+  #  client.block(:remove, id)
+  #  user = Twitter::User.find(id, client)
+  #  client.block(:add, user)
+  #  client.block(:remove, user)
+  def block(action, value)
+    raise ArgumentError, "Invalid friend action provided: #{action}" unless @@BLOCK_URIS.keys.member?(action)
+    value = value.to_i unless value.is_a?(String)
+    uri = "#{@@BLOCK_URIS[action]}/#{value}.json"
+    response = http_connect {|conn| create_http_get_request(uri) }
+    bless_model(Twitter::User.unmarshal(response.body))
+  end
+end

data/lib/twitter/client/favorites.rb

@@ -0,0 +1,53 @@
+class Twitter::Client
+  # Why Twitter.com developers can't correctly document their API, I do not know!
+	@@FAVORITES_URIS = {
+		:add => '/favourings/create',
+		:remove => '/favourings/destroy',
+	}
+
+  # Provides access to the Twitter list favorites API.
+  # 
+  # You can access the authenticated [Twitter] user's favorites list using this method.
+  # 
+  # By default you will receive the last twenty statuses added to your favorites list.
+  # To get a previous page you can provide options to this method.  For example,
+  #  statuses = client.favorites(:page => 2)
+  # The above one-liner will get the second page of favorites for the authenticated user.
+	def favorites(options = nil)
+	  def uri_suffix(opts); opts && opts[:page] ? "?page=#{opts[:page]}" : ""; end
+    uri = '/favorites.json' + uri_suffix(options)
+    response = http_connect {|conn|	create_http_get_request(uri) }
+    bless_models(Twitter::Status.unmarshal(response.body))
+	end
+	
+	# Provides access to the Twitter add/remove favorite API.
+	# 
+	# You can add and remove favorite status using this method.
+	# 
+	# <tt>action</tt> can be any of the following values:
+	# * <tt>:add</tt> - to add a status to your favorites, you would use this <tt>action</tt> value
+	# * <tt>:remove</tt> - to remove an status from your existing favorites list use this.
+	# 
+	# The <tt>value</tt> must be either the status object to add or remove or 
+	# the integer unique status ID.
+	# 
+	# Examples:
+	#  id = 126006103423
+	#  client.favorite(:add, id)
+	#  client.favorite(:remove, id)
+	#  status = Twitter::Status.find(id, client)
+	#  client.favorite(:add, status)
+	#  client.favorite(:remove, status)
+	def favorite(action, value)
+	  raise ArgumentError, "Invalid favorite action provided: #{action}" unless @@FAVORITES_URIS.keys.member?(action)
+		value = value.to_i.to_s unless value.is_a?(String)
+		uri = "#{@@FAVORITES_URIS[action]}/#{value}.json"
+		case action
+		when :add
+		  response = http_connect {|conn| create_http_post_request(uri) }
+		when :remove
+		  response = http_connect {|conn| create_http_delete_request(uri) }
+		end
+		bless_model(Twitter::Status.unmarshal(response.body))
+	end
+end