Add HTTP Verb to RKRequestDescriptor

Author: segiddins

Code/Network/RKObjectManager.m

@@ -69,16 +69,14 @@
  @param object The object to find a matching request descriptor for.
  @return An `RKRequestDescriptor` object matching the given object, or `nil` if none could be found.
  */
-static RKRequestDescriptor *RKRequestDescriptorFromArrayMatchingObject(NSArray *requestDescriptors, id object)
+static RKRequestDescriptor *RKRequestDescriptorFromArrayMatchingObjectAndRequestMethod(NSArray *requestDescriptors, id object, RKRequestMethod requestMethod)
 {
     Class searchClass = [object class];
     do {
         for (RKRequestDescriptor *requestDescriptor in requestDescriptors) {
-            if ([requestDescriptor.objectClass isEqual:searchClass]) return requestDescriptor;
+            if ([requestDescriptor matchesObject:object requestMethod:requestMethod exactMatch:YES]) return requestDescriptor;
         }
-        searchClass = [searchClass superclass];
-    } while (searchClass);
-    
+    } while ((searchClass = [searchClass superclass]));
     return nil;
 }
 
@@ -429,7 +427,7 @@ - (id)mergedParametersWithObject:(id)object method:(RKRequestMethod)method param
     NSArray *objectsToParameterize = ([object isKindOfClass:[NSArray class]] || object == nil) ? object : @[ object ];
     RKObjectParameters *objectParameters = [RKObjectParameters new];
     for (id objectToParameterize in objectsToParameterize) {
-        RKRequestDescriptor *requestDescriptor = RKRequestDescriptorFromArrayMatchingObject(self.requestDescriptors, objectToParameterize);
+        RKRequestDescriptor *requestDescriptor = RKRequestDescriptorFromArrayMatchingObjectAndRequestMethod(self.requestDescriptors, objectToParameterize, method);
         if ((method != RKRequestMethodGET && method != RKRequestMethodDELETE) && requestDescriptor) {
             NSError *error = nil;
             NSDictionary *parametersForObject = [RKObjectParameterization parametersWithObject:objectToParameterize requestDescriptor:requestDescriptor error:&error];

Code/Network/RKRequestDescriptor.h

@@ -19,12 +19,13 @@
 //
 
 #import <Foundation/Foundation.h>
+#import "RKHTTPUtilities.h"
 
 @class RKMapping;
 
 /**
  An `RKRequestDescriptor` object describes an object mapping configuration that is used to construct the parameters of an HTTP request for an object. Request descriptors are defined by specifying the `RKMapping` object (whose `objectClass` must be `NSMutableDictionary`) that is to be used when object mapping an object into an `NSDictionary` of parameters, the class of the type of object for which the mapping is to be applied, and an optional root key path under which the paramters are to be nested. Response descriptors are only utilized when construct parameters for an `NSURLRequest` with an HTTP method of `POST`, `PUT`, or `PATCH`.
- 
+
  @see RKObjectParameterization
  @see [RKObjectMapping requestMapping]
  @see [RKObjectManager requestWithObject:method:path:parameters:]
@@ -37,19 +38,24 @@
 
 /**
  Creates and returns a new `RKRequestDescriptor` object.
- 
+
  @param mapping The mapping to be used when parameterizing an object using the request descriptor. Cannot be nil and must have an objectClass equal to `[NSMutableDictionary class]`.
  @param objectClass The class of objects for which the request descriptor should be used. Cannot be nil.
  @param rootKeyPath The root key path under which paramters constructed using the response descriptor will be nested. If nil, the parameters will not be nested and returned as a flat dictionary object.
  @return A new `RKRequestDescriptor` object.
- 
+
  @see [RKObjectMapping requestMapping]
  @warning An exception will be raised if the objectClass of the given mapping is not `[NSMutableDictionary class]`.
  */
 + (instancetype)requestDescriptorWithMapping:(RKMapping *)mapping
                                  objectClass:(Class)objectClass
                                  rootKeyPath:(NSString *)rootKeyPath;
 
++ (instancetype)requestDescriptorWithMapping:(RKMapping *)mapping
+                                 objectClass:(Class)objectClass
+                                 rootKeyPath:(NSString *)rootKeyPath
+                               requestMethod:(RKRequestMethod)requestMethod;
+
 ///-----------------------------------------------------
 /// @name Getting Information About a Request Descriptor
 ///-----------------------------------------------------
@@ -69,16 +75,18 @@
  */
 @property (nonatomic, copy, readonly) NSString *rootKeyPath;
 
+@property (nonatomic, assign, readonly) RKRequestMethod requestMethod;
+
 ///--------------------------------
 /// @name Using Request Descriptors
 ///--------------------------------
 
 /**
  Returns `YES` if the given object is instance of objectClass or any class that inherits from objectClass, else `NO`.
- 
+
  @param object The object to be matched against the receiver.
  @return `YES` if the given object matches objectClass, else `NO`.
  */
-- (BOOL)matchesObject:(id)object;
+- (BOOL)matchesObject:(id)object requestMethod:(RKRequestMethod)requestMethod exactMatch:(BOOL)exact;
 
 @end

Code/Network/RKRequestDescriptor.m

@@ -47,12 +47,18 @@ @interface RKRequestDescriptor ()
 @property (nonatomic, strong, readwrite) RKMapping *mapping;
 @property (nonatomic, strong, readwrite) Class objectClass;
 @property (nonatomic, copy, readwrite) NSString *rootKeyPath;
+@property (nonatomic, assign, readwrite) RKRequestMethod requestMethod;
 
 @end
 
 @implementation RKRequestDescriptor
 
 + (instancetype)requestDescriptorWithMapping:(RKMapping *)mapping objectClass:(Class)objectClass rootKeyPath:(NSString *)rootKeyPath
+{
+    return [self requestDescriptorWithMapping:mapping objectClass:objectClass rootKeyPath:rootKeyPath requestMethod:RKRequestMethodAny];
+}
+
++ (instancetype)requestDescriptorWithMapping:(RKMapping *)mapping objectClass:(Class)objectClass rootKeyPath:(NSString *)rootKeyPath requestMethod:(RKRequestMethod)requestMethod
 {
     NSParameterAssert(mapping);
     NSParameterAssert(objectClass);
@@ -62,6 +68,7 @@ + (instancetype)requestDescriptorWithMapping:(RKMapping *)mapping objectClass:(C
     requestDescriptor.mapping = mapping;
     requestDescriptor.objectClass = objectClass;
     requestDescriptor.rootKeyPath = rootKeyPath;
+    requestDescriptor.requestMethod = requestMethod;
     return requestDescriptor;
 }
 
@@ -71,9 +78,9 @@ - (NSString *)description
             NSStringFromClass([self class]), self, NSStringFromClass(self.objectClass), self.rootKeyPath, self.mapping];
 }
 
-- (BOOL)matchesObject:(id)object
+- (BOOL)matchesObject:(id)object requestMethod:(RKRequestMethod)requestMethod exactMatch:(BOOL)exact
 {
-    return [object isKindOfClass:self.objectClass];
+    return (exact ? [object class] == self.objectClass : [object isKindOfClass:self.objectClass] ) && (requestMethod & self.requestMethod) != 0;
 }
 
 @end

Code/Network/RKRouteSet.h

@@ -21,7 +21,7 @@
 #import "RKRoute.h"
 
 // Wildcard matches on objects
-extern RKRequestMethod const RKRequestMethodAny;
+//extern RKRequestMethod const RKRequestMethodAny;
 
 /**
  The `RKRouteSet` class provides for the storage and retrieval of `RKRoute` objects. Route objects are added and removed the route set to manipulate the routing table of the application.

Code/Network/RKRouteSet.m

@@ -21,7 +21,7 @@
 #import "RKRouteSet.h"
 #import "RKPathMatcher.h"
 
-RKRequestMethod const RKRequestMethodAny = RKRequestMethodInvalid;
+//RKRequestMethod const RKRequestMethodAny = RKRequestMethodInvalid;
 
 @interface RKRouteSet ()
 

Code/ObjectMapping/RKHTTPUtilities.h

@@ -23,16 +23,23 @@
 /**
  HTTP methods for requests
  */
-typedef enum RKRequestMethod {
-    RKRequestMethodInvalid = -1,
-    RKRequestMethodGET,
-    RKRequestMethodPOST,
-    RKRequestMethodPUT,
-    RKRequestMethodDELETE,
-    RKRequestMethodHEAD,
-    RKRequestMethodPATCH,
-    RKRequestMethodOPTIONS
-} RKRequestMethod;  // RKHTTPMethod? RKStringFromHTTPMethod... RKHTTPMethodFromString
+typedef NS_OPTIONS(NSInteger, RKRequestMethod) {
+    RKRequestMethodInvalid      = -1,
+    RKRequestMethodGET          = 1 << 0,
+    RKRequestMethodPOST         = 1 << 1,
+    RKRequestMethodPUT          = 1 << 2,
+    RKRequestMethodDELETE       = 1 << 3,
+    RKRequestMethodHEAD         = 1 << 4,
+    RKRequestMethodPATCH        = 1 << 5,
+    RKRequestMethodOPTIONS      = 1 << 6,
+    RKRequestMethodAny          = (RKRequestMethodGET |
+                                   RKRequestMethodPOST |
+                                   RKRequestMethodPUT |
+                                   RKRequestMethodDELETE |
+                                   RKRequestMethodHEAD |
+                                   RKRequestMethodPATCH |
+                                   RKRequestMethodOPTIONS)
+};  // RKHTTPMethod? RKStringFromHTTPMethod... RKHTTPMethodFromString
 
 /**
  Returns the corresponding string for value for a given HTTP request method.