mbbx6spp-twitter4r 0.3.1 → 0.4.0

data/CHANGES

@@ -3,6 +3,11 @@
 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 specs for Twitter::Client#profile (:info, :colors and :device cases)
+* Added Twitter4R shell
+* Improved code coverage for twitter/ext/stdlib code and removed hard coded extension in GET request path for retrieving account information
+* Changed Twitter::RESTError super class to be RuntimeError instead of Exception
 * Added URI.encode => CGI.escape fix
 * Added block methods
 * Added Twitter::Client#inspect method to XXXX out passwords

data/README

@@ -7,10 +7,15 @@
 * {Susan Potter}[http://SusanPotter.NET] <me at susanpotter dot net>
 
 == Contributors
+Code:
 * 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
+* Christian Johansen <christian at cjohansen dot no> - in_reply_to attributes in Twitter::Status
+
+Design Suggestions:
+* Bosco So <rubymeetup at boscoso dot com> - making Twitter::Error a RuntimeError instead of an Exception to prevent irb from crashing out.
 
 == 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.

data/TODO

@@ -1,9 +1,7 @@
 
 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)
+* Add specs for Twitter::Client.account_info(:rate_limit_status)

data/bin/t4rsh

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require("irb")
+require("irb/completion")
+require("rubygems")
+
+begin
+  gem('twitter4r', '>0.3.0')
+  require("twitter")
+  require("twitter/console")
+rescue Gem::LoadError
+  begin
+    gem("mbbx6spp-twitter4r", '>=0.3.1')
+    require("twitter")
+    require("twitter/console")
+  rescue Gem::LoadError
+    abort("Error: You must install either twitter4r gem from Rubyforge with version 0.3.1 or greater or the mbbx6spp-twitter4r gem from GitHub's servers with version 0.3.1 or greater (and make sure it is a recent version of the gem).")
+  end
+end
+
+module Twitter
+  class Console
+    class << self
+      @@OPTIONS = { :debugger => false, :config => "~/.twitter4r/accounts.yml" }
+      def parse_options
+        OptionParser.new do |opt|
+          opt.banner = "Usage: t4rsh [environment] [options]"
+          opt.on("--config=[~/.twitter4r/accounts.yml]", 'Use a specific config file.') { |v| @@OPTIONS[:config] = v }
+          opt.parse!(ARGV)
+        end
+      end
+
+      def config_file
+        result = ENV["T4R_CONFIG"]
+        file_name = File.expand_path('twitter.yml')
+        result ||= file_name if File.exists?(file_name)
+        file_name = File.expand_path('twitter.yml', 'config')
+        result ||= file_name if File.exists?(file_name)
+        file_name = File.expand_path('~/.twitter.yml')
+        result ||= file_name if File.exists?(file_name)
+        result
+      end
+
+      def account
+        ENV["T4R_ENV"] || ENV["MERB_ENV"] || ENV["RAILS_ENV"]
+      end
+
+      def run(file)
+        IRB.init_config(nil)
+        # configuration...
+        IRB.conf[:IRB_NAME] = "t4rsh"
+        IRB.conf[:VERSION] = Twitter::Version.to_version
+        IRB.conf[:USE_READLINE] = true
+        IRB.conf[:PROMPT_MODE] = :T4RSH
+        IRB.conf[:PROMPT][:T4RSH] = {
+          :PROMPT_I => "%N[%3n:%i]> ", # top level prompt
+          :PROMPT_C => "%N[%3n:%i]* ", # after conditional like "if"
+          :PROMPT_S => "%N[%3n:%i]* ", # during continuing string
+          :RETURN => "=> %s\n", # return value
+        }
+        IRB.start(file)
+      end
+    end
+  end
+end
+
+#if __FILE__ == $0
+  @twitter = nil
+  config_file = Twitter::Console.config_file
+  account = Twitter::Console.account
+
+  if config_file && account
+    @twitter = Twitter::Client.from_config(config_file, account)
+    puts "Used #{config_file} to create client for #{account} account."
+    puts "Access @twitter for instantiated client."
+    Twitter::Console.run(__FILE__)
+  else
+    abort("Please make sure #{config_file} exists and contains your Twitter credentials (separated by account/environment) and that you specify the account/environment to use, e.g. if you have a 'test' section in your configuration file that you want to use set/export T4R_ENV=test as an environment variable or RAILS_ENV=test or MERB_ENV=test")
+  end
+#end

data/lib/twitter.rb

@@ -1,4 +1,5 @@
-# 
+#
+require('rubygems')
 
 module Twitter; end
 
@@ -6,9 +7,11 @@ def require_local(suffix)
   require(File.expand_path(File.join(File.dirname(__FILE__), suffix)))
 end
 
-# For better unicode support
-$KCODE = 'u'
-require 'jcode'
+# For better unicode support in 1.8
+if RUBY_VERSION < '1.9'
+  $KCODE = 'u'
+  require 'jcode'
+end
 
 # External requires
 require('yaml')

data/lib/twitter/client.rb

@@ -9,13 +9,16 @@ 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')
+require('twitter/client/base')
+require('twitter/client/timeline')
+require('twitter/client/status')
+require('twitter/client/friendship')
+require('twitter/client/messaging')
+require('twitter/client/user')
+require('twitter/client/auth')
+require('twitter/client/favorites')
+require('twitter/client/blocks')
+require('twitter/client/account')
+require('twitter/client/graph')
+require('twitter/client/profile')
+require('twitter/client/search')

data/lib/twitter/client/account.rb

@@ -3,22 +3,22 @@ class Twitter::Client
     :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.
+  # Provides access to the Twitter rate limit status API.
   # 
-	# 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))
+  # 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])
+      end
+      bless_models(Twitter::RateLimitStatus.unmarshal(response.body))
     end
-	end
+  end
 end

data/lib/twitter/client/base.rb

@@ -1,16 +1,18 @@
 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)
+    def http_connect(body = nil, require_auth = true, service = :rest, &block)
     	require_block(block_given?)
-    	connection = create_http_connection
+    	connection = create_http_connection(service)
     	connection.start do |connection|
     		request = yield connection if block_given?
     		request.basic_auth(@login, @password) if require_auth
@@ -34,8 +36,10 @@ class Twitter::Client
     @@http_header = nil
     
     def raise_rest_error(response, uri = nil)
+      map = JSON.parse(response.body)
       raise Twitter::RESTError.new(:code => response.code, 
                                    :message => response.message,
+                                   :error => map["error"],
                                    :uri => uri)        
     end
     
@@ -45,11 +49,17 @@ class Twitter::Client
       end
     end
     
-    def create_http_connection
-      conn = Net::HTTP.new(@@config.host, @@config.port, 
+    def create_http_connection(service = :rest)
+      case service
+      when :rest
+        protocol, host, port = @@config.protocol, @@config.host, @@config.port
+      when :search
+        protocol, host, port = @@config.search_protocol, @@config.search_host, @@config.search_port
+      end
+      conn = Net::HTTP.new(host, port, 
                             @@config.proxy_host, @@config.proxy_port,
                             @@config.proxy_user, @@config.proxy_pass)
-      if @@config.protocol == :ssl
+      if protocol == :ssl
         conn.use_ssl = true
         conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
@@ -84,4 +94,3 @@ class Twitter::Client
     	Net::HTTP::Delete.new(path, http_header)
     end
 end
-

data/lib/twitter/client/favorites.rb

@@ -1,9 +1,9 @@
 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',
-	}
+  @@FAVORITES_URIS = {
+    :add => '/favourings/create',
+    :remove => '/favourings/destroy',
+  }
 
   # Provides access to the Twitter list favorites API.
   # 
@@ -13,41 +13,41 @@ class Twitter::Client
   # 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
+  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
+  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
+  # 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

data/lib/twitter/client/graph.rb

@@ -0,0 +1,37 @@
+class Twitter::Client
+  @@GRAPH_URIS = {
+    :friends => '/friends/ids',
+    :followers => '/followers/ids',
+  }
+	
+  # Provides access to the Twitter Social Graphing API.
+  # 
+  # You can retrieve the full graph of a user's friends or followers in one method call.
+  # 
+  # <tt>action</tt> can be any of the following values:
+  # * <tt>:friends</tt> - retrieves ids of all friends of a given user.
+  # * <tt>:followers</tt> - retrieves ids of all followers of a given user.
+  # 
+  # 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.graph(:friends, 'dictionary')
+  #  client.graph(:followers, 'dictionary')
+  #  id = 1260061
+  #  client.graph(:friends, id)
+  #  client.graph(:followers, id)
+  #  user = Twitter::User.find(id, client)
+  #  client.graph(:friends, user)
+  #  client.graph(:followers, user)
+  def graph(action, value = nil)
+    raise ArgumentError, "Invalid friend action provided: #{action}" unless @@GRAPH_URIS.keys.member?(action)
+    id = value.to_i unless value.nil? || value.is_a?(String)
+    id ||= value
+    id ||= @login
+    uri = "#{@@GRAPH_URIS[action]}.json"
+    response = http_connect {|conn| create_http_get_request(uri, :id => id) }
+    JSON.parse(response.body)
+  end
+end

data/lib/twitter/client/profile.rb

@@ -0,0 +1,29 @@
+class Twitter::Client
+  @@PROFILE_URIS = {
+    :info => '/account/update_profile',
+    :colors => '/account/update_profile_colors',
+    :device => '/account/update_delivery_device',
+  }
+  
+  # Provides access to the Twitter Profile API.
+  # 
+  # You can update profile information.  You can update the types of profile 
+  # information:
+  # * :info (name, email, url, location, description)
+  # * :colors (background_color, text_color, link_color, sidebar_fill_color, 
+  # sidebar_border_color)
+  # * :device (set device to either "sms", "im" or "none")
+  # 
+  # Example:
+  #  user = client.profile(:info, :location => "University Library")
+  #  puts user.inspect
+  def profile(action, attributes)
+    connection = create_http_connection
+    connection.start do |connection|
+      response = http_connect(attributes.to_http_str) do |conn|
+        create_http_post_request(@@PROFILE_URIS[action])
+      end
+      bless_models(Twitter::User.unmarshal(response.body))
+    end
+  end
+end

data/lib/twitter/client/search.rb

@@ -0,0 +1,27 @@
+class Twitter::Client
+
+  @@SEARCH_URIS = {
+    :basic => "/search.json",
+  }
+
+  # Provides access to Twitter's Search API.
+  # 
+  # Example:
+  #  # For keyword search
+  #  iterator = @twitter.search(:q => "coworking")
+  #  while (tweet = iterator.next)
+  #    puts tweet.text
+  #  end
+  # 
+  # An <tt>ArgumentError</tt> will be raised if an invalid <tt>action</tt> 
+  # is given.  Valid actions are:
+  # * +:received+
+  # * +:sent+
+  def search(options = {})
+#    raise ArgumentError, "Invalid messaging action: #{action}"
+    uri = @@SEARCH_URIS[:basic]
+    response = http_connect(nil, false, :search) {|conn|	create_http_get_request(uri, options) }
+    json = JSON.parse(response.body)
+    bless_models(Twitter::Status.unmarshal(JSON.dump(json["results"])))
+  end
+end