handsoap 1.1.0

data/README.markdown

@@ -0,0 +1,105 @@
+Handsoap
+===
+
+Install
+---
+
+    gem sources -a http://gems.github.com
+    sudo gem install unwire-handsoap curb nokogiri
+
+What
+---
+Handsoap is a library for creating SOAP clients in Ruby.
+
+[Watch a tutorial](http://www.vimeo.com/4813848), showing how to use Handsoap. The final application can be found at: [http://github.com/troelskn/handsoap-example/tree/master](http://github.com/troelskn/handsoap-example/tree/master)
+
+API docs are at [http://rdoc.info/projects/unwire/handsoap/](http://rdoc.info/projects/unwire/handsoap/)
+
+Some usage information is to be found in [the wiki](http://wiki.github.com/unwire/handsoap).
+
+![Handsoap](http://ny-image0.etsy.com/il_430xN.68558416.jpg)
+
+Why
+---
+
+Ruby already has a SOAP-client library, [soap4r](http://dev.ctor.org/soap4r), so why create another one?
+
+> Let me summarize SOAP4R: it smells like Java code built on a Monday morning by an EJB coder.
+>
+> -- [Ruby In Practice: REST, SOAP, WebSphere MQ and SalesForce](http://blog.labnotes.org/2008/01/28/ruby-in-practice-rest-soap-websphere-mq-and-salesforce/)
+
+OK, not entirely fair, but soap4r has problems. It's incomplete and buggy. If you try to use it for any real-world services, you quickly run into compatibility issues. You can get around some of them, if you have control over the service, but you may not always be that lucky. In the end, even if you get it working, it has a bulky un-Rubyish feel to it.
+
+Handsoap tries to do better by taking a minimalistic approach. Instead of a full abstraction layer, it is more like a toolbox with which you can write SOAP bindings. You could think of it as a [ffi](http://c2.com/cgi/wiki?ForeignFunctionInterface) targeting SOAP.
+
+This means that you generally need to do more manual labor in the cases where soap4r would have automated the mapping. It also means that you need to get your hands dirty with wsdl, xsd and other heavyweight specifications. However, it does give you some tools to help you stay sane.
+
+There are several benefits of using Handsoap:
+
+* It supports the entire SOAP specification, all versions (because you have to implement it your self).
+* You actually get a sporting chance to debug and fix protocol level bugs.
+* It's much faster than soap4r, because it uses fast low-level libraries for xml-parsing and http-communication.
+
+To summarise, soap4r takes an optimistic approach, where Handsoap expects things to fail. If soap4r works for you today, it's probably the better choice. If you find your self strugling with it, Handsoap will offer a more smooth ride. It won't magically fix things for you though.
+
+Handsoap vs. soap4r benchmark
+---
+
+Benchmarks are always unfair, but my experiments has placed Handsoap at being approximately double as fast as soap4r. I'd love any suggestions for a more precise measure.
+
+    $ ruby tests/benchmark_test.rb 1000
+    Benchmarking 1000 calls ...
+                    user     system      total        real
+    handsoap    0.750000   0.090000   0.840000 (  1.992437)
+    soap4r      2.240000   0.140000   2.380000 (  3.605836)
+    ---------------
+    Legend:
+    The user CPU time, system CPU time, the sum of the user and system CPU times,
+    and the elapsed real time. The unit of time is seconds.
+
+SOAP basics
+---
+
+SOAP is a protocol that is tunneled through XML over HTTP. Apart from using the technology for transportation, it doesn't have much to do with HTTP. Some times, it hasn't even got much to do with XML either.
+
+A SOAP client basically consists of three parts:
+
+* A http-connectivity layer,
+* a mechanism for marshalling native data types to XML,
+* and a mechanism for unmarshalling XML to native data types.
+
+The protocol also contains a large and unwieldy specification of how to do the (un)marshalling, which can be used as the basis for automatically mapping to a rich type model. This makes the protocol fitting for .net/Java, but is a huge overhead for a very dynamically typed language such as Ruby. Much of the complexity of clients such as soap4r, is in the parts that tries to use this specification. Handsoap expects you to manually write the code that marshals/unmarshals, thereby bypassing this complexity (or rather - pass it to the programmer)
+
+Handsoap only supports RPC-style SOAP. This seems to be the most common style. It's probably possible to add support for Document-style with little effort, but until I see the need I'm not going there.
+
+API documentation
+---
+
+In addition to this guide, there's autogenerated API documentation available at [http://rdoc.info/projects/unwire/handsoap/](http://rdoc.info/projects/unwire/handsoap/)
+
+Getting started
+---
+
+For getting started with Handsoap, you should read [the guide in the wiki](http://wiki.github.com/unwire/handsoap/recommendations).
+
+The toolbox
+---
+
+The Handsoap toolbox consists of the following components.
+
+Handsoap can use either [curb](http://curb.rubyforge.org/), [Net::HTTP](http://www.ruby-doc.org/stdlib/libdoc/net/http/rdoc/index.html) or [httpclient](http://dev.ctor.org/http-access2) for HTTP-connectivity. The former is recommended, and default, but for portability you might choose one of the latter. You usually don't need to interact at the HTTP-level, but if you do (for example, if you have to use SSL), you can do so through a thin abstraction layer.
+
+For parsing XML, Handsoap defaults to use [Nokogiri](http://github.com/tenderlove/nokogiri/tree/master). Handsoap has an abstraction layer, so that you can switch between REXML, Nokogiri and ruby-libxml. Besides providing portability between these parsers, Handsop also gives some helper functions that are meaningful when parsing SOAP envelopes.
+
+Finally, there is a library for generating XML, which you'll use when mapping from Ruby to SOAP. It's quite similar to [Builder](http://builder.rubyforge.org/), but is tailored towards being used for writing SOAP-messages. The name of this library is `XmlMason` and it is included/part of Handsoap.
+
+License
+---
+
+Copyright: [Unwire A/S](http://www.unwire.dk), 2009
+
+License: [Creative Commons Attribution 2.5 Denmark License](http://creativecommons.org/licenses/by/2.5/dk/deed.en_GB)
+or: [LGPL 3](http://www.gnu.org/copyleft/lesser.html)
+___
+
+troelskn@gmail.com - April, 2009

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 1
+:minor: 1

data/generators/handsoap/handsoap_generator.rb

@@ -0,0 +1,113 @@
+# -*- coding: utf-8 -*-
+require "#{File.dirname(__FILE__)}/../../lib/handsoap/parser.rb"
+require "#{File.dirname(__FILE__)}/../../lib/handsoap/compiler.rb"
+require 'pathname'
+
+# TODO
+# options:
+#   soap_actions (true/false)
+#   soap_version (1/2/auto)
+#   basename
+class HandsoapGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    # Wsdl argument is required.
+    usage if @args.empty?
+    @wsdl_uri = @args.shift
+    @basename = @args.shift
+  end
+
+  # def add_options!(opt)
+  #   opt.on('--soap-actions') { |value| options[:soap_actions] = true }
+  #   opt.on('--no-soap-actions') { |value| options[:soap_actions] = false }
+  # end
+
+  def banner
+		"Generates the scaffold for a Handsoap binding." +
+      "\n" + "You still have to fill in most of the meat, but this gives you a head start." +
+			"\n" + "Usage: #{$0} #{spec.name} URI [BASENAME] [OPTIONS]" +
+      "\n" + "    URI       URI of the WSDL to generate from" +
+      "\n" + "    BASENAME  The basename to use for the service. If omitted, the name will be deducted from the URL."  +
+      # "\n"  +
+      # "\n" + "The following options are available:" +
+      # "\n" + "    --soap-actions     If set, stubs will be generated with soap-action parameters. (Default)" +
+      # "\n" + "    --no-soap-actions  If set, stubs will be generated without soap-action parameters." +
+      # "\n" + "    --soap-version-1   If set, the generator will look for SOAP v 1.1 endpoints." +
+      # "\n" + "    --soap-version-2   If set, the generator will look for SOAP v 1.2 endpoints." +
+      ""
+  end
+
+  def manifest
+    wsdl = Handsoap::Parser::Wsdl.read(@wsdl_uri)
+    compiler = Handsoap::Compiler.new(wsdl, @basename)
+    protocol = wsdl.preferred_protocol
+    file_name = compiler.service_basename
+    record do |m|
+      m.directory "app"
+      m.directory "app/models"
+      m.file_contents "app/models/#{file_name}_service.rb" do |file|
+        file.write compiler.compile_service(protocol, :soap_actions)
+      end
+      m.directory "test"
+      m.directory "test/integration"
+      m.file_contents "test/integration/#{file_name}_service_test.rb" do |file|
+        file.write compiler.compile_test(protocol)
+      end
+      # TODO
+      # Ask user about which endpoints to use ?
+      m.message do |out|
+        out.puts "----"
+        out.puts "Endpoints in WSDL"
+        out.puts "  You should copy these to the appropriate environment files."
+        out.puts "  (Eg. `config/environments/*.rb`)"
+        out.puts "----"
+        out.puts compiler.compile_endpoints(protocol)
+        out.puts "----"
+      end
+    end
+  end
+
+end
+
+module Handsoap #:nodoc:
+  module Generator #:nodoc:
+    module Commands #:nodoc:
+      module Create
+        def file_contents(relative_destination, &block)
+          destination = destination_path(relative_destination)
+          temp_file = Tempfile.new("handsoap_generator")
+          canonical_path = Pathname.new(source_path("/.")).realpath.to_s
+          temp_file_relative_path = relative_path(temp_file.path, canonical_path)
+          begin
+            yield temp_file
+            temp_file.close
+            return self.file(temp_file_relative_path, relative_destination)
+          ensure
+            temp_file.unlink
+          end
+        end
+
+        def message(&block)
+          yield $stdout unless logger.quiet
+        end
+
+        private
+
+        # Convert the given absolute path into a path
+        # relative to the second given absolute path.
+        # http://www.justskins.com/forums/file-relative-path-handling-97116.html
+        def relative_path(abspath, relative_to)
+          path = abspath.split(File::SEPARATOR)
+          rel = relative_to.split(File::SEPARATOR)
+          while (path.length > 0) && (path.first == rel.first)
+            path.shift
+            rel.shift
+          end
+          ('..' + File::SEPARATOR) * rel.length + path.join(File::SEPARATOR)
+        end
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Create.send :include, Handsoap::Generator::Commands::Create

data/lib/handsoap.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+require 'handsoap/xml_mason'
+require 'handsoap/xml_query_front'
+require 'handsoap/service'

data/lib/handsoap/compiler.rb

@@ -0,0 +1,182 @@
+# -*- coding: utf-8 -*-
+module Handsoap
+  # Used internally to generate Ruby source code
+  class CodeWriter #:nodoc: all
+
+    def initialize
+      @buffer = ""
+      @indentation = 0
+    end
+
+    def begin(text)
+      puts(text)
+      indent
+    end
+
+    def end(str = "end")
+      unindent
+      puts(str)
+    end
+
+    def puts(text = "")
+      @buffer << text.gsub(/^(.*)$/, ("  " * @indentation) + "\\1")
+      @buffer << "\n" # unless @buffer.match(/\n$/)
+    end
+
+    def indent
+      @indentation = @indentation + 1
+    end
+
+    def unindent
+      @indentation = @indentation - 1
+    end
+
+    def to_s
+      @buffer
+    end
+  end
+
+  # Used internally by the generator to generate a Service stub.
+  class Compiler #:nodoc: all
+
+    def initialize(wsdl, basename = nil)
+      @wsdl = wsdl
+      if basename
+        @basename = basename.gsub(/[^a-zA-Z0-9]/, "_").gsub(/_+/, "_").gsub(/(^_+|_+$)/, '')
+      else
+        @basename = @wsdl.service
+      end
+      @basename = underscore(@basename).gsub(/_service$/, "")
+    end
+
+    def write
+      writer = CodeWriter.new
+      yield writer
+      writer.to_s
+    end
+
+    def underscore(camel_cased_word)
+      camel_cased_word.to_s.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    def camelize(lower_case_and_underscored_word)
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) {
+        "::" + $1.upcase
+      }.gsub(/(^|_)(.)/) {
+        $2.upcase
+      }
+    end
+
+    def method_name(operation)
+      if operation.name.match /^(get|find|select|fetch)/i
+        "#{underscore(operation.name)}"
+      else
+        "#{underscore(operation.name)}!"
+      end
+    end
+
+    def service_basename
+      @basename
+    end
+
+    def service_name
+      camelize(service_basename) + "Service"
+    end
+
+    def endpoint_name
+      "#{service_basename.upcase}_SERVICE_ENDPOINT"
+    end
+
+    def detect_protocol
+      if endpoints.select { |endpoint| endpoint.protocol == :soap12 }.any?
+        :soap12
+      elsif endpoints.select { |endpoint| endpoint.protocol == :soap11 }.any?
+        :soap11
+      else
+        raise "Can't find any soap 1.1 or soap 1.2 endpoints"
+      end
+    end
+
+    def compile_endpoints(protocol)
+      version = protocol == :soap12 ? 2 : 1
+      @wsdl.endpoints.select { |endpoint| endpoint.protocol == protocol }.map do |endpoint|
+        write do |w|
+          w.puts "# wsdl: #{@wsdl.url}"
+          w.begin "#{endpoint_name} = {"
+          w.puts ":uri => '#{endpoint.url}',"
+          w.puts ":version => #{version}"
+          w.end "}"
+        end
+      end
+    end
+
+    def compile_service(protocol, *options)
+      binding = @wsdl.bindings.find { |b| b.protocol == protocol }
+      raise "Can't find binding for requested protocol (#{protocol})" unless binding
+      write do |w|
+        w.puts "# -*- coding: utf-8 -*-"
+        w.puts "require 'handsoap'"
+        w.puts
+        w.begin "class #{service_name} < Handsoap::Service"
+        w.puts "endpoint #{endpoint_name}"
+        w.begin "def on_create_document(doc)"
+        w.puts "# register namespaces for the request"
+        w.puts "doc.alias 'tns', '#{@wsdl.target_ns}'"
+        w.end
+        w.puts
+        w.begin "def on_response_document(doc)"
+        w.puts "# register namespaces for the response"
+        w.puts "doc.add_namespace 'ns', '#{@wsdl.target_ns}'"
+        w.end
+        w.puts
+        w.puts "# public methods"
+        @wsdl.interface.operations.each do |operation|
+          action = binding.actions.find { |a| a.name == operation.name }
+          raise "Can't find action for operation #{operation.name}" unless action
+          w.puts
+          w.begin "def #{method_name(operation)}"
+          # TODO allow :soap_action => :none
+          if operation.name != action.soap_action && options.include?(:soap_actions)
+            w.puts "soap_action = '#{action.soap_action}'"
+            maybe_soap_action = ", soap_action"
+          else
+            maybe_soap_action = ""
+          end
+          w.begin((operation.output ? 'response = ' : '') + "invoke('tns:#{operation.name}'#{maybe_soap_action}) do |message|")
+          w.puts 'raise "TODO"'
+          w.end
+          w.end
+        end
+        w.puts
+        w.puts "private"
+        w.puts "# helpers"
+        w.puts "# TODO"
+        w.end
+      end
+    end
+
+    def compile_test(protocol)
+      binding = @wsdl.bindings.find { |b| b.protocol == protocol }
+      raise "Can't find binding for requested protocol (#{protocol})" unless binding
+      write do |w|
+        w.puts "# -*- coding: utf-8 -*-"
+        w.puts "require 'test_helper'"
+        w.puts
+        w.puts "# #{service_name}.logger = $stdout"
+        w.puts
+        w.begin "class #{service_name}Test < Test::Unit::TestCase"
+        @wsdl.interface.operations.each do |operation|
+          w.puts
+          w.begin "def test_#{underscore(operation.name)}"
+          w.puts "result = #{service_name}.#{method_name(operation)}"
+          w.end
+        end
+        w.end
+      end
+    end
+  end
+end

data/lib/handsoap/deferred.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+module Handsoap
+  class Deferred
+    def initialize
+      @callback = nil
+      @callback_cache = nil
+      @errback = nil
+      @errback_cache = nil
+    end
+    def has_callback?
+      !! @callback
+    end
+    def has_errback?
+      !! @errback
+    end
+    def callback(&block)
+      raise "Already assigned a block for callback" if @callback
+      @callback = block
+      if @callback_cache
+        payload = @callback_cache
+        trigger_callback(*payload)
+      end
+      self
+    end
+    def errback(&block)
+      raise "Already assigned a block for errback" if @errback
+      @errback = block
+      if @errback_cache
+        payload = @errback_cache
+        trigger_errback(*payload)
+      end
+      self
+    end
+    def trigger_callback(*args)
+      if @callback
+        @callback.call(*args)
+      else
+        @callback_cache = args
+      end
+    end
+    def trigger_errback(*args)
+      if @errback
+        @errback.call(*args)
+      else
+        @errback_cache = args
+      end
+    end
+  end
+end