grackle 0.1.6 → 0.1.7

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+== 0.1.7 (2009-12-13)
+* Fixed a bug in Ruby 1.9 where the client was incorrectly handling request method parameters
+* Fixed a bug in the _ method that wasn't correctly appending numeric path elements
+* Provided a way to specify SSL Certificate Authority certs for correct SSL validation
+* The only thing that doesn't work in 1.9 in this version is OAuth because that gem is not up to date
+
 == 0.1.6 (2009-10-29)
 * Added support for HTTP methods beside GET and POST using block syntax
 * Added method for appending to the request path something that's not a valid ruby method

data/README.rdoc

@@ -1,7 +1,7 @@
 =grackle
 by Hayes Davis
 - http://twitter.com/hayesdavis
-- hayes [at] appozite.com
+- hayes [at] appozite [dot] com
 - http://cheaptweet.com
 - http://www.appozite.com
 - http://hayesdavis.net
@@ -19,6 +19,13 @@ will potentially require, however, some modifications to your code that uses Gra
 
 Grackle supports both OAuth and HTTP basic authentication.
 
+=== Support and Announcements
+The preferred forum for questions and discussions is the Google group at http://groups.google.com/group/gracklerb. 
+You can email me directly or @reply me on Twitter, but the group is better since the questions and responses 
+will be available to everyone. I'll also make announcements there. There are some examples on the wiki at 
+http://wiki.github.com/hayesdavis/grackle. If you prefer your information in 140 characters, follow 
+@gracklerb[http://twitter.com/gracklerb].
+
 ==USING GRACKLE
 
 Before you do anything else, you'll need to
@@ -145,14 +152,23 @@ If you need to append something to the request path that isn't a valid ruby meth
 you can use the Grackle::Client#_ method like so:
   client._('1user').lists.json
 
-== REQUIREMENTS:
+== REQUIREMENTS
 
 You'll need the following gems to use all features of Grackle:
 - json
 - oauth 
 - mime-types
 
-== INSTALL:
+=== Ruby Version Support
+Grackle works just fine on Ruby 1.8.x. It is also known to work on 1.9.1 with 
+the exception of OAuth. The OAuth gem used by Grackle has not been updated fully 
+to support 1.9. Please see this thread[http://groups.google.com/group/oauth-ruby/browse_thread/thread/d0851a907878cd22] 
+for more information.
+
+Once the OAuth gem has been updated, Grackle will work fully on 1.9. If you 
+aren't using OAuth it should be fine for use on 1.9 as is.
+
+== INSTALL
 The grackle gem is now hosted at http://gemcutter.org. If you've already setup gemcutter 
 in your sources, you can do the following:
   sudo gem install grackle
@@ -165,7 +181,7 @@ They will likely tell you to do the following:
 Once you've done that you can do: 
   sudo gem install grackle
 
-== LICENSE:
+== LICENSE
 
 (The MIT License)
 

data/grackle.gemspec

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

data/lib/grackle/client.rb

@@ -185,9 +185,9 @@ module Grackle
     end
     
     def append(name,*args)
-      name = name.to_sym
+      name = name.to_s.to_sym
       #The args will be a hash, store them if they're specified
-      self.request.params = *args
+      self.request.params = args.first
       #If method is a format name, execute using that format
       if format_invocation?(name)
         return call_with_format(name)

data/lib/grackle/transport.rb

@@ -18,6 +18,10 @@ module Grackle
     CRLF = "\r\n"
     DEFAULT_REDIRECT_LIMIT = 5
     
+    class << self
+      attr_accessor :ca_cert_file
+    end
+    
     def req_class(method)
       Net::HTTP.const_get(method.to_s.capitalize)
     end
@@ -44,6 +48,9 @@ module Grackle
     def execute_request(method,url,options={})
       conn = Net::HTTP.new(url.host, url.port)
       conn.use_ssl = (url.scheme == 'https')
+      if conn.use_ssl?
+        configure_ssl(conn)
+      end
       conn.start do |http| 
         req = req_class(method).new(url.request_uri)
         http.read_timeout = options[:timeout]
@@ -166,31 +173,56 @@ module Grackle
         consumer.sign!(req,access_token)
       end
 
-      private
-        def oauth_site(conn,req)
-          site = "#{(conn.use_ssl? ? "https" : "http")}://#{conn.address}"
-          if (conn.use_ssl? && conn.port != 443) || (!conn.use_ssl? && conn.port != 80) 
-            site << ":#{conn.port}"
-          end
-          site
-        end
-        
-        def dump_request(req)
-          puts "Sending Request"
-          puts"#{req.method} #{req.path}"
-          dump_headers(req)
+      def oauth_site(conn,req)
+        site = "#{(conn.use_ssl? ? "https" : "http")}://#{conn.address}"
+        if (conn.use_ssl? && conn.port != 443) || (!conn.use_ssl? && conn.port != 80) 
+          site << ":#{conn.port}"
         end
+        site
+      end
       
-        def dump_response(res)
-          puts "Received Response"
-          dump_headers(res)
-          puts res.body
+      def dump_request(req)
+        puts "Sending Request"
+        puts"#{req.method} #{req.path}"
+        dump_headers(req)
+      end
+    
+      def dump_response(res)
+        puts "Received Response"
+        dump_headers(res)
+        puts res.body
+      end
+    
+      def dump_headers(msg)
+        msg.each_header do |key, value|
+          puts "\t#{key}=#{value}"
         end
-      
-        def dump_headers(msg)
-          msg.each_header do |key, value|
-            puts "\t#{key}=#{value}"
+      end
+
+      def configure_ssl(conn)
+        if self.class.ca_cert_file
+          conn.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          conn.ca_file = self.class.ca_cert_file
+        else
+          # Turn off SSL verification which gets rid of warning in 1.8.x and 
+          # an error in 1.9.x.
+          conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+          unless @ssl_warning_shown
+            puts <<-EOS
+Warning: SSL Verification is not being performed. While your communication is 
+being encrypted, the identity of the other party is not being confirmed nor the 
+SSL certificate verified. It's recommended that you specify a file containing 
+root SSL certificates like so:
+ 
+Grackle::Transport.ca_cert_file = "path/to/cacerts.pem"
+  
+You can download this kind of file from the maintainers of cURL:
+http://curl.haxx.se/ca/cacert.pem
+  
+EOS
+            @ssl_warning_shown = true
           end
         end
+      end
   end
 end

data/test/test_client.rb

@@ -7,6 +7,10 @@ class TestClient < Test::Unit::TestCase
     class << self
       attr_accessor :response, :request, :last_instance, :responder
     end
+    
+    def connect
+      # This needs to be overridden so SSL requests can be mocked
+    end
    
     def request(req)
       self.class.last_instance = self
@@ -129,6 +133,14 @@ class TestClient < Test::Unit::TestCase
     assert(Net::HTTP.last_instance.use_ssl?,'Net::HTTP instance should be set to use SSL')
   end
   
+  def test_ssl_with_ca_cert_file
+    MockTransport.ca_cert_file = "some_ca_certs.pem"
+    client = new_client(200,'[{"id":1,"text":"test 1"}]',:ssl=>true)
+    client.statuses.public_timeline?
+    assert_equal(OpenSSL::SSL::VERIFY_PEER,Net::HTTP.last_instance.verify_mode,'Net::HTTP instance should use OpenSSL::SSL::VERIFY_PEER mode')
+    assert_equal(MockTransport.ca_cert_file,Net::HTTP.last_instance.ca_file,'Net::HTTP instance should have cert file set')
+  end
+  
   def test_default_format
     client = new_client(200,'[{"id":1,"text":"test 1"}]',:default_format=>:json)
     client.statuses.public_timeline?
@@ -235,6 +247,17 @@ class TestClient < Test::Unit::TestCase
     assert_equal(:post,client.transport.method, ":__method=>:post should override block setting and method suffix")
   end
   
+  def test_underscore_method_works_with_numbers
+    client = new_client(200,'{"id":12345,"screen_name":"test_user"}')
+    value = client.users.show._(12345).json?
+    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(12345,value.id)
+  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.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - Hayes Davis
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-29 00:00:00 -05:00
+date: 2009-12-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency