yamlrpc 0.1.080624130617 → 0.1.080630154212

data/lib/yamlrpc/client.rb

@@ -1,27 +1,43 @@
 
-# Simple RPC client on YAML.
+# Simple RPC client on YAML
+#
+# Exacmple:
+#
+#   yaml_rpc = YamlRpc.new('http://my.com/yaml_api/')
+#   yaml_rpc.invoice( :invoice_id => '123' )
+#
+# will POST { :invoice_id => YAML::dump('123') } value to http://my.com/yaml_api/invoice
+#
+# On the server side you can use YamlRpc.decode(params, [:invoice_id]) (in Ruby on Rails) to get decoded values.
 module YamlRpc
   
   class Client
     
     attr_accessor :url
+    attr_accessor :form_data_root
     
-    def initialize(url)
+    # * <tt>url</tt> Root url, ie. "http://my.com/something/"; YamlRpc#some_method(:foo => 'bar') will POST to http://my.com/something/some_method with { :foo => 'bar' } params
+    # * <tt>options</tt>
+    #   * <tt>:form_data_root</tt> Default to nil; if you want all params to have single root, ie. 'yaml', set :form_data_root => :yaml
+    def initialize(url, options = {})
       @url = url
+      @form_data_root = options[:form_data_root]
     end
     
+    # * <tt>method</tt> Method name
+    # * <tt>args</tt> Arguments, should always be a Hash
     def method_missing(method, args)
       post(method, args)
     end
 
   protected
 
-    # * <tt>url</tt> Url
-    # * <tt>data</tt> Data to be passed as POST form field 'yaml', ie: { :status => 'SUCCESS', :message => 'All ok' }
-    def post(url, data = {})
-      url = URI.parse("#{@url}#{url}")
+    # * <tt>add_url</tt> Path to be added to the YamlRpc#url (usually it's the method name), ie :invoice)
+    # * <tt>args</tt> Data to be passed as POST fields, ie: { :status => 'SUCCESS', :message => 'All ok' }
+    def post(add_url, args = {})
+      url = URI.parse("#{@url}#{add_url}")
       req = Net::HTTP::Post.new(url.path)
-      req.set_form_data({ :yaml => YAML::dump(data) }, ';')
+      req.set_form_data(args_to_form_data(args), ';')
       res = Net::HTTP.new(url.host, url.port).start { |http| http.request(req) }
       case res
         when Net::HTTPSuccess
@@ -30,6 +46,19 @@ module YamlRpc
           res.error!
       end
     end
+    
+    # POST form data can be passed in two ways:
+    # 1) with common root (set YamlRpc#form_data_root to ie. :my_root)
+    # 2) without common root, each key is at the root of POST
+    def args_to_form_data(args)
+      r = {}
+      if @form_data_root
+        r[@form_data_root.to_sym] = YAML::dump(args)
+      else
+        args.each { |k, v| r[k.to_sym] = YAML::dump(v) }
+      end
+      r
+    end
   
   end
 

data/lib/yamlrpc/helpers.rb

@@ -0,0 +1,35 @@
+
+module YamlRpc
+
+  class <<self  
+  
+    # Helper method to decode passed arguments on the server side.
+    #
+    # Please note this is trivial task and you don't have to use this helper function to decode POST data on the server.
+    # You can even use different language to parse YAML, like PHP.
+    #
+    # * <tt>params</tt> Hash
+    # * <tt>fields</tt> If nil, will decode all passed params; otherwise only passed list of keys
+    def decode(params, fields = nil)
+      r = {}
+      fields = params.keys unless fields
+      fields.each { |k| r[k] = YAML::load(params[k] || "--- \n" ) }
+      r
+    end
+  
+    # Helper method to decode arguments on the server side.
+    # 
+    # Returns a list of decoded values so you can use:
+    #
+    # image, description, keywords = YamlRpc.decode_to_ary(params, [:image, :description, :keywords])
+    #
+    # * <tt>params</tt> Hash
+    # * <tt>fields</tt> Optional, single field name or array of field names, ie. [:foo, :bar]
+    def decode_to_ary(params, fields)
+      fields = fields.is_a?(Array) ? fields : [ fields ]
+      fields.map { |k| YAML::load(params[k] || "--- \n") }
+    end
+
+  end
+
+end

data/lib/yamlrpc.rb

@@ -1,4 +1,5 @@
 require 'yaml'
 require 'net/http'
 
+require 'yamlrpc/helpers'
 require 'yamlrpc/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yamlrpc
 version: !ruby/object:Gem::Version 
-  version: 0.1.080624130617
+  version: 0.1.080630154212
 platform: ruby
 authors: 
 - Mirek Rusin
@@ -9,7 +9,7 @@ autorequire: yamlrpc
 bindir: bin
 cert_chain: []
 
-date: 2008-06-24 00:00:00 +01:00
+date: 2008-06-30 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -24,6 +24,7 @@ extra_rdoc_files:
 files: 
 - lib/yamlrpc
 - lib/yamlrpc/client.rb
+- lib/yamlrpc/helpers.rb
 - lib/yamlrpc.rb
 - README
 has_rdoc: true