hayesdavis-grackle 0.1.2 → 0.1.3

data/README.rdoc

@@ -31,7 +31,7 @@ Before you do anything else, you'll need to
 ====Using OAuth
   client = Grackle::Client.new(:auth=>{
     :type=>:oauth,
-    :consumer_key=>'SOMECONSUMERKEYFROMTWITTER', :consumer_token=>'SOMECONSUMERTOKENFROMTWITTER',
+    :consumer_key=>'SOMECONSUMERKEYFROMTWITTER', :consumer_secret=>'SOMECONSUMERTOKENFROMTWITTER',
     :token=>'ACCESSTOKENACQUIREDONUSERSBEHALF', :token_secret=>'SUPERSECRETACCESSTOKENSECRET'
   })
   

data/grackle.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grackle}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hayes Davis"]
-  s.date = %q{2009-04-12}
+  s.date = %q{2009-05-23}
   s.description = %q{Grackle is a lightweight library for the Twitter REST and Search API.}
   s.email = %q{hayes@appozite.com}
   s.files = ["History.txt", "README.rdoc", "grackle.gemspec", "lib/grackle.rb", "lib/grackle/client.rb", "lib/grackle/handlers.rb", "lib/grackle/transport.rb", "lib/grackle/utils.rb", "test/test_grackle.rb", "test/test_helper.rb", "test/test_client.rb", "test/test_handlers.rb"]

data/lib/grackle/client.rb

@@ -39,7 +39,7 @@ module Grackle
   # you've got all the necessary tokens and keys:
   #   client = Grackle::Client.new(:auth=>{
   #     :type=>:oauth,
-  #     :consumer_key=>'SOMECONSUMERKEYFROMTWITTER, :consumer_token=>'SOMECONSUMERTOKENFROMTWITTER',
+  #     :consumer_key=>'SOMECONSUMERKEYFROMTWITTER, :consumer_secret=>'SOMECONSUMERTOKENFROMTWITTER',
   #     :token=>'ACCESSTOKENACQUIREDONUSERSBEHALF', :token_secret=>'SUPERSECRETACCESSTOKENSECRET'
   #   }) 
   class Client
@@ -88,7 +88,7 @@ module Grackle
       :authorize_path=>'/oauth/authorize'
     }
     
-    attr_accessor :auth, :handlers, :default_format, :headers, :ssl, :api, :transport, :request, :api_hosts
+    attr_accessor :auth, :handlers, :default_format, :headers, :ssl, :api, :transport, :request, :api_hosts, :timeout
     
     # Arguments (all are optional):
     # - :username       - twitter username to authenticate with (deprecated in favor of :auth arg)
@@ -110,6 +110,7 @@ module Grackle
       self.ssl = options[:ssl] == true
       self.api = options[:api] || :rest
       self.api_hosts = TWITTER_API_HOSTS.clone
+      self.timeout = options[:timeout] || 60
       self.auth = {}
       if options.has_key?(:username) || options.has_key?(:password)
         #Use basic auth if :username and :password args are passed in
@@ -202,7 +203,7 @@ module Grackle
       def send_request(params)
         begin
           transport.request(
-            request.method,request.url,:auth=>auth,:headers=>headers,:params=>params
+            request.method,request.url,:auth=>auth,:headers=>headers,:params=>params, :timeout => timeout
           )
         rescue => e
           puts e

data/lib/grackle/transport.rb

@@ -16,6 +16,7 @@ module Grackle
     attr_accessor :debug
   
     CRLF = "\r\n"
+    DEFAULT_REDIRECT_LIMIT = 5
     
     def req_class(method)
       case method
@@ -31,6 +32,7 @@ module Grackle
     #             a multipart request will be sent. If a Time is included, .httpdate will be called on it.
     # - :headers - a hash of headers to send with the request
     # - :auth - a hash of authentication parameters for either basic or oauth
+    # - :timeout - timeout for the http request in seconds
     def request(method, string_url, options={})
       params = stringify_params(options[:params])
       if method == :get && params
@@ -49,6 +51,7 @@ module Grackle
       conn.use_ssl = (url.scheme == 'https')
       conn.start do |http| 
         req = req_class(method).new(url.request_uri)
+        http.read_timeout = options[:timeout]
         add_headers(req,options[:headers])
         if file_param?(options[:params])
           add_multipart_data(req,options[:params])
@@ -65,7 +68,12 @@ module Grackle
         dump_request(req) if debug
         res = http.request(req)
         dump_response(res) if debug
-        Response.new(method,url.to_s,res.code.to_i,res.body)
+        redirect_limit = options[:redirect_limit] || DEFAULT_REDIRECT_LIMIT
+        if res.code.to_s =~ /^30\d$/ && redirect_limit > 0
+          execute_request(method,URI.parse(res['location']),options.merge(:redirect_limit=>redirect_limit-1))
+        else 
+          Response.new(method,url.to_s,res.code.to_i,res.body)
+        end
       end
     end
 

data/lib/grackle.rb

@@ -1,7 +1,7 @@
 module Grackle
 
   # :stopdoc:
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/test/test_client.rb

@@ -5,21 +5,26 @@ class TestClient < Test::Unit::TestCase
   #Used for mocking HTTP requests
   class Net::HTTP
     class << self
-      attr_accessor :response, :request, :last_instance
+      attr_accessor :response, :request, :last_instance, :responder
     end
    
     def request(req)
       self.class.last_instance = self
-      self.class.request = req
-      self.class.response
+      if self.class.responder
+        self.class.responder.call(self,req)        
+      else
+        self.class.request = req
+        self.class.response
+      end
     end
   end  
   
-  #Mock responses that conform mostly to HTTPResponse's interface
-  class MockResponse
-    include Net::HTTPHeader
+  #Mock responses that conform to HTTPResponse's interface
+  class MockResponse < Net::HTTPResponse
+    #include Net::HTTPHeader
     attr_accessor :code, :body
     def initialize(code,body,headers={})
+      super
       self.code = code
       self.body = body
       headers.each do |name, value|
@@ -30,7 +35,7 @@ class TestClient < Test::Unit::TestCase
   
   #Transport that collects info on requests and responses for testing purposes
   class MockTransport < Grackle::Transport
-    attr_accessor :status, :body, :method, :url, :options
+    attr_accessor :status, :body, :method, :url, :options, :timeout
     
     def initialize(status,body,headers={})
       Net::HTTP.response = MockResponse.new(status,body,headers)
@@ -56,6 +61,36 @@ class TestClient < Test::Unit::TestCase
     end
   end
   
+  def test_redirects
+    redirects = 2 #Check that we can follow 2 redirects before getting to original request
+    req_count = 0
+    responder = Proc.new do |inst, req|
+      req_count += 1
+      #Store the original request
+      if req_count == 1
+        inst.class.request = req 
+      else
+        assert_equal("/somewhere_else#{req_count-1}.json",req.path)
+      end
+      if req_count <= redirects
+        MockResponse.new(302,"You are being redirected",'location'=>"http://twitter.com/somewhere_else#{req_count}.json")
+      else
+        inst.class.response
+      end
+    end
+    with_http_responder(responder) do
+      test_simple_get_request
+    end
+    assert_equal(redirects+1,req_count)
+  end
+  
+  def test_timeouts
+    client = new_client(200,'{"id":12345,"screen_name":"test_user"}')
+    assert_equal(60, client.timeout)
+    client.timeout = 30
+    assert_equal(30, client.timeout)
+  end
+  
   def test_simple_get_request
     client = new_client(200,'{"id":12345,"screen_name":"test_user"}')
     value = client.users.show.json? :screen_name=>'test_user'
@@ -150,6 +185,13 @@ class TestClient < Test::Unit::TestCase
   end
   
   private
+    def with_http_responder(responder)
+      Net::HTTP.responder = responder
+      yield
+    ensure
+      Net::HTTP.responder = nil
+    end
+    
     def new_client(response_status, response_body, client_opts={})
       client = Grackle::Client.new(client_opts)
       client.transport = MockTransport.new(response_status,response_body)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hayesdavis-grackle
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Hayes Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-12 00:00:00 -07:00
+date: 2009-05-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -65,6 +65,7 @@ files:
 - test/test_handlers.rb
 has_rdoc: true
 homepage: http://github.com/hayesdavis/grackle
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --inline-source
@@ -87,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: grackle
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Grackle is a library for the Twitter REST and Search API designed to not require a new release in the face Twitter API changes or errors. It supports both basic and OAuth authentication mechanisms.