From 9cd57b731ab1c666d4a1cb725538fdc137763d12 Mon Sep 17 00:00:00 2001 From: Starla Insigna Date: Sat, 30 Jul 2011 11:19:14 -0400 Subject: Initial commit (version 0.2.1) --- libs/cocoslive/CLScoreServerRequest.h | 122 ++++++++++++++++++++++++++++++++++ 1 file changed, 122 insertions(+) create mode 100755 libs/cocoslive/CLScoreServerRequest.h (limited to 'libs/cocoslive/CLScoreServerRequest.h') diff --git a/libs/cocoslive/CLScoreServerRequest.h b/libs/cocoslive/CLScoreServerRequest.h new file mode 100755 index 0000000..2002d4c --- /dev/null +++ b/libs/cocoslive/CLScoreServerRequest.h @@ -0,0 +1,122 @@ +/* + * cocos2d for iPhone: http://www.cocos2d-iphone.org + * + * Copyright (c) 2008-2010 Ricardo Quesada + * Copyright (c) 2011 Zynga Inc. + * + * 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. + * + */ + + + +#import + +// cocoslive definitions +#import "cocoslive.h" + +// Server URL +#if USE_LOCAL_SERVER +#define SCORE_SERVER_REQUEST_URL @"http://localhost:8080/api/get-scores" +#define SCORE_SERVER_GETRANK_URL @"http://localhost:8080/api/get-rank-for-score" +#else +#define SCORE_SERVER_REQUEST_URL @"http://fourislandscores.appspot.com/api/get-scores" +#define SCORE_SERVER_GETRANK_URL @"http://fourislandscores.appspot.com/api/get-rank-for-score" +#endif + +/** Type of predefined Query */ +typedef enum { + kQueryIgnore = 0, + kQueryDay = 1, + kQueryWeek = 2, + kQueryMonth = 3, + kQueryAllTime = 4, +} tQueryType; + +/** Flags that can be added to the query */ +typedef enum { + kQueryFlagIgnore = 0, + kQueryFlagByCountry = 1 << 0, + kQueryFlagByDevice = 1 << 1, +} tQueryFlags; + +/** + * Handles the Request Scores to the cocos live server + */ +@interface CLScoreServerRequest : NSObject { + + /// game name, used as a login name. + NSString *gameName; + + /// delegate instance of fetch score + id delegate; + + // data received + NSMutableData *receivedData; + + // To determine which delegate method will be called in connectionDidFinishLoading: of NSURLConnection Delegate + BOOL reqRankOnly; + + /// the connection + NSURLConnection *connection_; +} + +/** connection to the server */ +@property (nonatomic, retain) NSURLConnection *connection; + + +/** creates a ScoreServerRequest server with a game name*/ ++(id) serverWithGameName:(NSString*) name delegate:(id)delegate; + +/** initializes a ScoreServerRequest with a game name*/ +-(id) initWithGameName:(NSString*) name delegate:(id)delegate; + +/** request scores from server using a predefined query. This is an asyncronous request. + * limit: how many scores are being requested. Maximun is 100 + * flags: can be kQueryFlagByCountry (fetches only scores from country) + * category: an NSString. For example: 'easy', 'medium', 'type1'... When requesting scores, they can be filtered by this field. + */ +-(BOOL) requestScores: (tQueryType) type limit:(int)limit offset:(int)offset flags:(tQueryFlags)flags category:(NSString*)category; + +/** request scores from server using a predefined query. This is an asyncronous request. + * limit: how many scores are being requested. Maximun is 100 + * flags: can be kQueryFlagByCountry (fetches only scores from country) + */ +-(BOOL) requestScores: (tQueryType) type limit:(int)limit offset:(int)offset flags:(tQueryFlags)flags; + +/** parse the received JSON scores and convert it to objective-c objects */ +-(NSArray*) parseScores; + +/** request rank for a given score using a predefined query. This is an asyncronous request. + * score: int for a score + * category: an NSString. For example: 'easy', 'medium', 'type1'... When requesting ranks, they can be filtered by this field. + */ +-(BOOL) requestRankForScore:(int)score andCategory:(NSString*)category; + +/** It's actually not parsing anything, just returning int for a rank. Kept name PARSE for convinience with parseScores */ +-(int) parseRank; + +@end + +/** CocosLive Request protocol */ +@protocol CLRequestDelegate +-(void) scoreRequestOk:(id) sender; +-(void) scoreRequestRankOk:(id) sender; +-(void) scoreRequestFail:(id) sender; +@end -- cgit 1.4.1