Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Unofficial wrapper for the QUOTE.fm API, written in Ruby.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Gemfile
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 quotefm.gemspec
README.md

Unofficial wrapper for the QUOTE.fm API

This wrapper gives access to the currently available functions of the QUOTE.fm API. It lacks most of the interesting features but has every API-call mapped to a method.

General datastructure is a Mash, which provides easy attribute access.

Installation

Currently this wrapper is not available as a gem at RubyGems. However you can checkout the source with Bundler and get the latest version (or any specified one) build automatically.

Usage

quote = Quotefm::Quote.new

quote.user_by_id(1).username
# => "pwaldhauer"

quote.recommendation_by_id(963).article.title
# => "It's Like That Because It Has Always Been Like That"

At this point the API provides neither authentication, nor write access.

Todo

  • moar methods to play with! (maybe some cool stats stuff)
  • moar tests!
  • CLI for easier data-mining :D
  • tidy everything up and upload to RubyGems
  • input validations, especially for numeric values and URIs

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bugfix.
  • Add some basic tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine, but bump the version in a separate commit, that I can ignore when I pull)
  • Send me a pull request. Bonus points for expressiveness of the new feature.

Authors

  • Manuel Hotz

License

See LICENSE for details.

Made in Germany.

Something went wrong with that request. Please try again.