add fields sequence if it's required (need help) (#914)

vpulim · Jan 25, 2017 · 5dbcb1d · 5dbcb1d · mbianchihr · Mar 28, 2017
1 parent 00ec5f1
commit 5dbcb1d
Show file tree

Hide file tree

Showing 5 changed files with 183 additions and 2 deletions.
diff --git a/lib/client.js b/lib/client.js
@@ -182,6 +182,62 @@ Client.prototype._defineMethod = function(method, location) {
   };
 };
 
+Client.prototype._isSequenceRequired = function(methodName) {
+  var tns = this.wsdl.definitions.$targetNamespace;
+  var methodRequestName = _.result(this.wsdl.definitions, 'messages.' + methodName + '.$name');
+  var args = _.result(this.wsdl.definitions, 'messages.' + methodRequestName + '.parts');
+
+  if(typeof args === 'undefined' && typeof _.pick(args, 'params') !== 'undefined') {
+    return false;
+  }
+  if(Object.keys(args).length === 1) {
+    return false;
+  }
+
+  var complexTypeName = _.result(this.wsdl.definitions, 'messages.' + methodRequestName + '.element.$name');
+  var modeOfComplexType = _.result(
+    this.wsdl.definitions,
+    'schemas[\'' + tns + '\'].elements.' + complexTypeName + '.children[0].children[0].name');
+
+  if(modeOfComplexType === 'sequence') {
+    return true;
+  }
+
+  return false;
+};
+
+Client.prototype._setSequenceArgs = function(argsScheme, args) {
+  var result = {};
+  if(typeof argsScheme !== 'object') {
+    return args;
+  }
+  for (var partIndex in argsScheme) {
+    if(typeof args[partIndex] === 'undefined') {
+      continue;
+    }
+    if(typeof argsScheme[partIndex] !== 'object') {
+      result[partIndex] = args[partIndex];
+    } else {
+      result[partIndex] = this._setSequenceArgs(argsScheme[partIndex], args[partIndex]);
+    }
+  }
+  return result;
+};
+
+Client.prototype._getArgsScheme = function(methodName) {
+  var methodRequestName = _.result(this.wsdl.definitions, 'messages.'+methodName+'.$name');
+  var args = _.result(this.wsdl.definitions, 'messages.' + methodRequestName + '.parts');
+
+  if(typeof args === 'undefined' && typeof _.pick(args, 'params') !== 'undefined') {
+    return [];
+  }
+  if(Object.keys(args).length === 1) {
+    return [];
+  }
+
+  return args;
+};
+
 Client.prototype._invoke = function(method, args, location, callback, options, extraHeaders) {
   var self = this,
     name = method.$name,
@@ -202,6 +258,13 @@ Client.prototype._invoke = function(method, args, location, callback, options, e
     },
     xmlnsSoap = "xmlns:" + envelopeKey + "=\"http://schemas.xmlsoap.org/soap/envelope/\"";
 
+  if(this._isSequenceRequired(name)) {
+    var argsScheme = this._getArgsScheme(name);
+    if(argsScheme) {
+      args = this._setSequenceArgs(argsScheme, args);
+    }
+  }
+
   if (this.wsdl.options.forceSoap12Headers) {
     headers["Content-Type"] = "application/soap+xml; charset=utf-8";
     xmlnsSoap = "xmlns:" + envelopeKey + "=\"http://www.w3.org/2003/05/soap-envelope\"";

diff --git a/lib/wsdl.js b/lib/wsdl.js
@@ -2079,7 +2079,7 @@ WSDL.prototype._fromServices = function(services) {
 
 };
 
-
+WSDL.prototype._splitQName = splitQName;
 
 WSDL.prototype._xmlnsMap = function() {
   var xmlns = this.definitions.xmlns;

diff --git a/test/request-response-samples/readMetadata__should_respect_xsi_type_attribute/soap.wsdl b/test/request-response-samples/readMetadata__should_respect_xsi_type_attribute/soap.wsdl
@@ -11,7 +11,7 @@ Copyright 2006-2015 Salesforce.com, inc. All Rights Reserved
     <xsd:complexType>
      <xsd:sequence>
       <xsd:element name="type" type="xsd:string"/>
-      <xsd:element name="fullNames" minOccurs="0" maxOccurs="unbounded" type="xsd:string"/>
+      <xsd:element name="fullNames" type="xsd:string"/>
      </xsd:sequence>
     </xsd:complexType>
    </xsd:element>

diff --git a/test/sequence-test.js b/test/sequence-test.js
@@ -0,0 +1,55 @@
+'use strict';
+
+var fs = require('fs'),
+    soap = require('..'),
+    http = require('http'),
+    assert = require('assert'),
+    _ = require('lodash'),
+    sinon = require('sinon'),
+    wsdl = require('../lib/wsdl');
+
+var sequencedRequest = {
+  'url': 'https://github.com',
+  'fileName': 'qwe.txt',
+  'fileMode': 1,
+  'forceOverwrite': true,
+  'username': 'qwert',
+  'password': 'qwerty',
+  'base64EncodedCallback': '123'
+};
+
+var notSequencedRequest = {
+  'password': 'qwerty',
+  'base64EncodedCallback': '123',
+  'username': 'qwert',
+  'forceOverwrite': true,
+  'fileMode': 1,
+  'fileName': 'qwe.txt',
+  'url': 'https://github.com'
+};
+
+describe('Method args sequence', function() {
+
+    it('check if method required sequence args', function(done) {
+      soap.createClient(__dirname + '/wsdl/rpcexample.wsdl',  { suffix: '', options: {} }, function(err, client) {
+        assert.ok(client);
+        assert.ok(client._isSequenceRequired('pullFile') === false);
+
+        soap.createClient(__dirname + '/wsdl/sequnceexmple.wsdl',  { suffix: '', options: {} }, function(err, client) {
+          assert.ok(client);
+          assert.ok(client._isSequenceRequired('pullFile') === true);
+          done();
+        });
+      });
+    });
+
+    it('check sort args on sequence required method', function(done) {
+        soap.createClient(__dirname + '/wsdl/sequnceexmple.wsdl', { suffix: '', options: {} }, function(err, client) {
+          assert.ok(client);
+          var sequencedMethodRequest = client._setSequenceArgs(client._getArgsScheme('pullFile'), notSequencedRequest);
+          assert.ok(JSON.stringify(sequencedMethodRequest) === JSON.stringify(sequencedRequest));
+          done();
+        });
+    });
+
+});
diff --git a/test/wsdl/sequnceexmple.wsdl b/test/wsdl/sequnceexmple.wsdl
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions xmlns:tns="urn:RpcExample" xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
+             xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding"
+             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+             xmlns:RpcExample="urn:RpcExample" xmlns:SOAP="http://schemas.xmlsoap.org/wsdl/soap12/"
+             xmlns:MIME="http://schemas.xmlsoap.org/wsdl/mime/"
+             xmlns:DIME="http://schemas.xmlsoap.org/ws/2002/04/dime/wsdl/" xmlns:WSDL="http://schemas.xmlsoap.org/wsdl/"
+             xmlns="http://schemas.xmlsoap.org/wsdl/" name="urn:RpcExample" targetNamespace="urn:RpcExample">
+    <types>
+        <schema xmlns:SOAP-ENV="http://www.w3.org/2003/05/soap-envelope"
+                xmlns:SOAP-ENC="http://www.w3.org/2003/05/soap-encoding"
+                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+                xmlns:RpcExample="urn:RpcExample" xmlns="http://www.w3.org/2001/XMLSchema"
+                targetNamespace="urn:RpcExample" elementFormDefault="unqualified" attributeFormDefault="unqualified">
+            <import namespace="http://www.w3.org/2003/05/soap-encoding"/>
+            <element name="pullFile">
+                <complexType>
+                    <sequence>
+                        <element name="url" type="xsd:string" minOccurs="1" maxOccurs="1"/>
+                        <element name="fileName" type="xsd:string" minOccurs="1" maxOccurs="1"/>
+                        <element name="fileMode" type="xsd:int" minOccurs="1" maxOccurs="1"/>
+                        <element name="forceOverwrite" type="xsd:boolean" minOccurs="1" maxOccurs="1"/>
+                        <element name="username" type="xsd:string" minOccurs="1" maxOccurs="1"/>
+                        <element name="password" type="xsd:string" minOccurs="1" maxOccurs="1"/>
+                        <element name="base64EncodedCallback" type="xsd:string" minOccurs="1" maxOccurs="1"/>
+                    </sequence>
+                </complexType>
+            </element>
+        </schema>
+    </types>
+    <message name="pullFileRequest">
+        <part name="parameters" element="tns:pullFile"/>
+    </message>
+    <message name="pullFileResponse">
+        <part name="parameters" type="xsd:boolean"/>
+    </message>
+    <portType name="RpcExamplePortType">
+        <operation name="pullFile">
+            <documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">Generate an indicium.</documentation>
+            <input message="tns:pullFileRequest"/>
+            <output message="tns:pullFileResponse"/>
+        </operation>
+    </portType>
+    <binding name="RpcExample" type="tns:RpcExamplePortType">
+        <SOAP:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>
+        <operation name="pullFile">
+            <SOAP:operation style="rpc"/>
+            <input>
+                <SOAP:body use="encoded" namespace="urn:RpcExample"
+                           encodingStyle="http://www.w3.org/2003/05/soap-encoding"/>
+            </input>
+            <output>
+                <SOAP:body use="encoded" namespace="urn:RpcExample"
+                           encodingStyle="http://www.w3.org/2003/05/soap-encoding"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="RpcExample">
+        <port name="RpcExample" binding="tns:RpcExample">
+            <SOAP:address location="http://127.0.0.1/"/>
+        </port>
+    </service>
+</definitions>