http_request.rb 1.0.1 → 1.0.2

data/Changelog

@@ -1,4 +1,8 @@
-v1.1
+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
+
+v1.0.1
     * new feature: upload or download files by ftp
 
 v1.0

data/README.rdoc

@@ -22,7 +22,8 @@ The HttpRequest class is based on the 'net/http' and 'net/ftp' libraries, so the
 == Examples for your ruby program:
 
 include http_request.rb first
-    require '/path/to/http_request.rb'
+    require '/path/to/http_request.rb' 
+    or install it "gem install http_request.rb", then require 'http_request'
 
 get 
     puts HttpRequest.get('http://www.github.com')
@@ -33,7 +34,7 @@ get with query string, 4 are same
     puts HttpRequest.get({:url => 'http://www.google.com/search', :parameters => 'hl=en&q=ruby&start=0&sa=N'})
     puts HttpRequest.get({:url => 'http://www.google.com/search', :parameters => {:hl => 'en', :q => 'ruby', :start => 0, :sa => 'N'}})
 
-post with some paramet
+post with some parameters
     puts HttpRequest.get(:url => 'http://localhost/test.php', :parameters => 'from=http_request.rb').body
     puts HttpRequest.get(:url => 'http://localhost/test.php', :parameters => {:name => 'Ruby', :time => 'Now'}).body
 
@@ -133,11 +134,14 @@ post
 
 such as "get_only_header" and "get_with_header", post and other http methods also can do such as "post_only_header", "put_with_header" etc.
 
-== Examples for FTP (since 1.0.1):
+== Examples for FTP (since v1.0.1):
 
 download and save to
     ftp = HttpRequest.ftp(:get, :url => 'ftp://user:pass@my.domain.name/path/to/hello.mp3', :to => '/tmp/hello.mp3')
 
+    # get as string (since v1.0.2)
+    puts HttpRequest.ftp(:get_as_string, 'ftp://user:pass@localhost/path/to/file.txt')
+
 upload from local
     ftp = HttpRequest.ftp(:put, :url => 'ftp://user:pass@my.domain.name/path/to/hello.mp3', :from => '/tmp/hello.mp3')
 
@@ -177,12 +181,26 @@ download multiple files from a directory
     }
     ftp.close
 
+== Proc.call style (since v1.0.2)
+
+    HttpRequest.get('http://www.example.com/') {|http|
+      puts http.body
+      http.each_header {|k, v| puts "#{k} => #{v}" }
+      http.cookies.each {|k, v| puts "#{k} => #{v}" }
+    }
+
+    HttpRequest.ftp(:get, {"ftp://user:pass@localhost", :to => }) {|ftp|
+       puts ftp.ls
+       ftp.chdir('soft')
+       ftp.getbinaryfile('ruby.exe', '/path/to/local/ruby.exe');
+    }
+
 == TODO
 
   ......
 
 == LATEST VERSION
-  1.0.1
+  1.0.2
 
 == Author
    

data/lib/http_request.rb

@@ -3,7 +3,7 @@
 # == Description
 #
 #   This is a small, lightweight, powerful HttpRequest class based on the 'net/http' and 'net/ftp' libraries, 
-#   it's easy to use to send http request and get response, also can use it as a shell script in command line.
+#   it's easy to use to send http request and get response, also can use it as a shell script on command line in some cases.
 #
 # == Example
 #
@@ -11,9 +11,9 @@
 #
 # == Version
 # 
-#   v1.0.1
+#   v1.0.2
 #
-#   Last Change: 11 Apail, 2009
+#   Last Change: 2 May, 2009
 #
 # == Author
 #
@@ -29,226 +29,267 @@ require 'singleton'
 class HttpRequest
 	include Singleton
 
+	# version
+	VERSION = '1.0.2'.freeze
+	def self.version;VERSION;end
+
+	# avaiabled http methods
 	def self.http_methods
-    %w{get head post put proppatch lock unlock options propfind delete move copy mkcol trace}
+		%w{get head post put proppatch lock unlock options propfind delete move copy mkcol trace}
 	end
 
-  # initialize
-	def init_args(method, options)
-		options = {:url => options.to_s} if [String, Array].include? options.class
-		@options = {
-			:ssl_port        => 443,
-			:redirect_limits => 5,
-			:redirect        => true,
-			:url             => nil
-		}
-		@options.merge!(options)
-		@uri = URI(@options[:url])
-    @uri.path = '/' if @uri.path.empty?
-		@headers = {
-      'Host' => @uri.host,
-      'Referer' => @options[:url],
-      'Accept-Language' => 'en-us,zh-cn;q=0.7,en;q=0.3',
-      'Accept-Charset' => 'zh-cn,zh;q=0.5',
-      'Accept' => 'text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5',
-      'Cache-Control' => 'max-age=0',
-      'User-Agent' => 'Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.0.7) Gecko/2009030423 Ubuntu/8.04 (hardy) Firefox/3.0.7',
-      'Connection' => 'keep-alive'
-		}
-
-    # Basic Authenication
-    @headers['Authorization'] = "Basic " + [@uri.userinfo].pack('m').delete!("\r\n") if @uri.userinfo
-
-    # headers
-    @options[:headers].each {|k, v| @headers[k] = v} if @options[:headers].is_a? Hash
-
-    # add cookies if have
-    if @options[:cookies]
-      if @options[:cookies].is_a? Hash
-        cookies = []
-        @options[:cookies].each {|k, v|
-          cookies << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
-        }
-        cookies = cookies.join('; ')
-      else
-        cookies = @options[:cookies].to_s
-      end
-      @headers['Cookie'] = cookies unless cookies.empty?
-    end
-
-    @redirect_times = 0 if @options[:redirect]
+	# return data with or without block
+	def self.data(response, &block)
+		block_given? ? block.call(response) : response
 	end
 
-  # send request
-	def request(method, opt)
+	# send request by some given parameters
+	def request(method, opt, &block)
 		init_args(method, opt)
 		@options[:method] = method
 
-    # for upload files
-    if @options[:files].is_a?(Array) && 'post'.eql?(method)
-      build_multipart
-    else
-      if @options[:parameters].is_a? Hash
-        @options[:parameters] = @options[:parameters].collect{|k, v| 
-          CGI.escape(k.to_s) + '=' + CGI.escape(v.to_s)
-        }.join('&')
-      end
-    end
-
-		http =  if @options[:proxy_addr]
-      if @options[:proxy_user] and @options[:proxy_pass]
-        Net::HTTP::Proxy(@options[:proxy_addr], @options[:proxy_port], @options[:proxy_user], @options[:proxy_pass]).new(@u.host, @u.port)
-      else
-        Net::HTTP::Proxy(@options[:proxy_addr], @options[:proxy_port]).new(@uri.host, @uri.port)
-      end
-    else
-      Net::HTTP.new(@uri.host, @uri.port)
-    end
+		# for upload files
+		if @options[:files].is_a?(Array) && 'post'.eql?(method)
+			build_multipart
+		else
+			if @options[:parameters].is_a? Hash
+				@options[:parameters] = @options[:parameters].collect{|k, v| 
+					"#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+				}.join('&')
+			end
+		end
+
+		# for proxy
+		http = if @options[:proxy_addr]
+						 if @options[:proxy_user] && @options[:proxy_pass]
+							 Net::HTTP::Proxy(@options[:proxy_addr], @options[:proxy_port], @options[:proxy_user], @options[:proxy_pass]).new(@u.host, @u.port)
+						 else
+							 Net::HTTP::Proxy(@options[:proxy_addr], @options[:proxy_port]).new(@uri.host, @uri.port)
+						 end
+					 else
+						 Net::HTTP.new(@uri.host, @uri.port)
+					 end
 
 		# ssl support
 		http.use_ssl = true if @uri.scheme =~ /^https$/i
 
-		# get data by post or get method.
+		# sending request and get response 
 		response = send_request http
 
-		return response unless @options[:redirect]
+		return HttpRequest.data(response, &block) unless @options[:redirect]
 
-		# redirect....===>>>
+		# redirect?
 		case response
 		when Net::HTTPRedirection
-			@options[:url] = if response['location'] =~ /^http[s]*:\/\//i
-        response['location']
-      else
-        @uri.scheme + '://' + @uri.host + ':' + @uri.port.to_s + response['location']
-      end
-			@redirect_times = 0 unless @redirect_times
+			url = "#{@uri.scheme}://#{@uri.host}#{':' + @uri.port.to_s if @uri.port != 80}"
+			@options[:url] = case response['location']
+											 when /^https?:\/\//i
+												 response['location']
+											 when /^\// 
+												 url + response['location']
+											 when /^(\.\.\/|\.\/)/
+												 paths = (File.dirname(@uri.path) + '/' + response['location']).split('/')
+												 location = []
+												 paths.each {|path|
+													 next if path.empty? || path.eql?('.')
+													 path == '..' ? location.pop : location.push(path)
+												 }
+												 url + '/' + location.join('/')
+											 else
+												 url + File.dirname(@uri.path) + '/' + response['location']
+											 end
 			@redirect_times = @redirect_times.succ
-			raise 'too deep redirect...' if @redirect_times > @options[:redirect_limits]
-			request('get', @options)
+			raise 'too many redirects...' if @redirect_times > @options[:redirect_limits]
+			request('get', @options, &block)
 		else
-			response
+			return HttpRequest.data(response, &block)
 		end
 	end
 
-  # for ftp
-  def self.ftp(method, options)
-    require 'net/ftp'
-    options = {:close => true}.merge(options)
-    options[:url] = "ftp://#{options[:url]}" unless options[:url] =~ /^ftp:\/\//
-    uri = URI(options[:url])
-    guest_name, guest_pass = 'anonymous', 'guest@' + uri.host
-    unless options[:username]
-      options[:username], options[:password] = uri.userinfo ? uri.userinfo.split(':') : [guest_name, guest_pass]
-    end
-    options[:username] = guest_user unless options[:username]
-    options[:password] = guest_pass unless options[:password]
-    ftp = Net::FTP.open(uri.host, options[:username], options[:password])
-    return ftp unless method
-    stat = case method.to_sym
-           when :get
-             options[:to] = File.basename(uri.path) unless options[:to]
-             ftp.getbinaryfile(uri.path, options[:to])
-           when :put
-             ftp.putbinaryfile(options[:from], uri.path)
-           when :mkdir, :rmdir, :delete, :size, :mtime, :list, :nlst
-             ftp.method(method).call(uri.path)
-           when :rename
-             ftp.rename(uri.path, options[:to]) if options[:to]
-           when :status
-             ftp.status
-           else
-             return ftp
-           end
-    if options[:close]
-      ftp.close
-      stat
-    else
-      ftp.response = stat
-      ftp
-    end
-  end
-
-  # catch all of http requests
-	def self.method_missing(method_name, args)
+	# catch all of http requests
+	def self.method_missing(method_name, args, &block)
 		method_name = method_name.to_s.downcase
 		raise NoHttpMethodException, "No such http method can be called: #{method_name}" unless self.http_methods.include?(method_name)
-		self.instance.request(method_name, args)
+		self.instance.request(method_name, args, &block)
+	end
+
+	# 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:\/\//
+		uri = URI(options[:url])
+		guest_name, guest_pass = 'anonymous', "guest@#{uri.host}"
+		unless options[:username]
+			options[:username], options[:password] = uri.userinfo ? uri.userinfo.split(':') : [guest_name, guest_pass]
+		end
+		options[:username] = guest_name unless options[:username]
+		options[:password] = guest_pass if options[:password].nil?
+		ftp = Net::FTP.open(uri.host, options[:username], options[:password])
+		return self.data(ftp, &block) unless method
+		stat = case method.to_sym
+					 when :get_as_string
+						 require 'tempfile'
+						 tmp = Tempfile.new('http_request_ftp')
+						 ftp.getbinaryfile(uri.path, tmp.path)
+						 ftp.response = tmp.read
+						 tmp.close
+						 unless block_given?
+							 ftp.close
+							 return ftp.response
+						 end
+					 when :get
+						 options[:to] = File.basename(uri.path) unless options[:to]
+						 ftp.getbinaryfile(uri.path, options[:to])
+					 when :put
+						 ftp.putbinaryfile(options[:from], uri.path)
+					 when :mkdir, :rmdir, :delete, :size, :mtime, :list, :nlst
+						 ftp.method(method).call(uri.path)
+					 when :rename
+						 ftp.rename(uri.path, options[:to]) if options[:to]
+					 when :status
+						 ftp.status
+					 else
+						 return ftp
+					 end
+		if options[:close] && !block_given?
+			ftp.close
+			stat
+		else
+			ftp.response = stat unless ftp.response
+			self.data(ftp, &block)
+		end
 	end
 
 	private
 
-  # 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 = []
-    if @options[:parameters]
-      @options[:parameters] = CGI.parse(@options[:parameters]) if @options[:parameters].is_a? String
-      if @options[:parameters].is_a? Hash
-        @options[:parameters].each {|k, v| 
-          multipart << "--#{boundary}" 
-          multipart << "Content-disposition: form-data; name=\"#{CGI.escape(k.to_s)}\"" 
-          multipart << "\r\n#{CGI.escape(v.to_s)}"
-        }
-      end
-    end
-    @options[:files].each_with_index {|f, index|
-      f[:field_name] ||= "files[]"
-      f[:file_name] ||= "#{boundary}_#{index}"
-      f[:transfer_encoding] ||= "binary"
-      f[:content_type] ||= 'application/octet-stream'
-      multipart << "--#{boundary}" 
-      multipart << "Content-disposition: form-data; name=\"#{f[:field_name]}\"; filename=\"#{f[:file_name]}\""
-      multipart << "Content-type: #{f[:content_type]}"
-      multipart << "Content-Transfer-Encoding: #{f[:transfer_encoding]}"
-      multipart << "\r\n#{f[:file_content]}"
-    }
-    multipart << "--#{boundary}--"
-    multipart = multipart.join("\r\n")
-    @headers['Content-length'] = "#{multipart.size}"
-    @options[:parameters] = multipart
-  end
-
-  # send request
+	# initialize for the http request
+	def init_args(method, options)
+		options = {:url => options.to_s} if [String, Array].include? options.class
+		@options = {
+			:ssl_port        => 443,
+			:redirect_limits => 5,
+			:redirect        => true,
+			:url             => nil
+		}
+		@options.merge!(options)
+		@uri = URI(@options[:url])
+		@uri.path = '/' if @uri.path.empty?
+		@headers = {
+			'Host' => @uri.host,
+			'Referer' => @options[:url],
+			'User-Agent' => 'HttpRequest.rb ' + VERSION
+		}
+
+		# Basic Authenication
+		@headers['Authorization'] = "Basic " + [@uri.userinfo].pack('m').delete!("\r\n") if @uri.userinfo
+
+		# headers
+		@options[:headers].each {|k, v| @headers[k] = v} if @options[:headers].is_a? Hash
+
+		# add cookies if have
+		if @options[:cookies]
+			if @options[:cookies].is_a? Hash
+				cookies = []
+				@options[:cookies].each {|k, v|
+					cookies << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+				}
+				cookies = cookies.join('; ')
+			else
+				cookies = @options[:cookies].to_s
+			end
+			@headers['Cookie'] = cookies unless cookies.empty?
+		end
+
+		@redirect_times = 0 if @options[:redirect]
+	end
+
+	# 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 = []
+		if @options[:parameters]
+			@options[:parameters] = CGI.parse(@options[:parameters]) if @options[:parameters].is_a? String
+			if @options[:parameters].is_a? Hash
+				@options[:parameters].each {|k, v| 
+					multipart << "--#{boundary}" 
+					multipart << "Content-disposition: form-data; name=\"#{CGI.escape(k.to_s)}\"" 
+					multipart << "\r\n#{CGI.escape(v.to_s)}"
+				}
+			end
+		end
+		@options[:files].each_with_index {|f, index|
+			f[:field_name] ||= "files[]"
+			f[:file_name] ||= "#{boundary}_#{index}"
+			f[:transfer_encoding] ||= "binary"
+			f[:content_type] ||= 'application/octet-stream'
+			multipart << "--#{boundary}" 
+			multipart << "Content-disposition: form-data; name=\"#{f[:field_name]}\"; filename=\"#{f[:file_name]}\""
+			multipart << "Content-type: #{f[:content_type]}"
+			multipart << "Content-Transfer-Encoding: #{f[:transfer_encoding]}"
+			multipart << "\r\n#{f[:file_content]}"
+		}
+		multipart << "--#{boundary}--"
+		multipart = multipart.join("\r\n")
+		@headers['Content-length'] = "#{multipart.size}"
+		@options[:parameters] = multipart
+	end
+
+	# send http request
 	def send_request(http)
-		case @options[:method]
-		when /^(get|head|options|delete|move|copy|trace|)$/
-			@options[:parameters] = @uri.query.to_s if @options[:parameters].to_s.empty?
-			@options[:parameters] = "?#{@options[:parameters]}" unless @options[:parameters].empty?
+
+		# merge parameters
+		parameters = @options[:parameters].to_s
+		@options[:parameters] = "#{@uri.query}" if @uri.query
+		if parameters
+			if @options[:parameters]
+				@options[:parameters] << "&#{parameters}"
+			else
+				@options[:parameters] = "#{parameters}"
+			end
+		end
+
+		# GO !!
+		if @options[:method] =~ /^(get|head|options|delete|move|copy|trace|)$/
+			@options[:parameters] = "?#{@options[:parameters]}" if @options[:parameters]
 			http.method(@options[:method]).call("#{@uri.path}#{@options[:parameters]}", @headers)
 		else
 			http.method(@options[:method]).call(@uri.path, @options[:parameters], @headers)
 		end
+
 	end
+
 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
-  end
+	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
+	end
 end
 
 # for ftp response
 class Net::FTP
-  def response=(response)
-    @_response = response
-  end
+	def response=(response)
+		@_response = response
+	end
 
-  def response
-    @_response
-  end
+	def response
+		@_response
+	end
 end
 
 # exception
@@ -257,18 +298,18 @@ class NoHttpMethodException < Exception; end
 # for command line
 if __FILE__.eql? $0
 	method, url, params = ARGV
-  exit unless method
+	exit unless method
 	source_method = method
 	method = method.split('_')[0] if method.include? '_'
 
 	# fix path of the url
-	url = "http://#{url}" unless url =~ /^(http:\/\/)/i
+	url = "http://#{url}" unless url =~ /^(https?:\/\/)/i
 
 	params = if params
-    "{:url => '#{url}', :parameters => '" + params + "'}"
-  else
-    "'#{url}'"
-  end
+		"{:url => '#{url}', :parameters => '" + params + "'}"
+					 else
+		"'#{url}'"
+	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.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - xianhua.zhou
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-11 00:00:00 +08:00
+date: 2009-05-02 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -26,7 +26,7 @@ files:
 - README.rdoc
 - lib/http_request.rb
 has_rdoc: true
-homepage: http://httprequest.rubyforge.org
+homepage: http://my.cnzxh.net
 post_install_message: 
 rdoc_options: []