Welcome to GroovyRTM!

GroovyRTM allows you to easily take advantage of the Remember The Milk REST API using any language on the JVM. In short, you can now write apps for Remember The Milk without having to worry about all the HTTP transaction stuff, error handling, etc. As its name implies, it's written in Groovy, which made it much easier to write and test.

Recent Changes:

GroovyRTM 2.0 is out! Featuring:

• Better paradigm for handling Tasks, TaskLists, Notes, etc.
• Multi-user support
• Better notes handling

Download it and check out the javadocs

NOTE: GroovyRTM 2.0 is NOT drop-in replacement for 1.0. See more details on the migration guide

Getting Started:

You need 2 things to create a app using GroovyRTM:

1. The groovyrtm-all.jar file (which includes Groovy), or the groovyrtm.jar file using your own groovy install and libraries
2. Apply for an API key at http://www.rememberthemilk.com/services/api/keys.rtm (And an RTM account to test)

Simple Example Java Application:

 import org.eriwen.rtm.*;
 
 class MyGroovyRtmTest {
     public static void main(String[] args) {
         RtmService groovyrtm = new RtmService("<api key>","<shared secret>");
         groovyrtm.testEcho();
     }
 }

Authentication Example:

 package groovyrtmauth;
 
 import java.awt.Desktop;
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import org.eriwen.rtm.RtmService;
 import org.eriwen.rtm.RtmServiceException;
 
 public class MyGroovyRtmTest {
    public static void main(String[] args) {
        RtmService rtm = new RtmService("config/RtmService.properties");
        rtm.currentUser = "yourusername";
        try {
            if (!rtm.isAuthenticated("yourusername")) {
                // Start login process by getting the authorization URL
                try {
                    String authUrl = rtm.getAuthUrl();
                    if (Desktop.isDesktopSupported()) {
                        // Open the auth web page
                        Desktop desktop = Desktop.getDesktop();
                        desktop.browse(new URI(authUrl));
                        System.out.println("I've just opened a web page so you can authorize Groovy RTM");
                    } else {
                        System.out.println("Please open " + authUrl + " in a web browser to authorize Groovy RTM");
                    }
                    System.out.println("Press any key when done...");
 
                    //TODO: Put your application logic or button here so users can click a button when done
 
                    System.in.read();
                    // GroovyRTM automatically stores the auth token
                    String authToken = rtm.authGetToken();
                    if (authToken != null) {
                        // We're golden!
                        System.out.println("Groovy RTM successfully authorized!!");
                    }
                } catch (URISyntaxException ue) {
                    ue.printStackTrace();
                } catch (IOException ioe) {
                    ioe.printStackTrace();
                }
            } else {
                System.out.println("Groovy RTM already authorized!");
            }
        } catch (RtmServiceException rse) {
            rse.printStackTrace();
        }
    }
 }

Quick-start Project

Download a NetBeans project setup with the latest GroovyRTM JAR and optimal project structure here. Project also includes RTM authorization code to help you start even faster!

Licensing

GroovyRTM is licensed under the Apache 2.0 license.