milk_cap

getting it

gem install milk_cap

or at

github.com/jleverenz/milk_cap

credentials

‘milk_cap’ expects to find RTM credentials in the environment. It will look for:

  • RTM_API_KEY

  • RTM_SHARED_SECRET

  • RTM_FROB

  • RTM_AUTH_TOKEN

(Note since version 0.2, it’s OK to not set these environment variables and to pass their values for each method with :api_key, :shared_secret, :frob and :auth_token optional parameters (see test_2 of test/tasks_test.rb))

You have to apply for the first two ones at www.rememberthemilk.com/services/api/keys.rtm

Once you have the API key and the shared secret, you have to get the frob and the auth token. Fire your ‘irb’ and

>> require 'rubygems'
>> require 'milk_cap'

please visit this URL with your browser and then hit 'enter' :

http://www.rememberthemilk.com/services/auth/?api_sig=70036e47c38da170fee431f04e29e8f0&frob=fa794036814b78fddf3e5641fe7c37f80e7d91fc&perms=delete&api_key=7f07e4fc5a944bf8c02a7d1e45c79346

visit, the given URL, you should finally be greeted by a message like “You have successfully authorized the application API Application. You may now close this window and continue the authentication process with the application that sent you here.”, hit enter…

ok, now getting auth token...

here are your RTM_FROB and RTM_AUTH_TOKEN, make sure to place them
in your environment :

export RTM_FROB=3cef465718317b837eec2faeb5340fe777d55c7c
export RTM_AUTH_TOKEN=ca0022d705ea1831543b7cdd2d7e3d707a0e1efb

make then sure that all the 4 variables are set in the environment you use for running ‘milk_cap’.

usage

require 'rubygems'
require 'milk_cap'

include MilkCap::RTM

#
# listing tasks

tasks = Task.find
  # finding all the tasks

tasks = Task.find :filter => "status:incomplete"
  # finding all the incomplete tasks

tasks.each do |task|

  puts "task id #{task.task_id}"
  puts "   #{task.name} (#{task.tags.join(",")})"
  puts
end

#
# adding a task

task = Task.add! "study this milk_cap gem"
  # gets added to the 'Inbox' by default

puts "task id is #{task.task_id}"

#
# enumerating lists

lists = List.find

w = lists.find { |l| l.name == 'Work' }

puts "my Work list id is #{w.list_id}"

#
# adding a task to a list

task = Task.add! "work, more work", :list_id => w.list_id

#
# completing a task

task.complete!

#
# set tags for a task

task.tags = 'tag1,tag2'
task.tags = ['tag1', 'tag2']  # alternative
task.save!

#
# deleting a task

task.delete!

Note that the methods that change the state of the Remember The Milk dataset have names ending with an exclamation mark.

development

  • Testing with rspec – run suite with ‘rspec’, ‘rake’ or ‘rake spec’.

issue tracker

github.com/jleverenz/milk_cap/issues

source

github.com/jleverenz/milk_cap

git clone git://github.com/jleverenz/milk_cap.git

contributors

origin

milk_cap is the successor gem to rufus-rtm, originally authored by John Mettraux ([email protected], jmettraux.wordpress.com). rufus-rtm is no longer actively supported.

license

MIT