em-xmlrpc-client 1.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+vendor/bundle
+doc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in em-xmlrpc-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    em-xmlrpc-client (1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.1.8)
+    em-http-request (0.3.0)
+      addressable (>= 2.0.0)
+      escape_utils
+      eventmachine (>= 0.12.9)
+    escape_utils (0.2.3)
+    eventmachine (0.12.10)
+    rr (1.0.3)
+    webmock (1.6.4)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  em-http-request
+  em-xmlrpc-client!
+  eventmachine
+  rr
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Christopher J. Bottaro
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,31 @@
+= em-xmlrpc-client
+
+This gem monkey patches Ruby's built in XMLRPC::Client to be EventMachine + Fiber aware.  If you are not using EventMachine (or the reactor isn't running), then it will fallback to using XMLRPC::Client's default implemenation (using Net::HTTP).
+
+== Example
+
+  require "eventmachine"
+  require "em-xmlrpc-client"
+
+  EM.run do
+    Fiber.new do
+      client = XMLRPC::Client.new2("http://blah.com/api")
+      result = client.call("someMethod", "arg1", 123) # Uses em-http-request.
+    end.resume
+  end
+
+
+  client = XMLRPC::Client.new2("http://blah.com/api")
+  result = client.call("someMethod", "arg1", 123) # Uses Net::HTTP like normal.
+
+== Dependencies
+
+{em-http-request}[https://github.com/igrigorik/em-http-request] is required if you want to use the EventMachine + Fiber aware implementation.
+
+== Author
+
+Christopher J. Bottaro
+
+{\https://github.com/cjbottaro}[https://github.com/cjbottaro]
+
+@cjbottaro

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end

data/VERSION

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

data/em-xmlrpc-client.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "em-xmlrpc-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "em-xmlrpc-client"
+  s.version     = Em::Xmlrpc::Client::VERSION
+  s.authors     = ["Christopher J. Bottaro"]
+  s.email       = ["cjbottaro@alumni.cs.utexas.edu"]
+  s.homepage    = ""
+  s.summary     = %q{Evented and fibered XMLRPC Client}
+  s.description = %q{Monkey patches Ruby's standard XMLRPC Client to use EventMachine and fibers}
+
+  s.rubyforge_project = "em-xmlrpc-client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "eventmachine"
+  s.add_development_dependency "em-http-request"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "rr"
+
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/em-xmlrpc-client/version.rb

@@ -0,0 +1,7 @@
+module Em
+  module Xmlrpc
+    module Client
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/em-xmlrpc-client.rb

@@ -0,0 +1,189 @@
+require "em-xmlrpc-client/version"
+require "xmlrpc/client"
+
+module XMLRPC
+  class Client
+
+    def initialize(host=nil, path=nil, port=nil, proxy_host=nil, proxy_port=nil,
+                   user=nil, password=nil, use_ssl=nil, timeout=nil)
+
+      @http_header_extra = nil
+      @http_last_response = nil
+      @cookie = nil
+
+      @host       = host || "localhost"
+      @path       = path || "/RPC2"
+      @proxy_host = proxy_host
+      @proxy_port = proxy_port
+      @proxy_host ||= 'localhost' if @proxy_port != nil
+      @proxy_port ||= 8080 if @proxy_host != nil
+      @use_ssl    = use_ssl || false
+      @timeout    = timeout || 30
+
+      if use_ssl
+        require "net/https"
+        @port = port || 443
+      else
+        @port = port || 80
+      end
+
+      @user, @password = user, password
+
+      set_auth
+
+      # convert ports to integers
+      @port = @port.to_i if @port != nil
+      @proxy_port = @proxy_port.to_i if @proxy_port != nil
+
+      if defined?(EM) and EM.reactor_running?
+        require "em-http"
+        require "ostruct"
+        require "fiber"
+      else
+        # HTTP object for synchronous calls
+        Net::HTTP.version_1_2
+        @http = Net::HTTP.new(@host, @port, @proxy_host, @proxy_port)
+        @http.use_ssl = @use_ssl if @use_ssl
+        @http.read_timeout = @timeout
+        @http.open_timeout = @timeout
+      end
+
+      @parser = nil
+      @create = nil
+    end
+
+    def do_rpc(request, async=false)
+      header = {
+       "User-Agent"     =>  USER_AGENT,
+       "Content-Type"   => "text/xml; charset=utf-8",
+       "Content-Length" => request.size.to_s,
+       "Connection"     => (async ? "close" : "keep-alive")
+      }
+
+      header["Cookie"] = @cookie        if @cookie
+      header.update(@http_header_extra) if @http_header_extra
+
+      if @auth != nil
+        # add authorization header
+        header["Authorization"] = @auth
+      end
+
+      @http_last_response = nil
+
+      if defined?(EM) and EM.reactor_running?
+        resp = do_rpc_em_http(async, request, header)
+      else
+        resp = do_rpc_net_http(async, request, header)
+      end
+
+      @http_last_response = resp
+
+      data = resp.body
+
+      if resp.code == "401"
+        # Authorization Required
+        raise "Authorization failed.\nHTTP-Error: #{resp.code} #{resp.message}"
+      elsif resp.code[0,1] != "2"
+        raise "HTTP-Error: #{resp.code} #{resp.message}"
+      end
+
+      ct = parse_content_type(resp["Content-Type"]).first
+      if ct != "text/xml"
+        if ct == "text/html"
+          raise "Wrong content-type (received '#{ct}' but expected 'text/xml'): \n#{data}"
+        else
+          raise "Wrong content-type (received '#{ct}' but expected 'text/xml')"
+        end
+      end
+
+      expected = resp["Content-Length"] || "<unknown>"
+      if data.nil? or data.size == 0
+        raise "Wrong size. Was #{data.size}, should be #{expected}"
+      elsif expected != "<unknown>" and expected.to_i != data.size and resp["Transfer-Encoding"].nil?
+        raise "Wrong size. Was #{data.size}, should be #{expected}"
+      end
+
+      set_cookies = resp.get_fields("Set-Cookie")
+      if set_cookies and !set_cookies.empty?
+        require 'webrick/cookie'
+        @cookie = set_cookies.collect do |set_cookie|
+          cookie = WEBrick::Cookie.parse_set_cookie(set_cookie)
+          WEBrick::Cookie.new(cookie.name, cookie.value).to_s
+        end.join("; ")
+      end
+
+      return data
+    end
+
+    def timeout=(new_timeout)
+      @timeout = new_timeout
+      unless defined?(EM) and EM.reactor_running?
+        @http.read_timeout = @timeout
+        @http.open_timeout = @timeout
+      end
+    end
+
+    def do_rpc_em_http(async, request, header)
+      fiber = Fiber.current
+      http = EM::HttpRequest.new("http://#{@host}:#{@port}#{@path}").post :body => request, :timeout => @timeout
+      http.callback{ fiber.resume }
+      http.errback do
+        # Unfortunately, we can't determine exactly what the error is using EventMachine < 1.0.
+        error = RuntimeError.new("connection or timeout error")
+        fiber.resume(error)
+      end
+
+      e = Fiber.yield and raise(e)
+
+      # Ducktype our response object.
+      resp = OpenStruct.new :code     => http.response_header.http_status.to_s,
+                            :message  => http.response_header.http_reason,
+                            :header   => http.response_header.to_hash,
+                            :body     => http.response.to_s
+
+      resp.header["Content-Type"]      = resp.header["CONTENT_TYPE"]
+      resp.header["Content-Length"]    = resp.header["CONTENT_LENGTH"]
+      resp.header["Transfer-Encoding"] = resp.header["TRANSFER_ENCODING"]
+      resp.header["Set-Cookie"]        = resp.header["SET_COOKIE"]
+
+      def resp.[](name)
+        header[name]
+      end
+      def resp.get_fields(name)
+        value = header[name]
+        value and [value].flatten
+      end
+      
+      resp
+    end
+
+    def do_rpc_net_http(async, request, header)
+      resp = nil
+
+      if async
+        # use a new HTTP object for each call
+        Net::HTTP.version_1_2
+        http = Net::HTTP.new(@host, @port, @proxy_host, @proxy_port)
+        http.use_ssl = @use_ssl if @use_ssl
+        http.read_timeout = @timeout
+        http.open_timeout = @timeout
+
+        # post request
+        http.start {
+          resp = http.post2(@path, request, header)
+        }
+      else
+        # reuse the HTTP object for each call => connection alive is possible
+        # we must start connection explicitely first time so that http.request
+        # does not assume that we don't want keepalive
+        @http.start if not @http.started?
+
+        # post request
+        resp = @http.post2(@path, request, header)
+      end
+      
+      resp
+    end
+    
+  end
+end

data/test/data/response

@@ -0,0 +1,53 @@
+HTTP/1.1 200 OK
+Date: Fri, 29 Jul 2011 17:42:24 GMT
+Server: Apache
+X-Powered-By: PHP/5.2.11
+Content-Length: 988
+Connection: close
+Content-Type: text/xml; charset=UTF-8
+
+<?xml version="1.0" encoding="UTF-8"?>
+<methodResponse>
+<params>
+<param>
+<value><struct>
+<member><name>zoneId</name>
+<value><int>55</int></value>
+</member>
+<member><name>publisherId</name>
+<value><int>6</int></value>
+</member>
+<member><name>zoneName</name>
+<value><string>Telegraph ATW</string></value>
+</member>
+<member><name>type</name>
+<value><int>0</int></value>
+</member>
+<member><name>width</name>
+<value><int>150</int></value>
+</member>
+<member><name>height</name>
+<value><int>150</int></value>
+</member>
+<member><name>capping</name>
+<value><int>0</int></value>
+</member>
+<member><name>sessionCapping</name>
+<value><int>0</int></value>
+</member>
+<member><name>block</name>
+<value><int>0</int></value>
+</member>
+<member><name>comments</name>
+<value><string></string></value>
+</member>
+<member><name>append</name>
+<value><string></string></value>
+</member>
+<member><name>prepend</name>
+<value><string></string></value>
+</member>
+</struct></value>
+</param>
+</params>
+</methodResponse>

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'eventmachine'
+require 'em-http'
+require 'webmock/test_unit' # This needs to come after requiring 'em-http'.
+require 'rr'
+require 'em-xmlrpc-client'
+
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit
+end

data/test/test_em-xmlrpc-client.rb

@@ -0,0 +1,36 @@
+require 'helper'
+
+class TestEmXmlrpcClient < Test::Unit::TestCase
+
+  def test_em_http
+    host = "localhost"
+    path = "api/v2/xmlrpc"
+    stub_request(:post, "http://#{host}/#{path}").to_return(File.read("test/data/response"))
+    expected = {"zoneId"=>55, "publisherId"=>6, "zoneName"=>"Telegraph ATW", "type"=>0, "width"=>150, "height"=>150, "capping"=>0, "sessionCapping"=>0, "block"=>0, "comments"=>"", "append"=>"", "prepend"=>""}
+
+    EM.run do
+      Fiber.new do
+        client = XMLRPC::Client.new2("http://#{host}/#{path}")
+        mock.proxy(client).do_rpc_em_http(anything, anything, anything)
+        mock(client).do_rpc_net_http.never
+        actual = client.call("ox.getZone", "phpads4e32f100507466.86347358", 54)
+        assert_equal expected, actual
+        EM.stop
+      end.resume
+    end
+  end
+
+  def test_net_http
+    host = "localhost"
+    path = "api/v2/xmlrpc"
+    stub_request(:post, "http://#{host}/#{path}").to_return(File.read("test/data/response"))
+    expected = {"zoneId"=>55, "publisherId"=>6, "zoneName"=>"Telegraph ATW", "type"=>0, "width"=>150, "height"=>150, "capping"=>0, "sessionCapping"=>0, "block"=>0, "comments"=>"", "append"=>"", "prepend"=>""}
+
+    client = XMLRPC::Client.new2("http://#{host}/#{path}")
+    mock(client).do_rpc_em_http.never
+    mock.proxy(client).do_rpc_net_http(anything, anything, anything)
+    actual = client.call("ox.getZone", "phpads4e32f100507466.86347358", 54)
+    assert_equal expected, actual
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: em-xmlrpc-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Christopher J. Bottaro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70204197997120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70204197997120
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &70204197996700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70204197996700
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70204197996280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70204197996280
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70204197995860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70204197995860
+description: Monkey patches Ruby's standard XMLRPC Client to use EventMachine and
+  fibers
+email:
+- cjbottaro@alumni.cs.utexas.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- em-xmlrpc-client.gemspec
+- lib/em-xmlrpc-client.rb
+- lib/em-xmlrpc-client/version.rb
+- test/data/response
+- test/helper.rb
+- test/test_em-xmlrpc-client.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -159327133412347017
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -159327133412347017
+requirements: []
+rubyforge_project: em-xmlrpc-client
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Evented and fibered XMLRPC Client
+test_files:
+- test/data/response
+- test/helper.rb
+- test/test_em-xmlrpc-client.rb