(Ruby) How to Access Parts of a multipart/related HTTP Response

Demonstrates how to access the parts of a multipart/related response. This example sends a ficticious multipart/related request, and handles a ficticious multipart/related response.

We send the following multipart/related request:

Content-Type: multipart/related; start-info="text/xml"; type="application/xop+xml"; boundary="----=_Part_0_1744155.1118953559416"
Content-Length: 3453
SOAPAction: "some-SOAP-action"

------=_Part_1_4558657.1118953559446
Content-Type: application/xop+xml; type="text/xml"; charset=utf-8

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <Detail xmlns="http://example.org/mtom/data">
      <image>
        <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
      </image>
    </Detail>
  </soap:Body>
</soap:Envelope>

------=_Part_1_4558657.1118953559446
Content-Type: image/jpeg
Content-ID: <5aeaa450-17f0-4484-b845-a8480c363444@example.org>


... binary data ...

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

soapXml = Chilkat::CkXml.new()

# Build the following SOAP XML

# <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
#   <soap:Body>
#     <Detail xmlns="http://example.org/mtom/data">
#       <image>
#         <xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org" />
#       </image>
#     </Detail>
#   </soap:Body>
# </soap:Envelope>

soapXml.put_Tag("soap:Envelope")
soapXml.AddAttribute("xmlns:soap","http://schemas.xmlsoap.org/soap/envelope/")
soapXml.UpdateAttrAt("soap:Body|Detail",true,"xmlns","http://example.org/mtom/data")
soapXml.UpdateAttrAt("soap:Body|Detail|image|xop:Include",true,"xmlns:xop","http://www.w3.org/2004/08/xop/include")
soapXml.UpdateAttrAt("soap:Body|Detail|image|xop:Include",true,"href","cid:5aeaa450-17f0-4484-b845-a8480c363444@example.org")

soapXml.put_EmitXmlDecl(false)
xmlBody = soapXml.getXml()
print xmlBody + "\n";

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/something/someTarget")

req.put_ContentType("multipart/related; start-info=\"text/xml\"; type=\"application/xop+xml\"")
req.AddHeader("SOAPAction","some-SOAP-action")

success = req.AddStringForUpload2("","",xmlBody,"utf-8","application/xop+xml; type=\"text/xml\"; charset=utf-8")

# The bytes will be sent as binary (not base64 encoded).
success = req.AddFileForUpload2("","qa_data/jpg/starfish.jpg","image/jpeg")

# The JPEG data is the 2nd sub-part, and therefore is at index 1 (the first sub-part is at index 0)
success = req.AddSubHeader(1,"Content-ID","<5aeaa450-17f0-4484-b845-a8480c363444@example.org>")

http.put_FollowRedirects(true)

useTls = true
# resp is a CkHttpResponse
resp = http.SynchronousRequest("www.example.org",443,useTls,req)
if (http.get_LastMethodSuccess() != true)
    print http.lastErrorText() + "\n";
    exit
end

# Imagine the HTTP response is multipart related and is something like this:

# HTTP/1.1 200 OK
# Cache-Control: no-cache, no-store
# Pragma: no-cache
# Transfer-Encoding: chunked
# Content-Type: multipart/related; boundary=------------080001080500020607080905
# Expires: -1
# Server: Microsoft-IIS/10.0
# X-AspNet-Version: 4.0.30319
# X-Powered-By: ASP.NET
# Date: Wed, 19 Feb 2020 15:27:06 GMT
# 
# --------------080001080500020607080905
# Content-Type: application/xop+xml; charset=iso-8859-1
# Content-Id: RootPart
# Content-Transfer-Encoding: binary
# 
# <?xml version="1.0" encoding="iso-8859-1"?>
# <soapenv:Envelope xmlns:xcpt="...">
#   <soapenv:Header />
#   <soapenv:Body>
#     <xres:Transport profile="http://something.example.com/..." version="1.4">
#       <xres:TransportHeader>
# 	...
# 	...
#       </xres:TransportHeader>
#       <xres:TransportBody />
#     </xres:Transport>
#   </soapenv:Body>
# </soapenv:Envelope>
# --------------080001080500020607080905--

# To get the XML, load the full MIME of the response into a Chilkat MIME object.  Then get the body of the 1st sub-part.
mime = Chilkat::CkMime.new()
mime.LoadMime(resp.fullMime())

# Your code might verify that the Content-Type is indeed multipart/related.
print mime.contentType() + "\n";
print "num parts = " + mime.get_NumParts().to_s() + "\n";

# Assuming it is, and the number of sub-parts is > 0
if (mime.get_NumParts() > 0)
    # part0 is a CkMime
    part0 = mime.GetPart(0)
    # The Content-Type (in this ficticious example) should be "application/xop+xml"
    print "sub-part Content-Type: " + part0.contentType() + "\n";
    # Now get the XML 
    subPartXmlBody = part0.getBodyDecoded()
    print subPartXmlBody + "\n";

end