xmlrpc 0.3.2 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beb82c31668a9eac6cc5fec044fd06335c42126ce3d4f1f6defda2c987b42ac7
-  data.tar.gz: 216663d8c70e048ad6522be02c15e737da9bb4f29ffb268cd65fd8e270d52f15
+  metadata.gz: 2f2d8a8c29a5fc8c55bffcb7b56ff6dd3cd4331ba88cd9f6c30da98948296bef
+  data.tar.gz: d9480efd703fa30069f31c9c20c29067e560755e704268c2c5d44392a1b8014e
 SHA512:
-  metadata.gz: f2bc2b1c23323a22e37b5cde407ce06440f16d7b4a7ad733aa996616f04524de93e56b4e4deb37a1bf8a7793234011f4bf88141e4146c1aa5940ffb851de272f
-  data.tar.gz: 151dc29ed010ce4610c20d6673dea4ce939fdea3bcf287e7eebf728959768c868afe45a0fa8b0c4393754845efe14d0cf7e86b2c1ce046225aee1c8ca123860e
+  metadata.gz: 939cfd7ea5138f44b25e848bce42d8960cb334d0b3e919b80fa362c37f31457ff76e7525c6744ffca36fd30b69f417329230208cf6e07858a05b9f0b086578ce
+  data.tar.gz: 51e4c74654eba96955e151e97cbab7409097f89740de65fdab099673e0da8f4b2d5035af212b939bf2ce983b0964aa69672125bd787291a39a9d63f0ac4ec606

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

data/.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  github:
+    name: GitHub
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v6
+      - name: Extract release note
+        run: |
+          ruby \
+            -e 'print("## xmlrpc "); \
+                puts(ARGF.read.split(/^## /)[1])' \
+            NEWS.md > release-note.md
+      - name: Upload to release
+        run: |
+          title=$(head -n1 release-note.md | sed -e 's/^## //')
+          tail -n +2 release-note.md > release-note-without-version.md
+          gh release create ${GITHUB_REF_NAME} \
+            --discussion-category Announcements \
+            --notes-file release-note-without-version.md \
+            --title "${title}"
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+  rubygems:
+    name: RubyGems
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    permissions:
+      id-token: write
+    environment: release
+    steps:
+      - uses: actions/checkout@v6
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ruby
+          bundler-cache: true
+      - uses: rubygems/configure-rubygems-credentials@v1.0.0
+      - name: Push gems
+        run: |
+          bundle exec rake release:rubygem_push

data/.github/workflows/test.yml

@@ -17,10 +17,14 @@ jobs:
           - macos
           - windows
         ruby:
-          - "2.5"
           - "2.6"
           - "2.7"
           - "3.0"
+          - "3.1"
+          - "3.2"
+          - "3.3"
+          - "3.4"
+          - "4.0"
           - head
         include:
           - { os: windows , ruby: mingw }
@@ -28,9 +32,9 @@ jobs:
         exclude:
           - { os: windows , ruby: head }
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v6
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - run: bundle install
-      - run: rake
+          bundler-cache: true # 'bundle install' and cache gems
+      - run: bundle exec rake

data/Gemfile

@@ -1,3 +1,13 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development do
+  gem "bundler"
+  gem "libxml-ruby", platforms: [:ruby, :jruby]
+  gem "nokogiri", platforms: [:ruby, :jruby]
+  gem "rack"
+  gem "rack-test"
+  gem "rake"
+  gem "test-unit"
+end

data/NEWS.md

@@ -1,5 +1,51 @@
 # News
 
+## 0.3.4
+
+### Improvements
+
+  * GH-40: Added accessor methods to `XMLRPC::Config`.
+    * Patch by Herwin Weststrate
+
+  * Added REXML dependency.
+    * Patch by Herwin Weststrate
+
+  * GH-55: Added support for Nokogiri.
+    * Patch by Herwin Weststrate
+
+  * GH-56: Added support for Rack.
+    * Patch by Herwin Weststrate
+
+  * GH-59: Dropped support for mod_ruby.
+    * Patch by Herwin Weststrate
+
+  * GH-63: Added support for libxml_ruby 6.0.0 or later.
+    * Patch by Herwin Weststrate
+
+### Fixes
+
+  * GH-42 GH-43: Fixed a bug that IPv6 address host isn't used.
+    * Patch by Herwin Weststrate
+
+### Thanks
+
+  * Herwin Weststrate
+
+## 0.3.3
+
+### Improvements
+
+  * GH-36: Stopped to unmarshal all classes. Classes that include
+    `XMLRPC::Marshallable` are only allowed.
+
+    [Patch by ooooooo-q]
+    [Found by ooooooo-q and plenumlab separately]
+
+### Thanks
+
+  * ooooooo-q
+  * plenumlab
+
 ## 0.3.2
 
 ### Improvements

data/README.md

@@ -39,7 +39,7 @@ Try the following code.  It calls a standard demonstration remote procedure.
 require 'xmlrpc/client'
 require 'pp'
 
-server = XMLRPC::Client.new2("http://xmlrpc-c.sourceforge.net/api/sample.php")
+server = XMLRPC::Client.new2("http://localhost:8080/RPC2")
 result = server.call("sample.sumAndDifference", 5, 3)
 pp result
 ```

data/Rakefile

@@ -8,3 +8,13 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
+
+release_task = Rake.application["release"]
+# We use Trusted Publishing.
+release_task.prerequisites.delete("build")
+release_task.prerequisites.delete("release:rubygem_push")
+release_task_comment = release_task.comment
+if release_task_comment
+  release_task.clear_comments
+  release_task.comment = release_task_comment.gsub(/ and build.*$/, "")
+end

data/lib/xmlrpc/client.rb

@@ -44,7 +44,7 @@ module XMLRPC # :nodoc:
   #
   #     server = XMLRPC::Client.new("www.ruby-lang.org", "/RPC2", 80)
   #     ok, param = server.call2("michael.add", 4, 5)
-  #     if ok then
+  #     if ok
   #       puts "4 + 5 = #{param}"
   #     else
   #       puts "Error:"
@@ -147,7 +147,7 @@ module XMLRPC # :nodoc:
       proto  = url.scheme
       user   = url.user
       passwd = url.password
-      host   = url.host
+      host   = url.hostname
       port   = url.port
       path   = url.path.empty? ? nil : url.request_uri
 
@@ -246,7 +246,7 @@ module XMLRPC # :nodoc:
     # * Date, Time, XMLRPC::DateTime
     # * XMLRPC::Base64
     # * A Ruby object which class includes XMLRPC::Marshallable
-    #   (only if Config::ENABLE_MARSHALLING is +true+).
+    #   (only if Config.enable_marshalling? is +true+).
     #   That object is converted into a hash, with one additional key/value
     #   pair <code>___class___</code> which contains the class name
     #   for restoring that object later.

data/lib/xmlrpc/config.rb

@@ -15,6 +15,7 @@ module XMLRPC # :nodoc:
     #
     # * XMLParser::REXMLStreamParser
     # * XMLParser::LibXMLStreamParser
+    # * XMLParser::NokogiriStreamParser
     DEFAULT_PARSER = XMLParser::REXMLStreamParser
 
     # enable <code><nil/></code> tag
@@ -33,6 +34,27 @@ module XMLRPC # :nodoc:
     # enable Introspection extension by default
     ENABLE_INTROSPECTION = false
 
+    [
+      :DEFAULT_WRITER,
+      :DEFAULT_PARSER,
+      :ENABLE_NIL_CREATE,
+      :ENABLE_NIL_PARSER,
+      :ENABLE_BIGINT,
+      :ENABLE_MARSHALLING,
+      :ENABLE_MULTICALL,
+      :ENABLE_INTROSPECTION
+    ].each do |option|
+      getter = option.to_s.downcase
+      getter.concat('?') if [true, false].include?(const_get(option))
+      define_singleton_method(getter) do
+        const_get(option)
+      end
+
+      define_singleton_method("#{option.downcase}=") do |value|
+        remove_const(option)
+        const_set(option, value)
+      end
+    end
   end
 
 end

data/lib/xmlrpc/create.rb

@@ -106,7 +106,7 @@ module XMLRPC # :nodoc:
   class Create
 
     def initialize(xml_writer = nil)
-      @writer = xml_writer || Config::DEFAULT_WRITER.new
+      @writer = xml_writer || Config.default_writer.new
     end
 
 
@@ -180,7 +180,7 @@ module XMLRPC # :nodoc:
         val = case param
         when Integer
           # XML-RPC's int is 32bit int
-          if Config::ENABLE_BIGINT
+          if Config.enable_bigint?
             @writer.tag("i4", param.to_s)
           else
             if param >= -(2**31) and param <= (2**31-1)
@@ -199,7 +199,7 @@ module XMLRPC # :nodoc:
           @writer.tag("string", param)
 
         when NilClass
-          if Config::ENABLE_NIL_CREATE
+          if Config.enable_nil_create?
             @writer.ele("nil")
           else
             raise "Wrong type NilClass. Not allowed!"
@@ -248,7 +248,7 @@ module XMLRPC # :nodoc:
           @writer.tag("base64", param.encoded)
 
         else
-          if Config::ENABLE_MARSHALLING and param.class.included_modules.include? XMLRPC::Marshallable
+          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|
@@ -256,7 +256,7 @@ module XMLRPC # :nodoc:
               val = param.instance_variable_get(v)
 
               if val.nil?
-                ret[name] = val if Config::ENABLE_NIL_CREATE
+                ret[name] = val if Config.enable_nil_create?
               else
                 ret[name] = val
               end

data/lib/xmlrpc/parser.rb

@@ -107,12 +107,13 @@ module XMLRPC # :nodoc:
     def self.struct(hash)
       # convert to marshalled object
       klass = hash["___class___"]
-      if klass.nil? or Config::ENABLE_MARSHALLING == false
+      if klass.nil? or not Config.enable_marshalling?
         hash
       else
         begin
           mod = Module
           klass.split("::").each {|const| mod = mod.const_get(const.strip)}
+          return hash unless mod.included_modules.include?(XMLRPC::Marshallable)
 
           obj = mod.allocate
 
@@ -204,7 +205,7 @@ module XMLRPC # :nodoc:
           raise "error"
         end
 
-        if not cmp then
+        if not cmp
           raise "wrong xml-rpc (name)"
         end
 
@@ -216,14 +217,14 @@ module XMLRPC # :nodoc:
         if node.childNodes.to_a.size != 1
           raise "wrong xml-rpc (size)"
         end
-        if name != nil then
+        if name != nil
           nodeMustBe(node.firstChild, name)
         end
       end
 
 
       def assert(b)
-        if not b then
+        if not b
           raise "assert-fail"
         end
       end
@@ -416,7 +417,7 @@ module XMLRPC # :nodoc:
           when "struct"           then struct(child)
           when "array"            then array(child)
           when "nil"
-            if Config::ENABLE_NIL_PARSER
+            if Config.enable_nil_parser?
               v_nil(child)
             else
               raise "wrong/unknown XML-RPC type 'nil'"
@@ -435,7 +436,7 @@ module XMLRPC # :nodoc:
         assert( (1..2).include?( node.childNodes.to_a.size ) )
         name = methodName(node[0])
 
-        if node.childNodes.to_a.size == 2 then
+        if node.childNodes.to_a.size == 2
           pa = params(node[1])
         else # no parameters given
           pa = []
@@ -498,7 +499,7 @@ module XMLRPC # :nodoc:
         when "value"
           @value = nil
         when "nil"
-          raise "wrong/unknown XML-RPC type 'nil'" unless Config::ENABLE_NIL_PARSER
+          raise "wrong/unknown XML-RPC type 'nil'" unless Config.enable_nil_parser?
           @value = :nil
         when "array"
           @val_stack << @values
@@ -594,7 +595,7 @@ module XMLRPC # :nodoc:
 
     class LibXMLStreamParser < AbstractStreamParser
       def initialize
-        require 'libxml'
+        require 'libxml-ruby'
         @parser_class = LibXMLStreamListener
       end
 
@@ -623,7 +624,51 @@ module XMLRPC # :nodoc:
       end
     end
 
-    Classes = [REXMLStreamParser, LibXMLStreamParser]
+    class NokogiriStreamParser < AbstractStreamParser
+      def initialize
+        require 'nokogiri'
+        @parser_class = NokogiriStreamListener
+      end
+
+      class NokogiriStreamListener
+        include StreamParserMixin
+
+        def self.handler
+          # We need to construct this on first use, since we cannot be sure Nokogiri is available
+          @handler ||= begin
+            Class.new(Nokogiri::XML::SAX::Document) do
+              def initialize(parent)
+                super()
+                @parent = parent
+              end
+
+              def start_element_namespace(name, attrs = [], prefix = nil, uri = nil, ns = [])
+                @parent.startElement(name, attrs)
+              end
+
+              def end_element_namespace(name, prefix = nil, uri = nil)
+                @parent.endElement(name)
+              end
+
+              def characters(string)
+                @parent.character(string)
+              end
+
+              def cdata_block(string)
+                @parent.character(string)
+              end
+            end
+          end
+        end
+
+        def parse(str)
+          parser = Nokogiri::XML::SAX::Parser.new(self.class.handler.new(self))
+          parser.parse(str)
+        end
+      end
+    end
+
+    Classes = [REXMLStreamParser, LibXMLStreamParser, NokogiriStreamParser]
 
     # yields an instance of each installed parser
     def self.each_installed_parser

data/lib/xmlrpc/server.rb

@@ -63,8 +63,8 @@ class BasicServer
     @create = nil
     @parser = nil
 
-    add_multicall     if Config::ENABLE_MULTICALL
-    add_introspection if Config::ENABLE_INTROSPECTION
+    add_multicall     if Config.enable_multicall?
+    add_introspection if Config.enable_introspection?
   end
 
   # Adds +aBlock+ to the list of handlers, with +name+ as the name of
@@ -456,42 +456,24 @@ class CGIServer < BasicServer
 end
 
 
-# Implements a XML-RPC server, which works with Apache mod_ruby.
-#
-# Use it in the same way as XMLRPC::CGIServer!
-class ModRubyServer < BasicServer
-
-  # Creates a new XMLRPC::ModRubyServer instance.
-  #
-  # All parameters given are by-passed to XMLRPC::BasicServer.new.
-  def initialize(*a)
-    @ap = Apache::request
-    super(*a)
-  end
+# Implements a XML-RPC application, which works with Rack
+class RackApplication < BasicServer
 
-  # Call this after you have added all you handlers to the server.
-  #
   # This method processes a XML-RPC method call and sends the answer
   # back to the client.
-  def serve
-    catch(:exit_serve) {
-      header = {}
-      @ap.headers_in.each {|key, value| header[key.capitalize] = value}
+  def call(env)
+    length = env['CONTENT_LENGTH'].to_i
 
-      length = header['Content-length'].to_i
+    return http_error(405, "Method Not Allowed") unless env['REQUEST_METHOD'] == "POST"
+    return http_error(400, "Bad Request")        unless parse_content_type(env['CONTENT_TYPE']).first == "text/xml"
+    return http_error(411, "Length Required")    unless length > 0
 
-      http_error(405, "Method Not Allowed") unless @ap.request_method  == "POST"
-      http_error(400, "Bad Request")        unless parse_content_type(header['Content-type']).first == "text/xml"
-      http_error(411, "Length Required")    unless length > 0
+    req = Rack::Request.new(env)
+    data = req.body.read(length)
 
-      # TODO: do we need a call to binmode?
-      @ap.binmode
-      data = @ap.read(length)
+    return http_error(400, "Bad Request")        if data.nil? or data.bytesize != length
 
-      http_error(400, "Bad Request")        if data.nil? or data.bytesize != length
-
-      http_write(process(data), 200, "Content-type" => "text/xml; charset=utf-8")
-    }
+    [200, { "Content-type" => "text/xml; charset=utf-8" }, [process(data)]]
   end
 
 
@@ -511,22 +493,7 @@ class ModRubyServer < BasicServer
       </html>
     MSGEND
 
-    http_write(msg, status, "Status" => err, "Content-type" => "text/html")
-    throw :exit_serve # exit from the #serve method
-  end
-
-  def http_write(body, status, header)
-    h = {}
-    header.each {|key, value| h[key.to_s.capitalize] = value}
-    h['Status']         ||= "200 OK"
-    h['Content-length'] ||= body.bytesize.to_s
-
-    h.each {|key, value| @ap.headers_out[key] = value }
-    @ap.content_type = h["Content-type"]
-    @ap.status = status.to_i
-    @ap.send_http_header
-
-    @ap.print body
+    [status, { "Content-Type" => "text/html" }, [msg]]
   end
 
 end

data/lib/xmlrpc/utils.rb

@@ -26,7 +26,7 @@ module XMLRPC # :nodoc:
     #
     # Should be an instance of a class from module XMLRPC::XMLWriter.
     #
-    # If this method is not called, then XMLRPC::Config::DEFAULT_WRITER is used.
+    # If this method is not called, then XMLRPC::Config.default_writer is used.
     def set_writer(writer)
       @create = Create.new(writer)
       self
@@ -36,7 +36,7 @@ module XMLRPC # :nodoc:
     #
     # Should be an instance of a class from module XMLRPC::XMLParser.
     #
-    # If this method is not called, then XMLRPC::Config::DEFAULT_PARSER is used.
+    # If this method is not called, then XMLRPC::Config.default_parser is used.
     def set_parser(parser)
       @parser = parser
       self
@@ -46,16 +46,16 @@ module XMLRPC # :nodoc:
 
     def create
       # if set_writer was not already called then call it now
-      if @create.nil? then
-        set_writer(Config::DEFAULT_WRITER.new)
+      if @create.nil?
+        set_writer(Config.default_writer.new)
       end
       @create
     end
 
     def parser
       # if set_parser was not already called then call it now
-      if @parser.nil? then
-        set_parser(Config::DEFAULT_PARSER.new)
+      if @parser.nil?
+        set_parser(Config.default_parser.new)
       end
       @parser
     end

data/lib/xmlrpc.rb

@@ -44,7 +44,7 @@
 # * Server
 #   * Standalone XML-RPC server
 #   * CGI-based (works with FastCGI)
-#   * Apache mod_ruby server
+#   * Rack application
 #   * WEBrick servlet
 #
 # * Client
@@ -59,9 +59,12 @@
 #   * libxml (LibXMLStreamParser)
 #     * Compiled
 #     * See https://rubygems.org/gems/libxml-ruby/
+#   * nokogiri (NokogiriStreamParser)
+#     * Compiled
+#     * See https://nokogiri.org
 #
 # * General
-#   * possible to choose between XMLParser module (Expat wrapper) and REXML (pure Ruby) parsers
+#   * possible to choose between REXML (pure Ruby) and LibXML/Nokogiri (compiled) parsers
 #   * Marshalling Ruby objects to Hashes and reconstruct them later from a Hash
 #   * SandStorm component architecture XMLRPC::Client interface
 #
@@ -275,19 +278,19 @@
 # XMLRPC::Client Example:
 #
 #   # ...
-#   server = XMLRPC::Client.new( "xmlrpc-c.sourceforge.net", "/api/sample.php")
-#   server.set_parser(XMLRPC::XMLParser::XMLParser.new)
+#   client = XMLRPC::Client.new( "xmlrpc-c.sourceforge.net", "/api/sample.php")
+#   client.set_parser(XMLRPC::XMLParser::XMLParser.new)
 #   # ...
 #
 # XMLRPC::Server Example:
 #
 #   # ...
-#   s = XMLRPC::CGIServer.new
-#   s.set_parser(XMLRPC::XMLParser::XMLParser.new)
+#   server = XMLRPC::CGIServer.new
+#   server.set_parser(XMLRPC::XMLParser::XMLParser.new)
 #   # ...
 #
 #
 # You can change the XML-writer by calling method ParserWriterChooseMixin#set_writer.
 module XMLRPC
-  VERSION = "0.3.2"
+  VERSION = "0.3.4"
 end

data/xmlrpc.gemspec

@@ -15,14 +15,9 @@ Gem::Specification.new do |spec|
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.required_ruby_version = ">= 2.3"
 
+  spec.add_dependency "rexml"
   spec.add_dependency "webrick"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "test-unit"
 end

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: xmlrpc
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.4
 platform: ruby
 authors:
 - SHIBATA Hiroshi
 - Sutou Kouhei
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-02-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: webrick
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -26,41 +25,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test-unit
+  name: webrick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -76,6 +47,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - Gemfile
@@ -101,7 +74,6 @@ licenses:
 - Ruby
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
 summary: XMLRPC is a lightweight protocol that enables remote procedure calls over
   HTTP.