Redmine Client - Access the Redmine API in Ruby

Added by Eric Davis on April 22, 2010 in Home Code

Redmine 1.0 will include a REST API so I've started to build a Rubygem to make accessing the API in Ruby easy. So far redmine_client has support for all of the current APIs in Redmine, including:

  • Read/write support for Issues
  • Read/write support for Projects
  • Read support for News

Installation is an easy gem install redmine_client and it's used just like ActiveResource. For example to change Issue #19000 on the demo.redmine.org site using the "bob" user:

require 'rubygems'
require 'redmine_client'

RedmineClient::Base.configure do
  self.site = 'http://demo.redmine.org'
  self.user = 'bob'
  self.password = 'somepassword'
end

issue = RedmineClient::Issue.find(19000)
issue.subject = "Changed via the API"
issue.save

Both the Redmine API and the redmine_client are under development so I'll be adding new features over the next few months up to Redmine 1.0. Feel free to fork the project on Github and hack away at it.

Want to become more productive with Redmine?

Do you feel like you are fighting Redmine somedays? You know, that feeling where Redmine just can't seem to do what you want it to do?

I have a book that might help. Visit Redmine Tips and let's see if we can take your Redmine knowledge to the next level.

gravatar
Eric Davis

This blog is a place to learn about the Redmine Project Management application and it's community.

I am the founder of Little Stream Software, where I help project teams communicate easier by customizing Redmine. If your team could use a customized Redmine to suit your needs, please contact me.