Swiftgram/Classes/BITHockeyAppClient.h
Stephan Diederich 96304ac639 factor out BITHockeyAppClient to provide network services
* factor out HockeyAppClient
* configure Authenticator with HockeyAppClient
* move appendPostValue to HockeyAppClient (& add the missing boundary parameter)
* move tests over to new file
2013-09-06 17:11:55 +02:00

109 lines
3.2 KiB
Objective-C

//
// BITHockeyAppClient.h
// HockeySDK
//
// Created by Stephan Diederich on 06.09.13.
//
//
#import <Foundation/Foundation.h>
#import "BITHTTPOperation.h" //needed for typedef
@interface BITHockeyAppClient : NSObject
/**
* designated initializer
*
* @param baseURL the baseURL of the HockeyApp instance
*/
- (instancetype) initWithBaseURL:(NSURL*) baseURL;
/**
* baseURL to which relative paths are appended
*/
@property (nonatomic, strong) NSURL *baseURL;
/**
* creates an NRURLRequest for the given method and path by using
* the internally stored baseURL.
*
* @param method the HTTPMethod to check, must not be nil
* @param params parameters for the request (only supported for GET and POST for now)
* @param path path to append to baseURL. can be nil in which case "/" is appended
*
* @return an NSMutableURLRequest for further configuration
*/
- (NSMutableURLRequest *) requestWithMethod:(NSString*) method
path:(NSString *) path
parameters:(NSDictionary *) params;
/**
* Creates an operation for the given NSURLRequest
*
* @param request the request that should be handled
* @param completion completionBlock that is called once the operation finished
*
* @return operation, which can be queued via enqueueHTTPOperation:
*/
- (BITHTTPOperation*) operationWithURLRequest:(NSURLRequest*) request
completion:(BITNetworkCompletionBlock) completion;
/**
* Creates an operation for the given path, and enqueues it
*
* @param path the request path to check
* @param params parameters for the request
* @param completion completionBlock that is called once the operation finished
*
*/
- (void) getPath:(NSString*) path
parameters:(NSDictionary *) params
completion:(BITNetworkCompletionBlock) completion;
/**
* Creates an operation for the given path, and enqueues it
*
* @param path the request path to check
* @param params parameters for the request
* @param completion completionBlock that is called once the operation finished
*
*/
- (void) postPath:(NSString*) path
parameters:(NSDictionary *) params
completion:(BITNetworkCompletionBlock) completion;
/**
* adds the given operation to the internal queue
*
* @param operation operation to add
*/
- (void) enqeueHTTPOperation:(BITHTTPOperation *) operation;
/**
* cancels the specified operations
*
* @param path the path which operation should be cancelled. Can be nil to match all
* @param method the method which operations to cancel. Can be nil to match all
* @return number of operations cancelled
*/
- (NSUInteger) cancelOperationsWithPath:(NSString*) path
method:(NSString*) method;
/**
* Access to the internal operation queue
*/
@property (nonatomic, strong) NSOperationQueue *operationQueue;
#pragma mark - Helpers
/**
* create a post body from the given value, key and boundary
* c/p from HockeyBaseManager
*
* @param value -
* @param key -
* @param boundary -
*
* @return NSData instance configured to be attached on a (post) URLRequest
*/
+ (NSData *)dataWithPostValue:(NSString *)value forKey:(NSString *)key boundary:(NSString *) boundary;
@end