xmlrpc 0.1.0

data/lib/xmlrpc/config.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: false
+#
+# $Id$
+# Configuration file for XML-RPC for Ruby
+#
+
+module XMLRPC # :nodoc:
+
+  module Config
+
+    # or XMLWriter::XMLParser
+    DEFAULT_WRITER = XMLWriter::Simple
+
+    # === Available parsers
+    #
+    # * XMLParser::REXMLStreamParser
+    # * XMLParser::LibXMLStreamParser
+    DEFAULT_PARSER = XMLParser::REXMLStreamParser
+
+    # enable <code><nil/></code> tag
+    ENABLE_NIL_CREATE    = false
+    ENABLE_NIL_PARSER    = false
+
+    # allows integers greater than 32-bit if +true+
+    ENABLE_BIGINT        = false
+
+    # enable marshalling Ruby objects which include XMLRPC::Marshallable
+    ENABLE_MARSHALLING   = true
+
+    # enable multiCall extension by default
+    ENABLE_MULTICALL     = false
+
+    # enable Introspection extension by default
+    ENABLE_INTROSPECTION = false
+
+  end
+
+end
+

data/lib/xmlrpc/create.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: false
+#
+# Copyright (C) 2001, 2002, 2003 by Michael Neumann (mneumann@ntecs.de)
+#
+# $Id$
+#
+
+require "date"
+require "xmlrpc/base64"
+
+module XMLRPC # :nodoc:
+
+  module XMLWriter
+
+    class Abstract
+      def ele(name, *children)
+        element(name, nil, *children)
+      end
+
+      def tag(name, txt)
+        element(name, nil, text(txt))
+      end
+    end
+
+
+    class Simple < Abstract
+
+      def document_to_str(doc)
+        doc
+      end
+
+      def document(*params)
+        params.join("")
+      end
+
+      def pi(name, *params)
+        "<?#{name} " + params.join(" ") + " ?>"
+      end
+
+      def element(name, attrs, *children)
+        raise "attributes not yet implemented" unless attrs.nil?
+        if children.empty?
+          "<#{name}/>"
+        else
+          "<#{name}>" + children.join("") + "</#{name}>"
+        end
+      end
+
+      def text(txt)
+        cleaned = txt.dup
+        cleaned.gsub!(/&/, '&amp;')
+        cleaned.gsub!(/</, '&lt;')
+        cleaned.gsub!(/>/, '&gt;')
+        cleaned
+      end
+
+    end # class Simple
+
+
+    class XMLParser < Abstract
+
+      def initialize
+        require "xmltreebuilder"
+      end
+
+      def document_to_str(doc)
+        doc.to_s
+      end
+
+      def document(*params)
+        XML::SimpleTree::Document.new(*params)
+      end
+
+      def pi(name, *params)
+        XML::SimpleTree::ProcessingInstruction.new(name, *params)
+      end
+
+      def element(name, attrs, *children)
+        XML::SimpleTree::Element.new(name, attrs, *children)
+      end
+
+      def text(txt)
+        XML::SimpleTree::Text.new(txt)
+      end
+
+    end # class XMLParser
+
+    Classes = [Simple, XMLParser]
+
+    # yields an instance of each installed XML writer
+    def self.each_installed_writer
+      XMLRPC::XMLWriter::Classes.each do |klass|
+        begin
+          yield klass.new
+        rescue LoadError
+        end
+      end
+    end
+
+  end # module XMLWriter
+
+  # Creates XML-RPC call/response documents
+  #
+  class Create
+
+    def initialize(xml_writer = nil)
+      @writer = xml_writer || Config::DEFAULT_WRITER.new
+    end
+
+
+    def methodCall(name, *params)
+      name = name.to_s
+
+      if name !~ /[a-zA-Z0-9_.:\/]+/
+        raise ArgumentError, "Wrong XML-RPC method-name"
+      end
+
+      parameter = params.collect do |param|
+        @writer.ele("param", conv2value(param))
+      end
+
+      tree = @writer.document(
+               @writer.pi("xml", 'version="1.0"'),
+               @writer.ele("methodCall",
+                 @writer.tag("methodName", name),
+                 @writer.ele("params", *parameter)
+               )
+             )
+
+      @writer.document_to_str(tree) + "\n"
+    end
+
+
+
+    #
+    # Generates a XML-RPC methodResponse document
+    #
+    # When +is_ret+ is +false+ then the +params+ array must
+    # contain only one element, which is a structure
+    # of a fault return-value.
+    #
+    # When +is_ret+ is +true+ then a normal
+    # return-value of all the given +params+ is created.
+    #
+    def methodResponse(is_ret, *params)
+
+      if is_ret
+        resp = params.collect do |param|
+          @writer.ele("param", conv2value(param))
+        end
+
+        resp = [@writer.ele("params", *resp)]
+      else
+        if params.size != 1 or params[0] === XMLRPC::FaultException
+          raise ArgumentError, "no valid fault-structure given"
+        end
+        resp = @writer.ele("fault", conv2value(params[0].to_h))
+      end
+
+
+      tree = @writer.document(
+               @writer.pi("xml", 'version="1.0"'),
+               @writer.ele("methodResponse", resp)
+             )
+
+      @writer.document_to_str(tree) + "\n"
+    end
+
+
+
+    private
+
+    #
+    # Converts a Ruby object into a XML-RPC <code><value></code> tag
+    #
+    def conv2value(param) # :doc:
+
+        val = case param
+        when Fixnum, Bignum
+          # XML-RPC's int is 32bit int, and Fixnum also may be beyond 32bit
+          if Config::ENABLE_BIGINT
+            @writer.tag("i4", param.to_s)
+          else
+            if param >= -(2**31) and param <= (2**31-1)
+              @writer.tag("i4", param.to_s)
+            else
+              raise "Bignum is too big! Must be signed 32-bit integer!"
+            end
+          end
+        when TrueClass, FalseClass
+          @writer.tag("boolean", param ? "1" : "0")
+
+        when Symbol
+          @writer.tag("string", param.to_s)
+
+        when String
+          @writer.tag("string", param)
+
+        when NilClass
+          if Config::ENABLE_NIL_CREATE
+            @writer.ele("nil")
+          else
+            raise "Wrong type NilClass. Not allowed!"
+          end
+
+        when Float
+          raise "Wrong value #{param}. Not allowed!" unless param.finite?
+          @writer.tag("double", param.to_s)
+
+        when Struct
+          h = param.members.collect do |key|
+            value = param[key]
+            @writer.ele("member",
+              @writer.tag("name", key.to_s),
+              conv2value(value)
+            )
+          end
+
+          @writer.ele("struct", *h)
+
+        when Hash
+          # TODO: can a Hash be empty?
+
+          h = param.collect do |key, value|
+            @writer.ele("member",
+              @writer.tag("name", key.to_s),
+              conv2value(value)
+            )
+          end
+
+          @writer.ele("struct", *h)
+
+        when Array
+          # TODO: can an Array be empty?
+          a = param.collect {|v| conv2value(v) }
+
+          @writer.ele("array",
+            @writer.ele("data", *a)
+          )
+
+        when Time, Date, ::DateTime
+          @writer.tag("dateTime.iso8601", param.strftime("%Y%m%dT%H:%M:%S"))
+
+        when XMLRPC::DateTime
+          @writer.tag("dateTime.iso8601",
+            format("%.4d%02d%02dT%02d:%02d:%02d", *param.to_a))
+
+        when XMLRPC::Base64
+          @writer.tag("base64", param.encoded)
+
+        else
+          if Config::ENABLE_MARSHALLING and param.class.included_modules.include? XMLRPC::Marshallable
+            # convert Ruby object into Hash
+            ret = {"___class___" => param.class.name}
+            param.instance_variables.each {|v|
+              name = v[1..-1]
+              val = param.instance_variable_get(v)
+
+              if val.nil?
+                ret[name] = val if Config::ENABLE_NIL_CREATE
+              else
+                ret[name] = val
+              end
+            }
+            return conv2value(ret)
+          else
+            ok, pa = wrong_type(param)
+            if ok
+              return conv2value(pa)
+            else
+              raise "Wrong type!"
+            end
+          end
+        end
+
+        @writer.ele("value", val)
+    end
+
+    def wrong_type(value)
+      false
+    end
+
+
+  end # class Create
+
+end # module XMLRPC
+

data/lib/xmlrpc/datetime.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: false
+#
+# xmlrpc/datetime.rb
+# Copyright (C) 2001, 2002, 2003 by Michael Neumann (mneumann@ntecs.de)
+#
+# Released under the same term of license as Ruby.
+#
+require "date"
+
+module XMLRPC # :nodoc:
+
+# This class is important to handle XMLRPC +dateTime.iso8601+ values,
+# correctly, because normal UNIX-dates, ie: Date, only handle dates
+# from year 1970 on, and ruby's native Time class handles dates without the
+# time component.
+#
+# XMLRPC::DateTime is able to store a XMLRPC +dateTime.iso8601+ value correctly.
+class DateTime
+
+  # Return the value of the specified date/time component.
+  attr_reader :year, :month, :day, :hour, :min, :sec
+
+  # Set +value+ as the new date/time component.
+  #
+  # Raises ArgumentError if the given +value+ is out of range, or in the case
+  # of XMLRPC::DateTime#year= if +value+ is not of type Integer.
+  def year= (value)
+    raise ArgumentError, "date/time out of range" unless value.is_a? Integer
+    @year = value
+  end
+
+  # Set +value+ as the new date/time component.
+  #
+  # Raises an ArgumentError if the given +value+ isn't between 1 and 12.
+  def month= (value)
+    raise ArgumentError, "date/time out of range" unless (1..12).include? value
+    @month = value
+  end
+
+  # Set +value+ as the new date/time component.
+  #
+  # Raises an ArgumentError if the given +value+ isn't between 1 and 31.
+  def day= (value)
+    raise ArgumentError, "date/time out of range" unless (1..31).include? value
+    @day = value
+  end
+
+  # Set +value+ as the new date/time component.
+  #
+  # Raises an ArgumentError if the given +value+ isn't between 0 and 24.
+  def hour= (value)
+    raise ArgumentError, "date/time out of range" unless (0..24).include? value
+    @hour = value
+  end
+
+  # Set +value+ as the new date/time component.
+  #
+  # Raises an ArgumentError if the given +value+ isn't between 0 and 59.
+  def min= (value)
+    raise ArgumentError, "date/time out of range" unless (0..59).include? value
+    @min = value
+  end
+
+  # Set +value+ as the new date/time component.
+  #
+  # Raises an ArgumentError if the given +value+ isn't between 0 and 59.
+  def sec= (value)
+    raise ArgumentError, "date/time out of range" unless (0..59).include? value
+    @sec = value
+  end
+
+  # Alias for XMLRPC::DateTime#month.
+  alias mon  month
+  # Alias for XMLRPC::DateTime#month=.
+  alias mon= month=
+
+
+  # Creates a new XMLRPC::DateTime instance with the
+  # parameters +year+, +month+, +day+ as date and
+  # +hour+, +min+, +sec+ as time.
+  #
+  # Raises an ArgumentError if a parameter is out of range,
+  # or if +year+ is not of the Integer type.
+  def initialize(year, month, day, hour, min, sec)
+    self.year, self.month, self.day = year, month, day
+    self.hour, self.min, self.sec   = hour, min, sec
+  end
+
+  # Return a Time object of the date/time which represents +self+.
+  # If the <code>@year</code> is below 1970, this method returns +nil+,
+  # because Time cannot handle years below 1970.
+  #
+  # The timezone used is GMT.
+  def to_time
+    if @year >= 1970
+      Time.gm(*to_a)
+    else
+      nil
+    end
+  end
+
+  # Return a Date object of the date which represents +self+.
+  #
+  # The Date object do _not_ contain the time component (only date).
+  def to_date
+    Date.new(*to_a[0,3])
+  end
+
+  # Returns all date/time components in an array.
+  #
+  # Returns +[year, month, day, hour, min, sec]+.
+  def to_a
+    [@year, @month, @day, @hour, @min, @sec]
+  end
+
+  # Returns whether or not all date/time components are an array.
+  def ==(o)
+    self.to_a == Array(o) rescue false
+  end
+
+end
+
+
+end # module XMLRPC
+
+
+=begin
+= History
+    $Id$
+=end