rapuncel 0.0.5.RC1 → 0.0.5.RC2

data/lib/rapuncel/xml_rpc/serializer.rb

@@ -0,0 +1,153 @@
+require 'bigdecimal'
+require 'time'
+
+module Rapuncel
+  module XmlRpc
+    class Serializer
+      XML_ENCODING = 'UTF-8'
+    
+      attr_reader :builder
+    
+      def initialize object
+        @builder = Nokogiri::XML::Builder.new :encoding => XML_ENCODING
+      
+        serialize object
+      end
+    
+      def serialize object
+        case object
+        when Base64String
+          serialize_base64 object
+        when Array
+          serialize_array object
+        when String, Symbol
+          serialize_string object.to_s
+        when TrueClass
+          serialize_true
+        when FalseClass
+          serialize_false
+        when Float
+          serialize_float object
+        when BigDecimal
+          serialize_big_decimal object
+        when Hash
+          serialize_hash object
+        when Integer
+          serialize_integer object
+        when NilClass
+          serialize_nil
+        when Time
+          serialize_time object
+        when Request
+          serialize_request object
+        else
+          if object.respond_to?(:acts_like?) && object.acts_like?(:time)
+            serialize_time object
+          elsif object.respond_to?(:to_xmlrpc)
+            object.to_xmlrpc self
+          else
+            serialize_hash instance_variable_hash(object)
+          end
+        end
+      
+        self
+      end
+    
+      def serialize_base64 string
+        builder.base64 string.base64_encoded
+      end
+    
+      def serialize_array array
+        builder.array do |builder|
+          builder.data do |builder|
+            array.each do |element|
+              builder.value do |_|
+                serialize element
+              end
+            end
+          end
+        end
+      end
+    
+      def serialize_string string
+        builder.string string
+      end
+    
+      def serialize_true
+        builder.boolean "1"
+      end
+    
+      def serialize_false
+        builder.boolean "0"
+      end
+      alias_method :serialize_nil, :serialize_false
+    
+      def serialize_float float
+        builder.double float.to_s
+      end
+    
+      def serialize_big_decimal big_decimal
+        builder.double big_decimal.to_s("F")
+      end
+    
+      def serialize_hash hash
+        builder.struct do |builder|
+          hash.each_pair do |key, value|
+            builder.member do |builder|
+              # Get a better string representation of BigDecimals
+              key = key.to_s("F") if BigDecimal === key
+              builder.name key.to_s
+
+              builder.value do |builder|
+                serialize value
+              end
+            end
+          end
+        end
+      end
+    
+      def serialize_integer int
+        builder.int int.to_s
+      end
+    
+      def serialize_time time
+        builder.send "dateTime.iso8601", time.iso8601
+      end
+    
+      def serialize_request request
+        builder.methodCall do |builder|
+          builder.methodName request.method_name
+          builder.params do |builder|
+            request.arguments.each do |argument|
+              builder.param do |builder|
+                builder.value do |builder|
+                  serialize argument
+                end
+              end
+            end
+          end
+        end
+      end
+    
+      def to_xml
+        @builder.to_xml
+      end
+    
+      protected
+      def instance_variable_hash object
+        {}.tap do |hash|
+          object.instance_variables.each do |ivar|
+            hash[ivar[1..-1]] = object.instance_variable_get ivar
+          end
+        end
+      end
+    
+      class << self
+        def serialize object
+          new(object).to_xml
+        end
+        alias_method :[], :serialize
+      end
+    end
+  end
+end

data/rapuncel.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = "rapuncel"
-  s.version     = "0.0.5.RC1"
+  s.version     = "0.0.5.RC2"
   s.date        = Time.now.strftime("%Y-%m-%d")
   s.authors     = ["Michael Eickenberg", "Marian Theisen"]
   s.email       = 'marian@cice-online.net'

data/spec/unit/array_spec.rb

@@ -5,7 +5,7 @@ describe Array do
     before do
       @array = (1..10).to_a.map &:to_s
       
-      @xml = Rapuncel::XmlRpcSerializer[@array]
+      @xml = Rapuncel::XmlRpc::Serializer[@array]
     end
     
     it "yields a value tag for each array element" do
@@ -27,7 +27,7 @@ describe Array do
           <value><string>3</string></value>
         </data></array>
       XML
-      @array = Rapuncel::XmlRpcDeserializer[@xml]
+      @array = Rapuncel::XmlRpc::Deserializer[@xml]
     end
     
     it 'has correct number of elements' do

data/spec/unit/base64_spec.rb

@@ -14,7 +14,7 @@ describe "Base64" do
     string = "abcdefghABCDEFGH1234567890".as_base64
     string.should be_a Rapuncel::Base64String
     
-    xml = Rapuncel::XmlRpcSerializer[string]
+    xml = Rapuncel::XmlRpc::Serializer[string]
     xml.should have_xpath('/base64', :content => to_base64(string))
   end
   
@@ -23,7 +23,7 @@ describe "Base64" do
       <base64>YWJjZGVmZ2hBQkNERUZHSDEyMzQ1Njc4OTA=</base64>
     XML
     
-    string = Rapuncel::XmlRpcDeserializer[xml]
+    string = Rapuncel::XmlRpc::Deserializer[xml]
     string.should be_a Rapuncel::Base64String
     string.should == "abcdefghABCDEFGH1234567890"
   end

data/spec/unit/boolean_spec.rb

@@ -3,11 +3,11 @@ require 'spec_helper'
 describe TrueClass, FalseClass do
   describe "Serialization" do
     it 'represents true as 1' do
-      Rapuncel::XmlRpcSerializer[true].should have_xpath('/boolean', :content => '1')
+      Rapuncel::XmlRpc::Serializer[true].should have_xpath('/boolean', :content => '1')
     end
     
     it 'represents false as 0' do
-      Rapuncel::XmlRpcSerializer[false].should have_xpath('/boolean', :content => '0')
+      Rapuncel::XmlRpc::Serializer[false].should have_xpath('/boolean', :content => '0')
     end
   end
   
@@ -17,7 +17,7 @@ describe TrueClass, FalseClass do
         <boolean>1</boolean>
       XML
       
-      Rapuncel::XmlRpcDeserializer[xml].should be_a TrueClass
+      Rapuncel::XmlRpc::Deserializer[xml].should be_a TrueClass
     end
     
     it 'reads 0 as false' do
@@ -25,7 +25,7 @@ describe TrueClass, FalseClass do
         <boolean>0</boolean>
       XML
       
-      Rapuncel::XmlRpcDeserializer[xml].should be_a FalseClass
+      Rapuncel::XmlRpc::Deserializer[xml].should be_a FalseClass
     end
     
     it 'reads anything else as false' do
@@ -33,7 +33,7 @@ describe TrueClass, FalseClass do
         <boolean>abcd</boolean>
       XML
       
-      Rapuncel::XmlRpcDeserializer[xml].should be_a FalseClass
+      Rapuncel::XmlRpc::Deserializer[xml].should be_a FalseClass
     end
   end
 end

data/spec/unit/custom_serialization_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe "Custom serialization" do
+  module CustomSerialization
+    class Serializer < Rapuncel::XmlRpc::Serializer
+    end
+    
+    class Deserializer < Rapuncel::XmlRpc::Deserializer
+    end
+  end
+  
+  it 'client selects custom (de)serializer, if provided by Symbol' do
+    client = Rapuncel::Client.new :serialization => :CustomSerialization
+    
+    client.send(:serializer).should == CustomSerialization::Serializer
+  end
+  
+  it 'client selects custom (de)serializer, if provided by Class' do
+    client = Rapuncel::Client.new :serialization => CustomSerialization
+    
+    client.send(:serializer).should == CustomSerialization::Serializer
+  end
+end

data/spec/unit/float_spec.rb

@@ -4,12 +4,12 @@ describe Float do
   describe "Serialization" do
     it "can serialize Floats" do
       number = 1.23456
-      Rapuncel::XmlRpcSerializer[number].should have_xpath('/double', :content => "1.23456")
+      Rapuncel::XmlRpc::Serializer[number].should have_xpath('/double', :content => "1.23456")
     end
     
     it "can serialize BigDecimal" do
       number = BigDecimal.new '1.23456'
-      Rapuncel::XmlRpcSerializer[number].should have_xpath('/double', :content => "1.23456")
+      Rapuncel::XmlRpc::Serializer[number].should have_xpath('/double', :content => "1.23456")
     end
   end
   
@@ -18,18 +18,18 @@ describe Float do
       xml = <<-XML
         <double>1.23456</double>
       XML
-      number = Rapuncel::XmlRpcDeserializer[xml]
+      number = Rapuncel::XmlRpc::Deserializer[xml]
       number.should be_a Float
       number.should == 1.23456
     end
     
     it "can optionally deserialize all double to BigDecimal" do
-      Rapuncel::XmlRpcDeserializer.double_as_bigdecimal = true
+      Rapuncel::XmlRpc::Deserializer.double_as_bigdecimal = true
       
       xml = <<-XML
         <double>1.23456</double>
       XML
-      number = Rapuncel::XmlRpcDeserializer[xml]
+      number = Rapuncel::XmlRpc::Deserializer[xml]
       
       number.should be_a BigDecimal
       number.to_s("F").should == "1.23456"

data/spec/unit/hash_spec.rb

@@ -10,7 +10,7 @@ describe Hash do
         BigDecimal.new('1.23') => "abcd"
       }
       
-      @xml = Rapuncel::XmlRpcSerializer[@hash]
+      @xml = Rapuncel::XmlRpc::Serializer[@hash]
     end
     
     it 'preserves number of key-value pairs' do
@@ -35,7 +35,7 @@ describe Hash do
         </struct>
       XML
       
-      @hash = Rapuncel::XmlRpcDeserializer[@xml]
+      @hash = Rapuncel::XmlRpc::Deserializer[@xml]
     end
     
     it 'preserves number of key-value pairs' do

data/spec/unit/int_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Integer do
   it "serialization" do
-    Rapuncel::XmlRpcSerializer[123].should have_xpath('/int', :content => "123")
+    Rapuncel::XmlRpc::Serializer[123].should have_xpath('/int', :content => "123")
   end
   
   it "deserialization of int" do
@@ -10,7 +10,7 @@ describe Integer do
       <int>123</int>
     XML
     
-    Rapuncel::XmlRpcDeserializer[xml].should == 123
+    Rapuncel::XmlRpc::Deserializer[xml].should == 123
   end
   
   it 'deserialization of i4' do
@@ -18,6 +18,6 @@ describe Integer do
       <i4>123</i4>
     XML
     
-    Rapuncel::XmlRpcDeserializer[xml].should == 123
+    Rapuncel::XmlRpc::Deserializer[xml].should == 123
   end
 end

data/spec/unit/nil_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 
 describe NilClass do
   it 'serializes like false' do
-    Rapuncel::XmlRpcSerializer[nil].should have_xpath('/boolean', :content => '0')
+    Rapuncel::XmlRpc::Serializer[nil].should have_xpath('/boolean', :content => '0')
   end
 end

data/spec/unit/object_spec.rb

@@ -5,20 +5,41 @@ describe Object do
     attr_accessor :a, :b, :c
   end
   
+  class TestObjectWithOwnBehavior < TestObject
+    def to_xmlrpc serializer
+      serializer.builder.string "custom thing"
+    end
+  end
+  
   describe "Serialization of an arbitrary Object" do
     it "serializes all instance variables like a hash" do
       obj = TestObject.new
       obj.a = "one"
       obj.b = "two"
       
-      xml = Rapuncel::XmlRpcSerializer[obj]
+      xml = Rapuncel::XmlRpc::Serializer[obj]
       xml.should have_xpath('/struct/member', :count => 2)
       
-      reparsed_object = Rapuncel::XmlRpcDeserializer[xml]
+      reparsed_object = Rapuncel::XmlRpc::Deserializer[xml]
       reparsed_object.should == {
         :a => 'one',
         :b => 'two'
       }
     end
+    
+  end
+  
+  describe "Serialization of an Object with #to_xmlrpc" do
+    it "uses this method to serialize" do
+      obj = TestObjectWithOwnBehavior.new
+    
+      obj.a = 'one'
+    
+      xml = Rapuncel::XmlRpc::Serializer[obj]
+      xml.should have_xpath('/string')
+    
+      reparsed_object = Rapuncel::XmlRpc::Deserializer[xml]
+      reparsed_object.should == "custom thing"
+    end
   end
 end

data/spec/unit/request_spec.rb

@@ -5,7 +5,7 @@ describe Rapuncel::Request do
   describe "Serialization" do
     before do
       @request = Rapuncel::Request.new 'test_method', "one argument", "another"
-      @xml = Rapuncel::XmlRpcSerializer[@request]
+      @xml = Rapuncel::XmlRpc::Serializer[@request]
     end
   
     it 'should be in xml version=1.0' do

data/spec/unit/response_spec.rb

@@ -27,7 +27,7 @@ describe Rapuncel::Response do
       </methodResponse>
     XML
     
-    response = Rapuncel::Response.new successful_response
+    response = Rapuncel::Response.new successful_response, Rapuncel::XmlRpc::Deserializer
     response.should be_success
     
     response.result.should == "foo foo foo"
@@ -66,7 +66,7 @@ describe Rapuncel::Response do
       </methodResponse>
     XML
     
-    response = Rapuncel::Response.new fault_response
+    response = Rapuncel::Response.new fault_response, Rapuncel::XmlRpc::Deserializer
     response.should be_fault
     
     response.to_ruby.should be_a Hash
@@ -76,7 +76,7 @@ describe Rapuncel::Response do
   it 'should handle errors' do
     error_response = HttpResponse.new "Not Found", false, 404
     
-    response = Rapuncel::Response.new error_response
+    response = Rapuncel::Response.new error_response, Rapuncel::XmlRpc::Deserializer
     response.should be_error
     
     response.to_ruby.should be_a Hash

data/spec/unit/string_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 describe String, Symbol do
   it 'serialization of a String' do
     string = "foobar"
-    xml = Rapuncel::XmlRpcSerializer[string]
+    xml = Rapuncel::XmlRpc::Serializer[string]
     xml.should have_xpath('/string', :content => "foobar")
   end
   
   it 'serialization of a Symbol' do
     symbol = :foobar
-    xml = Rapuncel::XmlRpcSerializer[symbol]
+    xml = Rapuncel::XmlRpc::Serializer[symbol]
     xml.should have_xpath('/string', :content => "foobar")
   end
   
   it 'preservation of trailing an leading whitespaces' do
     string = "\n\t  abcd\n  \t"
-    xml = Rapuncel::XmlRpcSerializer[string]
+    xml = Rapuncel::XmlRpc::Serializer[string]
     xml.should have_xpath('/string', :content => "\n\t  abcd\n  \t")
   end
   
@@ -23,13 +23,13 @@ describe String, Symbol do
     xml = <<-XML
       <string>abcd\nefgh  \n\t</string>
     XML
-    string = Rapuncel::XmlRpcDeserializer[xml]
+    string = Rapuncel::XmlRpc::Deserializer[xml]
     string.should == "abcd\nefgh  \n\t"
   end
   
   it 'normalization of linebreaks' do
     string = "one\r\ntwo\rthree\nfour"
-    string2 = Rapuncel::XmlRpcDeserializer[Rapuncel::XmlRpcSerializer[string]]
+    string2 = Rapuncel::XmlRpc::Deserializer[Rapuncel::XmlRpc::Serializer[string]]
     string2.should == "one\ntwo\nthree\nfour"
   end
 end