grackle 0.1.9 → 0.1.10

data/CHANGELOG.rdoc

@@ -1,3 +1,7 @@
+== 0.1.10 (2010-6-13)
+* Changed :v1 (api.twitter.com/1) to be the default API instead of REST. :rest is now deprecated
+* Fixed issue with DELETE requests not being able to have form encoded body parameters. This was causing the list membership delete method to fail. As a side note, it appears that Twitter is actually violating the HTTP 1.1 spec on this one since RFC 2616 states that a DELETE "requests that the origin server delete the resource identified by the Request-URI" (note no mention of any "enclosed entity").
+
 == 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!)

data/README.rdoc

@@ -102,27 +102,22 @@ parameter to your method chain called :__method (note the double underscores) to
   client.direct_messages.destroy! :id=>1, :__method=>:delete #HTTP DELETE
 
 ===Toggling APIs
-By default, the Grackle::Client sends all requests to the unversioned Twitter REST API. If you want to send requests to 
-the Twitter Search API, just set Grackle::Client.api to :search. To toggle back, set it to be :rest. All requests made 
+DEPRECATION NOTICE: The :rest API key (pointing to twitter.com) has been 
+deprecated in favor of the versioned API :v1 (pointing to api.twitter.com/1). 
+:v1 is now the default if you do not specify an API. Please do not use :rest 
+in your code.
+
+By default, the Grackle::Client sends all requests to the versioned Twitter REST API. If you want to send requests to 
+the Twitter Search API, just set Grackle::Client.api to :search. To toggle back, set it to be :v1. All requests made 
 after setting this attribute will go to that API.
 
 If you want to make a specific request to one API and not change the Client's overall api setting beyond that request, you can use the 
 bracket syntax like so:
   client[:search].trends.daily? :exclude=>'hashtags'
-  client[:rest].users.show? :id=>'hayesdavis'
+  client[:v1].users.show? :id=>'hayesdavis'
  
 Search and REST requests are all built using the same method chaining and termination conventions.
 
-Twitter is introducing API versioning. Grackle now supports the version 1 API using the :v1 API name. When using the :v1 
-API, resources that were previously separated between the search and REST APIs are available under one unified API. To 
-use the :v1 API, do the following:
-  client[:v1].search? :q=>'grackle'
-  client[:v1].users.show? :id=>'hayesdavis'
-  
-If you want to use the :v1 API for all requests, you may set Grackle::Client.api to :v1 or specify the :api option in the 
-Grackle::Client constructor like:
-  client = Grackle::Client.new(:api=>:v1)
-
 ===Parameter handling
 - All parameters are URL encoded as necessary.
 - If you use a File object as a parameter it will be POSTed to Twitter in a multipart request.

data/grackle.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grackle}
-  s.version = "0.1.9"
+  s.version = "0.1.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hayes Davis"]
-  s.date = %q{2010-2-28}
+  s.date = %q{2010-6-13}
   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.9'
+  VERSION = '0.1.10'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/grackle/client.rb

@@ -86,10 +86,9 @@ module Grackle
     # refer to it wherever Grackle::Client uses an API symbol. You may wish 
     # to do this when Twitter introduces API versions greater than 1.
     TWITTER_API_HOSTS = {
-      :rest=>'twitter.com',
-      :search=>'search.twitter.com',
-      :v1=>'api.twitter.com/1'
+      :search=>'search.twitter.com', :v1=>'api.twitter.com/1'
     }
+    TWITTER_API_HOSTS[:rest] = TWITTER_API_HOSTS[:v1]
     
     #Basic OAuth information needed to communicate with Twitter
     TWITTER_OAUTH_SPEC = {
@@ -108,7 +107,7 @@ module Grackle
     # - :default_format - Symbol of format to use when no format is specified in an API call (e.g. :json, :xml)
     # - :headers        - Hash of string keys and values for headers to pass in the HTTP request to twitter
     # - :ssl            - true or false to turn SSL on or off. Default is off (i.e. http://)
-    # - :api            - one of :rest, :search or :v1. :rest is the default
+    # - :api            - one of :rest, :search or :v1. :v1 is the default and :rest is now deprecated
     # - :auth           - Hash of authentication type and credentials. Must have :type key with value one of :basic or :oauth
     #   - :type=>:basic  - Include :username and :password keys
     #   - :type=>:oauth  - Include :consumer_key, :consumer_secret, :token and :token_secret keys
@@ -119,7 +118,7 @@ module Grackle
       self.default_format = options[:default_format] || :json 
       self.headers = {"User-Agent"=>"Grackle/#{Grackle::VERSION}"}.merge!(options[:headers]||{})
       self.ssl = options[:ssl] == true
-      self.api = options[:api] || :rest
+      self.api = options[:api] || :v1
       self.api_hosts = TWITTER_API_HOSTS.clone
       self.timeout = options[:timeout] || 60
       self.auto_append_ids = options[:auto_append_ids] == false ? false : true

data/lib/grackle/transport.rb

@@ -126,7 +126,7 @@ module Grackle
       end
     
       def add_form_data(req,params)
-        if req.request_body_permitted? && params
+        if request_body_permitted?(req) && params
           req.set_form_data(params)
         end
       end
@@ -236,5 +236,13 @@ EOS
           end
         end
       end
+
+      # Methods like Twitter's DELETE list membership expect that the user id 
+      # will be form encoded like a POST request in the body. Net::HTTP seems 
+      # to think that DELETEs can't have body parameters so we have to work 
+      # around that.
+      def request_body_permitted?(req)
+        req.request_body_permitted? || req.kind_of?(Net::HTTP::Delete)
+      end
   end
 end

data/test/test_client.rb

@@ -118,8 +118,8 @@ class TestClient < Test::Unit::TestCase
     assert_equal(:get,client.transport.method)
     assert_equal('http',client.transport.url.scheme)
     assert(!Net::HTTP.last_instance.use_ssl?,'Net::HTTP instance should not be set to use SSL')
-    assert_equal('twitter.com',client.transport.url.host)
-    assert_equal('/users/show.json',client.transport.url.path)
+    assert_equal('api.twitter.com',client.transport.url.host)
+    assert_equal('/1/users/show.json',client.transport.url.path)
     assert_equal('test_user',client.transport.options[:params][:screen_name])
     assert_equal('screen_name=test_user',Net::HTTP.request.path.split(/\?/)[1])
     assert_equal(12345,value.id)
@@ -174,7 +174,7 @@ class TestClient < Test::Unit::TestCase
     assert_equal('search.twitter.com',client.transport.url.host)
 
     client[:rest].users.show.some_user?
-    assert_equal('twitter.com',client.transport.url.host)
+    assert_equal('api.twitter.com',client.transport.url.host)
 
     client.api = :search
     client.trends?
@@ -207,7 +207,7 @@ class TestClient < Test::Unit::TestCase
   def test_clear
     client = new_client(200,'[{"id":1,"text":"test 1"}]')
     client.some.url.that.does.not.exist
-    assert_equal('/some/url/that/does/not/exist',client.send(:request).path,"An unexecuted path should be build up")
+    assert_equal('/some/url/that/does/not/exist',client.send(:request).path,"An unexecuted path should be built up")
     client.clear
     assert_equal('',client.send(:request).path,"The path shoudl be cleared")
   end
@@ -222,14 +222,14 @@ class TestClient < Test::Unit::TestCase
     client = new_client(200,'[{"id":1,"text":"test 1"}]')
     time = Time.now-60*60
     client.statuses.public_timeline? :since=>time  
-    assert_equal("/statuses/public_timeline.json?since=#{CGI::escape(time.httpdate)}",Net::HTTP.request.path)
+    assert_equal("/1/statuses/public_timeline.json?since=#{CGI::escape(time.httpdate)}",Net::HTTP.request.path)
   end
 
   def test_simple_http_method_block
     client = new_client(200,'[{"id":1,"text":"test 1"}]')
     client.delete { direct_messages.destroy :id=>1, :other=>'value' }
     assert_equal(:delete,client.transport.method, "delete block should use delete method")
-    assert_equal("/direct_messages/destroy/1.json",Net::HTTP.request.path)
+    assert_equal("/1/direct_messages/destroy/1.json",Net::HTTP.request.path)
     assert_equal('value',client.transport.options[:params][:other])
     
     client = new_client(200,'{"id":54321,"screen_name":"test_user"}')
@@ -237,8 +237,8 @@ class TestClient < Test::Unit::TestCase
     assert_equal(:get,client.transport.method)
     assert_equal('http',client.transport.url.scheme)
     assert(!Net::HTTP.last_instance.use_ssl?,'Net::HTTP instance should not be set to use SSL')
-    assert_equal('twitter.com',client.transport.url.host)
-    assert_equal('/users/show.json',client.transport.url.path)
+    assert_equal('api.twitter.com',client.transport.url.host)
+    assert_equal('/1/users/show.json',client.transport.url.path)
     assert_equal('test_user',client.transport.options[:params][:screen_name])
     assert_equal('screen_name=test_user',Net::HTTP.request.path.split(/\?/)[1])
     assert_equal(54321,value.id)    
@@ -270,8 +270,8 @@ class TestClient < Test::Unit::TestCase
     assert_equal(:get,client.transport.method)
     assert_equal('http',client.transport.url.scheme)
     assert(!Net::HTTP.last_instance.use_ssl?,'Net::HTTP instance should not be set to use SSL')
-    assert_equal('twitter.com',client.transport.url.host)
-    assert_equal('/users/show/12345.json',client.transport.url.path)
+    assert_equal('api.twitter.com',client.transport.url.host)
+    assert_equal('/1/users/show/12345.json',client.transport.url.path)
     assert_equal(12345,value.id)
   end
   
@@ -296,10 +296,10 @@ class TestClient < Test::Unit::TestCase
   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")
+    assert_equal('/1/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('/1/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
@@ -307,11 +307,29 @@ class TestClient < Test::Unit::TestCase
   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('/1/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_default_api
+    client = Grackle::Client.new
+    assert_equal(:v1,client.api,":v1 should be default api")
+  end
+  
+  # Methods like Twitter's DELETE list membership expect that the user id will 
+  # be form encoded like a POST request in the body. Net::HTTP seems to think 
+  # that DELETEs can't have body parameters so we have to work around that.
+  def test_delete_can_send_body_parameters
+    client = new_client(200,'{"id":12345,"name":"Test List","members":0}')
+    client.delete { some_user.some_list.members? :user_id=>12345 }
+    assert_equal(:delete,client.transport.method,"Expected delete request")
+    assert_equal('http',client.transport.url.scheme,"Expected scheme to be http")
+    assert_equal('api.twitter.com',client.transport.url.host,"Expected request to be against twitter.com")
+    assert_equal('/1/some_user/some_list/members.json',client.transport.url.path)
+    assert_match(/user_id=12345/,Net::HTTP.request.body,"Parameters should be form encoded")
+  end
+  
   private
     def with_http_responder(responder)
       Net::HTTP.responder = responder
@@ -331,8 +349,8 @@ class TestClient < Test::Unit::TestCase
       value = client.statuses.update! :status=>'test status'
       assert_equal(:post,client.transport.method,"Expected post request")
       assert_equal('http',client.transport.url.scheme,"Expected scheme to be http")
-      assert_equal('twitter.com',client.transport.url.host,"Expected request to be against twitter.com")
-      assert_equal('/statuses/update.json',client.transport.url.path)
+      assert_equal('api.twitter.com',client.transport.url.host,"Expected request to be against twitter.com")
+      assert_equal('/1/statuses/update.json',client.transport.url.path)
       assert_match(/status=test%20status/,Net::HTTP.request.body,"Parameters should be form encoded")
       assert_equal(12345,value.id)
       yield(client) if block_given?

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grackle
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 10
+  version: 0.1.10
 platform: ruby
 authors: 
 - Hayes Davis
@@ -9,39 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-28 00:00:00 -06:00
+date: 2010-06-13 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mime-types
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: oauth
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 description: Grackle is a lightweight library for the Twitter REST and Search API.
 email: hayes@appozite.com
 executables: []
@@ -75,21 +93,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: grackle
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 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.