Merge pull request #161 from jzucker2/on-stub-end-one-place

Adds more logging blocks for debugging and extended features
AliSoftware · Mar 19, 2016 · a8b64f1 · a8b64f1
2 parents a97ebe7 + f0769f6
commit a8b64f1
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Master
 
+* Added more logging blocks for debugging and better insight into when OHHTTPStubs returns stubs and redirects.  
+  [@jzucker2](https://github.com/jzucker2), [#161](https://github.com/AliSoftware/OHHTTPStubs/pull/161)
+
 * Added matchers that check whether a request has a particular header present, and a matcher to check if a request has a header with a key and value.  
   [@hq-mobile](https://github.com/hq-mobile), [#160](https://github.com/AliSoftware/OHHTTPStubs/pull/160)
 

diff --git a/OHHTTPStubs/Sources/OHHTTPStubs.h b/OHHTTPStubs/Sources/OHHTTPStubs.h
@@ -185,7 +185,25 @@ typedef OHHTTPStubsResponse* __nonnull (^OHHTTPStubsResponseBlock)( NSURLRequest
  *  @param block The block to call each time a request is being stubbed by OHHTTPStubs.
  *               Set it to `nil` to do nothing. Defaults is `nil`.
  */
-+(void)onStubActivation:( nullable void(^)(NSURLRequest* request, id<OHHTTPStubsDescriptor> stub) )block;
++(void)onStubActivation:( nullable void(^)(NSURLRequest* request, id<OHHTTPStubsDescriptor> stub, OHHTTPStubsResponse* responseStub) )block;
+
+/**
+ *  Setup a block to be called whenever OHHTTPStubs encounters a redirect request.
+ *
+ *  @param block The block to call each time a redirect request is being stubbed by OHHTTPStubs. 
+ *               Set it to `nil` to do nothing. Defaults is `nil`.
+ */
++(void)onStubRedirectResponse:( nullable void(^)(NSURLRequest* request, NSURLRequest* redirectRequest, id<OHHTTPStubsDescriptor> stub, OHHTTPStubsResponse* responseStub) )block;
+
+/**
+ *  Setup a block to be called each time a stub finishes. Useful if stubs take an insignificant amount
+ *  of time to execute (due to low bandwidth or delayed response time). This block may also be called
+ *  if there are errors generated by OHHTTPStubs in the course of executing a network request.
+ *
+ *  @param block The block to call each time a request is finished being stubbed by OHHTTPStubs. 
+ *               Set it to `nil` to do nothing. Defaults is `nil`.
+ */
++(void)afterStubFinish:( nullable void(^)(NSURLRequest* request, id<OHHTTPStubsDescriptor> stub, OHHTTPStubsResponse* responseStub, NSError *error) )block;
 
 @end
 

diff --git a/OHHTTPStubs/Sources/OHHTTPStubs.m b/OHHTTPStubs/Sources/OHHTTPStubs.m
@@ -45,7 +45,9 @@ @interface OHHTTPStubs()
 + (instancetype)sharedInstance;
 @property(atomic, copy) NSMutableArray* stubDescriptors;
 @property(atomic, assign) BOOL enabledState;
-@property(atomic, copy, nullable) void (^onStubActivationBlock)(NSURLRequest*, id<OHHTTPStubsDescriptor>);
+@property(atomic, copy, nullable) void (^onStubActivationBlock)(NSURLRequest*, id<OHHTTPStubsDescriptor>, OHHTTPStubsResponse*);
+@property(atomic, copy, nullable) void (^onStubRedirectBlock)(NSURLRequest*, NSURLRequest*, id<OHHTTPStubsDescriptor>, OHHTTPStubsResponse*);
+@property(atomic, copy, nullable) void (^afterStubFinishBlock)(NSURLRequest*, id<OHHTTPStubsDescriptor>, OHHTTPStubsResponse*, NSError*);
 @end
 
 @interface OHHTTPStubsDescriptor : NSObject <OHHTTPStubsDescriptor>
@@ -227,11 +229,21 @@ +(NSArray*)allStubs
     return [OHHTTPStubs.sharedInstance stubDescriptors];
 }
 
-+(void)onStubActivation:( nullable void(^)(NSURLRequest* request, id<OHHTTPStubsDescriptor> stub) )block
++(void)onStubActivation:( nullable void(^)(NSURLRequest* request, id<OHHTTPStubsDescriptor> stub, OHHTTPStubsResponse* responseStub) )block
 {
     [OHHTTPStubs.sharedInstance setOnStubActivationBlock:block];
 }
 
++(void)onStubRedirectResponse:( nullable void(^)(NSURLRequest* request, NSURLRequest* redirectRequest, id<OHHTTPStubsDescriptor> stub, OHHTTPStubsResponse* responseStub) )block
+{
+    [OHHTTPStubs.sharedInstance setOnStubRedirectBlock:block];
+}
+
++(void)afterStubFinish:( nullable void(^)(NSURLRequest* request, id<OHHTTPStubsDescriptor> stub, OHHTTPStubsResponse* responseStub, NSError* error) )block
+{
+    [OHHTTPStubs.sharedInstance setAfterStubFinishBlock:block];
+}
+
 
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -364,14 +376,18 @@ - (void)startLoading
                                   nil];
         NSError* error = [NSError errorWithDomain:@"OHHTTPStubs" code:500 userInfo:userInfo];
         [client URLProtocol:self didFailWithError:error];
+        if (OHHTTPStubs.sharedInstance.afterStubFinishBlock)
+        {
+            OHHTTPStubs.sharedInstance.afterStubFinishBlock(request, self.stub, nil, error);
+        }
         return;
     }
 
     OHHTTPStubsResponse* responseStub = self.stub.responseBlock(request);
 
     if (OHHTTPStubs.sharedInstance.onStubActivationBlock)
     {
-        OHHTTPStubs.sharedInstance.onStubActivationBlock(request, self.stub);
+        OHHTTPStubs.sharedInstance.onStubActivationBlock(request, self.stub, responseStub);
     }
 
     if (responseStub.error == nil)
@@ -409,6 +425,10 @@ - (void)startLoading
                 if (!self.stopped)
                 {
                     [client URLProtocol:self wasRedirectedToRequest:redirectRequest redirectResponse:urlResponse];
+                    if (OHHTTPStubs.sharedInstance.onStubRedirectBlock)
+                    {
+                        OHHTTPStubs.sharedInstance.onStubRedirectBlock(request, redirectRequest, self.stub, responseStub);
+                    }
                 }
             }];
         }
@@ -427,13 +447,19 @@ - (void)startLoading
                                    completion:^(NSError * error)
                      {
                          [responseStub.inputStream close];
+                         NSError *blockError = nil;
                          if (error==nil)
                          {
                              [client URLProtocolDidFinishLoading:self];
                          }
                          else
                          {
                              [client URLProtocol:self didFailWithError:responseStub.error];
+                             blockError = responseStub.error;
+                         }
+                         if (OHHTTPStubs.sharedInstance.afterStubFinishBlock)
+                         {
+                             OHHTTPStubs.sharedInstance.afterStubFinishBlock(request, self.stub, responseStub, blockError);
                          }
                      }];
                 }
@@ -445,6 +471,10 @@ - (void)startLoading
             if (!self.stopped)
             {
                 [client URLProtocol:self didFailWithError:responseStub.error];
+                if (OHHTTPStubs.sharedInstance.afterStubFinishBlock)
+                {
+                    OHHTTPStubs.sharedInstance.afterStubFinishBlock(request, self.stub, responseStub, responseStub.error);
+                }
             }
         }];
     }