grackle 0.2.0 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,19 +1,22 @@
-== 0.2.0 (2012-6-10)
+== 0.2.1 (2012-08-14)
+* Add :valid_http_codes option that tells grackle not to raise an error when encountering those statuses.
+
+== 0.2.0 (2012-06-10)
 * New auto_append_format attribute (thanks @jcsalterego) for specifying whether or not to automatically add .json, etc to a request URI
 * New response attribute which captures raw info about the response from the most recent request. This permits access to response headers with rate limit information. Thanks to @mandoescamilla.
 * Added Twitter's media upload endpoint. Thanks @jbrennon.
 * Modernized the code a bit with better test running and a new gemspec
 * Now testing in 1.8.6, 1.8.7, 1.9.2 and 1.9.3
 
-== 0.1.10 (2010-6-13)
+== 0.1.10 (2010-06-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)
+== 0.1.9 (2010-02-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)
+== 0.1.8 (2010-02-02)
 * 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.
 
 == 0.1.7 (2009-12-13)

data/lib/grackle/client.rb

@@ -79,7 +79,8 @@ module Grackle
       end
     end
     
-    VALID_FORMATS = [:json,:xml,:atom,:rss]
+    VALID_FORMATS     = [:json,:xml,:atom,:rss]
+    VALID_HTTP_CODES  = [200]
 
     # Contains the mapping of API name symbols to actual host (and path) 
     # prefixes to use with requests. You can add your own to this hash and 
@@ -107,7 +108,7 @@ module Grackle
     
     attr_accessor :auth, :handlers, :default_format, :headers, :ssl, :api, 
       :transport, :request, :api_hosts, :timeout, :auto_append_ids,
-      :auto_append_format, :response_headers, :response
+      :auto_append_format, :response_headers, :response, :valid_http_codes
     
     # Arguments (all are optional):
     # - :username           - Twitter username to authenticate with (deprecated in favor of :auth arg)
@@ -122,6 +123,7 @@ module Grackle
     #   - :type=>:oauth     - Include :consumer_key, :consumer_secret, :token and :token_secret keys
     # - :auto_append_format - true or false to include format in URI (e.g. /test.json). Default is true
     # - :response_headers   - array of headers to return from the response
+    # - :valid_http_codes   - array of HTTP codes to consider valid (non-error)
     def initialize(options={})
       self.transport = Transport.new
       self.handlers = {:json=>Handlers::JSONHandler.new,:xml=>Handlers::XMLHandler.new,:unknown=>Handlers::StringHandler.new}
@@ -135,7 +137,8 @@ module Grackle
       self.timeout = options[:timeout] || 60
       self.auto_append_ids = options[:auto_append_ids] == false ? false : true
       self.auth = {}
-      self.response_headers = options[:response_headers] || DEFAULT_RESPONSE_HEADERS
+      self.response_headers = options[:response_headers] || DEFAULT_RESPONSE_HEADERS.clone
+      self.valid_http_codes = options[:valid_http_codes] || VALID_HTTP_CODES.clone
       if options.has_key?(:username) || options.has_key?(:password)
         #Use basic auth if :username and :password args are passed in
         self.auth.merge!({:type=>:basic,:username=>options[:username],:password=>options[:password]})
@@ -260,7 +263,7 @@ module Grackle
       def process_response(format,res)
         fmt_handler = handler(format)        
         begin
-          unless res.status == 200
+          unless self.valid_http_codes.include?(res.status)
             handle_error_response(res,fmt_handler)
           else
             fmt_handler.decode_response(res.body)

data/lib/grackle/version.rb

@@ -1,6 +1,6 @@
 module Grackle
 
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 
   def self.version
     VERSION

data/test/client_test.rb

@@ -381,7 +381,19 @@ class ClientTest < Test::Unit::TestCase
     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
-  
+
+  def test_valid_http_codes_causes_error_not_to_raise
+    client = new_client(202,'{"id":12345,"screen_name":"test_user"}')
+    assert_raise(Grackle::TwitterError) do
+      value = client.users.show.json? :screen_name=>'test_user'
+    end
+
+    client = new_client(202,'{"id":12345,"screen_name":"test_user"}',:valid_http_codes=>[200,202])
+    assert_nothing_raised do
+      value = client.users.show.json? :screen_name=>'test_user'
+    end
+  end
+
   private
     def with_http_responder(responder)
       Net::HTTP.responder = responder

metadata

@@ -1,75 +1,73 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: grackle
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Hayes Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-10 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mime-types
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: oauth
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-description: "    Grackle is a library for the Twitter REST and Search API designed to not\n    require a new release in the face Twitter API changes or errors.\n"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    Grackle is a library for the Twitter REST and Search API designed
+  to not\n    require a new release in the face Twitter API changes or errors.\n"
 email: hayes@unionmetrics.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - CHANGELOG.rdoc
-files: 
+files:
 - README.rdoc
 - CHANGELOG.rdoc
 - lib/grackle/client.rb
@@ -81,39 +79,28 @@ files:
 - test/client_test.rb
 - test/handlers_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/hayesdavis/grackle
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Grackle is a lightweight library for the Twitter REST and Search API.
 test_files: []
-