R – How to add a name.value to the header when generating a soap message from ruby with soap4r

attributeselementheaderrubysoap4r

I've created a driver from wsdl

When I invoke my request, I would like the header to contain an element, i.e, I want to see something like the following:

REPLACE_WITH_ACTUAL

blah blah blah

However, looking around, everyone talks about subclassing SOAP::Header::SimpleHandler and then injecting an instance into the driver.headerhandler

However, if I do that, then I end up with a nested header, i.e,

REPLACE_WITH_ACTUAL

So there must be a way to just add an element to the existing headerhandler so I can do something like

driver.headerhandler.AddElement("session", "123")

but I can't find any way to do that. I also tried things like

driver.headerhandler["session"]="123" and other such tricks, but I can't find any way to make this work.

Looking at driver.headerhandler.methods, I cannot see any obvious mechanism.

Would really appreciate a pointer to how to to this.

Best Solution

Well, a colleague in my team solved the problem above after looking at some of the typical examples that I had previously found including the one at http://dev.ctor.org/soap4r/browser/trunk/sample/soapheader/authheader/client2.rb

Turns out that the trivial (sigh) solution is to replace

def on_simple_outbound
  if @sessionid
     { "sessionid" => @sessionid }
  end
end

with

def on_simple_outbound
  if @sessionid
     @sessionid
  end
end

Now, if you just name the header "session" (in the QName creation), you get the unnested header, exactly what I wanted.

I thought I'd paste my solution to my own problem on the assumption that others might be running into the same problem.

Related Solutions

Ruby – How to call shell commands from Ruby

This explanation is based on a commented Ruby script from a friend of mine. If you want to improve the script, feel free to update it at the link.

First, note that when Ruby calls out to a shell, it typically calls /bin/sh, not Bash. Some Bash syntax is not supported by /bin/sh on all systems.

Here are ways to execute a shell script:

cmd = "echo 'hi'" # Sample string that can be used

Kernel#` , commonly called backticks – `cmd`

This is like many other languages, including Bash, PHP, and Perl.

Returns the result (i.e. standard output) of the shell command.

Docs: http://ruby-doc.org/core/Kernel.html#method-i-60
```
value = `echo 'hi'`
value = `#{cmd}`
```
Built-in syntax, %x( cmd )

Following the x character is a delimiter, which can be any character. If the delimiter is one of the characters (, [, {, or <, the literal consists of the characters up to the matching closing delimiter, taking account of nested delimiter pairs. For all other delimiters, the literal comprises the characters up to the next occurrence of the delimiter character. String interpolation #{ ... } is allowed.

Returns the result (i.e. standard output) of the shell command, just like the backticks.

Docs: https://docs.ruby-lang.org/en/master/syntax/literals_rdoc.html#label-Percent+Strings
```
value = %x( echo 'hi' )
value = %x[ #{cmd} ]
```
Kernel#system

Executes the given command in a subshell.

Returns true if the command was found and run successfully, false otherwise.

Docs: http://ruby-doc.org/core/Kernel.html#method-i-system
```
wasGood = system( "echo 'hi'" )
wasGood = system( cmd )
```
Kernel#exec

Replaces the current process by running the given external command.

Returns none, the current process is replaced and never continues.

Docs: http://ruby-doc.org/core/Kernel.html#method-i-exec
```
exec( "echo 'hi'" )
exec( cmd ) # Note: this will never be reached because of the line above
```

Here's some extra advice: $?, which is the same as $CHILD_STATUS, accesses the status of the last system executed command if you use the backticks, system() or %x{}. You can then access the exitstatus and pid properties:

$?.exitstatus

For more reading see:

R – gsoap – WS-Addressing elements in the SOAP Header

You can define the SOAP_ENV_Header in your typemap.dat like so:

wsa = <http://schemas.xmlsoap.org/ws/2004/08/addressing>

SOAP_ENV__Header =\
#import "wsa.h"\n\
struct SOAP_ENV__Header\n\
{\n\
   mustUnderstand _wsa__MessageID    wsa__MessageID 0;\n\
   mustUnderstand _wsa__RelatesTo *  wsa__RelatesTo 0;\n\
   mustUnderstand _wsa__From *       wsa__From      0;\n\
   mustUnderstand _wsa__ReplyTo *    wsa__ReplyTo   0;\n\
   mustUnderstand _wsa__FaultTo *    wsa__FaultTo   0;\n\
   mustUnderstand _wsa__To           wsa__To        0;\n\
   mustUnderstand _wsa__Action       wsa__Action    0;\n\
};

Then use wsdl2h with option "-t " to specify an external typemap.dat.

Best Solution

Related Solutions

Ruby – How to call shell commands from Ruby

R – gsoap – WS-Addressing elements in the SOAP Header

Related Question