rapuncel 0.0.1 → 0.0.2

data/lib/rapuncel/core_ext/integer.rb

@@ -1,19 +1,11 @@
-require 'builder'
-require 'nokogiri'
-require 'ruby-debug'
-
 class Integer
-
   def to_xml_rpc b = Rapuncel.get_builder
-    #warn "XML-RPC standard only supports 4 byte signed integers, i.e #{(-2**31).to_s} to #{2**31-1}" unless ((-2**31)...(2**31)) === self
-
     b.int self.to_s
 
+    b.to_xml
   end
 
   def self.from_xml_rpc xml_node
-    #warn "xml node given (name of #{xml_node.name}) is not of integer type, node name should be 'i4' or 'int'" unless ['i4','int'].include? xml_node.name.downcase
-
-    xml_node.text.to_i #calling to_i on the text between the i4 or int tags
+    xml_node.text.strip.to_i #calling to_i on the text between the i4 or int tags
   end
 end

data/lib/rapuncel/core_ext/nil.rb

@@ -0,0 +1,7 @@
+class NilClass
+  def to_xml_rpc b = Rapuncel.get_builder
+    false.to_xml_rpc b
+
+    b.to_xml
+  end
+end

data/lib/rapuncel/core_ext/object.rb

@@ -1,21 +1,21 @@
-require 'builder'
-
 class Object
   def to_xml_rpc b = Rapuncel.get_builder
     if respond_to?(:acts_like?) && acts_like?(:time)
       to_time.to_xml_rpc b
-    else    
+    else
       _collect_ivars_in_hash.to_xml_rpc b
     end
+
+    b.to_xml
   end
 
   def self.from_xml_rpc xml_node
     if xml_node.is_a? String
       xml_node = Nokogiri::XML.parse(xml_node).root
     end
-    
+
     return nil if xml_node.nil?
-    
+
     case xml_node.name
     when 'i4', 'int'
       Integer.from_xml_rpc xml_node
@@ -34,7 +34,7 @@ class Object
     when 'base64'
       raise 'Now its time to implement Base64'
     else
-      raise "What is this? I didn't know #{xml_node.name} was part of the XMLRPC specification? Anyway, the value was: #{xml_node.text}"
+      raise "What is this? I didn't know #{xml_node.name} was part of the XMLRPC specification? Anyway, the value was: #{xml_node.text.strip}"
     end
   end
 

data/lib/rapuncel/core_ext/string.rb

@@ -1,14 +1,12 @@
-require 'builder'
-require 'nokogiri'
-
 class String
   def to_xml_rpc b = Rapuncel.get_builder
     b.string self
+
+    b.to_xml
   end
-  
+
   def self.from_xml_rpc xml_node
-    #warn "I, String.from_xml_rpc have been given an xml_node with the wrong tag (name of #{xml_node.name}). My tag should be 'string'. Will still parse at your risk" unless ['string'].include? xml_node.name.downcase
-    
-    xml_node.text #just give back the string between the 'string' tags
+    xml_node.text.gsub(/(\r\n|\r)/, "\n") #just give back the string between the 'string' tags
+    # DISCUSS: to strip or not to strip
   end
 end

data/lib/rapuncel/core_ext/symbol.rb

@@ -1,8 +1,7 @@
-require 'builder'
-require 'nokogiri'
-
 class Symbol
   def to_xml_rpc b = Rapuncel.get_builder
     b.string to_s
+
+    b.to_xml
   end
 end

data/lib/rapuncel/core_ext/time.rb

@@ -1,17 +1,14 @@
-require 'builder'
 require 'time'
-require 'nokogiri'
 
 class Time
 
   def to_xml_rpc b=Rapuncel.get_builder
-    b.tag! "dateTime.iso8601", self.iso8601
+    b.send "dateTime.iso8601", self.iso8601
+
+    b.to_xml
   end
-  
+
   def self.from_xml_rpc xml_node
-    #warn "Need node to be named 'dateTime.iso8601', but it is #{xml_node.name}. Will still parse, at your risk" unless ['dateTime.iso8601'].include? xml_node.name
-    
-    Time.parse xml_node.text #make a Time object of this string which is hopefully in the right format
+    Time.parse xml_node.text.strip #make a Time object of this string which is hopefully in the right format
   end
-    
 end

data/lib/rapuncel/proxy.rb

@@ -2,23 +2,38 @@ require 'rapuncel/request'
 
 module Rapuncel
   class Proxy
-    PROXY_METHODS  = %w(tap inspect clone freeze dup class initialize)
-    LOCKED_METHODS = %w(method_missing)
-    LOCKED_PATTERN = /(\A__|\?\Z|!\Z)/
+    PROXY_METHODS  = %w(tap inspect clone freeze dup class initialize).freeze
+    LOCKED_METHODS = %w(method_missing).freeze
+    LOCKED_PATTERN = /(\A__|\?\Z|!\Z)/.freeze
 
     class << self
-      def new client_or_configuration, interface = nil        
+      # Initialize a new Proxy object for a specific Client. Alternatively
+      # you can pass a Hash containing configuration for a new Client, which
+      # will be created on-the-fly, but not accessible. The second parameter
+      # specifies a specific interface/namespace for the remote calls,
+      # i.e. if your RPC method is
+      #
+      #     int numbers.add(int a, int b)
+      #
+      # You can create a specific proxy for +numbers+, and use +add+ directly
+      #
+      #     proxy = Proxy.new client, 'numbers'
+      #     proxy.add(40, 2) -> 42
+      #
+      def new client_or_configuration, interface = nil
         client_or_configuration = Client.new client_or_configuration if client_or_configuration.is_a?(Hash)
-        
+
         allocate.__tap__ do |new_proxy|
           new_proxy.__initialize__ client_or_configuration, interface
         end
       end
 
       def define_proxy_method name
-        define_method name do |*args|
-          call! name, *args
-        end
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{name} *args, &block
+            call! '#{name}', *args, &block
+          end
+        RUBY
       end
     end
 
@@ -33,24 +48,34 @@ module Rapuncel
     end
 
     def call! name, *args
-      name = [@interface, name] * '.' if @interface
-      @client.execute_to_ruby Request.new(name, *args)
+      name = "#{@interface}.#{name}" if @interface
+
+      @client.call_to_ruby(name, *args).tap do |response|
+
+        if block_given?
+          yield response
+        end
+      end
     end
 
-    def __initialize__ client, interface
+    def __initialize__ client, interface #:nodoc:
       @interface = interface
       @client = client
     end
 
+    def respond_to? name #:nodoc:
+      LOCKED_PATTERN.match(name.to_s) ? super : true
+    end
+
     protected
-    def method_missing name, *args
+    def method_missing name, *args, &block #:nodoc:
       name = name.to_s
 
       if LOCKED_PATTERN.match name
-        super
+        super name.to_sym, *args, &block
       else
         self.__class__.define_proxy_method name
-        call! name, *args
+        call! name, *args, &block
       end
     end
   end

data/lib/rapuncel/request.rb

@@ -1,4 +1,4 @@
-require 'builder'
+
 
 
 module Rapuncel
@@ -13,13 +13,14 @@ module Rapuncel
 
     def to_xml_rpc builder = Rapuncel.get_builder
       method_call! builder
+
+      builder.to_xml :encoding => 'UTF-8'
     end
 
     protected
     def method_call! builder
-      builder.instruct!
 
-      builder.methodCall do
+      builder.methodCall do |builder|
         method_name! builder
         params! builder
       end
@@ -30,7 +31,7 @@ module Rapuncel
     end
 
     def params! builder
-      builder.params do
+      builder.params do |builder|
         arguments.each do |value|
           param! builder, value
         end
@@ -38,8 +39,8 @@ module Rapuncel
     end
 
     def param! builder, value
-      builder.param do
-        builder.value do
+      builder.param do |builder|
+        builder.value do |builder|
           value.to_xml_rpc builder
         end
       end

data/lib/rapuncel/response.rb

@@ -1,9 +1,12 @@
 require 'active_support/core_ext/module/delegation'
-require 'rapuncel/fault'
 
 module Rapuncel
   class Response
-    attr_accessor :http_response, :status
+    class Exception < ::Exception ; end
+    class Fault < Exception ; end
+    class Error < Exception ; end
+
+    attr_accessor :http_response, :status, :status_code
 
     delegate  :body,
               :to => :http_response
@@ -11,11 +14,16 @@ module Rapuncel
     def initialize http_response
       @http_response = http_response
 
-      if http_response.success?
-        parse_response
-      else
-        @status = http_response.code
-        raise("HTTP Error: #{@status}\n#{body}")
+      evaluate_status
+    end
+
+    def evaluate_status
+      @status_code = http_response.code.to_i
+
+      @status = case
+      when !http_response.success?                  then 'error'
+      when parsed_body && method_response_success?  then 'success'
+      else 'fault'
       end
     end
 
@@ -23,32 +31,53 @@ module Rapuncel
       status == 'success'
     end
 
-    def to_ruby
-      @to_ruby
-    end
-    
-    def parse_fault
-      fault = @xml_doc.xpath('/methodResponse/fault/value/struct')
-      
-      @to_ruby = Fault.new Hash.from_xml_rpc(fault.first)
-    end
-    
-    def parse_response
-      @xml_doc = Nokogiri::XML.parse body
-
-      if @xml_doc.xpath('/methodResponse/fault').empty?
-        @status = 'success'
-        parse_success
-      else
-        @status = 'fault'
-        parse_fault
+    def fault?
+      status == 'fault'
+    end
+
+    def error?
+      status == 'error'
+    end
+
+    def fault
+      if fault?
+        @fault ||= begin
+          fault_node = parsed_body.xpath('/methodResponse/fault/value/struct').first
+          
+          Hash.from_xml_rpc(fault_node).tap do |h|
+            h[:faultString] = h[:faultString].strip
+          end
+        end
+      end
+    end
+
+    def error
+      if error?
+        @error ||= { :http_code => @status_code, :http_body => body }
+      end
+    end
+
+    def result
+      if success?
+        @result ||= begin
+          return_values = parsed_body.xpath('/methodResponse/params/param/value/*')
+
+          Object.from_xml_rpc return_values.first
+        end
       end
     end
-    
-    def parse_success
-      values = @xml_doc.xpath('/methodResponse/params/param/value/*')
-      
-      @to_ruby = Object.from_xml_rpc values.to_a.first
+
+    def to_ruby
+      result || fault || error
+    end
+
+    protected
+    def parsed_body
+      @xml_doc ||= Nokogiri::XML.parse body
+    end
+
+    def method_response_success?
+      parsed_body.xpath('/methodResponse/fault').empty?
     end
   end
 end

data/rapuncel.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name        = "rapuncel"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.date        = Time.now.strftime("%Y-%m-%d")
   s.authors     = ["Michael Eickenberg", "Marian Theisen"]
   s.email       = 'marian@cice-online.net'
   s.summary     = "Simple XML-RPC Client"
   s.homepage    = "http://github.com/cice/rapuncel"
-  s.description = "Simple XML-RPC Client"
+  s.description = "Rapuncel is a simple XML-RPC Client based on Nokogiri, thus provides a fast and easy way to interact with XML-RPC services."
 
   s.files        =  Dir["**/*"] -
                     Dir["coverage/**/*"] -
@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
                     Dir["rcov/**/*"]
 
   s.add_dependency 'nokogiri'
-  s.add_dependency 'builder'
   s.add_dependency 'activesupport', '>= 3.0.0'
 
   s.add_development_dependency 'mocha'

data/test/functional/client_test.rb

@@ -2,22 +2,53 @@ require 'functional_test_helper'
 
 class FunctionalClientTest < FunctionalTest
   test "Simple XMLRPC call" do
-    client = Rapuncel::Client.new :port => 8080
+    client = Rapuncel::Client.new :port => 8080, :raise_on => :both
     proxy = client.proxy_for 'num'
-    
+
     result = proxy.add 40, 2
-    
+
     assert_equal 42, result
   end
   
-  test "Fault rpc call" do
+  test "Fault rpc call without raise" do
     client = Rapuncel::Client.new :port => 8080
     proxy = client.proxy_for 'num'
     
-    result = proxy.add 20, 20, 2
+    assert_nothing_raised Rapuncel::Response::Exception do
+      proxy.add 20, 20, 2
+    end
     
-    assert_kind_of Rapuncel::Fault, result
+    assert_kind_of Hash, proxy.add(20, 20, 2)    
   end
-  
 
+  test "Fault rpc call" do
+    client = Rapuncel::Client.new :port => 8080, :raise_on => :both
+    proxy = client.proxy_for 'num'
+    
+    assert_raise Rapuncel::Response::Fault do
+      proxy.add 20, 20, 2
+    end
+  end
+  
+  test "Error rpc connection" do
+    client = Rapuncel::Client.new :host => 'www.cice-online.net', :port => 80, :path => '/hullahoobahubbahooo', :raise_on => :both
+    proxy = client.proxy
+    
+    assert_raise Rapuncel::Response::Error do
+      proxy.foo :bar, :baz
+    end
+  end
+  
+  test "Error rpc connection without raise" do
+    client = Rapuncel::Client.new :host => 'www.google.de', :port => 80, :path => '/hullahoobahubbahooo'
+    proxy = client.proxy
+    
+    assert_nothing_raised Rapuncel::Response::Error do
+      proxy.foo :bar, :baz
+    end
+    
+    err = proxy.foo(:bar, :baz)
+    assert_kind_of Hash, err
+    assert_equal 404, err[:http_code]
+  end
 end