lolsoap 0.1.0

data/.document

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  # - jruby
+  # - rbx-18mode

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'nokogiri'
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "minitest"
+  gem "yard"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    minitest (2.10.0)
+    nokogiri (1.5.0)
+    rake (0.9.2.2)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  minitest
+  nokogiri
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Loco2 Ltd.
+
+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.md

@@ -0,0 +1,124 @@
+# LolSoap #
+
+A library for dealing with SOAP requests and responses. We tear our hair
+out so you don't have to.
+
+https://github.com/loco2/lolsoap
+
+[![Build Status](https://secure.travis-ci.org/loco2/lolsoap.png)](http://travis-ci.org/loco2/lolsoap)
+
+## Aims ##
+
+* A collection of classes to make dealing with SOAP requests and
+  responses, and WSDL documents, easier.
+* The classes are intended to be loosely coupled and non-prescriptive
+  about how they are used.
+* LolSoap does not know anything about what HTTP library you want to
+  use, and does not care whether you're doing the IO in a synchronous or
+  asynchronous fashion. This does mean you have to provide a little bit
+  of glue code, but the benefit is flexibility.
+* No monkey-patching.
+* Runs without warnings.
+
+## Synopsis ##
+
+``` ruby
+# You will need your own HTTP client
+http = MyHttpClient.new
+
+# LolSoap::Client is just a thin wrapper object that handles creating
+# other objects for you, with a given WSDL file
+client = LolSoap::Client.new(File.read('lolapi.wsdl'))
+
+# Create a request object
+request = client.request('getLols')
+
+# Populate the request with some data. Namespacing is taken care of
+# using the type data from the WSDL.
+request.body do |b|
+  b.lolFactor '11'
+  b.lolDuration 'lolever'
+  ...
+end
+
+# See the full request XML
+puts request.content
+
+# Send that request!
+raw_response = http.post(request.url, request.headers, request.content)
+
+# Create a response object
+response = client.response(request, raw_response)
+
+# Get access to the XML structure (a Nokogiri::XML::Document)
+p response.doc
+
+# Get access to the first node inside the Body
+p response.body
+
+# Turn the body into a hash. The WSDL schema is used to work out which
+# elements are supposed to be collections and which are just singular.
+p response.body_hash
+```
+
+## Bugs/Features ##
+
+* SOAP 1.1 is not supported. Patches to add support will be considered
+  if they don't add too much extra complexity.
+* WSSE is not supported.
+* Assumes that you are able to supply a WSDL document for the service.
+
+## Overview ##
+
+These are some of the key classes. If you want, you can require them
+directly (e.g. `require 'lolsoap/request'` rather than having to
+`require 'lolsoap'`).
+
+The main ones:
+
+* `LolSoap::Request` - A HTTP request to be sent
+* `LolSoap::Envelope` - The SOAP envelope in the body of a request
+* `LolSoap::Response` - The API's response
+* `LolSoap::WSDL` - A WSDL document
+
+The others:
+
+* `LolSoap::WSDLParser` - Lower level representation of the WSDL
+  document
+* `LolSoap::Builder` - XML builder object that knows about types, and
+  therefore how elements should be namespaced.
+* `LolSoap::Fault` - A SOAP 'fault' (error)
+* `LolSoap::HashBuilder` - Builds hashes from the API response, using
+  the WSDL type data to determine which elements are collection
+  elements.
+
+## Authors ##
+
+* [Jon Leighton](http://jonathanleighton.com/)
+
+Development sponsored by [Loco2](http://loco2.com/).
+
+## License ##
+
+(The MIT License)
+
+Copyright (c) 2012 Loco2 Ltd.
+
+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/Rakefile

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lolsoap"
+  gem.homepage = "http://github.com/jonleighton/lolsoap"
+  gem.license = "MIT"
+  gem.summary = %Q{A library for dealing with SOAP requests and responses.}
+  gem.description = %Q{A library for dealing with SOAP requests and responses. We tear our hair out so you don't have to.}
+  gem.email = "j@jonathanleighton.com"
+  gem.authors = ["Jon Leighton"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs      = ["test"]
+  t.pattern   = "test/**/test_*.rb"
+  t.ruby_opts = ['-w']
+end
+
+task :default => :test

data/VERSION

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

data/lib/lolsoap.rb

@@ -0,0 +1,11 @@
+module LolSoap
+  require 'lolsoap/builder'
+  require 'lolsoap/client'
+  require 'lolsoap/envelope'
+  require 'lolsoap/errors'
+  require 'lolsoap/fault'
+  require 'lolsoap/request'
+  require 'lolsoap/response'
+  require 'lolsoap/wsdl'
+  require 'lolsoap/wsdl_parser'
+end

data/lib/lolsoap/builder.rb

@@ -0,0 +1,93 @@
+require 'lolsoap/wsdl'
+
+module LolSoap
+  # Used to build XML, with namespaces automatically added.
+  #
+  # @example General
+  #   builder = Builder.new(node, type)
+  #   builder.someTag do |t|
+  #     t.foo 'bar'
+  #   end
+  #   # => <ns1:someTag><ns1:foo>bar</ns1:foo></ns1:someTag>
+  #
+  # @example Explicitly specifying a namespace prefix
+  #   builder = Builder.new(node, type)
+  #   builder['ns2'].someTag
+  #   # => <ns2:someTag/>
+  class Builder
+    RESERVED_METHODS = %w(object_id respond_to_missing? inspect === to_s)
+
+    alias :__class__ :class
+    instance_methods.each do |m|
+      undef_method m unless RESERVED_METHODS.include?(m.to_s) || m =~ /^__/
+    end
+
+    # @private
+    class Prefix
+      instance_methods.each do |m|
+        undef_method m unless RESERVED_METHODS.include?(m.to_s) || m =~ /^__/
+      end
+
+      def initialize(owner, prefix)
+        @owner  = owner
+        @prefix = prefix
+      end
+
+      def respond_to?(name)
+        true
+      end
+
+      private
+
+      def method_missing(*args, &block)
+        @owner.__prefixed_tag__(@prefix, LolSoap::WSDL::NullType.new, *args, &block)
+      end
+    end
+
+    def initialize(node, type = WSDL::NullType.new)
+      @node = node
+      @type = type
+    end
+
+    # Add a tag manually, rather than through method_missing. This is so you can still
+    # add tags for the very small number of tags that are also existing methods.
+    def __tag__(name, *args, &block)
+      __prefixed_tag__(@type.prefix, @type.sub_type(name.to_s), name, *args, &block)
+    end
+
+    # @private
+    def __prefixed_tag__(prefix, sub_type, name, *args)
+      sub_node = @node.document.create_element(name.to_s, *args)
+      sub_node.namespace = @node.namespace_scopes.find { |n| n.prefix == prefix }
+
+      @node << sub_node
+
+      builder = __class__.new(sub_node, sub_type)
+      yield builder if block_given?
+      builder
+    end
+
+    # Node accessor. Named to prevent method_missing conflict.
+    def __node__
+      @node
+    end
+
+    # Type accessor. Named to prevent method_missing conflict.
+    def __type__
+      @type
+    end
+
+    # Specify a namespace prefix explicitly
+    def [](prefix)
+      Prefix.new(self, prefix)
+    end
+
+    def respond_to?(name)
+      true
+    end
+
+    private
+
+    alias method_missing __tag__
+  end
+end

data/lib/lolsoap/client.rb

@@ -0,0 +1,25 @@
+require 'lolsoap/wsdl'
+require 'lolsoap/request'
+require 'lolsoap/envelope'
+require 'lolsoap/response'
+
+module LolSoap
+  class Client
+    attr_reader :wsdl
+
+    # @param wsdl a WSDL object, or a string that will be parsed into one
+    def initialize(wsdl)
+      @wsdl = wsdl.respond_to?(:to_str) ? WSDL.parse(wsdl.to_str) : wsdl
+    end
+
+    # @return [LolSoap::Request] A request for the API action you want to perform
+    def request(name)
+      Request.new(Envelope.new(wsdl, wsdl.operation(name)))
+    end
+
+    # @return [LolSoap::Response] A response object for an API action that has been performed
+    def response(request, raw)
+      Response.parse(request, raw)
+    end
+  end
+end

data/lib/lolsoap/envelope.rb

@@ -0,0 +1,94 @@
+require 'nokogiri'
+require 'lolsoap/builder'
+
+module LolSoap
+  class Envelope
+    attr_reader :wsdl, :operation, :doc
+
+    # @private
+    SOAP_PREFIX    = 'soap'
+
+    # @private
+    SOAP_NAMESPACE = 'http://www.w3.org/2003/05/soap-envelope'
+
+    def initialize(wsdl, operation, doc = Nokogiri::XML::Document.new)
+      @wsdl      = wsdl
+      @operation = operation
+      @doc       = doc
+
+      initialize_doc
+    end
+
+    # Build the body of the envelope
+    #
+    # @example
+    #   env.body do |b|
+    #     b.some 'data'
+    #   end
+    def body(klass = Builder)
+      builder = klass.new(input, operation.input)
+      yield builder if block_given?
+      builder
+    end
+
+    # Build the header of the envelope
+    def header(klass = Builder)
+      builder = klass.new(@header)
+      yield builder if block_given?
+      builder
+    end
+
+    def endpoint
+      wsdl.endpoint
+    end
+
+    def action
+      operation.action
+    end
+
+    def input_type
+      operation.input
+    end
+
+    def output_type
+      operation.output
+    end
+
+    def to_xml
+      doc.to_xml
+    end
+
+    def soap_prefix
+      SOAP_PREFIX
+    end
+
+    def soap_namespace
+      SOAP_NAMESPACE
+    end
+
+    private
+
+    # @private
+    def input; @input; end
+
+    # @private
+    def initialize_doc
+      doc.root = root = doc.create_element('Envelope')
+
+      namespaces = Hash[wsdl.type_namespaces.map { |prefix, uri| [prefix, root.add_namespace(prefix, uri)] }]
+      namespaces[soap_prefix] = root.add_namespace(soap_prefix, soap_namespace)
+
+      @header = doc.create_element 'Header'
+
+      @body  = doc.create_element 'Body'
+      @input = doc.create_element input_type.name
+
+      [root, @header, @body].each { |el| el.namespace = namespaces[soap_prefix] }
+      @input.namespace = namespaces[input_type.prefix]
+
+      @body << @input
+      root  << @header
+      root  << @body
+    end
+  end
+end