Catch

Ruby wrapper for the Catch API.

Installation

gem install catch

Usage

Instantiate a client (Basic Auth)

catch = Catch::Client.new(:username => "fooman", :password => "supersecret")

or configure once

Catch.configure do |config|
  config.username = "fooman"
  config.password = "supersecret"
end
catch = Catch::Client.new

Examples

catch.notes
catch.note(<note_id>)
catch.add_note({:text => "Lorem ipsum dolor"})
catch.modify_note(<note_id>, {:text => "Lorem ipsum dolor"})
catch.delete_note(<note_id>)

catch.comments(<note_id>)
catch.comment(<note_id>, <comment_id>)
catch.add_comment(<note_id>, {:text => "Lorem ipsum dolor"})
catch.modify_comment(<note_id>, <comment_id>, {:text => "Lorem ipsum dolor"})
catch.delete_comment(<note_id>, <comment_id>)

catch.add_media(<note_id>, <filepath>)
catch.media(<note_id>, <media_id>)
catch.delete_media(<note_id>, <media_id>)

catch.search(<query string>)

catch.user

catch.tags

See the Catch API documentation for more information.

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add 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 version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

Copyright (c) 2011 Samuel Mullen. See LICENSE for details.