rapuncel 0.0.1.alpha → 0.0.1

data/README.md

@@ -1,7 +1,7 @@
 # Rapuncel - Simple XML-RPC Client
 
-Rapuncel ([wikipedia](http://en.wikipedia.org/wiki/Rapunzel)) is a simple and lightweight, but fast XML-RPC client library for ruby.
-It's based on Nokogiri for XML parsing and thus provides a major performance improvement for large XML responses.
+Rapuncel ([wikipedia](http://en.wikipedia.org/wiki/Rapunzel)) is a simple and lightweight, but fast XML-RPC client library for ruby. 
+It's based on Nokogiri for XML parsing and thus provides a major performance improvement for large XML responses. 
 
 ## Installation
 
@@ -9,18 +9,18 @@ It's based on Nokogiri for XML parsing and thus provides a major performance imp
 Add this to your Gemfile:
 
     gem 'rapuncel'
-
-Run
+    
+Run 
 
     bundle install
-
-and you're good to go.
-
+    
+and you're good to go. 
+    
 ### Other Ruby / IRB
 Install it as gem:
 
     gem install rapuncel
-
+    
 Require **rubygems** and **rapuncel**
 
     require 'rubygems'
@@ -34,50 +34,47 @@ object.
 First you have to create a client with the connection details, e.g.
 
     client = Rapuncel::Client.new :host => 'localhost', :port => 8080, :path => '/xmlrpc'
-
+    
 Available options are:
 
 * **host**
-hostname or ip-address,
+hostname or ip-address,  
 _default_: localhost
 * **port**
-port where your XMLRPC service is listening,
+port where your XMLRPC service is listening,  
 _default_: 8080
 * **path**
-path to the service,
+path to the service,  
 _default_: /
 * **user**
-Username for HTTP Authentication
+Username for HTTP Authentication  
 _default_: _empty_
 * **password**
-Username for HTTP Authentication
+Username for HTTP Authentication  
 _default_: _empty_
 * **auth\_method**
-HTTP Auth method
+HTTP Auth method  
 _default_: basic **IF** user or password is set
 * **api\_key**
 If set, sends all request with a X-ApiKey: _api\_key_ header
 * **api\_key\_header**
-Allows you to modify the header key for API-Key auth
+Allows you to modify the header key for API-Key auth  
 _default_: X-ApiKey
-* **raise_on**
-Lets you define the behavior on errors or faults, if set to _:fault_, _:error_ or _:both_,
-an Exception will be raised if something goes wrong
 
-### Get a proxy object and ...
+### Get a proxy object and ... 
 A proxy object receives ruby method calls, redirects them to your XMLRPC service and returns the response as ruby objects!
-
+    
     proxy = client.proxy
-
+    
     # suppose your XMLRPC service has a method exposed 'concat_string(string1, string2)'
     proxy.concat_string "foo", "bar"
     -> "foobar"
-
+    
     # if you need to access specific interfaces on your service, e.g. 'string.concat(string1, string2)'
     proxy = client.proxy_for 'string'
     proxy.concat 'foo', 'bar'
     -> 'foobar'
-
+    
 ## Supported objects
 Rapuncel supports natively following object-types (and all their subclasses):
 
@@ -87,7 +84,6 @@ Rapuncel supports natively following object-types (and all their subclasses):
 * Hash
 * TrueClass, FalseClass
 * Float
-* BigDecimal (treated like Float)
 * Time, Time-like objects
 
 * Symbols are converted to Strings
@@ -111,33 +107,34 @@ Of course you don't have to delegate to #to\_s, you just can use the Builder obj
 You can use most methods via
 
     proxy.methodname *args
-
+    
 However methods starting with \_\_, or ending with a bang \! or a question mark ? are not supported. To call those methods you can always
 use
 
     proxy.call! 'methodname', *args
-
+    
 or via
 
     client.call_to_ruby 'methodname', *args
+    
+note 
 
-note
-
-    client.call 'methodname', *args
-
+    client.call 'methodname', *args 
+    
 will return a Rapuncel::Response object, use _call\_to\_ruby_ to get standard ruby objects
 
 ## Todo ?
 
-* RDoc
-* Extensive functional tests
-* Async requests
 * Base64 support (or rather a consistent concept for Base64)
 * XMLRPC Extensions (pluggable support)
+* RDoc
+* Extensive functional tests
 
 ## What happens if something goes wrong?
-### HTTP Errors / XMLRPC Faults
-See Usage -> configuration -> raise\_on switch
+### HTTP Errors
+Any HTTP response but 200 OK will raise an error, containing the returned status code and response body.
+### XMLRPC Faults
+If the XMLRPC response is 'fault', a Rapuncel::Fault object will be returned, having a _code_ and a _string_ attribute
 ### Malformed XML/XMLRPC
 Rapuncel will most likely fail hard.
 

data/{Rakefile → Rakefile.rb}

@@ -19,6 +19,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Rapuncel'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('README')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/rapuncel.rb

@@ -1,4 +1,4 @@
-
+require 'builder'
 
 require 'active_support/core_ext/hash/keys'
 
@@ -20,6 +20,5 @@ require 'rapuncel/core_ext/float'
 require 'rapuncel/core_ext/hash'
 require 'rapuncel/core_ext/array'
 require 'rapuncel/core_ext/boolean'
-require 'rapuncel/core_ext/nil'
 
 require 'rapuncel/core_ext/time'

data/lib/rapuncel/adapters/net_http_adapter.rb

@@ -5,28 +5,28 @@ module Rapuncel
   module Adapters
     module NetHttpAdapter
       extend ActiveSupport::Memoizable
-
+      
       class HttpResponse
         def initialize response
           @response = response
         end
-
+        
         def success?
           @response.is_a? Net::HTTPOK
         end
-
+        
         def body
           @response.body
         end
-
+        
         def code
           @response.code
         end
       end
-
+      
       def send_method_call str
         req = Net::HTTP.new connection.host, connection.port
-
+        
         HttpResponse.new req.post(connection.path, str, connection.headers.stringify_keys)
       end
     end

data/lib/rapuncel/adapters/typhoeus_adapter.rb

@@ -0,0 +1,33 @@
+require 'typhoeus'
+require 'active_support/memoizable'
+
+module Rapuncel
+  module Adapters
+    module TyphoeusAdapter
+      extend ActiveSupport::Memoizable
+      
+      
+      def send_method_call str
+        Typhoeus::Request.post connection.url, typhoeus_params.merge(:body => str)
+      end
+
+      protected
+      def typhoeus_params
+        {
+          :headers => connection.headers
+        }.merge auth_params
+      end
+      memoize :typhoeus_params
+
+      def auth_params
+        return {} unless connection.http_auth?
+
+        {
+          :user         => connection.user,
+          :password     => connection.password,
+          :auth_method  => connection.auth_method
+        }
+      end
+    end
+  end
+end

data/lib/rapuncel/base.rb

@@ -1,7 +1,7 @@
 module Rapuncel
-  BUILDER_OPTIONS = {:encoding => 'UTF-8'}
+  BUILDER_OPTIONS = {}
 
   def self.get_builder options = {}
-    Nokogiri::XML::Builder.new options
+    Builder::XmlMarkup.new BUILDER_OPTIONS.merge(options)
   end
 end

data/lib/rapuncel/client.rb

@@ -1,34 +1,28 @@
+# require 'rapuncel/adapters/typhoeus_adapter'
 require 'rapuncel/adapters/net_http_adapter'
 require 'rapuncel/connection'
-require 'active_support/core_ext/hash/except'
+
 
 module Rapuncel
   class Client
-    attr_accessor :connection, :raise_on_fault, :raise_on_error
+    attr_accessor :connection
 
     include Adapters::NetHttpAdapter
 
     def proxy_for interface
       Proxy.new self, interface
     end
-
+    
     def proxy
       proxy_for nil
     end
 
     def initialize configuration = {}
-      @connection = Connection.build configuration.except(:raise_on)
+      @connection = init_connection(configuration)
+    end
 
-      @raise_on_fault, @raise_on_error = case configuration[:raise_on]
-      when :fault
-        [true, false]
-      when :error
-        [false, true]
-      when :both
-        [true, true]
-      else
-        [false, false]
-      end
+    def init_connection configuration = {}
+      Connection.build configuration
     end
 
     def call name, *args
@@ -36,18 +30,16 @@ module Rapuncel
     end
 
     def call_to_ruby name, *args
-      response = call name, *args
-
-      raise_on_fault && response.fault? && raise(response.fault)
-      raise_on_error && response.error? && raise(response.error)
+      call(name, *args).to_ruby
+    end
 
-      response.to_ruby
+    def execute_to_ruby request
+      execute(request).to_ruby
     end
 
-    protected
     def execute request
       xml = request.to_xml_rpc
-
+      
       Response.new send_method_call(xml)
     end
   end

data/lib/rapuncel/connection.rb

@@ -17,7 +17,7 @@ module Rapuncel
     alias_method :ssl?, :ssl
 
     def initialize configuration = {}
-
+      
       @host     = configuration[:host]    || 'localhost'
       @port     = configuration[:port]    || '8080'
       @path     = configuration[:path]    || '/'
@@ -33,7 +33,7 @@ module Rapuncel
     def url
       "http://#{host}:#{port}#{path}"
     end
-
+    
     def headers
       @headers.merge  :Accept => 'text/xml', :'content-type' => 'text/xml'
     end

data/lib/rapuncel/core_ext/array.rb

@@ -1,23 +1,30 @@
+require 'builder'
+require 'nokogiri'
+
 class Array
+
   def to_xml_rpc b = Rapuncel.get_builder
-    b.array do |b|
-      b.data do |b|
+
+    b.array do
+      b.data do
         each do |array_entry|
-          b.value do |b|
+          b.value do
             array_entry.to_xml_rpc b
           end
         end
       end
     end
-
-    b.to_xml
   end
-
+  
+  
   def self.from_xml_rpc xml_node
-    values = xml_node.first_element_child.element_children
-
+    #warn "Warning: This is not an array-node (It is a(n) #{xml_node.name}.). Parsing may go wrong. Continuing at your risk" unless ['array'].include? xml_node.name.downcase
+    
+    
+    values = xml_node.first_element_child.element_children #xpath('./data/value/*')
+    
     values.map do |value|
       Object.from_xml_rpc value.first_element_child
-    end
+    end    
   end
 end

data/lib/rapuncel/core_ext/big_decimal.rb

@@ -1,7 +0,0 @@
-class BigDecimal
-  def to_xml_rpc b = Rapuncel.get_builder
-    b.double self.to_s
-
-    b.to_xml
-  end
-end

data/lib/rapuncel/core_ext/boolean.rb

@@ -1,29 +1,32 @@
+require 'builder'
+require 'nokogiri'
+
 class TrueClass
+
   def to_xml_rpc b = Rapuncel.get_builder
     b.boolean "1"
-
-    b.to_xml
   end
 end
 
+
 class FalseClass
+
   def to_xml_rpc b = Rapuncel.get_builder
     b.boolean "0"
-
-    b.to_xml
   end
 end
 
-# this is to catch the from_xml_rpc call from Object
-class Rapuncel::Boolean
-  def self.from_xml_rpc xml_node
 
-    # DISCUSS: need convention here:
+class Rapuncel::Boolean #this is to catch the from_xml_rpc call from Object
+  def self.from_xml_rpc xml_node
+    #warn "This node is not boolean (it is #{xml_node.name}), but will be treated as one at your request. keep in mind that 1 means true and all the rest will be false" unless ['boolean'].include? xml_node.name.downcase
+    
+    #need convention here:
     case xml_node.text.downcase
     when '1'
       true
     else
       false
-    end
-  end
+    end    
+  end  
 end

data/lib/rapuncel/core_ext/float.rb

@@ -1,11 +1,14 @@
+require 'builder'
+require 'nokogiri'
+
 class Float
   def self.from_xml_rpc xml_node
-    xml_node.text.strip.to_f #calling to_float on the text between the (hopefully correct) tags
+    #warn "Node given (name of #{xml_node.name}) is not a 'double' node, name should be 'double'. Will still parse, at your risk." unless ['double'].include? xml_node.name.downcase
+    
+    xml_node.text.to_f #calling to_float on the text between the (hopefully correct) tags
   end
-
+  
   def to_xml_rpc b = Rapuncel.get_builder
     b.double to_s
-
-    b.to_xml
   end
 end