http_request.rb 1.0.2 → 1.0.3

data/Changelog

@@ -1,3 +1,8 @@
+v1.0.3
+    * add some dynamic methods such as code_1xx?, code_200?, code_403? etc. for check the http status 
+    * decompressing gzipped body automatically, the 'Accept-Encoding: gzip,deflate' has been added into the header for sending request automatically.
+		* fixed retrieve cookies problem which is if a cookie name is a keyword of the cookie's info such as path, expire etc. then it doesn't work.
+
 v1.0.2
     * Proc.call (block) style supported and some small changes
 		* improve ftp protocol and add a new method get_as_string for the ftp calls

data/README.rdoc

@@ -189,18 +189,28 @@ download multiple files from a directory
       http.cookies.each {|k, v| puts "#{k} => #{v}" }
     }
 
-    HttpRequest.ftp(:get, {"ftp://user:pass@localhost", :to => }) {|ftp|
+    HttpRequest.ftp(:get, {"ftp://user:pass@localhost/soft.zip", :to => '/path/to/soft.zip'}) {|ftp|
        puts ftp.ls
        ftp.chdir('soft')
        ftp.getbinaryfile('ruby.exe', '/path/to/local/ruby.exe');
     }
 
+== check the http status (since v1.0.3)
+
+   HttpRequest.get('http://www.example.com/it_doesnot_exists.page').code_4xx? # true
+   HttpRequest.get('http://www.example.com/it_doesnot_exists.page').code_404? # true
+   HttpRequest.get('http://www.rubyonrails.com/').code_404? # false
+   HttpRequest.head('http://www.rubyonrails.com/').code_2xx? # true
+   HttpRequest.head('http://www.ruby-lang.org/').code_200? # true
+
+   supported methods:  code_1xx? code_2xx? code_3xx? code_4xx? code_5xx? code_101? code_200? ...
+
 == TODO
 
-  ......
+  bug fixing, testing and testing...
 
 == LATEST VERSION
-  1.0.2
+  1.0.3
 
 == Author
    

data/lib/http_request.rb

@@ -11,9 +11,9 @@
 #
 # == Version
 # 
-#   v1.0.2
+#   v1.0.3
 #
-#   Last Change: 2 May, 2009
+#   Last Change: 27 May, 2009
 #
 # == Author
 #
@@ -21,16 +21,19 @@
 #   homepage: http://my.cnzxh.net
 #
 #
+require 'cgi'
 require 'net/http'
 require 'net/https'
-require 'cgi'
+require 'net/ftp'
 require 'singleton'
+require 'md5'
+require 'stringio'
 
 class HttpRequest
 	include Singleton
 
 	# version
-	VERSION = '1.0.2'.freeze
+	VERSION = '1.0.3'.freeze
 	def self.version;VERSION;end
 
 	# avaiabled http methods
@@ -43,6 +46,18 @@ class HttpRequest
 		block_given? ? block.call(response) : response
 	end
 
+	# check the http resource whether or not available
+	def self.available?(url, timeout = 5)
+		timeout(timeout) {
+			u = URI(url)
+			s = TCPSocket.new(u.host, u.port)
+			s.close
+		}
+		return true
+	rescue Exception => e
+		return false
+	end
+
 	# send request by some given parameters
 	def request(method, opt, &block)
 		init_args(method, opt)
@@ -115,7 +130,6 @@ class HttpRequest
 
 	# for ftp
 	def self.ftp(method, options, &block)
-		require 'net/ftp'
 		options = {:url => options} if options.is_a? String
 		options = {:close => true}.merge(options)
 		options[:url] = "ftp://#{options[:url]}" unless options[:url] =~ /^ftp:\/\//
@@ -177,9 +191,10 @@ class HttpRequest
 		@uri = URI(@options[:url])
 		@uri.path = '/' if @uri.path.empty?
 		@headers = {
-			'Host' => @uri.host,
-			'Referer' => @options[:url],
-			'User-Agent' => 'HttpRequest.rb ' + VERSION
+			'Host'            => @uri.host,
+			'Accept-Encoding' => 'gzip,deflate',
+			'Referer'         => @options[:url],
+			'User-Agent'      => 'HttpRequest.rb ' + VERSION
 		}
 
 		# Basic Authenication
@@ -207,7 +222,6 @@ class HttpRequest
 
 	# for upload files by post method
 	def build_multipart
-		require 'md5'
 		boundary = MD5.md5(rand.to_s).to_s[0..5]
 		@headers['Content-type'] = "multipart/form-data, boundary=#{boundary}"
 		multipart = []
@@ -264,20 +278,60 @@ class HttpRequest
 
 end
 
-# get cookies as hash
-class Net::HTTPResponse
-	def cookies
-		cookies = {}
-		ignored_cookie_names = %w{expires domain path secure httponly}
-		self['set-cookie'].split(/[;,]/).each {|it|
-			next unless it.include? '='
-			eq = it.index('=')
-			key = it[0...eq].strip
-			value = it[eq.succ..-1]
-			next if ignored_cookie_names.include? key.downcase
-			cookies[key] = value
-		}
-		cookies
+module Net
+	class HTTPResponse
+
+		# get cookies as a hash
+		def cookies
+			cookies = {}
+			return cookies unless @header['set-cookie']
+			@header['set-cookie'].each {|k|
+				k, v = k.split(';')[0].split('=')
+				cookies[k] = v
+			}
+			cookies
+		end
+
+		# for gzipped body
+		def body
+			bd = read_body()
+			return bd unless bd
+			unless self['content-encoding'].eql? 'gzip'
+				bd
+			else
+				::Zlib::GzipReader.new(StringIO.new(bd)).read
+			end
+		end
+
+		# body
+		def raw_body
+			read_body()
+		end
+
+		# detect the response code
+		#
+		# Example:
+		# puts HttpRequest.get('http://www.example.com').code_200?
+		# puts HttpRequest.get('http://www.example.com').code_2xx?
+		# HttpRequest.get('http://www.example.com/404.html') {|http|
+		#   puts "IS 4xx" if http.code_4xx?
+		#   puts "IS 404" if http.code_404?
+		# }
+		#
+		# supported methods
+		# code_1xx? code_2xx? code_3xx? code_4xx? code_5xx?
+		# code_100? code_101? code_200? code_201? ... code_505?
+		def method_missing(method_name)
+			case method_name.to_s
+			when /^code_([0-9])xx\?$/
+				is_a? CODE_CLASS_TO_OBJ[$1]
+			when /^code_([0-9]+)\?$/
+				is_a? CODE_TO_OBJ[$1]
+			else
+				raise NoHttpMethodException, 'Unknown method of response code!'
+			end
+		end
+
 	end
 end
 
@@ -309,7 +363,7 @@ if __FILE__.eql? $0
 		"{:url => '#{url}', :parameters => '" + params + "'}"
 					 else
 		"'#{url}'"
-	end
+					 end
 
 	if HttpRequest.http_methods.include?(method) && url
 		http = eval("HttpRequest.#{method}(#{params})")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: http_request.rb
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors: 
 - xianhua.zhou
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-02 00:00:00 +08:00
+date: 2009-05-27 00:00:00 +08:00
 default_executable: 
 dependencies: []