猿圈APP（个人模仿版）

// AVHTTPClient.h // // Copyright (c) 2011 Gowalla (http://gowalla.com/) // // 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. #import <Foundation/Foundation.h> #import <Availability.h> #import <SystemConfiguration/SystemConfiguration.h> #import <MobileCoreServices/MobileCoreServices.h> /** `AVHTTPClient` captures the common patterns of communicating with an web application over HTTP. It encapsulates information like base URL, authorization credentials, and HTTP headers, and uses them to construct and manage the execution of HTTP request operations. ## Automatic Content Parsing Instances of `AVHTTPClient` may specify which types of requests it expects and should handle by registering HTTP operation classes for automatic parsing. Registered classes will determine whether they can handle a particular request, and then construct a request operation accordingly in `enqueueHTTPRequestOperationWithRequest:success:failure`. ## Subclassing Notes In most cases, one should create an `AVHTTPClient` subclass for each website or web application that your application communicates with. It is often useful, also, to define a class method that returns a singleton shared HTTP client in each subclass, that persists authentication credentials and other configuration across the entire application. ## Methods to Override To change the behavior of all url request construction for an `AVHTTPClient` subclass, override `requestWithMethod:path:parameters`. To change the behavior of all request operation construction for an `AVHTTPClient` subclass, override `HTTPRequestOperationWithRequest:success:failure`. ## Default Headers By default, `AVHTTPClient` sets the following HTTP headers: - `Accept-Language: (comma-delimited preferred languages), en-us;q=0.8` - `User-Agent: (generated user agent)` You can override these HTTP headers or define new ones using `setDefaultHeader:value:`. ## URL Construction Using Relative Paths Both `-requestWithMethod:path:parameters:` and `-multipartFormRequestWithMethod:path:parameters:constructingBodyWithBlock:` construct URLs from the path relative to the `-baseURL`, using `NSURL +URLWithString:relativeToURL:`. Below are a few examples of how `baseURL` and relative paths interact: NSURL *baseURL = [NSURL URLWithString:@"http://example.com/v1/"]; [NSURL URLWithString:@"foo" relativeToURL:baseURL]; // http://example.com/v1/foo [NSURL URLWithString:@"foo?bar=baz" relativeToURL:baseURL]; // http://example.com/v1/foo?bar=baz [NSURL URLWithString:@"/foo" relativeToURL:baseURL]; // http://example.com/foo [NSURL URLWithString:@"foo/" relativeToURL:baseURL]; // http://example.com/v1/foo [NSURL URLWithString:@"/foo/" relativeToURL:baseURL]; // http://example.com/foo/ [NSURL URLWithString:@"http://example2.com/" relativeToURL:baseURL]; // http://example2.com/ Also important to note is that a trailing slash will be added to any `baseURL` without one, which would otherwise cause unexpected behavior when constructing URLs using paths without a leading slash. ## NSCoding / NSCopying Conformance `AVHTTPClient` conforms to the `NSCoding` and `NSCopying` protocols, allowing operations to be archived to disk, and copied in memory, respectively. There are a few minor caveats to keep in mind, however: - Archives and copies of HTTP clients will be initialized with an empty operation queue. - NSCoding cannot serialize / deserialize block properties, so an archive of an HTTP client will not include any reachability callback block that may be set. */ #ifdef _SYSTEMCONFIGURATION_H typedef enum { AVNetworkReachabilityStatusUnknown = -1, AVNetworkReachabilityStatusNotReachable = 0, AVNetworkReachabilityStatusReachableViaWWAN = 1, AVNetworkReachabilityStatusReachableViaWiFi = 2, } AVNetworkReachabilityStatus; #else #warning SystemConfiguration framework not found in project, or not included in precompiled header. Network reachability functionality will not be available. #endif #ifndef __UTTYPE__ #if __IPHONE_OS_VERSION_MIN_REQUIRED #warning MobileCoreServices framework not found in project, or not included in precompiled header. Automatic MIME type detection when uploading files in multipart requests will not be available. #else #warning CoreServices framework not found in project, or not included in precompiled header. Automatic MIME type detection when uploading files in multipart requests will not be available. #endif #endif typedef enum { AVFormURLParameterEncoding, AVJSONParameterEncoding, AVPropertyListParameterEncoding, } AVHTTPClientParameterEncoding; @class AVHTTPRequestOperation; @protocol AVMultipartFormData; @interface AVHTTPClient : NSObject <NSCoding, NSCopying> ///--------------------------------------- /// @name Accessing HTTP Client Properties ///--------------------------------------- /** The url used as the base for paths specified in methods such as `getPath:parameters:success:failure` */ @property (readonly, nonatomic) NSURL *baseURL; /** The string encoding used in constructing url requests. This is `NSUTF8StringEncoding` by default. */ @property (nonatomic, assign) NSStringEncoding stringEncoding; /** The `AVHTTPClientParameterEncoding` value corresponding to how parameters are encoded into a request body. This is `AVFormURLParameterEncoding` by default. @warning Some nested parameter structures, such as a keyed array of hashes containing inconsistent keys (i.e. `@{@"": @[@{@"a" : @(1)}, @{@"b" : @(2)}]}`), cannot be unambiguously represented in query strings. It is strongly recommended that an unambiguous encoding, such as `AVJSONParameterEncoding`, is used when posting complicated or nondeterministic parameter structures. */ @property (nonatomic, assign) AVHTTPClientParameterEncoding parameterEncoding; /** The operation queue which manages operations enqueued by the HTTP client. */ @property (readonly, nonatomic) NSOperationQueue *operationQueue; /** The reachability status from the device to the current `baseURL` of the `AVHTTPClient`. @warning This property requires the `SystemConfiguration` framework. Add it in the active target's "Link Binary With Library" build phase, and add `#import <SystemConfiguration/SystemConfiguration.h>` to the header prefix of the project (`Prefix.pch`). */ #ifdef _SYSTEMCONFIGURATION_H @property (readonly, nonatomic, assign) AVNetworkReachabilityStatus networkReachabilityStatus; #endif ///--------------------------------------------- /// @name Creating and Initializing HTTP Clients ///--------------------------------------------- /** Creates and initializes an `AVHTTPClient` object with the specified base URL. @param url The base URL for the HTTP client. This argument must not be `nil`. @return The newly-initialized HTTP client */ + (instancetype)c