aerogear-ios-httpstub

A small library inspired by OHHTTPStubs to stub your network requests written in Swift.

This module is beta software, it currently supports Xcode 6.1.1

	Project Info
License:	Apache License, Version 2.0
Build:	Cocoapods
Documentation:	https://aerogear.org/docs/guides/aerogear-ios-2.X/
Issue tracker:	https://issues.jboss.org/browse/AGIOS
Mailing lists:	aerogear-users (subscribe)
	aerogear-dev (subscribe)

Example Usage

Initialize from an NSData

// set up http stub
StubsManager.stubRequestsPassingTest({ (request: NSURLRequest!) -> Bool in
    return true
}, withStubResponse:( { (request: NSURLRequest!) -> StubResponse in
    return StubResponse(data:NSData.data(), statusCode: 200, headers: ["Content-Type" : "text/json"])
}))

// async test expectation
let registrationExpectation = expectationWithDescription("testStubWithNSURLSessionDefaultConfiguration");

let request = NSMutableURLRequest(URL: NSURL(string: "http://server.com"))

let config = NSURLSessionConfiguration.defaultSessionConfiguration()
let session = NSURLSession(configuration: config)

let task = session.dataTaskWithRequest(request) {(data, response, error) in
    XCTAssertNil(error, "unexpected error")
    XCTAssertNotNil(data, "response should contain data")
    
    registrationExpectation.fulfill()
}

task.resume()

waitForExpectationsWithTimeout(10, handler: nil)

Initialize from a file located in either a Bundle or a Documents Directory

// set up http stub from a stubbed file located in the test bundle
StubsManager.stubRequestsPassingTest({ (request: NSURLRequest!) -> Bool in
    return true
}, withStubResponse:( { (request: NSURLRequest!) -> StubResponse in
     return StubResponse(filename: "mystubbedjson.json", location:.Bundle(NSBundle(forClass: AeroGearHttpStubTests.self)), statusCode: 200, headers: ["Content-Type" : "text/json"])
}))

// or
// set up http stub from a stubbed file located in the 'Documents' directory
StubsManager.stubRequestsPassingTest({ (request: NSURLRequest!) -> Bool in
    return true
}, withStubResponse:( { (request: NSURLRequest!) -> StubResponse in
     return StubResponse(filename: "mystubbedjson.json", location:.Documents, statusCode: 200, headers: ["Content-Type" : "text/json"])
}))

Adding the library to your project

To add the library in your project, you can either use Cocoapods or manual install in your project. See the respective sections below for instructions:

Using Cocoapods

At this time, Cocoapods support for Swift frameworks is supported in a pre-release. In your Podfile add:

pod 'AeroGearHttpStub'

and then:

pod install

to install your dependencies

Manual Installation

Follow these steps to add the library in your Swift project:

1. Add AeroGearHttpStub as a submodule in your project. Open a terminal and navigate to your project directory. Then enter:

git submodule add https://github.com/aerogear/aerogear-ios-httpstub.git

2. Open the aerogear-ios-httpstub folder, and drag the AeroGearHttpStub.xcodeproj into the file navigator in Xcode.
3. In Xcode select your application target and under the "Targets" heading section, ensure that the 'iOS Deployment Target' matches the application target of AeroGearHttpStub.framework (Currently set to 8.0).
4. Select the "Build Phases" heading section, expand the "Target Dependencies" group and add AeroGearHttpStub.framework.
5. Click on the + button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add AeroGearHttpStub.framework.

Documentation

For more details about the current release, please consult our documentation.

Development

If you would like to help develop AeroGear you can join our developer's mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.

Also takes some time and skim the contributor guide

Questions?

Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!

Found a bug?

If you found a bug please create a ticket for us on Jira with some steps to reproduce it.