| commit | author | age | ||
| a0a843 | 1 | /* |
| H | 2 | |
| 3 | Copyright 2011 TweetDeck Inc. All rights reserved. | |
| 4 | ||
| 5 | Redistribution and use in source and binary forms, with or without | |
| 6 | modification, are permitted provided that the following conditions are met: | |
| 7 | ||
| 8 | 1. Redistributions of source code must retain the above copyright notice, | |
| 9 | this list of conditions and the following disclaimer. | |
| 10 | ||
| 11 | 2. Redistributions in binary form must reproduce the above copyright notice, | |
| 12 | this list of conditions and the following disclaimer in the documentation | |
| 13 | and/or other materials provided with the distribution. | |
| 14 | ||
| 15 | THIS SOFTWARE IS PROVIDED BY TWEETDECK INC. ``AS IS'' AND ANY EXPRESS OR | |
| 16 | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
| 17 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO | |
| 18 | EVENT SHALL TWEETDECK INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | |
| 19 | INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
| 20 | (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | |
| 21 | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND | |
| 22 | ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
| 23 | (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | |
| 24 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
| 25 | ||
| 26 | The views and conclusions contained in the software and documentation are | |
| 27 | those of the authors and should not be interpreted as representing official | |
| 28 | policies, either expressed or implied, of TweetDeck Inc. | |
| 29 | ||
| 30 | */ | |
| 31 | ||
| 32 | #import <Foundation/Foundation.h> | |
| 33 | ||
| 34 | /* | |
| 35 | This OAuth implementation doesn't cover the whole spec (eg. it’s HMAC only). | |
| 36 | But you'll find it works with almost all the OAuth implementations you need | |
| 37 | to interact with in the wild. How ace is that?! | |
| 38 | */ | |
| 39 | @interface TWTRGCOAuth : NSObject { | |
| 40 | @private | |
| 41 | NSString *signatureSecret; | |
| 42 | NSDictionary *OAuthParameters; | |
| 43 | } | |
| 44 | ||
| 45 | /* | |
| 46 | Set the user agent to be used for all requests. | |
| 47 | */ | |
| 48 | + (void)setUserAgent:(NSString *)agent; | |
| 49 | ||
| 50 | /* | |
| 51 | Set the time offset to be used for timestamp calculations. | |
| 52 | */ | |
| 53 | + (void)setTimeStampOffset:(time_t)offset; | |
| 54 | ||
| 55 | /* | |
| 56 | Control HTTPS cookie storage for all generated requests | |
| 57 | */ | |
| 58 | + (void)setHTTPShouldHandleCookies:(BOOL)handle; | |
| 59 | ||
| 60 | /** | |
| 61 | Creates and returns a URL request that will perform an HTTP operation for the given method. All | |
| 62 | of the appropriate fields will be parameter encoded as necessary so do not | |
| 63 | encode them yourself. The contents of the parameters dictionary must be string | |
| 64 | key/value pairs. You are contracted to consume the NSURLRequest *immediately*. | |
| 65 | */ | |
| 66 | + (NSURLRequest *)URLRequestForPath:(NSString *)path HTTPMethod:(NSString *)HTTPMethod parameters:(NSDictionary *)parameters scheme:(NSString *)scheme host:(NSString *)host consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 67 | ||
| 68 | /* | |
| 69 | Creates and returns a URL request that will perform a GET HTTP operation. All | |
| 70 | of the appropriate fields will be parameter encoded as necessary so do not | |
| 71 | encode them yourself. The contents of the parameters dictionary must be string | |
| 72 | key/value pairs. You are contracted to consume the NSURLRequest *immediately*. | |
| 73 | */ | |
| 74 | + (NSURLRequest *)URLRequestForPath:(NSString *)path GETParameters:(NSDictionary *)parameters host:(NSString *)host consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 75 | ||
| 76 | /* | |
| 77 | Performs the same operation as the above method but allows a customizable URL | |
| 78 | scheme, e.g. HTTPS. | |
| 79 | */ | |
| 80 | + (NSURLRequest *)URLRequestForPath:(NSString *)path GETParameters:(NSDictionary *)parameters scheme:(NSString *)scheme host:(NSString *)host consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 81 | ||
| 82 | /* | |
| 83 | Creates and returns a URL request that will perform a DELETE HTTP operation. All | |
| 84 | of the appropriate fields will be parameter encoded as necessary so do not | |
| 85 | encode them yourself. The contents of the parameters dictionary must be string | |
| 86 | key/value pairs. You are contracted to consume the NSURLRequest *immediately*. | |
| 87 | */ | |
| 88 | + (NSURLRequest *)URLRequestForPath:(NSString *)path DELETEParameters:(NSDictionary *)parameters host:(NSString *)host consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 89 | ||
| 90 | /* | |
| 91 | Performs the same operation as the above method but allows a customizable URL | |
| 92 | scheme, e.g. HTTPS. | |
| 93 | */ | |
| 94 | + (NSURLRequest *)URLRequestForPath:(NSString *)path DELETEParameters:(NSDictionary *)parameters scheme:(NSString *)scheme host:(NSString *)host consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 95 | ||
| 96 | /* | |
| 97 | Creates and returns a URL request that will perform a POST HTTP operation. All | |
| 98 | data will be sent as form URL encoded. Restrictions on the arguments to this | |
| 99 | method are the same as the GET request methods. | |
| 100 | */ | |
| 101 | + (NSURLRequest *)URLRequestForPath:(NSString *)path POSTParameters:(NSDictionary *)parameters host:(NSString *)host consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 102 | ||
| 103 | /* | |
| 104 | Performs the same operation as the above method but allows a customizable URL | |
| 105 | scheme, e.g. HTTPS. | |
| 106 | */ | |
| 107 | + (NSURLRequest *)URLRequestForPath:(NSString *)path POSTParameters:(NSDictionary *)parameters scheme:(NSString *)scheme host:(NSString *)host consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 108 | ||
| 109 | /** | |
| 110 | * Convenience method that takes in a `NSURLRequest` but performs the same operation as the above. | |
| 111 | * | |
| 112 | * @param request The request to sign | |
| 113 | * @param consumerKey The app consumer key | |
| 114 | * @param consumerSecret The app consumer secret | |
| 115 | * @param accessToken The oauth access token | |
| 116 | * @param tokenSecret The oauth access token secret | |
| 117 | * | |
| 118 | * @return A signed request given the oauth credentials | |
| 119 | */ | |
| 120 | + (NSURLRequest *)URLRequestFromRequest:(NSURLRequest *)request consumerKey:(NSString *)consumerKey consumerSecret:(NSString *)consumerSecret accessToken:(NSString *)accessToken tokenSecret:(NSString *)tokenSecret; | |
| 121 | ||
| 122 | @end | |
| 123 | ||
| 124 | /* | |
| 125 | ||
| 126 | XAuth example (because you may otherwise be scratching your head): | |
| 127 | ||
| 128 | NSURLRequest *xauth = [GCOAuth URLRequestForPath:@"/oauth/access_token" | |
| 129 | POSTParameters:[NSDictionary dictionaryWithObjectsAndKeys: | |
| 130 | username, @"x_auth_username", | |
| 131 | password, @"x_auth_password", | |
| 132 | @"client_auth", @"x_auth_mode", | |
| 133 | nil] | |
| 134 | host:@"api.twitter.com" | |
| 135 | consumerKey:CONSUMER_KEY | |
| 136 | consumerSecret:CONSUMER_SECRET | |
| 137 | accessToken:nil | |
| 138 | tokenSecret:nil]; | |
| 139 | ||
| 140 | OAuth Echo example (we have found that some consumers require HTTPS for the | |
| 141 | echo, so to be safe we always do it): | |
| 142 | ||
| 143 | NSURLRequest *echo = [GCOAuth URLRequestForPath:@"/1/account/verify_credentials.json" | |
| 144 | GETParameters:nil | |
| 145 | scheme:@"https" | |
| 146 | host:@"api.twitter.com" | |
| 147 | consumerKey:CONSUMER_KEY | |
| 148 | consumerSecret:CONSUMER_SECRET | |
| 149 | accessToken:accessToken | |
| 150 | tokenSecret:tokenSecret]; | |
| 151 | NSMutableURLRequest *rq = [NSMutableURLRequest new]; | |
| 152 | [rq setValue:[[echo URL] absoluteString] forHTTPHeaderField:@"X-Auth-Service-Provider"]; | |
| 153 | [rq setValue:[echo valueForHTTPHeaderField:@"Authorization"] forHTTPHeaderField:@"X-Verify-Credentials-Authorization"]; | |
| 154 | // Now consume rq with an NSURLConnection | |
| 155 | [rq release]; | |
| 156 | ||
| 157 | ||
| 158 | Suggested usage would be to make some categories for this class that | |
| 159 | automatically adds both secrets, both tokens and host information. This | |
| 160 | makes usage less cumbersome. Eg: | |
| 161 | ||
| 162 | [TwitterOAuth GET:@"/1/statuses/home_timeline.json"]; | |
| 163 | [TwitterOAuth GET:@"/1/statuses/home_timeline.json" queryParameters:dictionary]; | |
| 164 | ||
| 165 | At TweetDeck we have TDAccount classes that represent separate user logins | |
| 166 | for different services when instantiated. | |
| 167 | ||
| 168 | */ | |
