lib/tmhoauth/README.md

   1 # tmhOAuth
   2
   3 An OAuth 1.0A library written in PHP by @themattharris, specifically for use
   4 with the Twitter API.
   5
   6 **Disclaimer**: This project is a work in progress and may contain bugs.
   7
   8 ## Goals
   9
  10 - Support OAuth 1.0A
  11 - Use Authorisation headers instead of query string or POST parameters
  12 - Allow uploading of images
  13 - Provide enough information to assist with debugging
  14
  15 ## Dependancies
  16
  17 The library has been tested with PHP 5.3+ and relies on CURL and hash_hmac. The
  18 vast majority of hosting providers include these libraries and run with PHP 5.1+.
  19
  20 The code makes use of hash_hmac, which was introduced in PHP 5.1.2. If you version
  21 of PHP is lower than this you should ask your hosting provider for an update.
  22
  23 ## Usage
  24
  25 This will be built out later but for the moment review the examples for ways
  26 the library can be used. Each example contains instructions on how to use it
  27
  28 ## Change History
  29 0.4   03 March 2011
  30       Fixed handling of parameters when using DELETE. Thanks to yusuke for reporting
  31       Fixed php_self to handle port numbers other than 80/443. Props: yusuke
  32       Updated function pr to use pre only when not running in CLI mode
  33       Add support for proxy servers. Props juanchorossi
  34       Function request now returns the HTTP status code. Props: kronenthaler
  35       Documentation fixes for xAuth. Props: 140dev
  36       Some minor code formatting changes
  37
  38 0.3   28 September 2010
  39       Moved entities rendering into the library
  40
  41 0.2   17 September 2010
  42       Added support for the Streaming API
  43
  44 0.14  17 September 2010
  45       Fixed authorisation header for use with OAuth Echo
  46
  47 0.13  17 September 2010
  48       Added use_ssl configuration parameter
  49       Fixed config array typo
  50       Removed v from the config
  51       Remove protocol from the host (configured by use_ssl)
  52       Added include for easier debugging
  53
  54 0.12  17 September 2010
  55       Moved curl options to config
  56       Added the ability for curl to follow redirects, default false
  57
  58 0.11  17 September 2010
  59       Fixed a bug in the GET requests
  60
  61 0.1   26 August 2010
  62       Initial beta version
  63
  64 ## Community
  65
  66 License: Apache 2 (see included LICENSE file)
  67
  68 Follow me on Twitter: <http://twitter.com/themattharris>
  69 Check out the Twitter Developer Resources: <http://dev.twitter.com>
  70
  71 ## To Do
  72
  73 - Add good behavior logic to the Streaming API handler - i.e. on disconnect back off
  74 - Add demo of responsible rate limit handling
  75 - Async Curl support
  76 - Split Utilities functions out