yamlrpc 0.1.080704174553 → 0.1.080706215610

data/lib/yamlrpc/client.rb

@@ -1,14 +1,30 @@
-
 # Simple RPC client on YAML
 #
-# Exacmple:
+# Example usage:
+#
+#   yaml_rpc = YamlRpc.new('http://rubyforge.org/projects/yamlrpc/')
+#   yaml_rpc.foo({
+#     :bar => 'foo-bar'
+#   )
+#
+# will HTTP POST
+#
+#   {
+#     :bar => YAML::dump('foo-bar')
+#   }
+#
+# to http://rubyforge.org/projects/yamlrpc/<b>foo</b>
+#
+# On the server side you can use (Ruby on Rails):
+# 
+#   YAML::load(params[:yaml_rpc])[:foo]
 #
-#   yaml_rpc = YamlRpc.new('http://my.com/yaml_api/')
-#   yaml_rpc.invoice( :invoice_id => '123' )
+# or in PHP:
 #
-# will POST { :invoice_id => YAML::dump('123') } value to http://my.com/yaml_api/invoice
+#   $data = syck_load($_POST['yaml_rpc']);
+#   $data['foo']
 #
-# On the server side you can use YamlRpc.decode(params, [:invoice_id]) (in Ruby on Rails) to get decoded values.
+# See examples in /examples directory
 module YamlRpc
   
   class Client
@@ -33,8 +49,8 @@ module YamlRpc
     end
     
     # * <tt>method</tt> Method name
-    # * <tt>args</tt> Arguments, should always be a Hash
-    def method_missing(method, args)
+    # * <tt>args</tt> Arguments, nil or Hash of values
+    def method_missing(method, args = {})
       post(method, args)
     end
 

data/lib/yamlrpc.rb

@@ -1,3 +1,26 @@
+#--
+# Copyright (c) 2008 Mirek Rusin
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++ 
+
 require 'yaml'
 require 'net/http'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yamlrpc
 version: !ruby/object:Gem::Version 
-  version: 0.1.080704174553
+  version: 0.1.080706215610
 platform: ruby
 authors: 
 - Mirek Rusin
@@ -9,7 +9,7 @@ autorequire: yamlrpc
 bindir: bin
 cert_chain: []
 
-date: 2008-07-04 00:00:00 +01:00
+date: 2008-07-06 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -27,7 +27,7 @@ files:
 - lib/yamlrpc/helpers.rb
 - lib/yamlrpc.rb
 - README
-has_rdoc: true
+has_rdoc: false
 homepage: http://mirekrusin.com/ruby/yamlrpc
 post_install_message: 
 rdoc_options: []