xmlrpc-endpoint 0.1.1 → 0.2.0

data/README.rdoc

@@ -2,22 +2,53 @@
 
 Rails has native support for xmlrpc.  Most people are familiar with the 'xmlrpc/client' library.  The 'xmlrpc/server' library examples mostly make an assumption that you will run a standalone server.
 
-xmlrpc-endpoint allows you to expose normal Rails controller methods via XMLRPC, tied to a single xmlrpc endpoint route in your normal app.
+xmlrpc-endpoint allows you to instead expose normal Rails controller methods via XMLRPC, tied to an xmlrpc endpoint route in your app.
 
+Install
+
+  gem install xmlrpc-endpoint
+  config.gem "xmlrpc-endpoint" (inside environment.rb Rails::Initializer block)
+            -- OR --
+  ./script/plugin install git://github.com/wkoffel/xmlrpc-endpoint.git
+  
 Setup your environment
 
-*  gem install xmlrpc-endpoint
-*  include ActionController::Acts::XmlrpcEndpoint somewhere in your environment
-*  set up a route to the action "index" in your controller (this action will be created for you by the xmlrpc-endpoint)
+  # set up a route to the controller action "xe_index" in your routes.rb file
+  # (this "xe_index" action will be created for you by the xmlrpc-endpoint, the route must point at 'xe_index' action to work)
+  # In a future release, xmlrpc-endpoint may support auto-generation of this route, and customization
+  
+  map.connect 'api/xmlrpc', :controller => 'my_api_controller', :action => 'xe_index'
 
 Add this code to your controller:
 
   class MyApiController < ApplicationController
     exposes_xmlrpc_methods
+    
+    def hello_world
+      puts "Hello XMLRPC."
+    end
   end
 
 Then, pointing an XMLRPC client at the defined route, your normal controller actions will handle the requests.
 
+  require 'xmlrpc/client'
+  server = XMLRPC::Client.new2("http://localhost:3000/api/xmlrpc")
+  server.call("hello_world")
+
+To use a custom namespace prefix on all exposed methods (for example, if using someone else's specified protocol like MetaWeblog[http://www.xmlrpc.com/metaWeblogApi]), declare a method_prefix:
+
+  class MyApiController < ApplicationController
+    exposes_xmlrpc_methods :method_prefix => "metaWeblog."
+    
+    # This method will be exposed externally as "metaWeblog.newPost()"
+    def newPost(blogid, username, password, struct, publish)
+    ...
+    end
+  end
+
+Thanks to Nathan Crause for saving me some time on the details of avoiding the standalone server.
+http://nathan.crause.name/entries/programming/xlm-rpc-under-ruby-on-rails
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/doc/created.rid

@@ -1 +1 @@
-Fri, 01 Jan 2010 15:19:07 -0500
+Fri, 01 Jan 2010 16:09:53 -0500

data/doc/files/README_rdoc.html

@@ -56,7 +56,7 @@
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Jan 01 15:19:02 -0500 2010</td>
+      <td>Fri Jan 01 16:09:48 -0500 2010</td>
     </tr>
     </table>
   </div>
@@ -77,37 +77,72 @@ library examples mostly make an assumption that you will run a standalone
 server.
 </p>
 <p>
-xmlrpc-endpoint allows you to expose normal Rails controller methods via
-XMLRPC, tied to a single xmlrpc endpoint route in your normal app.
+xmlrpc-endpoint allows you to instead expose normal Rails controller
+methods via XMLRPC, tied to an xmlrpc endpoint route in your app.
 </p>
 <p>
+Install
+</p>
+<pre>
+  gem install xmlrpc-endpoint
+  config.gem &quot;xmlrpc-endpoint&quot; (inside environment.rb Rails::Initializer block)
+            -- OR --
+  ./script/plugin install git://github.com/wkoffel/xmlrpc-endpoint.git
+</pre>
+<p>
 Setup your environment
 </p>
-<ul>
-<li>gem install xmlrpc-endpoint
-
-</li>
-<li>include ActionController::Acts::XmlrpcEndpoint somewhere in your
-environment
-
-</li>
-<li>set up a route to the action &quot;index&quot; in your controller (this
-action will be created for you by the xmlrpc-endpoint)
+<pre>
+  # set up a route to the action &quot;xe_index&quot; in your controller
+  # (this &quot;xe_index&quot; action will be created for you by the xmlrpc-endpoint, the route must point at 'xe_index' action to work)
+  # In a future release, xmlrpc-endpoint may support auto-generation of this route, and customization
 
-</li>
-</ul>
+  map.connect 'api/xmlrpc', :controller =&gt; 'my_api_controller', :action =&gt; 'xe_index'
+</pre>
 <p>
 Add this code to your controller:
 </p>
 <pre>
   class MyApiController &lt; ApplicationController
     exposes_xmlrpc_methods
+
+    def hello_world
+      puts &quot;Hello XMLRPC.&quot;
+    end
   end
 </pre>
 <p>
 Then, pointing an XMLRPC client at the defined route, your normal
 controller actions will handle the requests.
 </p>
+<pre>
+  require 'xmlrpc/client'
+  server = XMLRPC::Client.new2(&quot;http://localhost:3000/api/xmlrpc&quot;)
+  server.call(&quot;hello_world&quot;)
+</pre>
+<p>
+To use a custom namespace prefix on all exposed methods (for example, if
+using someone else&#8216;s specified protocol like <a
+href="http://www.xmlrpc.com/metaWeblogApi">MetaWeblog</a>), declare a
+method_prefix:
+</p>
+<pre>
+  class MyApiController &lt; ApplicationController
+    exposes_xmlrpc_methods :method_prefix =&gt; &quot;metaWeblog.&quot;
+
+    # This method will be exposed externally as &quot;metaWeblog.newPost()&quot;
+    def newPost(blogid, username, password, struct, publish)
+    ...
+    end
+
+    etc.
+  end
+</pre>
+<p>
+Thanks to Nathan Crause for saving me some time on the details of avoiding
+the standalone server. <a
+href="http://nathan.crause.name/entries/programming/xlm-rpc-under-ruby-on-rails">nathan.crause.name/entries/programming/xlm-rpc-under-ruby-on-rails</a>
+</p>
 <h2>Note on Patches/Pull Requests</h2>
 <ul>
 <li>Fork the project.

data/lib/action_controller/acts/xmlrpc_endpoint.rb

@@ -7,7 +7,7 @@ module ActionController
 
       module ClassMethods
         def exposes_xmlrpc_methods(options = {})
-          configuration = { :method_prefix => nil, :endpoint_action => "index" }
+          configuration = { :method_prefix => nil }
           configuration.update(options) if options.is_a?(Hash)
           
           before_filter(:add_method_handlers, :only => [:index])
@@ -15,7 +15,7 @@ module ActionController
             require 'xmlrpc/server'
             include ActionController::Acts::XmlrpcEndpoint::InstanceMethods
 
-            def method_prefix
+            def xe_method_prefix
               '#{configuration[:method_prefix]}'
             end
           EOV
@@ -23,9 +23,8 @@ module ActionController
       end
 
       module InstanceMethods
-        # TODO: name this via the endpoint_action option instead of hardcoding to "index"
         # TODO: add route automatically for this?
-        def index
+        def xe_index
           result = @xmlrpc_server.process(request.body)
           puts "\n\n----- BEGIN RESULT -----\n#{result}----- END RESULT -----\n\n"
           render :text => result, :content_type => 'text/xml'
@@ -37,9 +36,9 @@ module ActionController
           @xmlrpc_server = XMLRPC::BasicServer.new
           # loop through all the methods, adding them as handlers
           self.class.instance_methods(false).each do |method|
-            unless ['index'].member?(method)
+            unless ['xe_index', 'xe_method_prefix'].member?(method)
               puts "Adding XMLRPC method for #{method.to_s}"
-              @xmlrpc_server.add_handler(method_prefix + method) do |*args|
+              @xmlrpc_server.add_handler(xe_method_prefix + method) do |*args|
                 self.send(method.to_sym, *args)
               end
             end

data/xmlrpc-endpoint.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{xmlrpc-endpoint}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Will Koffel"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: xmlrpc-endpoint
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Will Koffel