xmlrpc-endpoint 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/README.rdoc

@@ -0,0 +1,35 @@
+= xmlrpc-endpoint
+
+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.
+
+Setup
+<tt>
+  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)
+</tt>
+
+Code
+<tt>
+class MyApiController < ApplicationController
+  exposes_xmlrpc_methods
+end
+</tt>
+
+Then, pointing an XMLRPC client at the defined route, your normal controller actions will handle the requests.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Will Koffel, released under the MIT license.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "xmlrpc-endpoint"
+    gem.summary = %Q{Expose Rails controller actions as XMLRPC method calls.}
+    gem.description = %Q{Expose Rails controller actions as XMLRPC method calls.}
+    gem.email = "wkoffel@alum.mit.edu"
+    gem.homepage = "http://github.com/wkoffel/xmlrpc-endpoint"
+    gem.authors = ["Will Koffel"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "xmlrpc-endpoint #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,2 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+ActionController::Base.send(:include, ActionController::Acts::XmlrpcEndpoint )

data/lib/action_controller/acts/xmlrpc_endpoint.rb

@@ -0,0 +1,51 @@
+module ActionController
+  module Acts
+    module XmlrpcEndpoint
+      def self.included(controller)
+        controller.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def exposes_xmlrpc_methods(options = {})
+          configuration = { :method_prefix => nil, :endpoint_action => "index" }
+          configuration.update(options) if options.is_a?(Hash)
+          
+          before_filter(:add_method_handlers, :only => [:index])
+          class_eval <<-EOV
+            require 'xmlrpc/server'
+            include ActionController::Acts::XmlrpcEndpoint::InstanceMethods
+
+            def method_prefix
+              '#{configuration[:method_prefix]}'
+            end
+          EOV
+        end
+      end
+
+      module InstanceMethods
+        # TODO: name this via the endpoint_action option instead of hardcoding to "index"
+        # TODO: add route automatically for this?
+        def 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'
+        end
+
+        private
+      
+        def add_method_handlers
+          @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)
+              puts "Adding XMLRPC method for #{method.to_s}"
+              @xmlrpc_server.add_handler(method_prefix + method) do |*args|
+                self.send(method.to_sym, *args)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'xmlrpc-endpoint'
+
+class Test::Unit::TestCase
+end

data/test/test_xmlrpc-endpoint.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestXmlrpcEndpoint < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: xmlrpc-endpoint
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Will Koffel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Expose Rails controller actions as XMLRPC method calls.
+email: wkoffel@alum.mit.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/action_controller/acts/xmlrpc_endpoint.rb
+- test/helper.rb
+- test/test_xmlrpc-endpoint.rb
+has_rdoc: true
+homepage: http://github.com/wkoffel/xmlrpc-endpoint
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Expose Rails controller actions as XMLRPC method calls.
+test_files: 
+- test/helper.rb
+- test/test_xmlrpc-endpoint.rb