twitter4r 0.5.3 → 0.6.0

data/bin/t4r-oauth-access

@@ -0,0 +1,91 @@
+#!/usr/bin/env ruby
+
+require("irb")
+require("irb/completion")
+require("rubygems")
+
+begin
+  gem('twitter4r', '>0.3.0')
+  require("twitter")
+  require("twitter/console")
+  require("pp")
+rescue Gem::LoadError
+  begin
+    gem("mbbx6spp-twitter4r", '>=0.3.1')
+    require("twitter")
+    require("twitter/console")
+    require("pp")
+  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 OAuthAccess
+    class << self
+      @@OPTIONS = { :key => "", :secret => "" }
+      def parse_options!
+        OptionParser.new do |opt|
+          opt.banner = "Usage: t4r-oauth-access [environment] [options]"
+          opt.on("--key=[<YOUR KEY>]", 'Use this OAuth consumer key.') { |v| @@OPTIONS[:key] = v }
+          opt.on("--secret=[<YOUR SECRET>]", 'Use this OAuth consumer secret.') { |v| @@OPTIONS[:secret] = 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()
+        # TODO: fill in here
+        consumer = OAuth::Consumer.new(@@OPTIONS[:key], @@OPTIONS[:secret],
+                                       :site => "https://twitter.com")
+        rtoken = consumer.get_request_token
+        puts "1. Visit this URL to grant your application authorization:"
+        puts "   >> #{rtoken.authorize_url}"
+        puts "2. When you have authorized your application to access your account, Twitter.com will display a PIN to you."
+        print "3. Enter the PIN here: "
+        pin = STDIN.readline.chomp
+        atoken = rtoken.get_access_token(:oauth_verifier => pin)
+        puts "4. Your access token details are:"
+        puts "   >> key:    #{atoken.token}"
+        puts "   >> secret: #{atoken.secret}"
+        resp = atoken.get("/account/verify_credentials.json")
+        data = JSON.parse(resp.body)
+        puts
+        puts "Your account details are:"
+        p data
+      end
+    end
+  end
+end
+
+def run_twitter4r_oauth_registration!
+  @twitter = nil
+  Twitter::OAuthAccess.parse_options!
+  config_file = Twitter::OAuthAccess.config_file
+  account = Twitter::OAuthAccess.account
+
+  if config_file && account
+    @twitter = Twitter::Client.from_config(config_file, account)
+    puts "Used #{config_file} to create client for #{account} account."
+    puts "Follow instructions below to grant authorization to your application and determine access token details."
+    Twitter::OAuthAccess.run()
+  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
+
+run_twitter4r_oauth_registration!

data/bin/t4rsh

@@ -0,0 +1,73 @@
+#!/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
+      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
+
+def run_twitter4r_console!
+  @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
+
+run_twitter4r_console!

data/lib/twitter/client/base.rb

@@ -46,7 +46,7 @@ class Twitter::Client
     end
     
   private
-    @@http_header = nil
+  @@http_header = nil
 
     def rest_consumer
       unless @rest_consumer
@@ -113,10 +113,11 @@ class Twitter::Client
 
     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)        
+      error = Twitter::RESTError.registry[response.code]
+      raise error.new(:code => response.code, 
+                      :message => response.message,
+                      :error => map["error"],
+                      :uri => uri)        
     end
     
     def handle_rest_response(response, uri = nil)

data/lib/twitter/config.rb

@@ -55,6 +55,7 @@ module Twitter
       :oauth_request_token_path,
       :oauth_access_token_path,
       :oauth_authorize_path,
+      :exception_registry,
     ]
 
     attr_accessor(*@@ATTRIBUTES)
@@ -91,6 +92,7 @@ module Twitter
                    :oauth_request_token_path => '/oauth/request_token',
                    :oauth_access_token_path => '/oauth/access_token',
                    :oauth_authorize_path => '/oauth/authorize',
+                   :exception_registry => Twitter::RESTError.registry,
     }
     @@config = Twitter::Config.new(@@defaults)
 

data/lib/twitter/core.rb

@@ -84,7 +84,7 @@ module Twitter
     end
   end # ClassUtilMixin
   
-  # Exception subclass raised when there is an error encountered upon 
+  # Exception API base class raised when there is an error encountered upon 
   # querying or posting to the remote Twitter REST API.
   # 
   # To consume and query any <tt>RESTError</tt> raised by Twitter4R:
@@ -100,6 +100,18 @@ module Twitter
   #  Resource Not Found
   #  /i_am_crap.json
   class RESTError < RuntimeError 
+    class << self
+      @@REGISTRY = {}
+
+      def registry
+        @@REGISTRY
+      end
+
+      def register(status_code)
+        @@REGISTRY[status_code] = self
+      end
+    end
+
     include ClassUtilMixin
     @@ATTRIBUTES = [:code, :message, :uri, :error]
     attr_accessor :code, :message, :uri, :error
@@ -107,31 +119,126 @@ module Twitter
     # Returns string in following format:
     #  "HTTP #{@code}: #{@message} at #{@uri}"
     # For example,
-    #  "HTTP 404: Resource Not Found at /i_am_crap.json"
+    #  "HTTP 404: Resource Not Found at /i_am_crap.json
+    #     >This is the error message sent back by the Twitter.com API"
     def to_s
       "HTTP #{@code}: #{@message} at #{@uri}"
     end
   end # RESTError
+
+  # Runtime error leaf class raised when Twitter.com API has no new results 
+  # to return from the last query. HTTP code: 304 (aka Not Modified).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue NotModifiedError => nme
+  #    timeline = []
+  #  end
+  class NotModifiedError < RESTError; register('304'); end
   
-  # Remote REST API interface representation
-  # 
-  class RESTInterfaceSpec
-  	include ClassUtilMixin
-  	
-  end
+  # Runtime error leaf class raised when client has reached rate limits.
+  # HTTP code: 400 (aka Bad Request).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue RateLimitError => rlre
+  #    # do something here...
+  #  end
+  class RateLimitError < RESTError; register('400'); end
   
-  # Remote REST API method representation
-  # 
-  class RESTMethodSpec
-  	include ClassUtilMixin
-  	attr_accessor :uri, :method, :parameters
-  end
+  # Runtime error leaf class raised when user and/or client credentials 
+  # are missing or invalid. 
+  # HTTP code: 401 (aka Unauthorized).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue UnauthorizedError => uae
+  #    # do something to prompt for valid credentials to user here.
+  #  end
+  class UnauthorizedError < RESTError; register('401'); end
   
-  # Remote REST API method parameter representation
-  # 
-  class RESTParameterSpec
-  	include ClassUtilMixin
-  	attr_accessor :name, :type, :required
-  	def required?; @required; end
-  end
+  # Runtime error leaf class raised when update limit reached. 
+  # HTTP code: 403 (aka Forbidden).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue ForbiddenError => fe
+  #    # do something to notify user that update limit has been reached
+  #  end
+  class ForbiddenError < RESTError; register('403'); end
+  
+  # Runtime error leaf class raised when a resource requested was not found.
+  # HTTP code: 404 (aka Not Found).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue NotFoundError => nfe
+  #    # do something to notify user that resource was not found.
+  #  end
+  class NotFoundError < RESTError; register('404'); end
+  
+  # Runtime error leaf class raised when the format specified in the request
+  # is not understood by the Twitter.com API. 
+  # HTTP code: 406 (aka Not Acceptable).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue NotAcceptableError => nae
+  #    # 
+  #  end
+  class NotAcceptableError < RESTError; register('406'); end
+  
+  # Runtime error leaf class raised when search rate limit reached.
+  # HTTP code: 420.
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue SearchRateLimitError => nme
+  #    # 
+  #  end
+  class SearchRateLimitError < RESTError; register('420'); end
+  
+  # Runtime error leaf class raised when Twitter.com API is borked for 
+  # an unknown reason.
+  # HTTP code: 500 (aka Internal Server Error).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue InternalServerError => ise
+  #    # do something to notify user that an unknown internal server error
+  #    # has arisen.
+  #  end
+  class InternalServerError < RESTError; register('500'); end
+  
+  # Runtime error leaf class raised when Twitter.com servers are being 
+  # upgraded.
+  # HTTP code: 502 (aka Bad Gateway).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue BadGatewayError => bge
+  #    #
+  #  end
+  class BadGatewayError < RESTError; register('502'); end
+ 
+  # Runtime error leaf class raised when Twitter.com servers are unable 
+  # to respond to the current load.
+  # HTTP code: 502 (aka Service Unavailable).
+  #
+  # To handle specifically you would do the following:
+  #  begin
+  #    timeline = twitter.timeline_for(:friends, :since => tweet)
+  #  rescue ServiceUnavailableError => sue
+  #    #
+  #  end
+  class ServiceUnavailableError < RESTError; register('503'); end
 end

data/lib/twitter/model.rb

@@ -225,9 +225,9 @@ module Twitter
   # Represents a status posted to <tt>Twitter</tt> by a <tt>Twitter</tt> user.
   class Status
     include ModelMixin
-    @@ATTRIBUTES = [:id, :text, :source, :truncated, :created_at, :user, :from_user, :to_user,
-                    :favorited, :in_reply_to_status_id, :in_reply_to_user_id,
-                    :in_reply_to_screen_name, :geo]
+    @@ATTRIBUTES = [:id, :id_str, :text, :source, :truncated, :created_at, :user, 
+                    :from_user, :to_user, :favorited, :in_reply_to_status_id, 
+                    :in_reply_to_user_id, :in_reply_to_screen_name, :geo]
     attr_accessor(*@@ATTRIBUTES)
 
     class << self

data/lib/twitter/version.rb

@@ -3,8 +3,8 @@
 
 module Twitter::Version #:nodoc:
   MAJOR = 0
-  MINOR = 5
-  REVISION = 3
+  MINOR = 6
+  REVISION = 0
   class << self
     # Returns X.Y.Z formatted version string
     def to_version

data/spec/twitter/core_spec.rb

@@ -27,15 +27,28 @@ describe "Twitter::ClassUtilMixin mixed-in class" do
   end
 end
 
-describe "Twitter::RESTError#to_s" do
-  before(:each) do
-    @hash = { :code => 200, :message => 'OK', :uri => 'http://test.host/bla' }
-    @error = Twitter::RESTError.new(@hash)
-    @expected_message = "HTTP #{@hash[:code]}: #{@hash[:message]} at #{@hash[:uri]}"
+describe Twitter::RESTError do
+  describe "#to_s" do
+    before(:each) do
+      @hash = { :code => 200, :message => 'OK', :uri => 'http://test.host/bla' }
+      @error = Twitter::RESTError.new(@hash)
+      @expected_message = "HTTP #{@hash[:code]}: #{@hash[:message]} at #{@hash[:uri]}"
+    end
+    
+    it "should return @expected_message" do
+      @error.to_s.should eql(@expected_message)
+    end
   end
-  
-  it "should return @expected_message" do
-    @error.to_s.should eql(@expected_message)
+
+  describe ".register" do
+    before(:each) do
+      @status_code = '999'
+      class MyCustomError < Twitter::RESTError; register('999'); end
+    end
+
+    it "should register a new RESTError subclass with a status code" do
+      described_class.registry[@status_code].should eql(MyCustomError)
+    end
   end
 end
 
@@ -125,3 +138,67 @@ describe "Twitter::ClassUtilMixin#require_block" do
     @test_subject = nil
   end
 end
+
+shared_examples_for "REST error returned" do
+  before(:each) do
+    @twitter = client_context
+    @connection = mas_net_http(mas_net_http_response(error_response_code))
+  end
+
+  it "should raise relevant RuntimeError subclass" do
+    lambda {
+      @twitter.account_info
+    }.should raise_error(described_class)
+  end
+end
+
+describe Twitter::NotModifiedError do
+  def error_response_code; :not_modified; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::RateLimitError do
+  def error_response_code; :bad_request; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::UnauthorizedError do
+  def error_response_code; :not_authorized; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::ForbiddenError do
+  def error_response_code; :forbidden; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::NotFoundError do
+  def error_response_code; :file_not_found; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::NotAcceptableError do
+  def error_response_code; :not_acceptable; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::SearchRateLimitError do
+  def error_response_code; :search_rate_limit; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::InternalServerError do
+  def error_response_code; :server_error; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::BadGatewayError do
+  def error_response_code; :bad_gateway; end
+  it_should_behave_like "REST error returned"
+end
+
+describe Twitter::ServiceUnavailableError do
+  def error_response_code; :service_unavailable; end
+  it_should_behave_like "REST error returned"
+end
+

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: twitter4r
 version: !ruby/object:Gem::Version 
-  hash: 13
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 3
-  version: 0.5.3
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Susan Potter
@@ -15,45 +14,44 @@ autorequire: twitter
 bindir: bin
 cert_chain: []
 
-date: 2010-09-21 00:00:00 -05:00
+date: 2010-11-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: oauth
+  name: json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
         segments: 
-        - 0
-        - 4
         - 1
-        version: 0.4.1
+        - 1
+        - 1
+        version: 1.1.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: oauth
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 17
         segments: 
+        - 0
+        - 4
         - 1
-        - 1
-        - 1
-        version: 1.1.1
+        version: 0.4.1
   type: :runtime
   version_requirements: *id002
 description: 
 email: twitter4r-users@googlegroups.com
-executables: []
-
+executables: 
+- t4rsh
+- t4r-oauth-access
 extensions: []
 
 extra_rdoc_files: 
@@ -108,6 +106,8 @@ files:
 - spec/twitter/meta_spec.rb
 - spec/twitter/config_spec.rb
 - spec/twitter/console_spec.rb
+- bin/t4rsh
+- bin/t4r-oauth-access
 - README
 - CHANGES
 - TODO
@@ -126,7 +126,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 59
       segments: 
       - 1
       - 8
@@ -137,7 +136,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"