Added STIgnore protocol to easily ignore property in request.

Author: kevin-lyn

README.md

@@ -57,6 +57,7 @@ STHTTPNetTaskQueueHandler *httpHandler = [[STHTTPNetTaskQueueHandler alloc] init
 @property (nonatomic, strong) NSString *body;
 @property (nonatomic, strong) NSDate *date;
 @property (nonatomic, assign) int userId;
+@property (nonatomic, strong) NSString<STIgnore> *ignored; // This property is ignored when packing the request.
 @property (nonatomic, strong, readonly) NSDictionary *post;
 
 @end
@@ -129,8 +130,29 @@ testPostTask.title = @"Test Post Net Task Title";
 testPostTask.body = @"Test Post Net Task Body";
 testPostTask.userId = 1;
 testPostTask.date = [NSDate new];
+testPostTask.ignored = @"test";
 [[STNetTaskQueue sharedQueue] addTaskDelegate:self uri:testPostTask.uri];
 [[STNetTaskQueue sharedQueue] addTask:testPostTask];
+
+// The net task will be sent as described below.
+/*
+    URI: posts
+    Method: POST
+    Request Type: Key-Value String
+    Response Type: JSON
+    Custom Headers:
+    {
+        "custom_header" = value;
+    }
+    Parameters:
+    {
+        body = "Test Post Net Task Body";
+        date = "1452239110.829915";
+        "other_parameter" = value;
+        title = "Test Post Net Task Title";
+        "user_id" = 1;
+    }
+ */
 ```
 
 #### Use subscription block

STNetTaskQueue/STHTTPNetTask.h

@@ -41,6 +41,23 @@ typedef NS_ENUM(NSUInteger, STHTTPNetTaskResponseType) {
     STHTTPNetTaskResponseRawData
 };
 
+/**
+ STIgnore marks a property as "ignore" so that the property will be ignored when packing the request.
+ STHTTPNetTaskRequestObject-ignoredProperties will do the same.
+ 
+ @see STHTTPNetTaskRequestObject
+ */
+@protocol STIgnore
+
+@end
+
+/**
+ To avoid complier warnings
+ */
+@interface NSObject (STHTTPNetTaskRequestObject) <STIgnore>
+
+@end
+
 /**
  If a class conforms to this protocol, it means the instance of this class will be converted to a dictionary and passed as parameter in a HTTP request.
  */

STNetTaskQueue/STHTTPNetTaskParametersPacker.m

@@ -158,8 +158,8 @@ - (NSString *)separatorFromRequestObject:(id<STHTTPNetTaskRequestObject>)request
 
 - (BOOL)shouldPackPropertyWithAttributes:(NSArray *)attributes
 {
-    // Only pack non-readonly property
-    return ![attributes containsObject:@"R"];
+    // Only pack non-readonly property and property which is not ignored.
+    return ![attributes containsObject:@"R"] && [attributes[0] rangeOfString:NSStringFromProtocol(@protocol(STIgnore))].location == NSNotFound;
 }
 
 @end

STNetTaskQueueTest/STNetTaskQueueTest/STNetTaskQueueTestHTTP.m

@@ -99,6 +99,7 @@ - (void)testPostNetTask
     testPostTask.body = @"Test Post Net Task Body";
     testPostTask.userId = 1;
     testPostTask.date = [NSDate new];
+    testPostTask.ignored = @"test";
     [[STNetTaskQueue sharedQueue] addTaskDelegate:self uri:testPostTask.uri];
     [[STNetTaskQueue sharedQueue] addTask:testPostTask];
 
@@ -273,7 +274,8 @@ - (void)netTaskDidEnd:(STNetTask *)task
             ![testPostTask.post[@"title"] isEqualToString:testPostTask.title] ||
             ![testPostTask.post[@"body"] isEqualToString:testPostTask.body] ||
             [testPostTask.post[@"user_id"] intValue] != testPostTask.userId ||
-            [testPostTask.post[@"date"] doubleValue] != testPostTask.date.timeIntervalSince1970) {
+            [testPostTask.post[@"date"] doubleValue] != testPostTask.date.timeIntervalSince1970 ||
+            testPostTask.post[@"ignored"] != nil) {
             XCTFail(@"%@ failed", _expectation.description);
         }
     }

STNetTaskQueueTest/STNetTaskQueueTest/STTestPostNetTask.h

@@ -14,6 +14,7 @@
 @property (nonatomic, strong) NSString *body;
 @property (nonatomic, strong) NSDate *date;
 @property (nonatomic, assign) int userId;
+@property (nonatomic, strong) NSString<STIgnore> *ignored; // This property is ignored when packing the request.
 @property (nonatomic, strong, readonly) NSDictionary *post;
 
 @end