summary refs log tree commit diff stats
path: root/libs/cocoslive/CLScoreServerPost.h
blob: e782b9095a04a66c94b0a40db9dd537085fcd5d0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
 * 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 <UIKit/UIKit.h>

// for MD5 signing
#import <CommonCrypto/CommonDigest.h>

// cocoslive definitions
#import "cocoslive.h"

// Score Server protocol version
#define SCORE_SERVER_PROTOCOL_VERSION @"1.1"

// Server URL
#ifdef USE_LOCAL_SERVER
#define SCORE_SERVER_SEND_URL @"http://localhost:8080/api/post-score"
#define SCORE_SERVER_UPDATE_URL @"http://localhost:8080/api/update-score"
#else
#define SCORE_SERVER_SEND_URL @"http://fourislandscores.appspot.com/api/post-score"
#define SCORE_SERVER_UPDATE_URL @"http://fourislandscores.appspot.com/api/update-score"
#endif

/// Type of errors from the Post Score request
typedef enum {
	/// post request successful
	kPostStatusOK = 0,
	/// post request failed to establish a connection. wi-fi isn't enabled.
	/// Don't retry when this option is preset
	kPostStatusConnectionFailed = 1,
	/// post request failed to post the score. Server might be busy.
	/// Retry is suggested
	kPostStatusPostFailed = 2,
} tPostStatus;

enum {
	//! Invalid Ranking. Valid rankins are from 1 to ...
	kServerPostInvalidRanking = 0,
};

/**
 * Handles the Score Post to the cocos live server
 */
@interface CLScoreServerPost : NSObject {
	/// game key. secret shared with the server.
	/// used to sign the values to prevent spoofing.
	NSString	*gameKey;
	
	/// game name, used as a login name.
	NSString	*gameName;

	/// delegate instance of fetch score
	id			delegate;
	
	/// ranking
	NSUInteger	ranking_;
	
	/// score was updated
	BOOL		scoreDidUpdate_;

	/// data received
	NSMutableData *receivedData;
	
	/// values to send in the POST
	NSMutableArray *bodyValues;
	
	/// status of the request
	tPostStatus		postStatus_;
	
	/// mdt context
	CC_MD5_CTX		md5Ctx;
	
	/// the connection
	NSURLConnection	*connection_;
}

/** status from the score post */ 
@property (nonatomic,readonly) tPostStatus postStatus;
 
/** connection to the server */
@property (nonatomic, retain) NSURLConnection *connection;

/** ranking of your score
 @since v0.7.3
 */
@property (nonatomic,readonly) NSUInteger ranking;

/** whether or not the score was updated
 @since v0.7.3
 */
@property (nonatomic,readonly) BOOL scoreDidUpdate;

/** creates a cocos server with a game name and a game key */
+(id) serverWithGameName:(NSString*) name gameKey:(NSString*) key delegate:(id)delegate;

/** initializes a cocos server with a game name and a game key */
-(id) initWithGameName:(NSString*) name gameKey:(NSString*) key delegate:(id)delegate;

/** send the scores to the server. A new entre will be created on the server */
-(BOOL) sendScore: (NSDictionary*) dict;

/** 
 * Sends a score dictionary to the server for updating an existing entry by playername and device id, or creating a new one.
 * The passed dictionary must contain a cc_playername key, otherwise it will raise and exception.
 * @since v0.7.1
 */
-(BOOL) updateScore: (NSDictionary*) dict;

@end

/** CocosLivePost protocol */
@protocol CLPostDelegate <NSObject>
/** callback method that will be called if the post is successful */
-(void) scorePostOk:(id) sender;
/** callback method that will be called if the post fails */
-(void) scorePostFail:(id) sender;
@end