rally_rest_api 1.0.3 → 1.0.4

data/lib/rally_rest_api/rest_builder.rb

@@ -4,6 +4,58 @@ require 'rexml/document'
 require 'rubygems'	
 require 'builder'
 
+# Intended to extend the Net::HTTP response object
+# and adds support for decoding gzip and deflate encoded pages
+#
+# Author: Jason Stirk <http://griffin.oobleyboo.com>
+# Home: http://griffin.oobleyboo.com/projects/http_encoding_helper
+# Created: 5 September 2007
+# Last Updated: 23 November 2007
+#
+# Usage:
+#
+# require 'net/http'
+# require 'http_encoding_helper'
+# headers={'Accept-Encoding' => 'gzip, deflate' }
+# http = Net::HTTP.new('griffin.oobleyboo.com', 80)
+# http.start do |h|
+#   request = Net::HTTP::Get.new('/', headers)
+#   response = http.request(request)
+#   content=response.plain_body     # Method from our library
+#   puts "Transferred: #{response.body.length} bytes"
+#   puts "Compression: #{response['content-encoding']}"
+#   puts "Extracted: #{response.plain_body.length} bytes"
+# end
+#
+
+require 'zlib'
+require 'stringio'
+
+class Net::HTTPResponse
+  # Return the uncompressed content
+  def plain_body
+    encoding=self['content-encoding']
+    content=nil
+    if encoding then
+      case encoding
+        when 'gzip'
+          i=Zlib::GzipReader.new(StringIO.new(self.body))
+          content=i.read
+        when 'deflate'
+          i=Zlib::Inflate.new
+          content=i.inflate(self.body)
+        else
+          raise "Unknown encoding - #{encoding}"
+      end
+    else
+      content=self.body
+    end
+    return content
+  end
+
+end
+
+
 class RestBuilder # :nodoc:
 
   attr_reader :base_url, :username, :password, :http_headers
@@ -82,15 +134,20 @@ class RestBuilder # :nodoc:
     @http_headers.add_headers(req)
     req.basic_auth username, password
     req.content_type = 'text/xml'
+    req.add_field('Accept-Encoding', 'gzip, deflate')
     proxy = ENV['http_proxy'] ? URI.parse(ENV['http_proxy']) : OpenStruct.new
     http = Net::HTTP.new(url.host, url.port, proxy.host, proxy.port, proxy.user, proxy.password)
     http.use_ssl = true if url.scheme == "https"
     http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http.read_timeout = 300
     debug  "RestBuilder#send_request req = #{req.inspect} -- #{url}"
     response = http.start { |http| http.request(req) }
+    #debug  "RestBuilder#send_request result = #{response.body}"
+    #check_for_errors(response)
+    #response.body
     debug  "RestBuilder#send_request result = #{response.body}"
     check_for_errors(response)
-    response.body
+    response.plain_body
   end
   
   def create_builder
@@ -104,7 +161,8 @@ class RestBuilder # :nodoc:
     when Net::HTTPUnauthorized
       raise Rally::NotAuthenticatedError.new("Invalid Username or Password.")
     else
-      s = response.body
+      #s = response.body
+      s = response.plain_body
       document = REXML::Document.new s
       node = REXML::XPath.first document, '//Errors'
       raise node.to_s if node && node.has_elements?
@@ -211,3 +269,4 @@ class RestBuilder # :nodoc:
 
 
 end
+

data/lib/rally_rest_api/version.rb

@@ -2,7 +2,7 @@ module RallyRestVersion #:nodoc:
   module LIBRARY_VERSION #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 3
+    TINY  = 4
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/spec/rally_rest_api/rest_builder_spec.rb

@@ -49,7 +49,7 @@ describe "a RestBuilder " do
   it "should raise an error if the response contains an Error element" do
     body = "<xml><Errors><Error/></Errors></xml>"
     response = mock("response")
-    response.should_receive(:body).and_return(body)
+    response.should_receive(:plain_body).and_return(body)
     lambda { @builder.check_for_errors(response) }.should raise_error(StandardError)
   end
 

data/spec/test_helper.rb

@@ -3,7 +3,7 @@ app_path = File.expand_path("#{dir}/../lib")
 $LOAD_PATH.unshift app_path unless $LOAD_PATH.include?(app_path)
 require 'test/unit'
 require 'rubygems'
-require 'spec'
+require 'rspec'
 require 'net/http'
 require 'rally_rest_api'
 

metadata

@@ -1,35 +1,25 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rally_rest_api
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+version: !ruby/object:Gem::Version
+  version: 1.0.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Bob Cotton
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-09-17 00:00:00 -06:00
-default_executable: 
+date: 2012-10-09 00:00:00.000000000Z
 dependencies: []
-
-description: ""
+description: ''
 email: bob.cotton@rallydev.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGELOG.txt
 - History.txt
 - README.txt
-files: 
+files:
 - CHANGELOG.txt
 - History.txt
 - Manifest.txt
@@ -68,40 +58,30 @@ files:
 - tasks/spec.rake
 - tasks/svn.rake
 - tasks/test.rake
-has_rdoc: true
 homepage: http://rally-rest-api.rubyforge.org/rally_rest_api
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
-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: rally-rest-api
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the Rally REST API
 test_files: []
-