coreyfloyd / xauthtwitterengine Goto Github PK

XAuthTwitterEngine library and demo for iPhone.
by Aral Balkan (@aral, http://aralbalkan.com)
Copyright 2010 Aral Balkan. All Rights Reserved. 

License: MIT

Removes a lot of the unnecessary oAuth browser-based authentication bloat from the Twitter+oAuth Source and provides a very simple example to demonstrate how to use Twitter's new xAuth authentication system. 

The easiest way to use the library in your own projects is to drag the Twitter+oAuth folder from the Libraries folder in the demo application to your own project. Also, don't forget to add libxml2.dylib to your new project. 

If you find this helpful, I would really appreciate it if you could tweet or blog about @feathers_app my Twitter app for iPhone:

Feathers: decorate your tweets.
http://feathersapp.com

* * *

Special thanks to: 

Norio Nomura for sharing his xAuth implementation:
http://github.com/norio-nomura/ntlniph/commit/5ce25d68916cd45254c7ff2ba9b91de4f324899a

Steve Reynolds for alerting me to Norio Nomura's xAuth code, with which I updated Ben's oAuth Twitter engine for xAuth.

Ben's original notes for Twitter+OAuth follow:

Twitter+OAuth Source and Example for iPhone
Glommed together by Ben Gottlieb
copyright 2009 Stand Alone, Inc - all rights reserved.
License: BSD, If you use it, please include the following text somewhere in your application's user-facing text:
"Includes Twitter+OAuth code by Ben Gottlieb"

The goal of this was to create a drop-in code package for iPhone apps that want to access Twitter via OAuth. The main benefit here is that the source line on the Twitter page will say your app name, rather than "from web". 

This includes source taken from several other open frameworks, listed below. Most of the heavy lifting was all done by them, I just synthesized it into a (hopefully) easily digestible chunk.

I decided not to do the whole thing as a static library since most developers are already using Matt Gemmell's MGTwitterEngine, and there was no reason to duplicate code. It adds about 200k to the final size of your project, mainly due to the OAuth library.

Enjoy, and please let me know if you have any feedback!

Ben Gottlieb
[email protected]

== Major Changes Log ==
2/24/10					- added additional PIN checks in case Twitter changes the way they pass the PIN back
					- if all else fails, prompt the user to copy their PIN. The app will grab this and use it
					- this last part only works on OS 3.x and later, Everything else should work fine on 2.x.
					- integrated the latest build of MGTwitterEngine


Example:
Use the project in the Demo folder. You'll need to replace the strings in Demo/Src/OAuthTwitterDemoViewController.m with your own consumer key and consumer secret (visit  http://twitter.com/oauth_clients/new to obtain these).


Built using:
MGTwitterEngine by Matt Gemmell
http://mattgemmell.com
License:  http://mattgemmell.com/license
I have included 1.0.8 release of the MGTwitterEngine unchanged in this project.  
The goal is to create an easily buildable project that has no dependancies.


OAuthConsumer Framework
Jon Crosby
http://code.google.com/p/oauth/
License:  http://www.apache.org/licenses/LICENSE-2.0
I have included a pre-built binary of the OAuthConsumer Framework unchanged in this project.  
The goal is to create an easily buildable project that has no dependancies.


OAuth-MyTwitter
Chris Kimpton
http://github.com/kimptoc/MGTwitterEngine-1.0.8-OAuth-MyTwitter/tree/master
License:  Couldn't find one.  Will amend this if I do.
Some code from this project was used to create the YHOATwitterEngine subclass of MGTwitterEngine.
Thanks Chris, you made this project a simple!


OAuth Test Application
Isaiah Carew
http://github.com/yourhead/OAuth_ObjC_Test_App/tree/master
License: None found.
Isaiah's test app worked great on the Mac, but didn't make use of the PIN number passed back by Twitter, and also needed to be re-worked to work on the phone.