Repository navigation
Expand file tree
/
Copy pathJSONHTTPClient.h
More file actions
157 lines (130 loc) · 6.47 KB
/
Copy pathJSONHTTPClient.h
File metadata and controls
157 lines (130 loc) · 6.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
//
// JSONModelHTTPClient.h
//
// @version 0.9.0
// @author Marin Todorov, http://www.touch-code-magazine.com
//
// Copyright (c) 2012 Marin Todorov, Underplot ltd.
// This code is distributed under the terms and conditions of the MIT license.
//
// 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.
//
// The MIT License in plain English: http://www.touch-code-magazine.com/JSONModel/MITLicense
#import "JSONModel.h"
#import "JSONCache.h"
#pragma mark - definitions
/**
* HTTP Request methods
*/
extern NSString* const kHTTPMethodGET;
extern NSString* const kHTTPMethodPOST;
/**
* Content-type strings
*/
extern NSString* const kContentTypeAutomatic;
extern NSString* const kContentTypeJSON;
extern NSString* const kContentTypeWWWEncoded;
extern NSData* kUseCachedObjectResponse;
/**
* A block type to handle incoming JSON object and an error.
* You pass it to methods which fetch JSON asynchroniously. When the operation is finished
* you receive back the fetched JSON (or nil) and an error (or nil)
*
* @param json object derived from a JSON string
* @param err JSONModelError or nil
*/
typedef void (^JSONObjectBlock)(NSDictionary* json, JSONModelError* err);
/////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark - configuration methods
/**
* A very thin HTTP client that can do GET and POST HTTP requests.
* It fetches only JSON data and also deserializes it using NSJSONSerialization.
*
*/
@interface JSONHTTPClient : NSObject
/////////////////////////////////////////////////////////////////////////////////////////////
/** @name HTTP Client configuration */
/**
* A dictioanry of HTTP headers the client sends along the requests
*/
+(NSMutableDictionary*)requestHeaders;
/**
* Sets the default encoding of the request body.
* See NSStringEncoding for a list of supported encodings
* @param encoding text encoding constant
*/
+(void)setDefaultTextEncoding:(NSStringEncoding)encoding;
/**
* Sets the policies for caching HTTP data
* See NSURLRequestCachePolicy for a list of the pre-defined policies
* @param policy the caching policy
*/
+(void)setCachingPolicy:(NSURLRequestCachePolicy)policy;
/**
* Sets the timeout for network calls
* @param seconds the amount of seconds to wait before considering the call failed
*/
+(void)setTimeoutInSeconds:(int)seconds;
/**
* A method to enable/disable automatic network indicator showing.
* Set to YES by default.
* @param doesControlIndicator if YES, the library shows and hides the
* system network indicator automatically on begin and end of
* network operations
*/
+(void)setControlsNetworkIndicator:(BOOL)doesControlIndicator;
/**
* A method to set the default conent type of the request body
* By default the content type is set to kContentTypeAutomatic
* which checks the body request and decides between "application/json"
* and "application/x-www-form-urlencoded"
*/
+(void)setRequestContentType:(NSString*)contentTypeString;
+(void)setIsUsingJSONCache:(BOOL)doesUse;
/////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark - GET asynchronious JSON calls
/** @name Making asynchronious HTTP requests */
/**
* Makes GET request to the given URL address and fetches a JSON response.
* @param urlString the URL as a string
* @param completeBlock JSONObjectBlock to execute upon completion
* @return JSON compliant object or nil
*/
+(void)getJSONFromURLWithString:(NSString*)urlString completion:(JSONObjectBlock)completeBlock;
/**
* Makes GET request to the given URL address and fetches a JSON response. Sends the params as a query string variables.
* @param urlString the URL as a string
* @param params a dictionary of key / value pairs to be send as variables to the request
* @param completeBlock JSONObjectBlock to execute upon completion
* @return JSON compliant object or nil
*/
+(void)getJSONFromURLWithString:(NSString*)urlString params:(NSDictionary*)params completion:(JSONObjectBlock)completeBlock;
/////////////////////////////////////////////////////////////////////////////////////////////
#pragma mark - POST synchronious JSON calls
/**
* Makes POST request to the given URL address and fetches a JSON response. Sends the bodyString param as the POST request body.
* @param urlString the URL as a string
* @param params a dictionary of key / value pairs to be send as variables to the request
* @param completeBlock JSONObjectBlock to execute upon completion
* @return JSON compliant object or nil
*/
+(void)postJSONFromURLWithString:(NSString*)urlString params:(NSDictionary*)params completion:(JSONObjectBlock)completeBlock;
/**
* Makes POST request to the given URL address and fetches a JSON response. Sends the bodyString param as the POST request body.
* @param urlString the URL as a string
* @param bodyString the body of the POST request as a string
* @param completeBlock JSONObjectBlock to execute upon completion
* @return JSON compliant object or nil
*/
+(void)postJSONFromURLWithString:(NSString*)urlString bodyString:(NSString*)bodyString completion:(JSONObjectBlock)completeBlock;
/**
* Makes POST request to the given URL address and fetches a JSON response. Sends the bodyString param as the POST request body.
* @param urlString the URL as a string
* @param bodyData the body of the POST request as an NSData object
* @param completeBlock JSONObjectBlock to execute upon completion
* @return JSON compliant object or nil
*/
+(void)postJSONFromURLWithString:(NSString*)urlString bodyData:(NSData*)bodyData completion:(JSONObjectBlock)completeBlock;
@end