oxmlrpc 0.1

data/lib/oxmlrpc.rb

@@ -0,0 +1,2 @@
+require_relative 'oxmlrpc/serializer'
+require_relative 'oxmlrpc/parser'

data/lib/oxmlrpc/parser.rb

@@ -0,0 +1,64 @@
+require 'ox'
+
+module OXMLRPC
+  class Parser < ::Ox::Sax
+
+    attr_reader :rpc_method, :params
+
+    def self.parse(xml)
+      parser = self.new
+      Ox.sax_parse(parser, StringIO.new(xml))
+      parser
+    end
+
+    def initialize
+      @elements = []
+      @rpc_method = nil
+      @params = []
+      @array_mode = false
+      @struct_mode = false
+    end
+
+    def start_element(name)
+      @elements << name
+      
+      if :array == name
+        @array_mode = true
+        @params << Array.new
+      end
+
+      if :struct == name
+        @struct_mode = true
+        @params << Hash.new
+      end
+    end
+
+    def end_element(name)
+      @array_mode = false if :array == name 
+      @struct_mode = false if :struct == name 
+      
+      raise "Invalid XML" unless @elements.pop == name
+    end
+
+    def text(value)
+      @rpc_method = value if :methodName == @elements.last
+      @params.last[value] = nil if :name == @elements.last && @struct_mode
+      
+      add_to_params value == 1 || value == "1"  if :boolean == @elements.last
+      add_to_params value                       if [:value, :string].include?(@elements.last)
+      add_to_params Integer(value)              if [:int, :i4].include?(@elements.last)
+      add_to_params Float(value)                if :double == @elements.last
+      add_to_params Time.parse(value)           if :'dateTime.iso8601' == @elements.last
+    end
+
+    def add_to_params(value)
+      if @array_mode
+        @params.last << value
+      elsif @struct_mode
+        @params.last[@params.last.keys.last] = value
+      else
+        @params << value
+      end
+    end
+  end
+end

data/lib/oxmlrpc/serializer.rb

@@ -0,0 +1,95 @@
+require 'ox'
+
+module OXMLRPC
+  class Serializer
+    
+    def self.serialize(data)
+      self.new(data).to_rpc
+    end
+    
+    def initialize(data = {})
+      @data = data
+    end
+
+    def to_rpc
+      doc = Ox::Document.new(:version => '1.0')
+      doc << mr = Ox::Element.new('methodResponse')
+      mr << params = Ox::Element.new('params')
+      params << param = Ox::Element.new('param')
+      param << serialize(@data)
+      Ox.dump(doc, :indent => -1)
+    end
+
+    private
+
+    def serialize(sth)
+      case sth
+      when String then serialize_string(sth)
+      when Integer then serialize_integer(sth)
+      when Hash then serialize_hash(sth)
+      when Array then serialize_array(sth)
+      when Float then serialize_double(sth)
+      when TrueClass then serialize_boolean(true)
+      when FalseClass then serialize_boolean(false)
+      when Time then serialize_time(sth)
+      else
+        raise "Uknkown type"
+      end
+    end
+
+    def serialize_hash(hash)
+      value = Ox::Element.new('value')
+      value << struct = Ox::Element.new('struct')
+      hash.each do |key, value|
+        struct << member = Ox::Element.new('member')
+        member << (Ox::Element.new('name') << key.to_s)
+        member << serialize(value)
+      end
+      value
+    end
+
+    def serialize_array(arr)
+      value = Ox::Element.new('value')
+      value << array = Ox::Element.new('array')
+      array << data = Ox::Element.new('data')
+      arr.each do |element|
+        data << serialize(element)
+      end
+      value
+    end
+
+    def serialize_string(string)
+      value = Ox::Element.new('value')
+      value << string
+      value
+    end
+
+    def serialize_integer(integer)
+      value = Ox::Element.new('value')
+      value << int = Ox::Element.new('int')
+      int << integer.to_s
+      value
+    end
+    
+    def serialize_double(float)
+      value = Ox::Element.new('value')
+      value << double = Ox::Element.new('double')
+      double << float.to_s
+      value
+    end
+    
+    def serialize_boolean(boolean)
+      value = Ox::Element.new('value')
+      value << bool = Ox::Element.new('boolean')
+      bool << (boolean ? "1" : "0")
+      value
+    end
+    
+    def serialize_time(time)
+      value = Ox::Element.new('value')
+      value << td = Ox::Element.new('dateTime.iso8601')
+      td << time.strftime("%Y%m%dT%H:%M:%S")
+      value
+    end
+  end
+end

data/spec/parser_spec.rb

@@ -0,0 +1,220 @@
+require_relative 'spec_helper'
+
+describe OXMLRPC::Parser do
+  it 'should parse simple request with <int> value' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value><int>41</int></value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [41]
+  end  
+  
+  it 'should parse simple request with <i4> value' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value><i4>41</i4></value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [41]
+  end  
+  
+  it 'should parse simple request with <string> value' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value><string>41</string></value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq ["41"]
+  end  
+  
+  it 'should parse simple request with <empty> value' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value>41</value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq ["41"]
+  end  
+
+  it 'should parse simple request with <int> values' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value><int>41</int></value>
+              </param>
+              <param>
+                <value><int>99</int></value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [41,99]
+  end  
+  
+  it 'should parse simple request with <bool> values' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value><boolean>0</boolean></value>
+              </param>
+              <param>
+                <value><boolean>1</boolean></value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [false,true]
+  end  
+  
+  it 'should parse simple request with <double> values' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value><double>-12.214</double></value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [-12.214]
+  end  
+  
+  it 'should parse simple request with <dateTime> values' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value><dateTime.iso8601>19980717T14:08:55</dateTime.iso8601></value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [Time.parse("19980717T14:08:55")]
+  end  
+  
+  it 'should parse simple request with <array> values' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value>
+                  <array>
+                    <data>
+                      <value><int>12</int></value>
+                      <value><string>Egypt</string></value>
+                      <value><boolean>0</boolean></value>
+                      <value><i4>-31</i4></value>
+                    </data>
+                  </array>
+                </value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [[12,"Egypt", false, -31]]
+  end  
+  
+  it 'should parse simple request with <struct> values' do
+    xml_request = %{
+      <?xml version="1.0"?>
+      <methodCall>
+         <methodName>examples.getStateName</methodName>
+            <params>
+              <param>
+                <value>
+                  <struct>
+                    <member>
+                     <name>lowerBound</name>
+                     <value><i4>18</i4></value>
+                    </member>
+                    <member>
+                     <name>upperBound</name>
+                     <value><i4>139</i4></value>
+                   </member>
+                  </struct>
+                </value>
+              </param>
+            </params>
+      </methodCall>
+    }
+
+    request = OXMLRPC::Parser.parse(xml_request)
+    
+    request.rpc_method.should eq "examples.getStateName"
+    request.params.should eq [{"lowerBound" => 18, "upperBound" => 139}]
+  end  
+
+end

data/spec/serializer_spec.rb

@@ -0,0 +1,47 @@
+require_relative 'spec_helper'
+
+describe OXMLRPC::Serializer do
+  it 'should serialize <int> value' do
+    OXMLRPC::Serializer.serialize(12).chomp
+      .should eq "<methodResponse><params><param><value><int>12</int></value></param></params></methodResponse>"
+  end
+  
+  it 'should serialize <string> value' do
+    OXMLRPC::Serializer.serialize("hello").chomp
+      .should eq "<methodResponse><params><param><value>hello</value></param></params></methodResponse>"
+  end
+  
+  it 'should serialize <boolean> value' do
+    OXMLRPC::Serializer.serialize(true).chomp
+      .should eq "<methodResponse><params><param><value><boolean>1</boolean></value></param></params></methodResponse>"
+  end
+  
+  it 'should serialize <double> value' do
+    OXMLRPC::Serializer.serialize(-12.45).chomp
+      .should eq "<methodResponse><params><param><value><double>-12.45</double></value></param></params></methodResponse>"
+  end
+
+  it 'should serialize <dateTime.iso8601> value' do
+    OXMLRPC::Serializer.serialize(Time.parse("19980717T14:08:55")).chomp
+      .should eq "<methodResponse><params><param><value><dateTime.iso8601>19980717T14:08:55</dateTime.iso8601></value></param></params></methodResponse>"
+  end
+  
+  it 'should serialize <struct> value' do
+    OXMLRPC::Serializer.serialize({:x => 2, :y => "z"}).chomp
+      .should eq "<methodResponse><params><param><value><struct><member><name>x</name><value><int>2</int></value></member><member><name>y</name><value>z</value></member></struct></value></param></params></methodResponse>"
+  end
+  
+  it 'should serialize <array> value' do
+    OXMLRPC::Serializer.serialize([12, "test"]).chomp
+      .should eq "<methodResponse><params><param><value><array><data><value><int>12</int></value><value>test</value></data></array></value></param></params></methodResponse>"
+  end
+  
+  it 'should serialize <exception> value' do
+    pending
+    OXMLRPC::Serializer.serialize(StandardError.new("something wrong")).chomp
+      .should eq ""
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler.require(:default)
+
+require_relative '../lib/oxmlrpc/parser'
+require_relative '../lib/oxmlrpc/serializer'
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: oxmlrpc
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- fazibear
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple, lightweight and fast XML-RPC client library for ruby based on
+  OX XML parser.
+email: fazibear@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/oxmlrpc.rb
+- lib/oxmlrpc/parser.rb
+- lib/oxmlrpc/serializer.rb
+- spec/parser_spec.rb
+- spec/serializer_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/fazibear/oxmlrpc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fast and simple XML-RPC Client
+test_files: []
+has_rdoc: