grackle 0.1.8 → 0.1.9

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.1.9 (2010-2-28)
+* Added support for a boolean option called auto_append_ids that controls whether parameters named "id" are automatically appended to the URL or used as request parameters. It's true by default so there's no change to existing behavior unless you explicitly set it to false.
+* Updated the README with changes describing how to use custom handlers (thanks akahn!)
+
 == 0.1.8 (2010-2-2)
 * Added proxy support to Grackle::Transport via proxy attribute. Can specify a Proc that returns a Net::HTTP subclass or a Net::HTTP subclass directly. Typically this will be from Net::HTTP.Proxy.
 

data/README.rdoc

@@ -140,12 +140,21 @@ returned by Twitter. It's a good idea to wrap your API calls with rescue clauses
 If there is an unexpected connection error or Twitter returns data in the wrong format (which it can do), you'll still get a TwitterError.
 
 ===Formats
-Twitter allows you to request data in particular formats. Grackle automatically parses JSON and XML formatted responses 
-and returns an OpenStruct. If you specify a format that Grackle doesn't parse for you, you'll receive a string containing 
-the raw response body. The Grackle::Client has a default_format you can specify. By default, the default_format is :json. 
-If you don't include a named format in your method chain as described above, but use a "?" or "!" then the 
+Twitter allows you to request data in particular formats. Grackle automatically 
+parses JSON and XML formatted responses and returns an OpenStruct. The 
+Grackle::Client has a default_format you can specify. By default, the 
+default_format is :json. If you don't include a named format in your method 
+chain as described above, but use a "?" or "!" then the 
 Grackle::Client.default_format is used.
 
+If you specify a format that Grackle doesn't parse for you, you'll receive a 
+string containing the raw response body. If you want to receive the raw 
+response body even for XML or JSON formatted responses, tell the Grackle client 
+to use the +StringHandler+ handler. For example, the following code sets the 
+Grackle client to return JSON instead of an OpenStruct:
+
+  client = Grackle::Client.new(:handlers=>{:json=>Grackle::Handlers::StringHandler.new })
+
 ===Odds and Ends
 If you need to append something to the request path that isn't a valid ruby method, e.g.
   /1user/lists.json #1user isn't a valid Ruby method

data/grackle.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grackle}
-  s.version = "0.1.8"
+  s.version = "0.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hayes Davis"]
-  s.date = %q{2010-2-2}
+  s.date = %q{2010-2-28}
   s.description = %q{Grackle is a lightweight library for the Twitter REST and Search API.}
   s.email = %q{hayes@appozite.com}
   s.files = ["CHANGELOG.rdoc", "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.rb

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

data/lib/grackle/client.rb

@@ -98,7 +98,8 @@ module Grackle
       :authorize_path=>'/oauth/authorize'
     }
     
-    attr_accessor :auth, :handlers, :default_format, :headers, :ssl, :api, :transport, :request, :api_hosts, :timeout
+    attr_accessor :auth, :handlers, :default_format, :headers, :ssl, :api, 
+      :transport, :request, :api_hosts, :timeout, :auto_append_ids
     
     # Arguments (all are optional):
     # - :username       - twitter username to authenticate with (deprecated in favor of :auth arg)
@@ -121,6 +122,7 @@ module Grackle
       self.api = options[:api] || :rest
       self.api_hosts = TWITTER_API_HOSTS.clone
       self.timeout = options[:timeout] || 60
+      self.auto_append_ids = options[:auto_append_ids] == false ? false : true
       self.auth = {}
       if options.has_key?(:username) || options.has_key?(:password)
         #Use basic auth if :username and :password args are passed in
@@ -213,8 +215,10 @@ module Grackle
     
     protected
       def call_with_format(format)
-        id = request.params.delete(:id)
-        request << "/#{id}" if id
+        if auto_append_ids
+          id = request.params.delete(:id)
+          request << "/#{id}" if id
+        end
         request << ".#{format}"
         res = send_request
         process_response(format,res)

data/test/test_client.rb

@@ -293,6 +293,25 @@ class TestClient < Test::Unit::TestCase
     assert_equal(false,MockProxy.started,"Proxy should not have been called")
   end
   
+  def test_auto_append_ids_is_honored
+    client = new_client(200,'{"id":12345,"screen_name":"test_user"}')
+    client.users.show.json? :id=>12345
+    assert_equal('/users/show/12345.json',client.transport.url.path,"Id should be appended by default")
+    client.auto_append_ids = false
+    client.users.show.json? :id=>12345
+    assert_equal('/users/show.json',client.transport.url.path,"Id should not be appended")
+    assert_equal(12345,client.transport.options[:params][:id], "Id should be treated as a parameter")
+    assert_equal("id=#{12345}",Net::HTTP.request.path.split(/\?/)[1],"id should be part of the query string")    
+  end
+  
+  def test_auto_append_ids_can_be_set_in_constructor
+    client = new_client(200,'{"id":12345,"screen_name":"test_user"}',:auto_append_ids=>false)
+    client.users.show.json? :id=>12345
+    assert_equal('/users/show.json',client.transport.url.path,"Id should not be appended")
+    assert_equal(12345,client.transport.options[:params][:id], "Id should be treated as a parameter")
+    assert_equal("id=#{12345}",Net::HTTP.request.path.split(/\?/)[1],"id should be part of the query string")    
+  end
+  
   private
     def with_http_responder(responder)
       Net::HTTP.responder = responder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: grackle
 version: !ruby/object:Gem::Version 
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors: 
 - Hayes Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-02 00:00:00 -06:00
+date: 2010-02-28 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency