Skip to content

Latest commit

 

History

History
63 lines (51 loc) · 2.89 KB

README.md

File metadata and controls

63 lines (51 loc) · 2.89 KB
Raw

SZNetworking

The library is similar in intent to AFNetworking, with a slightly different architecture, fewer features and a lot less code. It’s meant to be (nearly) the bare minimum you need to create http requests and manage NSMutableURLRequests through NSOperation and NSOperationQueue.

It’s not used in any production apps at the moment. It's intended for use with the next generation Socialize API. Use should be experimental at this point unless you intend to fix a bug or two. The project does have heavy unit test coverage. It is small enough where bugs should be minimal and you can quickly get a good understanding of what’s going on if you’d like to.

Example GET (GitHub API)

self.operationQueue = [[NSOperationQueue alloc] init];
self.operationQueue.maxConcurrentOperationCount = 5;

NSMutableURLRequest *request = [NSMutableURLRequest HTTPRequestWithMethod:@"GET" scheme:@"https" host:@"api.github.com" path:@"/users/socialize/repos" parameters:nil];
SZURLRequestOperation *operation = [[SZURLRequestOperation alloc] initWithURLRequest:request];
operation.URLCompletionBlock = ^(NSURLResponse *response, NSData *data, NSError *error) {
    id json = [data objectFromJSONData];
    NSLog(@"%@", json);
};

[self.operationQueue addOperation:operation];

Example POST With OAuth (Socialize API v1)

NSString *payload = [@{@"udid": @"12345"} JSONString];
NSMutableURLRequest *request = [NSMutableURLRequest HTTPRequestWithMethod:@"POST" scheme:@"https" host:@"api.getsocialize.com" path:@"/v1/authenticate/" parameters:@{@"payload": payload}];
[request setAuthorizationHeaderWithConsumerKey:@"252f7ed8-2fe5-49a5-8b52-b5c06bd63891" consumerSecret:@"ea9dc991-fb32-4d40-9d85-aab35debf61c" token:nil tokenSecret:nil];
SZURLRequestOperation *operation = [[SZURLRequestOperation alloc] initWithURLRequest:request];
operation.URLCompletionBlock = ^(NSURLResponse *response, NSData *data, NSError *error) {
    id result = [data objectFromJSONData];
    NSLog(@"%@", result);
};

Some major differences from AFNetworking:

  • Ships with builtin support for signing oauth requests (setting HTTP Authorization header). Depends on widely used OAuthCore library for setting signature. This is the request-level support for oauth, you are on your own for UI or auth process.
  • Lighter (<1000 SLOC vs >5000 SLOC)
  • HTTP request setup (parameters, OAuth) exists on exposed category methods of NSMutableURLRequest instead of on an included HTTP client class. This is organizational preference and allows a bit more flexibility when working with url requests.
  • Operations autofail if one of their dependencies has already failed.

Planned but missing features:

  • Request Pausing. You can pause a queue, but not a request midstream.
  • SSL whitelisting
  • Progress delegate callbacks.