network-facade 0.1 → 0.2

data/lib/network-facade/base.rb

@@ -30,34 +30,36 @@ module Base
 			@@klass ||= {}
 			if defined? @@uri and not @@uri.nil?
 				@@klass[klass] = URI.parse(@@uri)
-				@@klass[klass].path = '/' + klass.name.downcase
-				NetworkFacade.log(:debug, "#{klass} is bound to #{@@klass[klass]}")
+				if @@klass[klass].path.empty? or @@klass[klass].path == '/'
+					@@klass[klass].path = '/' + klass.name.downcase
+				end
 			end
 			@@uri = nil
 		end
 
 		def initialize(options = {})
 			@options = options
-			@uri ||= @options[:uri] || @@klass[self.class] ||
-				URI::Generic.new('nf', nil, nil, nil, nil, '/' + self.class.name.downcase, nil, nil, nil)
+			if @options[:uri]
+				@uri ||= URI.parse(@options[:uri])
+			elsif @@klass[self.class]
+				@uri ||= @@klass[self.class]
+			else
+				@uri ||= URI::Generic.new('nf', nil, nil, nil, nil, '/' + self.class.name.downcase, nil, nil, nil)
+			end
 			@uri.host = @options[:host] if @options[:host]
 			@uri.port = @options[:port] if @options[:port]
 			@uri.path = @options[:path] if @options[:path]
 			@uri.query = @options[:query] if @options[:query]
 			@uri.userinfo = @options[:userinfo] if @options[:userinfo]
 			@mutex = Mutex.new
+			require 'zlib' if @options[:compress]
 		end
 
 		def method_missing(name, *args)
 			NetworkFacade.log(:debug, "Method called with #{args.inspect}", "#{self.class}##{name}")
 			begin
-				data = Marshal.dump([@uri.path[1..-1], name, args])
-				size = [data.size].pack('N')
-				@client.write(size)
-				@client.write(data)
-				size = @client.read(4).unpack('N').first
-				data = @client.read(size)
-				result = Marshal.load(data)
+				__write__([@uri.path[1..-1], name, args])
+				result = __read__
 				if result.is_a? Exception
 					NetworkFacade.log(:info, "Exception occured : #{result.inspect}", "#{self.class}##{name}")
 					result.backtrace.collect! do |line|
@@ -72,11 +74,31 @@ module Base
 				retry
 			end
 		end
+
+		def __read__
+			size = @client.read(4).unpack('N').first
+			NetworkFacade.log(:debug, "Read #{size + 4} bytes", @uri)
+			data = @client.read(size)
+			data = Zlib::Inflate.inflate(data) if @options[:compress]
+			Marshal.load(data)
+		end
+
+		def __write__(data)
+			data = Marshal.dump(data)
+			data = Zlib::Deflate.deflate(data, Zlib::FINISH) if @options[:compress]
+			NetworkFacade.log(:debug, "Write #{data.size + 4} bytes", @uri)
+			size = [data.size].pack('N')
+			@client.write(size)
+			@client.write(data)
+			@client.flush
+		end
+
 	end
 
 	class Server
 		def initialize(options = {})
 			@options = options
+			require 'zlib' if @options[:compress]
 			@fd = [@options[:server]]
 			@objs = {}
 		end
@@ -115,10 +137,7 @@ module Base
 					size = nil
 					data = nil
 					begin
-						size = client.read(4)
-						raise EOFError if size.nil?
-						size = size.unpack('N').first
-						data = Marshal.load(client.read(size))
+						data = read(client)
 						result = nil
 						begin
 							if @objs[data[0]].respond_to? data[1]
@@ -132,9 +151,7 @@ module Base
 							NetworkFacade.log(:info, "Error occured when executing #{data[1].inspect} with #{data[2].inspect}", client_id(client))
 							NetworkFacade.log(:info, $!)
 						end
-						result = Marshal.dump(result)
-						client.write([result.size].pack('N'))
-						client.write(result)
+						write(client, result)
 					rescue Exception
 						NetworkFacade.log(:info, "Close connection", client_id(client))
 						client.close
@@ -144,6 +161,25 @@ module Base
 				end
 			end
 		end
+
+		def read(client)
+			size = client.read(4)
+			raise EOFError if size.nil?
+			size = size.unpack('N').first
+			NetworkFacade.log(:debug, "Read #{size + 4} bytes", client_id(client))
+			data = client.read(size)
+			data = Zlib::Inflate.inflate(data) if @options[:compress]
+			Marshal.load(data)
+		end
+
+		def write(client, data)
+			data = Marshal.dump(data)
+			data = Zlib::Deflate.deflate(data, Zlib::FINISH) if @options[:compress]
+			NetworkFacade.log(:debug, "Write #{data.size + 4} bytes", client_id(client))
+			client.write([data.size].pack('N'))
+			client.write(data)
+			client.flush
+		end
 	end
 
 end

data/lib/network-facade/config.rb

@@ -1,6 +1,6 @@
 module NetworkFacade
 	NAME = 'Network-Facade'
-	VERSION = '0.1'
+	VERSION = '0.2'
 	COPYRIGHT = 'Copyright (C) 2007 Florent Solt'
 	DESC = 'Object-oriented netwotk facade'
 	AUTHOR = 'Florent Solt'

data/lib/network-facade/rest.rb

@@ -0,0 +1,119 @@
+require 'net/http'
+require 'cgi'
+require 'rubygems'
+begin
+	require 'xml/libxml'
+rescue LoadError
+	require 'rexml/document'
+end
+begin
+	require 'json'
+rescue
+	# Do nothing
+end
+
+
+module NetworkFacade
+module REST
+
+	def self.Client(uri = nil)
+		Client.uri = uri
+		Client
+	end
+
+	class Client < Base::Client
+		def initialize(options = {})
+			super
+			@cookies = {}
+		end
+
+		def method_missing(name, *args)
+
+			# Build query string
+			params = args.first || {}
+			raise "Params must be an Hash table" unless params.is_a? Hash
+			qs = params.keys.collect do |k|
+				"#{k}=#{CGI::escape(params[k].to_s)}"
+			end.join('&')
+
+			# Cutom method mapping defined ?
+			if @options[:mapping] and @options[:mapping][name]
+				@uri.path = @options[:mapping][name]
+			end
+
+			format = @options[:append_slash] ? '%s/?%s' : '%s?%s'
+			Net::HTTP.start(@uri.host, @uri.port) do |http|
+
+				# Build header fields
+				header = @options[:header] || {}
+				header['User-Agent'] = @options[:user_agent] || NetworkFacade::NAME + '/' + NetworkFacade::VERSION
+				unless @cookies.empty?
+					header['Cookie'] = @cookies.keys.collect do |k|
+						"#{k}=#{@cookies[k]}"
+					end.join('; ')
+				end
+
+				# Build request path
+				if @options[:method] == :path
+					path = format % [ "#{@uri.path}/#{name}", qs ]
+				elsif @options[:method] == :param and @options[:method_param]
+					path = format % [ @uri.path, "#{qs}&#{@options[:method_param]}=#{CGI::escape(name.to_s)}" ]
+				else
+					path = format % [ @uri.path, qs ]
+				end
+
+				# POST or GET
+				if @options[:post].is_a? Array and @options[:post].include? name
+					req = Net::HTTP::Post.new(path, header)
+					req.form_data = params
+				else
+					req = Net::HTTP::Get.new(path, header)
+					NetworkFacade.log(:info, "GET #{req.path}")
+				end
+				res = http.request(req)
+
+				# Remember cookies
+				CGI::Cookie::parse(res['set-cookie']).each do |k,v|
+					next if k == 'path' or k == 'expires'
+					@cookies[k] = v.value
+				end
+
+				# Return the correct data
+				case res.code
+				when '200'
+					case res.content_type
+					when /xml/
+						if defined? XML
+							parser = XML::Parser.new
+							parser.string = res.body
+							data = parser.parse
+						else
+							data = REXML::Document.new(res.body)
+						end
+					when /json/
+						if defined? JSON
+							data = JSON.parse res.body
+						else
+							data = res.body
+						end
+					when /php/
+						#TODO: http://php.net/serialize, http://hurring.com/code/perl/serialize/
+						raise "Not implemented yet"
+					else
+						data = res.body
+					end
+				when /3\d\d/
+					# FIXME
+					raise "Redirection not supported yet"
+				else
+					NetworkFacade.log(:error, "An error occured when calling #{name} (returned code = #{res.code})")
+				end
+				
+				# Return the header if asked
+				@options[:header] ? [res.to_hash, data] : data
+			end
+		end
+	end
+
+end
+end

data/lib/network-facade.rb

@@ -8,49 +8,113 @@ require 'network-facade/base'
 require 'network-facade/tcp'
 require 'network-facade/unix'
 require 'network-facade/ssl'
+require 'network-facade/rest'
 require 'network-facade/defaults'
 
 if __FILE__ == $0
 	NetworkFacade.log = STDERR
 
-	case ARGV.first
+	case ARGV.shift
 		#=======================<client>==============================#
 	when 'client-tcp-uri'
-		class Foo < NetworkFacade::Client 'nf://backoffice:5042/?hu=dtc'
+
+		class Foo < NetworkFacade::Client 'nf://localhost:5042'
 		end
 		f = Foo.new
 		p f.bar
+
 	when 'client-tcp-class'
+		
 		class Foo < NetworkFacade::Client
 		end
-		f = Foo.new(:host => 'dev', :port => 5042)
-		p f.bar
+		f = Foo.new(:host => 'localhost', :port => 5042)
+		p f.big
+
 	when 'client-unix'
+
 		class Foo < NetworkFacade::Unix::Client
 		end
 		f = Foo.new
 		p f.bar
+
 	when 'client-ssl'
-		class Foo < NetworkFacade::SSL::Client 'nf://installclick:5044'
+
+		class Foo < NetworkFacade::SSL::Client 'nf://localhost:5044'
 		end
 		f = Foo.new(:ca => '../cert/ca.cert',
 					:cert => '../cert/client.cert',
 					:key => '../cert/client.key')
 		p f.bar
+
+	when 'client-tcp-compress'
+
+		class Foo < NetworkFacade::Client
+		end
+		p Foo.new(:compress => true).big
+
+	when 'client-rest-rtm'
+
+		class Foo < NetworkFacade::REST::Client 'http://www.rememberthemilk.com/services/rest/'
+		end
+
+		f = Foo.new
+		p f.call(:method => 'rtm.test.echo', :api_key => ARGV.first, :foo => 'bar')
+
+		f = Foo.new(:method => :param, :method_param => 'method')
+		p f.send('rtm.test.echo', :api_key => ARGV.first, :foo => 'bar')
+
+	when 'client-rest-netvibes'
+
+		class Foo < NetworkFacade::REST::Client 'http://www.netvibes.com'
+		end
+		f = Foo.new(:mapping => {
+			:login => '/user/signIn.php',
+			:load => '/get/userData.php',
+			:save => '/save/userData.php'
+		}, :post => [:login, :save])
+
+		p f.login(:email => 'paillerosse@lescampeurs.org', :password => ARGV.first)
+		p f.load
+
+	when 'client-rest-flickr'
+
+		class Foo < NetworkFacade::REST::Client 'http://api.flickr.com/services/rest/'
+		end
+
+		f = Foo.new
+		p f.call(:method => 'flickr.test.echo', :api_key => ARGV.first, :foo => 'bar')
+
+	when 'client-rest-digg'
+
+		class Foo < NetworkFacade::REST::Client 'http://services.digg.com'
+		end
+		f = Foo.new(:mapping => {
+			:apple_stories => '/stories/topic/apple',
+			:me => '/user/pyros'
+		})
+		p f.apple_stories(:appkey => 'http://network-facade.rubyforge.org', :count => 3)
+		p f.apple_stories(:appkey => 'http://network-facade.rubyforge.org', :count => 3, :type => :json)
+		p f.me(:appkey => 'http://network-facade.rubyforge.org')
+
 		#=======================</client>=============================#
 	else
 		class Foo
 			def bar
 				42
 			end
+			def big
+				(Time.now.to_s + "\n") * 10
+			end
 			def error
 				raise "Error"
 			end
 		end
-		case ARGV.first
+		case ARGV.shift
 			#=======================<server>==============================#
 		when 'server-tcp'
 			NetworkFacade::Server.new.add(Foo.new).start
+		when 'server-tcp-compress'
+			NetworkFacade::Server.new(:compress => true).add(Foo.new).start
 		when 'server-unix'
 			NetworkFacade::Unix::Server.new.add(Foo.new).start
 		when 'server-ssl'

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: network-facade
 version: !ruby/object:Gem::Version 
-  version: "0.1"
-date: 2007-05-02 00:00:00 +02:00
+  version: "0.2"
+date: 2007-05-03 00:00:00 +02:00
 summary: Object-oriented netwotk facade
 require_paths: 
 - lib
@@ -35,6 +35,7 @@ files:
 - lib/network-facade/base.rb
 - lib/network-facade/defaults.rb
 - lib/network-facade/ssl.rb
+- lib/network-facade/rest.rb
 - lib/network-facade.rb
 test_files: []