yamlrpc 0.2.3 → 1.0.0

data/Manifest.txt

@@ -5,9 +5,110 @@ Rakefile
 lib/yamlrpc/client.rb
 lib/yamlrpc/helpers.rb
 lib/yamlrpc.rb
-examples/common_root_example.rb
-examples/helper.rb
-examples/image_example.rb
-examples/pdf_example.pdf
-examples/pdf_example.rb
-examples/simple_example.rb
+examples
+examples/examples_helper.rb
+examples/girlfriend.jpg
+examples/rails_basic_add_foo_bar.rb
+examples/rails_basic_hello_world.rb
+examples/rails_basic_hello_world_with_status.rb
+examples/rails_basic_redirect_to_hello_world.rb
+examples/rails_basic_redirect_twice_to_hello_world.rb
+examples/rails_basic_unnamed_arguments.rb
+examples/rails_basic_upload_image.rb
+examples/rails_example
+examples/rails_example/app
+examples/rails_example/app/controllers
+examples/rails_example/app/controllers/api
+examples/rails_example/app/controllers/api/authenticated_controller.rb
+examples/rails_example/app/controllers/api/basic_controller.rb
+examples/rails_example/app/controllers/application.rb
+examples/rails_example/app/helpers
+examples/rails_example/app/helpers/api
+examples/rails_example/app/helpers/api/authenticated_helper.rb
+examples/rails_example/app/helpers/api/basic_helper.rb
+examples/rails_example/app/helpers/application_helper.rb
+examples/rails_example/app/models
+examples/rails_example/app/views
+examples/rails_example/app/views/api
+examples/rails_example/app/views/api/authenticated
+examples/rails_example/app/views/api/basic
+examples/rails_example/app/views/layouts
+examples/rails_example/config
+examples/rails_example/config/boot.rb
+examples/rails_example/config/database.yml
+examples/rails_example/config/environment.rb
+examples/rails_example/config/environments
+examples/rails_example/config/environments/development.rb
+examples/rails_example/config/environments/production.rb
+examples/rails_example/config/environments/test.rb
+examples/rails_example/config/initializers
+examples/rails_example/config/initializers/inflections.rb
+examples/rails_example/config/initializers/mime_types.rb
+examples/rails_example/config/routes.rb
+examples/rails_example/db
+examples/rails_example/db/development.sqlite3
+examples/rails_example/doc
+examples/rails_example/doc/README_FOR_APP
+examples/rails_example/lib
+examples/rails_example/lib/tasks
+examples/rails_example/log
+examples/rails_example/log/development.log
+examples/rails_example/log/test.log
+examples/rails_example/public
+examples/rails_example/public/.htaccess
+examples/rails_example/public/404.html
+examples/rails_example/public/422.html
+examples/rails_example/public/500.html
+examples/rails_example/public/dispatch.cgi
+examples/rails_example/public/dispatch.fcgi
+examples/rails_example/public/dispatch.rb
+examples/rails_example/public/favicon.ico
+examples/rails_example/public/images
+examples/rails_example/public/images/rails.png
+examples/rails_example/public/index.html
+examples/rails_example/public/javascripts
+examples/rails_example/public/javascripts/application.js
+examples/rails_example/public/javascripts/controls.js
+examples/rails_example/public/javascripts/dragdrop.js
+examples/rails_example/public/javascripts/effects.js
+examples/rails_example/public/javascripts/prototype.js
+examples/rails_example/public/robots.txt
+examples/rails_example/public/stylesheets
+examples/rails_example/Rakefile
+examples/rails_example/README
+examples/rails_example/script
+examples/rails_example/script/about
+examples/rails_example/script/console
+examples/rails_example/script/destroy
+examples/rails_example/script/generate
+examples/rails_example/script/performance
+examples/rails_example/script/performance/benchmarker
+examples/rails_example/script/performance/profiler
+examples/rails_example/script/performance/request
+examples/rails_example/script/plugin
+examples/rails_example/script/process
+examples/rails_example/script/process/inspector
+examples/rails_example/script/process/reaper
+examples/rails_example/script/process/spawner
+examples/rails_example/script/runner
+examples/rails_example/script/server
+examples/rails_example/test
+examples/rails_example/test/fixtures
+examples/rails_example/test/functional
+examples/rails_example/test/functional/api
+examples/rails_example/test/functional/api/authenticated_controller_test.rb
+examples/rails_example/test/functional/api/basic_controller_test.rb
+examples/rails_example/test/integration
+examples/rails_example/test/mocks
+examples/rails_example/test/mocks/development
+examples/rails_example/test/mocks/test
+examples/rails_example/test/test_helper.rb
+examples/rails_example/test/unit
+examples/rails_example/tmp
+examples/rails_example/tmp/cache
+examples/rails_example/tmp/pids
+examples/rails_example/tmp/sessions
+examples/rails_example/tmp/sockets
+examples/rails_example/vendor
+examples/rails_example/vendor/plugins
+examples/README.txt

data/README.txt

@@ -1,17 +1,46 @@
-= YamlRpc -- simple RPC client
+= YamlRpc -- advanced RPC client on YAML
 
-client = YamlRpc::Client.new('http://localhost:3000/somewhere/')
-# Invokes http://localhost:3000/somewhere/my_method passing POST data { :test => 'My test' } as YAML
-result = client.my_method( :test => 'My test' )
+Supports:
 
-# Result is YAML which is loaded and returned as object
-puts result['my_response_message']
+* Data types (String, Regexp, Arrays, Hashes etc.)
+* Passing images, PDFs and other binary data so easy you don't even think about it
+* HTTP redirects
+* HTTP Authentication
+
+Simple to use:
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic')
+
+client.add_foo_bar( :foo => 3, :bar => 5 )            # -> { :result => 8 }
+client.add(7, 11)                                     # -> 18
+client.upload(:image => open('image.gif', 'rb').read) # -> uploads image
+
+Example add_foo_bar POSTs:
+
+  http://localhost:3000/api/basic/add_foo_bar
+
+passing POST data:
+
+  yamlrpc=---%20%0A:foo:%203%0A:bar:%205%0A
+
+which can be captured in any language like PHP, Java or Ruby, ie. Ruby on Rails:
+
+  class Api::BasicController < ApplicationController 
+    def add_foo_bar
+      @yamlrpc = YAML.load(params[:yamlrpc])
+      render :text => (@yamlrpc[:foo] + @yamlrpc[:bar]).to_yaml
+    end
+  end
+
+Result is returned as YAML as well and automatically decoded.
+
+See /examples dir for more examples.
 
 == Download
 
-The latest version of Csv2sql can be found at
+The latest version:
 
-* http://mirekrusin.com/ruby/yamlrpc
+* http://svn.mirekrusin.com/ruby/yamlrpc/trunk
 
 == Installation
 
@@ -19,11 +48,11 @@ gem install yamlrpc
 
 == License
 
-Csv2sql is released under the LGPL license.
+This library is released under the LGPL license.
 
 == Support
 
-The Csv2sql homepage is http://mirekrusin.com/ruby/yamlrpc
+The homepage is located under http://www.rubyforge/projects/yamlrpc
 
 For other information, feel free to ask on the ruby-talk mailing list
 (which is mirrored to comp.lang.ruby) or contact mailto:ruby@mirekrusin.com 

data/Rakefile

@@ -1,23 +1,31 @@
-
-require 'rubygems'
-require 'hoe'
-
-$:.unshift(File.dirname(__FILE__) + "/lib")
-require 'yamlrpc'
-
-Hoe.new('YamlRpc', YamlRpc::VERSION) do |p|
-  p.name            = "yamlrpc"
-  p.author          = "Mirek Rusin"
-  p.email           = 'ruby@mirekrusin.com'
-  p.summary         = "YamlRpc is a simple RPC client based on YAML"
-  p.description     = "YamlRpc is a simple RPC client based on YAML"
-  p.url             = "http://rubyforge.com/projects/yamlrpc"
-  p.clean_globs     = ['test/actual'] # Remove this directory on "rake clean"
-  p.remote_rdoc_dir = '' # Release to root
-  p.changes         = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
-  p.rsync_args     << ' --exclude=statsvn/'
-  # * extra_deps - An array of rubygem dependencies.
-end
-
-desc "Release and publish documentation"
-task :default => [:release, :publish_docs]
+
+require 'rubygems'
+require 'hoe'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'yamlrpc'
+
+RUBYFORGE_PROJECT = 'yamlrpc'
+
+Hoe.new('YamlRpc', YamlRpc::VERSION) do |p|
+  p.name            = RUBYFORGE_PROJECT
+  p.author          = "Mirek Rusin"
+  p.email           = 'ruby@mirekrusin.com'
+  p.summary         = "YamlRpc is a simple RPC client based on YAML"
+  p.description     = "YamlRpc is a simple RPC client based on YAML"
+  p.url             = "http://rubyforge.com/projects/#{RUBYFORGE_PROJECT}"
+  p.clean_globs     = ['test/actual'] # Remove this directory on "rake clean"
+  p.remote_rdoc_dir = '' # Release to root
+  p.changes         = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
+  #p.rsync_args     << ' --exclude=statsvn/'
+  # * extra_deps - An array of rubygem dependencies.
+end
+
+desc 'Publish RDoc to RubyForge via pscp'
+task :publish_docs_via_pscp => [:clean, :docs] do
+  config = YAML.load(File.read(File.expand_path("~/.rubyforge/user-config.yml")))
+  sh %{pscp -r doc/* #{config["username"]}@rubyforge.org:/var/www/gforge-projects/#{RUBYFORGE_PROJECT}/}
+end 
+
+desc "Release and publish documentation"
+task :default => [:release, :publish_docs_via_pscp]

data/examples/README.txt

@@ -0,0 +1,8 @@
+
+To launch rails_* tests run rails_test Ruby on Rails server first.
+
+Make sure you've got sqlite3:
+
+gem install sqlite3-ruby
+
+and on Windows download http://www.sqlite.org/sqlitedll-3_5_9.zip and extrace to c:\Windows\System32 

data/examples/examples_helper.rb

@@ -0,0 +1,5 @@
+
+require 'pp'
+
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'yamlrpc'

data/examples/rails_basic_add_foo_bar.rb

@@ -0,0 +1,6 @@
+
+require 'examples_helper'
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic/')
+
+puts client.add_foo_bar(:foo => 3, :bar => 5)

data/examples/rails_basic_hello_world.rb

@@ -0,0 +1,6 @@
+
+require 'examples_helper'
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic/')
+
+pp client.hello_world

data/examples/rails_basic_hello_world_with_status.rb

@@ -0,0 +1,8 @@
+
+require 'examples_helper'
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic/')
+
+response = client.hello_world_with_status
+puts response[:status]
+puts response[:message]

data/examples/rails_basic_redirect_to_hello_world.rb

@@ -0,0 +1,6 @@
+
+require 'examples_helper'
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic/')
+
+puts client.redirect_to_hello_world

data/examples/rails_basic_redirect_twice_to_hello_world.rb

@@ -0,0 +1,6 @@
+
+require 'examples_helper'
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic/')
+
+puts client.redirect_twice_to_hello_world

data/examples/rails_basic_unnamed_arguments.rb

@@ -0,0 +1,6 @@
+
+require 'examples_helper'
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic/')
+
+pp client.unnamed_arguments(1, 2, :foo, 'bar')

data/examples/rails_basic_upload_image.rb

@@ -0,0 +1,9 @@
+
+require 'examples_helper'
+
+client = YamlRpc::Client.new('http://localhost:3000/api/basic/')
+
+pp client.upload_image({
+  :image   => open('girlfriend.jpg', 'rb').read,
+  :save_as => 'julie.jpg'
+})

data/examples/rails_example/README

@@ -0,0 +1,203 @@
+== Welcome to Rails
+
+Rails is a web-application and persistence framework that includes everything
+needed to create database-backed web-applications according to the
+Model-View-Control pattern of separation. This pattern splits the view (also
+called the presentation) into "dumb" templates that are primarily responsible
+for inserting pre-built data in between HTML tags. The model contains the
+"smart" domain objects (such as Account, Product, Person, Post) that holds all
+the business logic and knows how to persist themselves to a database. The
+controller handles the incoming requests (such as Save New Account, Update
+Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+   (If you've downloaded Rails in a complete tgz or zip, this step is already done)
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You’re riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
+Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.erb. Inside default.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  This directory is in the load path.

data/examples/rails_example/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/examples/rails_example/app/controllers/api/authenticated_controller.rb

@@ -0,0 +1,2 @@
+class Api::AuthenticatedController < ApplicationController
+end

data/examples/rails_example/app/controllers/api/basic_controller.rb

@@ -0,0 +1,68 @@
+class Api::BasicController < ApplicationController
+
+  before_filter :set_yamlrpc
+
+  # Simple hellow world example
+  def hello_world
+    render :text => 'Hello World!'.to_yaml
+  end
+  
+  # Hello world example with status and message response
+  def hello_world_with_status
+    render :text => {
+      :status  => :ok,
+      :message => 'Hello World!'
+    }.to_yaml
+  end
+  
+  # Unnamed arguments example, ie: client.unnamed_arguments(1, 2, 'foo', 'bar')
+  def unnamed_arguments
+    render :text => {
+      :response => @yamlrpc.map { |e| "#{e.to_s} in response!" }
+    }.to_yaml
+  end
+  
+  # Add two arguments and return result example
+  def add_foo_bar
+    render :text => (@yamlrpc[:foo] + @yamlrpc[:bar]).to_yaml
+  end
+  
+  # Upload binary image example
+  # Uploaded image is saved to #{RAILS_ROOT}/public/images/#{@yamlrpc[:save_as]}
+  # Returns:
+  # * <tt>:status</tt> :ok on success, :error on error
+  # * <tt>:message</tt> Descriptive response message
+  def upload_image
+    begin
+      file = open("#{RAILS_ROOT}/public/images/#{@yamlrpc[:save_as]}", "wb")
+      file.write @yamlrpc[:image]
+      file.close
+      status  = :ok
+      message = 'Image uploaded successfully'
+    rescue StandardError => ex
+      status  = :error
+      message = ex.message
+    end
+    render :text => {
+      :status  => status,
+      :message => message
+    }.to_yaml
+  end
+
+  def redirect_to_hello_world
+    redirect_to :action => 'hello_world'
+  end
+
+  def redirect_twice_to_hello_world
+    redirect_to :action => 'redirect_to_hello_world'
+  end
+
+protected
+
+  def set_yamlrpc
+    if request.post? && params[:yamlrpc]
+      @yamlrpc = YAML.load(params[:yamlrpc] || "--- \n")
+    end
+  end
+  
+end

data/examples/rails_example/app/controllers/application.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => '49596d8b57f7619503bc50f5331b44bd'
+end

data/examples/rails_example/app/helpers/api/authenticated_helper.rb

@@ -0,0 +1,2 @@
+module Api::AuthenticatedHelper
+end

data/examples/rails_example/app/helpers/api/basic_helper.rb

@@ -0,0 +1,2 @@
+module Api::BasicHelper
+end

data/examples/rails_example/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end