FHSTwitterEngine
Twitter API for Cocoa developers
Created by Nathaniel Symer
FHSTwitterEngine
can:
- Authenticate using OAuth and/or xAuth.
- Make a request to just about every API endpoint.
Why you should use FHSTwitterEngine
:
- Single .h/.m pair
- No dependencies
- Shared instance
- Scientific
This project started with OAuthConsumer.
Setup
CocoaPods
pod 'FHSTwitterEngine', '~> 2.0'
Manual
- Add
FHSTwitterEngine.h
andFHSTwitterEngine.m
to your project
- Link against
SystemConfiguration.framework
- Enable ARC for both files if applicable
Usage
Add import where necessary
#import "FHSTwitterEngine.h"
Set up
FHSTwitterEngine
[[FHSTwitterEngine sharedEngine]permanentlySetConsumerKey:@"<consumer_key>" andSecret:@"<consumer_secret>"];
Or with a temporary consumer that gets cleared after each request
[[FHSTwitterEngine sharedEngine]temporarilySetConsumerKey:@"<consumer_key>" andSecret:@"<consumer_secret>"];
Set access token delegate (see header)
[[FHSTwitterEngine sharedEngine]setDelegate:myDelegate];
Login via OAuth:
UIViewController *loginController = [[FHSTwitterEngine sharedEngine]loginControllerWithCompletionHandler:^(BOOL success) {
NSLog(success?@"L0L success":@"O noes!!! Loggen faylur!!!");
}];
[self presentViewController:loginController animated:YES completion:nil];
Login via XAuth:
dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
@autoreleasepool {
NSError *error = [[FHSTwitterEngine sharedEngine]getXAuthAccessTokenForUsername:@"<username>" password:@"<password>"];
// Handle error
dispatch_sync(dispatch_get_main_queue(), ^{
@autoreleasepool {
// Update UI
}
});
}
});
Clear the current consumer key
[[FHSTwitterEngine sharedEngine]clearConsumer];
Load a saved access_token (called when API calls are made):
[[FHSTwitterEngine sharedEngine]loadAccessToken];
Clear your access token:
[[FHSTwitterEngine sharedEngine]clearAccessToken];
Check if a session is valid:
[[FHSTwitterEngine sharedEngine]isAuthorized];
Do an API call (POST and GET):
dispatch_async((dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
@autoreleasepool {
id twitterData = [[FHSTwitterEngine sharedEngine]postTweet:@"Hi!"];
// Handle twitterData (see "About GET Requests")
dispatch_sync(dispatch_get_main_queue(), ^{
@autoreleasepool {
// Update UI
}
});
}
});
The "Singleton" Pattern
The singleton pattern allows the programmer to use the library across scopes without having to manually keep a reference to the FHSTwitterEngine
object. When the app is killed, any memory used by FHSTwitterEngine
is freed.
Threading
While you can use any threading technology for threading, I recommend Grand Central Dispatch (GCD).
General Comments
FHSTwitterEngine
will attempt to preemptively detect errors in your requests, before they are actually sent. This includes missing parameters, and a lack of authorization. If FHSTwitterEngine
detects that a user is not logged in, it will attempt to load an access token using its delegate. This process is designed to prevent bad requests from being needlessly sent.
About requests
Most methods return id
. The returned object can be a(n):
NSMutableDictionary
NSMutableArray
UIImage
NSString
NSError
nil
Contact
- Open an issue
- Daniel Khamsing
- Nathaniel Symer