AlamofireXMLRPC

AlamofireXMLRPC brings XML RPC functionalities to Alamofire. It aims to provide an easy way to perform XMLRPC call and to retrieve smoothly the response.

XML is handled internally with AEXML.

Example

Take the following request and response handler:

let data: NSData = ...
let params: [Any] = [42, "text", 3.44, NSDate(), data]
AlamofireXMLRPC.request("http://localhost:8888/xmlrpc", methodName: "foo", parameters: params).responseXMLRPC { (response:Response<[XMLRPCNode], NSError>) -> Void in
      guard response.result.isSuccess else {
        ...
        return
      }

      if let value = response.result.value, message = value[0].string, age = value[1]["age"].int32  {
              ...
      }
}

It will generate the following call and lets you parse the corresponding answer from the XMLRPC service:

<!-- request -->
<methodCall>
	<methodName>foo</methodName>
	<params>
		<param>
			<value>
				<int>42</int>
			</value>
		</param>
		<param>
			<value>
				<string>text</string>
			</value>
		</param>
		<param>
			<value>
				<double>3.44</double>
			</value>
		</param>
		<param>
			<value>
				<dateTime.iso8601>19980717T14:08:55</dateTime.iso8601>
			</value>
		</param>
		<param>
			<value>
				<base64>eW91IGNhbid0IHJlYWQgdGhpcyE=</base64>
			</value>
		</param>
	</params>
</methodCall>

<!-- response -->
<methodResponse>
  <params>
    <param>
      <value>
        <string>Hello world!</string>
      </value>
    </param>
    <param>
      <value>
        <struct>
          <member>
            <name>name</name>
            <value>
              <string>John Doe</string>
            </value>
          </member>
          <member>
            <name>age</name>
            <value>
              <int>36</int>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

Requirements

• iOS 8.0+ / Mac OS X 10.10+
• Xcode 7

Install CocoaPods

You can use Cocoapods to install AlamofireXMLRPCby adding it to your Podfile:

use_frameworks!

target 'MyApp' do
	pod 'AlamofireXMLRPC', :git => 'https://github.com/kodlian/AlamofireXMLRPC.git'
end

Request

Method request

// Call XMLRPC service with the sharedManager of Alamofire
AlamofireXMLRPC.request("https://xmlrpcservice", method:"foo" parameters: [1,2.0,"ddd",["key":"value"]])
// Call XMLRPC service with your custom manager
manager.requestXMLRPC("https://xmlrpcservice", method:"foo" parameters: [1,2.0,"ddd",["key":"value"]])

XMLRPC Request convertible

Types adopting the XMLRPCRequestConvertible protocol can be used to construct XMLRPC call.

public protocol XMLRPCRequestConvertible {
    var URLString: URLStringConvertible { get }
    var methodName: String { get }
    var parameters: [Any]? { get }
    var headers: [String : String]? { get }
}

struct MyRequest: XMLRPCRequestConvertible {
  ...
}

let request =  MyRequest(...)
Alamofire.request(request) // Call XMLRPC service with Alamofire

Values

Mapping

AlamofireXMLRPC uses the following mapping for swift values to XML RPC values:

Swift	Example	XMLRPC	note
String	"foo"	<string>foo</string>
Int, Int32, Int16, Int8, UInt16, UInt8	42	<int>42</int>	XML RPC Integer is 32bits, Int values are converted to Int32
Bool	true	<boolean>1</boolean>
Double, Float	3.44	<double>3.44</double>
NSDate	NSDate()	<dateTime.iso8601>19980717T14:08:55</dateTime.iso8601>
NSData	NSData()	<base64>eW91IGNhbid0IHJlYWQgdGhpcyE=</base64>

By default other types will be mapped as XML RPC String and use the default String representation. Bu you can provide your own mapping for custom Types by adopting the protocol XMLRPCValueConvertible.

enum XMLRPCValueKind: String {
    case Integer = "int"
    case Double = "double"
    case Boolean = "boolean"
    case String = "string"
    case DateTime = "dateTime.iso8601"
    case Base64 = "base64"
}

protocol XMLRPCValueConvertible {
    var xmlRpcKind: XMLRPCValueKind { get }
    var xmlRpcValue: String { get }
}

Collection

Swift arrays [Any] are convertible to XMLRPC arrays but you need to cast them as XMLRPCArray.

[1,"too"] as XMLRPCArray

As well dictionaries [String:Any] are convertible to XMLRPC structure by casting them as XMLRPCStructure.

["name":"John Doe","age":35] as XMLRPCStructure

Response

Response

XMLRPC Responses are handled with the method responseXMLRPC(completionHandler: Response<[XMLRPCNode], NSError> -> Void). The received parameters are mapped to an XMLRPCNode. This allows you to fetch easily data within complex structure or tree.

Subscript

For each XMLRPCNode you can access subnode by index or by String key. Internally children of XMLRPC Array and Structure will be fetched.

aRequest.responseXMLRPC{ (response:Response<[XMLRPCNode], NSError>) -> Void in
      guard let value = response.result.value where response.result.isSuccess else {
        return
      }

      if let message = value[0]["aKey"][9].string  {
              ...
      }
}

Don't worry about unwrapping things and checking the value type or presence. The optional management is solely done when you request the swift value with one of the optional getters.

For instance, you can call value[0]["aKey"][9] without worrying if the objects tree actually exist.

Optional getters

var array: [XMLRPCNode]?
var dictionary: [String:XMLRPCNode]?
var string: String?
var int32: Int32?
var double: Double?
var bool: Bool?
var count: Int?

License

AlamofireXMLRPC is released under the MIT license. See LICENSE for details.

TO DO

• XMLRPCNode enumeration
• Find a way to avoid to cast array and dictionary for value mapping