yamlrpc 0.2.3 → 1.0.0

data/examples/rails_example/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/examples/rails_example/script/about

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/about'

data/examples/rails_example/script/console

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/console'

data/examples/rails_example/script/destroy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/destroy'

data/examples/rails_example/script/generate

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/generate'

data/examples/rails_example/script/performance/benchmarker

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/benchmarker'

data/examples/rails_example/script/performance/profiler

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/profiler'

data/examples/rails_example/script/performance/request

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/performance/request'

data/examples/rails_example/script/plugin

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/plugin'

data/examples/rails_example/script/process/inspector

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/inspector'

data/examples/rails_example/script/process/reaper

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/reaper'

data/examples/rails_example/script/process/spawner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../../config/boot'
+require 'commands/process/spawner'

data/examples/rails_example/script/runner

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/runner'

data/examples/rails_example/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/server'

data/examples/rails_example/test/functional/api/authenticated_controller_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class Api::AuthenticatedControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/rails_example/test/functional/api/basic_controller_test.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class Api::BasicControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  def test_truth
+    assert true
+  end
+end

data/examples/rails_example/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class Test::Unit::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/lib/yamlrpc/client.rb

@@ -2,8 +2,8 @@
 #
 # Example usage:
 #
-#   yaml_rpc = YamlRpc.new('http://rubyforge.org/projects/yamlrpc/')
-#   yaml_rpc.foo({
+#   yamlrpc = YamlRpc.new('http://rubyforge.org/projects/yamlrpc/')
+#   yamlrpc.foo({
 #     :bar => 'foo-bar'
 #   )
 #
@@ -17,11 +17,11 @@
 #
 # On the server side you can use (Ruby on Rails):
 # 
-#   YAML::load(params[:yaml_rpc])[:foo]
+#   YAML::load(params[:yamlrpc])[:foo]
 #
 # or in PHP:
 #
-#   $data = syck_load($_POST['yaml_rpc']);
+#   $data = syck_load($_POST['yamlrpc']);
 #   $data['foo']
 #
 # See examples in /examples directory
@@ -29,62 +29,89 @@ module YamlRpc
   
   class Client
     
-    DEFAULT_FORM_DATA_ROOT = :yaml_rpc
+    DEFAULT_FORM_DATA_ROOT = :yamlrpc
     DEFAULT_OPEN_TIMEOUT   = 120 # 2 minutes
     DEFAULT_READ_TIMEOUT   = 120 # 2 minutes
     
-    attr_accessor :url
+    attr_accessor :uri
     attr_accessor :form_data_root
     attr_accessor :open_timeout
     attr_accessor :read_timeout
+    attr_accessor :user
+    attr_accessor :password
+    attr_accessor :permanent_data
     
-    # * <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>uri</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 :yamlrpc, meaning all params are passed inside :yamlrpc form field
-    def initialize(url, options = {})
-      @open_timeout = options[:open_timeout]
-      @read_timeout = options[:read_timeout]
-      @url = url
-      @form_data_root = options.has_key?(:form_data_root) ? options[:form_data_root] : DEFAULT_FORM_DATA_ROOT
+    #   * <tt>:open_timeout</tt> Open timeout
+    #   * <tt>:read_timeout</tt> Read timeout
+    #   * <tt>:user</tt> Basic http auth, user name
+    #   * <tt>:password</tt> Basic http auth, password
+    def initialize(uri, options = {})
+      @open_timeout   = options[:open_timeout]
+      @read_timeout   = options[:read_timeout]
+      @user           = options[:user]
+      @password       = options[:password]
+      @permanent_data = options[:permanent_data]
+      @uri            = URI.parse(uri.to_s)
+      @form_data_root = options[:form_data_root] || DEFAULT_FORM_DATA_ROOT
     end
     
-    # * <tt>method</tt> Method name
+    # * <tt>uri</tt> Method name (mainly) or full uri (to support redirects to other domains)
     # * <tt>args</tt> Arguments, nil or Hash of values
-    def method_missing(method, args = {})
-      post(method, args)
+    def method_missing(uri, *args)
+      args = args.first if args.size == 1 && args.first.is_a?(Hash)
+      uri = URI.parse(uri.to_s)
+      if uri.host.nil?
+        uri.host = @uri.host
+        uri.port = @uri.port
+      end
+      uri.path = "#{@uri.path}#{uri.path}" unless uri.path =~ /^\//
+      post(uri, args)
     end
 
   protected
 
-    # * <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(args_to_form_data(args), ';')
-      http = Net::HTTP.new(url.host, url.port)
+    # * <tt>uri</tt> URI instance
+    # * <tt>args</tt> Optional data to be passed as POST fields, ie: { :status => 'SUCCESS', :message => 'All ok' }
+    def post(uri, args = nil)
+      req = Net::HTTP::Post.new(uri.path)
+      req.set_form_data(args_to_form_data(args) || {}, ';')
+      #req.basic_auth @user, @password if @user && @password
+      http = Net::HTTP.new(uri.host, uri.port)
       http.open_timeout = @open_timeout
       http.read_timeout = @read_timeout
       res = http.start { |http| http.request(req) }
       case res
         when Net::HTTPSuccess
           YAML::load(res.body)
+        when Net::HTTPRedirection
+          redirect_uri = URI.parse(res['location'])
+          if redirect_uri.host.nil?
+            redirect_uri.host = uri.host
+            redirect_uri.port = uri.port
+          end
+          post(redirect_uri, args)
         else
           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) }
+    # POST form data is always passed in YamlRpc#form_data_root variable name
+    # * <tt>args</tt>
+    def args_to_form_data(args = nil)
+      args = @permanent_data if args.nil? # HACK: this is hack as hell but logically ok for merging to work for nil args
+      unless @permanent_data.nil?
+        if @permanent_data.respond_to?('merge')
+          args = @permanent_data.merge(args)
+        elsif @permanent_data.respond_to?('+')
+          args = @permanent_data + args
+        else
+          raise ArgumentError.new("Can't merge #{@permanent_data.class} and #{args.class}")
+        end
       end
-      r
+      { @form_data_root.to_sym => YAML::dump(args) }
     end
   
   end

data/lib/yamlrpc.rb

@@ -28,5 +28,5 @@ require 'yamlrpc/helpers'
 require 'yamlrpc/client'
 
 module YamlRpc
-  VERSION = '0.2.3'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yamlrpc
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Mirek Rusin
@@ -32,6 +32,8 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
+- examples/rails_example/public/robots.txt
+- examples/README.txt
 files: 
 - History.txt
 - Manifest.txt
@@ -40,12 +42,113 @@ files:
 - 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
 has_rdoc: true
 homepage: http://rubyforge.com/projects/yamlrpc
 post_install_message: 

data/examples/common_root_example.rb

@@ -1,13 +0,0 @@
-
-require 'helper'
-
-client = YamlRpc::Client.new('http://localhost:3000/site/', :form_data_root => :yaml_rpc)
-
-pp client.create_online_sales_order( :test => 'My test', :test2 => 'My test2' )[:response]
-
-# On the server side, if you're using Ruby on Rails you may want to:
-#
-# def create_online_sales_order
-#   rpc_params = YamlRpc.decode(params[:yaml_rpc])
-#   render => YAML::dump({ :response => "Got your #{rpc_params.inspect}!" })
-# end

data/examples/helper.rb

@@ -1,3 +0,0 @@
-$:.unshift '../lib'
-require 'yamlrpc'
-require 'pp'

data/examples/image_example.rb

@@ -1,15 +0,0 @@
-
-require 'helper'
-require 'open-uri'
-
-client = YamlRpc::Client.new('http://localhost:3000/site/')
-
-image = open('http://www.google.co.uk/intl/en_uk/images/logo.gif').read
-
-pp client.send_image( :image => image )
-
-# On the server side, if you're using Ruby on Rails you may want to:
-#
-# rpc_params = YamlRpc.decode(params, [:image])
-# send_data rpc_params[:image],
-#           :content_type => 'image/gif'

data/examples/pdf_example.rb

@@ -1,26 +0,0 @@
-
-require 'helper'
-require 'open-uri'
-
-client = YamlRpc::Client.new('http://www.pdfonrails.com/api/yaml_rpc/')
-
-params = {
-  :layout => 'basic',
-  :html   => <<END
-    <h1>Hello world!</h1>
-    <p>
-      Hello <b>PDF</b> world!
-    </p>
-    <p>
-      <ul>
-        <li>Hello
-        <li><i>World</i>
-        <li>!!!
-      </ul>
-    </p>
-END
-}
-
-pdf = open('pdf_example.pdf', 'wb')
-pdf.write(client.pdf(params)[:pdf])
-pdf.close

data/examples/simple_example.rb

@@ -1,13 +0,0 @@
-
-require 'helper'
-
-client = YamlRpc::Client.new('http://localhost:3000/site/')
-
-pp client.create_online_sales_order( :test => 'My test' )[:response]
-
-# On the server side, if you're using Ruby on Rails you may want to:
-#
-# def create_online_sales_order
-#   rpc_params = YamlRpc.decode(params, [:test])
-#   render => YAML::dump({ :response => "Got your #{rpc_params[:test]}!" })
-# end