/ 
SOAP-Lite-Simple-1.1
River stage zero No dependents
/ SOAP::Lite::Simple::Real

NAME

SOAP::Lite::Simple::Real - talk with 'real' webservices, e.g. not .net

DESCRIPTION

This package helps in talking with SOAP webservers, it just needs a bit of XML thrown at it and you get some XML back. It's designed to be REALLY simple to use, it doesn't try to be cleaver in any way (patches for 'cleaverness' welcome).

The major difference to SOAP::Lite::Simple::DotNet is it will submit as:

SOAPAction: "http://www.yourdomain.com/services#GetSellerActivity"

and namesp<X> will be added to the XML submitted, including for the xmlns.

SYNOPSIS

If your service looks like this:

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetActivity xmlns="http://www.yourdomain.com/services">
      <userId>long</userId>
    </GetActivity>
  </soap:Body>
</soap:Envelope>


# Create an object with basic SOAP::Lite config stuff
my $soap_simple = SOAP::Lite::Simple::Real->new({
  uri 		=> 'http://www.yourdomain.com/services',
  proxy 		=> 'http://www.yourproxy.com/services',
  xmlns 		=> 'http://www.yourdomain.com/services',
  soapversion 	=> '1.1', # defaults to 1.1
  timeout		=> '30', # detauls to 30 seconds
});


# Create the following XML:

my $user_id = '900109';
my $xml = "<userId _value_type='long'>$user_id</userId>";
# IMPORTANT: you must set _value_type to long - matching the requirement of the SOAP server

# Actually do the call
if( $soap_simple->fetch({
                       'method' => 'GetActivity',
                       'xml' => $xml,
                   }) ) {

                   # extract the results (XML string)
                   my $xml_results = $obj->results;

                   # Now validate the XML

} else {
  # Got an error
  print "Problem using service:" . $soap_simple->error();

}

methods

new()

my $soap_simple->SOAP::Lite::Simple::Real->new({
  uri 	=> 'http://www.yourdomain.com/services',
  proxy 	=> 'http://www.yourproxy.com/services',
  xmlns 	=> 'http://www.yourdomain.com/services',
  soapversion => '1.1', # defaults to 1.1
  timeout	=> '30', # detauls to 30 seconds
  strip_default_xmlns => 1, # defaults to 1
});

This constructor requires uri, proxy and xmlns to be supplied, otherwise it will croak.

strip_default_xmlns is used to remove xmlns="http://.../" from returned XML, it will NOT alter xmlns:FOO="http//.../" set to '0' if you do not wish for this to happen.

fetch()

  # Generate the required XML (you don't need the SOAP wrapper or method part of the XML
  my $user_id = '900109';
  my $xml = "<userId _value_type='long'>$user_id</userId>";

  if(my $xml_result = $soap_simple->fetch({ method => 'GetActivity', xml => $xml }) {
	# You got some XML back
	my $parser = XML::LibXML->new();
	my $doc = $parser->parse_string($xml_result);

	# now validate the XML is what you were expecting.

  } else {
	# There was some sort of error
	print $soap_simple->error() . "\n";
  }

This method actually calls the web service, it takes a method name and an xml string. If there is a problem with either the XML or the SOAP transport (e.g. web server error/could not connect etc) undef will be returned and the error() will be set.

If all is successful the the XML string will be parsed back. This still has all the SOAP wrapper stuff on it, so you'll want to strip that out.

We check for Fault/faultstring in the returned XML, anything else you'll need to check for yourself.

error()

$self->error();

If fetch returns undef then check this method, it will either be that the XML you supplied was not correctly formatted and XML::LibXML could not parse it, there was a transport error with the web service or either soap:Fault and soapenv:Fault error messages were returned in the XML.

results();

my $results = $soap_simple->results();

Can be called after fetch() to get the raw XML, if fetch was sucessful.

results_xml();

my $results_as_xml = $soap_simple->results_xml();

Can be called after fetch() to get the XML::LibXML Document element of the returned xml, as long as fetch was sucessful.

HOW TO DEBUG

At the top of your script, before 'use SOAP::Lite::Simple::Real' add:

use SOAP::Lite ( +trace => 'all', readable => 1, outputxml => 1, );

It may or may not help, not all services don't give you helpful error messages! At least you can see what's being submitted and returned. It can be the smallest thing that causes a problem, mis-typed data (see _value_type in xml), or typo in xmlns line.

BUGS

This is only designed to work with generic services, it may work with others. I haven't found any open webservices which I can use to test against, but as far as I'm aware it all works - web services are all standard.. right.. :) ?

AUTHOR

Leo Lapworth <LLAP@cuckoo.org>

COPYRIGHT

(c) 2005 Leo Lapworth

This library is free software, you can use it under the same terms as perl itself.

SEE ALSO

<SOAP::Lite::Simple>, <SOAP::Lite::Simple::DotNet>