hayesdavis-grackle 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,5 +1,6 @@
 =grackle
 by Hayes Davis
+- http://twitter.com/hayesdavis
 - hayes [at] appozite.com
 - http://cheaptweet.com
 - http://www.appozite.com
@@ -25,14 +26,14 @@ Before you do anything else, you'll need to
 
 ===Creating a Grackle::Client
 ====Using Basic Auth
-  client = Grackle::Client.new(:auth=>{:type=:basic,:username=>'your_user',:password=>'yourpass'})
+  client = Grackle::Client.new(:auth=>{:type=>:basic,:username=>'your_user',:password=>'yourpass'})
 
 ====Using OAuth
   client = Grackle::Client.new(:auth=>{
     :type=>:oauth,
     :consumer_key=>'SOMECONSUMERKEYFROMTWITTER', :consumer_token=>'SOMECONSUMERTOKENFROMTWITTER',
     :token=>'ACCESSTOKENACQUIREDONUSERSBEHALF', :token_secret=>'SUPERSECRETACCESSTOKENSECRET'
-  }}
+  })
   
 ====Using No Auth
   client = Grackle::Client.new
@@ -51,32 +52,34 @@ request to be execute include:
 - A format method can also include a ? or ! to determine GET or POST in that format respectively
 
 ===GETting Data
-Invoking the API method "/users/show" in XML format for the Twitter user "some_user" looks like
-  client.users.show.xml :id=>'some_user' #http://twitter.com/users/show.xml?id=some_user
+The preferred and simplest way of executing a GET is to use the "?" method notation. This will use the default client 
+format (usually JSON, but see Formats section below):
+  client.users.show? :screen_name=>'some_user' #http://twitter.com/users/show.json?screen_name=some_user
 
-Or using the JSON format:
-  client.users.show.json :id=>'some_user' #http://twitter.com/users/show.json?id=some_user
-
-Or, since Twitter also allows certain ids to be part of their URLs, this works:
-  client.users.show.some_user.json #http://twitter.com/users/show/some_user.json
+You can force XML format by doing:
+  client.users.show.xml? :screen_name=>'some_user' #http://twitter.com/users/show.xml?scren_name=some_user
+  
+You can force JSON:
+  client.users.show.json? :screen_name=>'some_user' #http://twitter.com/users/show.json?screen_name=some_user
 
-The client has a default format of :json so if you want to use the above call with the default format you can do:
+Or, since Twitter also allows certain ids/screen_names to be part of their URLs, this works:
   client.users.show.some_user? #http://twitter.com/users/show/some_user.json
 
-If you include a "?" at the end of any method name, that signals to the Grackle client that you want to execute an HTTP GET request.
+If you use an explicit format, you can leave off the "?" like so:
+  client.users.show.xml :screen_name=>'some_user' #http://twitter.com/users/show.xml?scren_name=some_user
 
 ===POSTing data
 To use Twitter API methods that require an HTTP POST, you need to end your method chain with a bang (!)
 
-For example, to update the authenticated user's status using the XML format:
+The preferred way is to use the Client's default format (usually JSON, but see Formats section below):
+  client.statuses.update! :status=>'this status is from grackle' #POST to http://twitter.com/statuses/update.json
+
+You can force a format. To update the authenticated user's status using the XML format:
   client.statuses.update.xml! :status=>'this status is from grackle' #POST to http://twitter.com/statuses/update.xml
 
 Or, with JSON
   client.statuses.update.json! :status=>'this status is from grackle' #POST to http://twitter.com/statuses/update.json
 
-Or, using the default format
-  client.statuses.update! :status=>'this status is from grackle' #POST to http://twitter.com/statuses/update.json
-
 ===Toggling APIs
 By default, the Grackle::Client sends all requests to the 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 after setting this 
@@ -84,7 +87,7 @@ 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? :exclue=>'hashtags'
+  client[:search].trends.daily? :exclude=>'hashtags'
   client[:rest].users.show? :id=>'hayesdavis'
  
 Search and REST requests are all built using the same method chaining and termination conventions.
@@ -106,9 +109,11 @@ 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 currently supports JSON and XML. 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.
+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 
+Grackle::Client.default_format is used.
 
 == REQUIREMENTS:
 

data/grackle.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{grackle}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hayes Davis"]

data/lib/grackle.rb

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

data/lib/grackle/client.rb

@@ -41,7 +41,7 @@ module Grackle
   #     :type=>:oauth,
   #     :consumer_key=>'SOMECONSUMERKEYFROMTWITTER, :consumer_token=>'SOMECONSUMERTOKENFROMTWITTER',
   #     :token=>'ACCESSTOKENACQUIREDONUSERSBEHALF', :token_secret=>'SUPERSECRETACCESSTOKENSECRET'
-  #   }} 
+  #   }) 
   class Client
     
     class Request #:nodoc:

data/lib/grackle/transport.rb

@@ -45,7 +45,9 @@ module Grackle
     end
     
     def execute_request(method,url,options={})
-      Net::HTTP.new(url.host, url.port).start do |http| 
+      conn = Net::HTTP.new(url.host, url.port)
+      conn.use_ssl = (url.scheme == 'https')
+      conn.start do |http| 
         req = req_class(method).new(url.request_uri)
         add_headers(req,options[:headers])
         if file_param?(options[:params])

data/test/test_client.rb

@@ -5,10 +5,11 @@ class TestClient < Test::Unit::TestCase
   #Used for mocking HTTP requests
   class Net::HTTP
     class << self
-      attr_accessor :response, :request
+      attr_accessor :response, :request, :last_instance
     end
    
     def request(req)
+      self.class.last_instance = self
       self.class.request = req
       self.class.response
     end
@@ -60,6 +61,7 @@ class TestClient < Test::Unit::TestCase
     value = client.users.show.json? :screen_name=>'test_user'
     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('test_user',client.transport.options[:params][:screen_name])
@@ -89,6 +91,7 @@ class TestClient < Test::Unit::TestCase
     client = new_client(200,'[{"id":1,"text":"test 1"}]',:ssl=>true)
     client.statuses.public_timeline?
     assert_equal("https",client.transport.url.scheme)
+    assert(Net::HTTP.last_instance.use_ssl?,'Net::HTTP instance should be set to use SSL')
   end
   
   def test_default_format

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hayesdavis-grackle
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Hayes Davis