xmlrpc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b3f1922edd931c783c840f45865c76b1f535a19
+  data.tar.gz: 12b38e9e3f0d94a73bec9fa2a02944c914b2f15b
+SHA512:
+  metadata.gz: 88ad59a4a1028d7912bff03208909c0009526fe1ec77a61ef140e3e82c143077f1573b00c246d6e953a15352857b7e803b2e27ac14b7e9afae9aeebe58b0705c
+  data.tar.gz: 1890b83eefe2fb6f3e0baf3c6a4afb221c8a164d9eb43d455aca46734c1912d16daaea41c854dae8ec395cbfe0a3fb4f003b7434af529dd988c87eaa3ee8eba4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - ruby-head
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.md

@@ -0,0 +1,58 @@
+# XMLRPC
+
+## Overview
+
+XMLRPC is a lightweight protocol that enables remote procedure calls over
+HTTP.  It is defined at http://www.xmlrpc.com.
+
+XMLRPC allows you to create simple distributed computing solutions that span
+computer languages.  Its distinctive feature is its simplicity compared to
+other approaches like SOAP and CORBA.
+
+The Ruby standard library package 'xmlrpc' enables you to create a server that
+implements remote procedures and a client that calls them.  Very little code
+is required to achieve either of these.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xmlrpc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xmlrpc
+
+## Example
+
+Try the following code.  It calls a standard demonstration remote procedure.
+
+```ruby
+require 'xmlrpc/client'
+require 'pp'
+
+server = XMLRPC::Client.new2("http://xmlrpc-c.sourceforge.net/api/sample.php")
+result = server.call("sample.sumAndDifference", 5, 3)
+pp result
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/xmlrpc.
+
+
+## License
+
+Released under the same term of license as Ruby.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xmlrpc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xmlrpc.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: false
+# == Author and Copyright
+#
+# Copyright (C) 2001-2004 by Michael Neumann (mailto:mneumann@ntecs.de)
+#
+# Released under the same term of license as Ruby.
+#
+# == Overview
+#
+# XMLRPC is a lightweight protocol that enables remote procedure calls over
+# HTTP.  It is defined at http://www.xmlrpc.com.
+#
+# XMLRPC allows you to create simple distributed computing solutions that span
+# computer languages.  Its distinctive feature is its simplicity compared to
+# other approaches like SOAP and CORBA.
+#
+# The Ruby standard library package 'xmlrpc' enables you to create a server that
+# implements remote procedures and a client that calls them.  Very little code
+# is required to achieve either of these.
+#
+# == Example
+#
+# 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")
+#   result = server.call("sample.sumAndDifference", 5, 3)
+#   pp result
+#
+# == Documentation
+#
+# See http://www.ntecs.de/ruby/xmlrpc4r/.  There is plenty of detail there to
+# use the client and implement a server.
+#
+# == Features of XMLRPC for Ruby
+#
+# * Extensions
+#   * Introspection
+#   * multiCall
+#   * optionally nil values and integers larger than 32 Bit
+#
+# * Server
+#   * Standalone XML-RPC server
+#   * CGI-based (works with FastCGI)
+#   * Apache mod_ruby server
+#   * WEBrick servlet
+#
+# * Client
+#   * synchronous/asynchronous calls
+#   * Basic HTTP-401 Authentication
+#   * HTTPS protocol (SSL)
+#
+# * Parsers
+#   * REXML (XMLParser::REXMLStreamParser)
+#     * Not compiled (pure ruby)
+#     * See ruby standard library
+#   * libxml (LibXMLStreamParser)
+#     * Compiled
+#     * See https://rubygems.org/gems/libxml-ruby/
+#
+# * General
+#   * possible to choose between XMLParser module (Expat wrapper) and REXML (pure Ruby) parsers
+#   * Marshalling Ruby objects to Hashes and reconstruct them later from a Hash
+#   * SandStorm component architecture XMLRPC::Client interface
+#
+# == Howto
+#
+# === Client
+#
+#   require "xmlrpc/client"
+#
+#   # Make an object to represent the XML-RPC server.
+#   server = XMLRPC::Client.new( "xmlrpc-c.sourceforge.net", "/api/sample.php")
+#
+#   # Call the remote server and get our result
+#   result = server.call("sample.sumAndDifference", 5, 3)
+#
+#   sum = result["sum"]
+#   difference = result["difference"]
+#
+#   puts "Sum: #{sum}, Difference: #{difference}"
+#
+# === XMLRPC::Client with XML-RPC fault-structure handling
+#
+# There are two possible ways, of handling a fault-structure:
+#
+# ==== by catching a XMLRPC::FaultException exception
+#
+#   require "xmlrpc/client"
+#
+#   # Make an object to represent the XML-RPC server.
+#   server = XMLRPC::Client.new( "xmlrpc-c.sourceforge.net", "/api/sample.php")
+#
+#   begin
+#     # Call the remote server and get our result
+#     result = server.call("sample.sumAndDifference", 5, 3)
+#
+#     sum = result["sum"]
+#     difference = result["difference"]
+#
+#     puts "Sum: #{sum}, Difference: #{difference}"
+#
+#   rescue XMLRPC::FaultException => e
+#     puts "Error: "
+#     puts e.faultCode
+#     puts e.faultString
+#   end
+#
+# ==== by calling "call2" which returns a boolean
+#
+#   require "xmlrpc/client"
+#
+#   # Make an object to represent the XML-RPC server.
+#   server = XMLRPC::Client.new( "xmlrpc-c.sourceforge.net", "/api/sample.php")
+#
+#   # Call the remote server and get our result
+#   ok, result = server.call2("sample.sumAndDifference", 5, 3)
+#
+#   if ok
+#     sum = result["sum"]
+#     difference = result["difference"]
+#
+#     puts "Sum: #{sum}, Difference: #{difference}"
+#   else
+#     puts "Error: "
+#     puts result.faultCode
+#     puts result.faultString
+#   end
+#
+# === Using XMLRPC::Client::Proxy
+#
+# You can create a Proxy object onto which you can call methods. This way it
+# looks nicer. Both forms, _call_ and _call2_ are supported through _proxy_ and
+# _proxy2_.  You can additionally give arguments to the Proxy, which will be
+# given to each XML-RPC call using that Proxy.
+#
+#   require "xmlrpc/client"
+#
+#   # Make an object to represent the XML-RPC server.
+#   server = XMLRPC::Client.new( "xmlrpc-c.sourceforge.net", "/api/sample.php")
+#
+#   # Create a Proxy object
+#   sample = server.proxy("sample")
+#
+#   # Call the remote server and get our result
+#   result = sample.sumAndDifference(5,3)
+#
+#   sum = result["sum"]
+#   difference = result["difference"]
+#
+#   puts "Sum: #{sum}, Difference: #{difference}"
+#
+# === CGI-based server using XMLRPC::CGIServer
+#
+# There are also two ways to define handler, the first is
+# like C/PHP, the second like Java, of course both ways
+# can be mixed:
+#
+# ==== C/PHP-like (handler functions)
+#
+#   require "xmlrpc/server"
+#
+#   s = XMLRPC::CGIServer.new
+#
+#   s.add_handler("sample.sumAndDifference") do |a,b|
+#     { "sum" => a + b, "difference" => a - b }
+#   end
+#
+#   s.serve
+#
+# ==== Java-like (handler classes)
+#
+#   require "xmlrpc/server"
+#
+#   s = XMLRPC::CGIServer.new
+#
+#   class MyHandler
+#     def sumAndDifference(a, b)
+#       { "sum" => a + b, "difference" => a - b }
+#     end
+#   end
+#
+#   # NOTE: Security Hole (read below)!!!
+#   s.add_handler("sample", MyHandler.new)
+#   s.serve
+#
+#
+# To return a fault-structure you have to raise an XMLRPC::FaultException e.g.:
+#
+#   raise XMLRPC::FaultException.new(3, "division by Zero")
+#
+# ===== Security Note
+#
+# From Brian Candler:
+#
+#   Above code sample has an extremely nasty security hole, in that you can now call
+#   any method of 'MyHandler' remotely, including methods inherited from Object
+#   and Kernel! For example, in the client code, you can use
+#
+#     puts server.call("sample.send","`","ls")
+#
+#   (backtick being the method name for running system processes). Needless to
+#   say, 'ls' can be replaced with something else.
+#
+#   The version which binds proc objects (or the version presented below in the next section)
+#   doesn't have this problem, but people may be tempted to use the second version because it's
+#   so nice and 'Rubyesque'. I think it needs a big red disclaimer.
+#
+#
+# From Michael:
+#
+# A solution is to undef insecure methods or to use
+# XMLRPC::Service::PublicInstanceMethodsInterface as shown below:
+#
+#   class MyHandler
+#     def sumAndDifference(a, b)
+#       { "sum" => a + b, "difference" => a - b }
+#     end
+#   end
+#
+#   # ... server initialization ...
+#
+#   s.add_handler(XMLRPC::iPIMethods("sample"), MyHandler.new)
+#
+#   # ...
+#
+# This adds only public instance methods explicitly declared in class MyHandler
+# (and not those inherited from any other class).
+#
+# ==== With interface declarations
+#
+# Code sample from the book Ruby Developer's Guide:
+#
+#   require "xmlrpc/server"
+#
+#   class Num
+#     INTERFACE = XMLRPC::interface("num") {
+#       meth 'int add(int, int)', 'Add two numbers', 'add'
+#       meth 'int div(int, int)', 'Divide two numbers'
+#     }
+#
+#     def add(a, b) a + b end
+#     def div(a, b) a / b end
+#   end
+#
+#
+#   s = XMLRPC::CGIServer.new
+#   s.add_handler(Num::INTERFACE, Num.new)
+#   s.serve
+#
+# === Standalone XMLRPC::Server
+#
+# Same as CGI-based server, the only difference being
+#
+#   server = XMLRPC::CGIServer.new
+#
+# must be changed to
+#
+#   server = XMLRPC::Server.new(8080)
+#
+# if you want a server listening on port 8080.
+# The rest is the same.
+#
+# === Choosing a different XMLParser or XMLWriter
+#
+# The examples above all use the default parser (which is now since 1.8
+# XMLParser::REXMLStreamParser) and a default XMLRPC::XMLWriter.
+# If you want to use a different XMLParser, then you have to call the
+# ParserWriterChooseMixin#set_parser method of XMLRPC::Client instances
+# or instances of subclasses of XMLRPC::BasicServer or by editing
+# xmlrpc/config.rb.
+#
+# XMLRPC::Client Example:
+#
+#   # ...
+#   server = XMLRPC::Client.new( "xmlrpc-c.sourceforge.net", "/api/sample.php")
+#   server.set_parser(XMLRPC::XMLParser::XMLParser.new)
+#   # ...
+#
+# XMLRPC::Server Example:
+#
+#   # ...
+#   s = XMLRPC::CGIServer.new
+#   s.set_parser(XMLRPC::XMLParser::XMLParser.new)
+#   # ...
+#
+#
+# You can change the XML-writer by calling method ParserWriterChooseMixin#set_writer.
+module XMLRPC
+  VERSION = "0.1.0"
+end