##About
[rubyoverflow][1] is an ruby wrapper for the Stack Overflow API.

###Status
###Documentation
Available via [Github Pages][2]
###All routes mapped  
Going forward, the major and minor version numbers will match the Stack Overflow API, the patch number will denote updates to rubyoverflow for that version

Routes are mapped to what they return ('/answers/id' is accessed from the Answers class, while '/answers/id/comments' is accessed from the Comments class)  

###Future Plans
Added contextual methods to class instances (once you retrieve a user, you can see their favorites by calling `userVariable.retrieve_favorites'

###License
Released under the [MIT Open Source License][3].

###Download
    gem install rubyoverflow 
  or [GitHub][4]

###Platform
Ruby 1.8.x (Have not tested in 1.9)

##Contact
rubyoverflow contains contributions from Dan Seaver. Leave feedback and bug reports on my GitHub [project page][5].

##Code
Written in Ruby 1.8.x . Complete source can be downloaded from [GitHub][6].

##Notes
Documentation of how API methods map to rubyoverflow coming shortly

##Release Notes

###0.8.0
All routes mapped, all parts of the API now available in rubyoverflow
Added Revision and Revisions, along with revision retrieval methods  
Added Questions.search which maps to '/search'  
Added Errors  

###0.6.0
Added RepChange and RepChanges with RepChanges.retrieve_by_user  
Added UserTimeLineEvent and UserTimeLineEvents with UserTimeLineEvent.retrieve_by_user  
Added PostTimeLineEvent and PostTimeLineEvents with PostTimeLineEvent.retrieve_by_question

###0.5.1
Removed @dash member from classes, as it is only used in initialize, shrinking memory usage of classes

###0.5.0
Added Question and Questions with question retrieval methods

###0.4.1
Added Users and retrieve, retrieve_by_id and retrieve_by_badge

###0.4.0
Added Comment and Answer wrappers  
Added retrieval methods for comments and answers

###0.3.2
Update Badges.retrieve_by_user(id) and Tags.retrieve_by_user(id) to accept and array of ids

###0.3.1
Added Badges.retrieve_by_user(id)
Fixed User class (added if to creation of BadgesCount member)

###0.3.0
Mapped User, Badge, BadgeCount, Badges  
Added PagedBase and PagedDash to reuse common properties of paged queries  
Added Badges.retrieve_all, retrieve_all_non_tag_based and retrieve_all_tag_based  
Refactored Tags to use new PagedBase and PagedDash classes

###0.2.3
Added Tags.retrieve_by_user(id, options)

###0.2.x
Configurable, added tag retrieval, added support for query string options via a hash

###0.1.x
Retrieves Stack Overflow statistics by calling `Statistics.retrieve`

    sample = Statistics.retrieve
    sample.total_users # returns total users


  [1]: http://github.com/phsr/rubyoverflow
  [2]: http://phsr.github.com/rubyoverflow/
  [3]: http://www.opensource.org/licenses/mit-license.php
  [4]: http://github.com/phsr/rubyoverflow
  [5]: http://github.com/phsr/rubyoverflow
  [6]: http://github.com/phsr/rubyoverflow