lolsoap 0.1.0

data/lolsoap.gemspec

@@ -0,0 +1,97 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "lolsoap"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jon Leighton"]
+  s.date = "2012-01-17"
+  s.description = "A library for dealing with SOAP requests and responses. We tear our hair out so you don't have to."
+  s.email = "j@jonathanleighton.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    ".yardopts",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/lolsoap.rb",
+    "lib/lolsoap/builder.rb",
+    "lib/lolsoap/client.rb",
+    "lib/lolsoap/envelope.rb",
+    "lib/lolsoap/errors.rb",
+    "lib/lolsoap/fault.rb",
+    "lib/lolsoap/hash_builder.rb",
+    "lib/lolsoap/request.rb",
+    "lib/lolsoap/response.rb",
+    "lib/lolsoap/wsdl.rb",
+    "lib/lolsoap/wsdl/element.rb",
+    "lib/lolsoap/wsdl/null_element.rb",
+    "lib/lolsoap/wsdl/null_type.rb",
+    "lib/lolsoap/wsdl/operation.rb",
+    "lib/lolsoap/wsdl/type.rb",
+    "lib/lolsoap/wsdl_parser.rb",
+    "lolsoap.gemspec",
+    "test/fixtures/stock_quote.wsdl",
+    "test/fixtures/stock_quote_fault.xml",
+    "test/fixtures/stock_quote_response.xml",
+    "test/helper.rb",
+    "test/integration/test_client.rb",
+    "test/integration/test_envelope.rb",
+    "test/integration/test_request.rb",
+    "test/integration/test_response.rb",
+    "test/integration/test_wsdl.rb",
+    "test/unit/test_builder.rb",
+    "test/unit/test_client.rb",
+    "test/unit/test_envelope.rb",
+    "test/unit/test_fault.rb",
+    "test/unit/test_hash_builder.rb",
+    "test/unit/test_request.rb",
+    "test/unit/test_response.rb",
+    "test/unit/test_wsdl.rb",
+    "test/unit/test_wsdl_parser.rb",
+    "test/unit/wsdl/test_element.rb",
+    "test/unit/wsdl/test_type.rb"
+  ]
+  s.homepage = "http://github.com/jonleighton/lolsoap"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A library for dealing with SOAP requests and responses."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/test/fixtures/stock_quote.wsdl

@@ -0,0 +1,74 @@
+<?xml version="1.0"?>
+<!-- example borrowed and extended from http://cs.au.dk/~amoeller/WWW/webservices/wsdlexample.html -->
+<definitions name="StockQuote"
+             targetNamespace="http://example.com/stockquote.wsdl"
+             xmlns:tns="http://example.com/stockquote.wsdl"
+             xmlns:xsd1="http://example.com/stockquote.xsd"
+             xmlns:xsd2="http://example.com/stockquote2.xsd"
+             xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap12/"
+             xmlns="http://schemas.xmlsoap.org/wsdl/">
+
+  <types>
+    <schema targetNamespace="http://example.com/stockquote.xsd"
+            xmlns="http://www.w3.org/2001/XMLSchema">
+      <element name="TradePrice">
+         <complexType>
+           <all>
+             <element name="price" type="float"/>
+           </all>
+         </complexType>
+      </element>
+      <complexType name="TradePriceRequest">
+        <sequence>
+          <element name="tickerSymbol" type="string" maxOccurs="5"/>
+          <element name="specialTickerSymbol" type="xsd2:TickerSymbol" maxOccurs="unbounded"/>
+        </sequence>
+      </complexType>
+    </schema>
+
+    <schema targetNamespace="http://example.com/stockquote2.xsd"
+            xmlns="http://www.w3.org/2001/XMLSchema">
+      <complexType name="TickerSymbol">
+        <sequence>
+          <element name="name" type="string" maxOccurs="1"/>
+        </sequence>
+      </complexType>
+    </schema>
+  </types>
+
+  <message name="GetLastTradePriceInput">
+    <part name="body" element="xsd1:TradePriceRequest"/>
+  </message>
+
+  <message name="GetLastTradePriceOutput">
+    <part name="body" element="xsd1:TradePrice"/>
+  </message>
+
+  <portType name="StockQuotePortType">
+    <operation name="GetLastTradePrice">
+      <input message="tns:GetLastTradePriceInput"/>
+      <output message="tns:GetLastTradePriceOutput"/>
+    </operation>
+  </portType>
+
+  <binding name="StockQuoteSoapBinding" type="tns:StockQuotePortType">
+    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
+    <operation name="GetLastTradePrice">
+      <soap:operation soapAction="http://example.com/GetLastTradePrice"/>
+      <input>
+        <soap:body use="literal"/>
+      </input>
+      <output>
+        <soap:body use="literal"/>
+      </output>
+    </operation>
+  </binding>
+
+  <service name="StockQuoteService">
+    <documentation>My first service</documentation>
+    <port name="StockQuotePort" binding="tns:StockQuoteSoapBinding">
+      <soap:address location="http://example.com/stockquote"/>
+    </port>
+  </service>
+
+</definitions>

data/test/fixtures/stock_quote_fault.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
+<soap:Body>
+  <soap:Fault>
+    <soap:Code>
+      <soap:Value>soap:Sender</soap:Value>
+    </soap:Code>
+    <soap:Reason>
+      <soap:Text>Omg! stock market has crashed!</soap:Text>
+    </soap:Reason>
+    <soap:Detail>
+      <Foo>Some detail</Foo>
+    </soap:Detail>
+  </soap:Fault>
+</soap:Body>
+</soap:Envelope>

data/test/fixtures/stock_quote_response.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:m="http://example.com/stockquote.xsd">
+<soap:Body>
+  <m:GetStockPriceResponse>
+    <m:Price>34.5</m:Price>
+  </m:GetStockPriceResponse>
+</soap:Body>
+</soap:Envelope>

data/test/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'ostruct'
+
+TEST_ROOT = File.expand_path('..', __FILE__)
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+if RUBY_VERSION == '1.8.7'
+  class OpenStruct
+    undef_method :type
+  end
+end

data/test/integration/test_client.rb

@@ -0,0 +1,20 @@
+require 'helper'
+require 'lolsoap/client'
+
+module LolSoap
+  describe Client do
+    subject { Client.new(File.read(TEST_ROOT + '/fixtures/stock_quote.wsdl')) }
+
+    it 'builds a request' do
+      request = subject.request('GetLastTradePrice')
+      request.body { |foo| foo.bar }
+      request.content.empty?.must_equal false
+    end
+
+    it 'builds a response' do
+      request = subject.request('GetLastTradePrice')
+      response = subject.response(request, File.read(TEST_ROOT + '/fixtures/stock_quote_response.xml'))
+      response.body.wont_equal nil
+    end
+  end
+end

data/test/integration/test_envelope.rb

@@ -0,0 +1,45 @@
+require 'helper'
+require 'lolsoap/envelope'
+require 'lolsoap/wsdl'
+
+module LolSoap
+  describe Envelope do
+    let(:wsdl) { WSDL.parse(File.read(TEST_ROOT + '/fixtures/stock_quote.wsdl')) }
+    subject { Envelope.new(wsdl, wsdl.operations['GetLastTradePrice']) }
+
+    let(:doc) { subject.doc }
+
+    it 'creates an empty envelope' do
+      body = doc.at_xpath('/soap:Envelope/soap:Body/xsd1:TradePriceRequest', doc.namespaces)
+      body.wont_equal nil
+    end
+
+    it 'creates some input' do
+      subject.body do |b|
+        b.tickerSymbol 'LOCO2'
+        b.specialTickerSymbol do |s|
+          s.name 'LOCOLOCOLOCO'
+        end
+        b.lol
+      end
+
+      el = doc.at_xpath('//xsd1:TradePriceRequest/xsd1:tickerSymbol', doc.namespaces)
+      el.wont_equal nil
+      el.text.to_s.must_equal 'LOCO2'
+
+      el = doc.at_xpath('//xsd1:TradePriceRequest/xsd1:specialTickerSymbol/xsd2:name', doc.namespaces)
+      el.wont_equal nil
+      el.text.to_s.must_equal 'LOCOLOCOLOCO'
+    end
+
+    it 'creates some header' do
+      subject.header do |h|
+        h['xsd1'].verySpecialBoolean true
+      end
+
+      el = doc.at_xpath('/soap:Envelope/soap:Header/xsd1:verySpecialBoolean', doc.namespaces)
+      el.wont_equal nil
+      el.text.to_s.must_equal 'true'
+    end
+  end
+end

data/test/integration/test_request.rb

@@ -0,0 +1,19 @@
+require 'helper'
+require 'lolsoap/envelope'
+require 'lolsoap/request'
+
+module LolSoap
+  describe Request do
+    let(:wsdl) { WSDL.parse(File.read(TEST_ROOT + '/fixtures/stock_quote.wsdl')) }
+    let(:operation) { wsdl.operation('GetLastTradePrice') }
+    let(:envelope) { Envelope.new(wsdl, operation) }
+
+    subject { Request.new(envelope) }
+
+    it 'should put together a HTTP request' do
+      subject.url.must_equal "http://example.com/stockquote"
+      subject.headers['SOAPAction'].must_equal "http://example.com/GetLastTradePrice"
+      subject.content.empty?.must_equal false
+    end
+  end
+end

data/test/integration/test_response.rb

@@ -0,0 +1,15 @@
+require 'helper'
+require 'lolsoap/client'
+
+module LolSoap
+  describe Response do
+    let(:client) { LolSoap::Client.new File.read(TEST_ROOT + '/fixtures/stock_quote.wsdl') }
+    let(:request) { client.request('GetLastTradePrice') }
+
+    subject { Response.parse(request, File.read(TEST_ROOT + '/fixtures/stock_quote_response.xml')) }
+
+    it 'should build a hash from the body' do
+      subject.body_hash.must_equal({ 'Price' => '34.5' })
+    end
+  end
+end

data/test/integration/test_wsdl.rb

@@ -0,0 +1,28 @@
+require 'helper'
+require 'lolsoap/wsdl'
+
+module LolSoap
+  describe WSDL do
+    subject { WSDL.parse(File.read(TEST_ROOT + '/fixtures/stock_quote.wsdl')) }
+
+    it 'should successfully parse a WSDL document' do
+      subject.operations.length.must_equal 1
+      subject.operations['GetLastTradePrice'].tap do |o|
+        o.input.must_equal  subject.types['TradePriceRequest']
+        o.action.must_equal 'http://example.com/GetLastTradePrice'
+      end
+
+      subject.types.length.must_equal 3
+      subject.types['TradePriceRequest'].tap do |t|
+        t.name.must_equal 'TradePriceRequest'
+        t.namespace.must_equal 'http://example.com/stockquote.xsd'
+      end
+    end
+
+    describe '#inspect' do
+      it 'works' do
+        subject.inspect
+      end
+    end
+  end
+end

data/test/unit/test_builder.rb

@@ -0,0 +1,95 @@
+require 'helper'
+require 'lolsoap/builder'
+
+module LolSoap
+  describe Builder do
+    let(:doc) { MiniTest::Mock.new }
+    let(:node) do
+      node = OpenStruct.new(
+        :document         => doc,
+        :namespace_scopes => [OpenStruct.new(:prefix => 'b'), OpenStruct.new(:prefix => 'a')],
+        :children         => MiniTest::Mock.new
+      )
+      def node.<<(child); children << child; end
+      node
+    end
+    let(:type) do
+      type = OpenStruct.new(:prefix => 'a')
+      def type.sub_type(name)
+        @sub_types ||= { 'foo' => Object.new, 'bar' => Object.new, 'clone' => Object.new }
+        @sub_types[name]
+      end
+      type
+    end
+
+    subject { Builder.new(node, type) }
+
+    def expect_node_added(namespace, *args)
+      sub_node = MiniTest::Mock.new
+
+      doc.expect(:create_element, sub_node, args)
+      sub_node.expect(:namespace=, nil, [namespace])
+      node.children.expect(:<<, nil, [sub_node])
+
+      yield sub_node
+
+      [doc, sub_node, node].each(&:verify)
+    end
+
+    describe '#__tag__' do
+      it 'adds an element to the node, using the correct namespace' do
+        expect_node_added node.namespace_scopes[1], 'foo', 'bar' do |sub_node|
+          sub_builder = subject.__tag__(:foo, 'bar')
+          sub_builder.__node__.object_id.must_equal sub_node.object_id
+          sub_builder.__type__.must_equal type.sub_type('foo')
+        end
+      end
+
+      it 'yields to a block, if given' do
+        expect_node_added node.namespace_scopes[1], 'bar' do
+          block = nil
+          ret = subject.__tag__(:bar) { |b| block = b }
+          block.object_id.must_equal ret.object_id
+        end
+      end
+    end
+
+    describe 'method missing' do
+      it 'delegates to __tag__' do
+        expect_node_added node.namespace_scopes[1], 'bar', 'baz' do
+          subject.bar 'baz'
+        end
+      end
+
+      it 'supports standard methods that are usually defined' do
+        expect_node_added node.namespace_scopes[1], 'clone' do
+          subject.clone
+        end
+      end
+    end
+
+    it 'responds to anything' do
+      subject.respond_to?('omgwtfbbq').must_equal true
+      subject['b'].respond_to?('omgwtfbbq').must_equal true
+    end
+
+    it 'can add elements with a custom prefix' do
+      expect_node_added node.namespace_scopes[0], 'foo' do
+        subject['b'].foo
+      end
+    end
+
+    describe '#__node__' do
+      it 'returns the node' do
+        subject.__node__.must_equal node
+      end
+    end
+
+    describe '#__type__' do
+      it 'returns the type' do
+        subject.__type__.must_equal type
+      end
+    end
+
+  end
+end