Minimalistic Swift HTTP request agent for iOS and OS X.

This is a tiny framework that gives you nice a API for crafting an HTTP request.

Throughout this documentation req is used as an instance of Agent.

The Agent API is simple and easy to use. Simply use Agent.<verb>(url) and you're good to go.

It is possible to perform an entire request with a single call. Supply the required parameters when first creating the request. There are usually multiple degrees of overloading.

Agent.post("http:https://example.com", headers: [ "Header": "Value" ],
                                    data: [ "Key": "Value" ],
                                    done: { (error: NSError?, response: NSHTTPURLResponse?) -> () in
  if (error) {
    return
  }
  println(response!)
})

It's possible to omit must overloaded parameters such as headers.

Every Agent method returns the Agent itself, therefor it is possible to write more expressive code.

Agent.post("http:https://example.com")
  .send([ "Key": "Value" ])
  .end({ (error: NSError?, response: NSHTTPURLResponse?) -> () in
    if (error) {
      return
    }
    println(response!)
  }
)

let req = Agent.get("http:https://example.com")
req.end({ (error: NSError?, response: NSHTTPURLResponse?) -> () in
  if (error) {
    return
  }
  println(response!)
})

let req = Agent.post("http:https://example.com")
req.send([ "Key": "Value" ])
req.end({ (error: NSError?, response: NSHTTPURLResponse?) -> () in
  if (error) {
    return
  }
  println(response!)
})

let req = Agent.put("http:https://example.com")
req.send([ "Key": "Value" ])
req.end({ (error: NSError?, response: NSHTTPURLResponse?) -> () in
  if (error) {
    return
  }
  println(response!)
})

let req = Agent.delete("http:https://example.com")
req.end({ (error: NSError?, response: NSHTTPURLResponse?) -> () in
  if (error) {
    return
  }
  println(response!)
})

Will JSON serialize any data and send it along as the HTTP body. Also implicitly sets the Content-Type header to application/json.

Sets the HTTP header to value.

Will start the request and call done when it's complete.

If there was an error then $0 will be an NSErrror that you can inspect for more information.

If the request was successful then $1 will be an NSHTTPURLResponse.

You can always access the underlying NSMutableURLRequest using req.request!, please notice that it is an optional.

We're happy to receive any pull requests. Right now we're working hard on a number of features as seen below.

• Complete asynchronous tests
• Reading response data
• Plugins
• Specialized agents (to handle default headers and such)

Any issue is appreciated.

(The MIT License)

Copyright (c) 2014 Christoffer Hallas <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.