README.txt in rufus-rtm-0.1 vs README.txt in rufus-rtm-0.1.2
- old
+ new
@@ -18,10 +18,12 @@
* 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 http://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'
@@ -47,31 +49,33 @@
== usage
require 'rubygems'
require 'rufus/rtm'
+ include Rufus::RTM
+
#
# listing tasks
tasks = Task.find
- # finding all the tasks
+ # finding all the tasks
tasks = Task.find :filter => "status:incomplete"
- # finding all the incomplete tasks
+ # finding all the incomplete tasks
tasks.each do |task|
- puts "task id #{task.task_id}"
- puts " #{task.name} (#{task.tags.join(",")})"
- puts
+ puts "task id #{task.task_id}"
+ puts " #{task.name} (#{task.tags.join(",")})"
+ puts
end
#
# adding a task
task = Task.add! "study this rufus-rtm gem"
- # gets added to the 'Inbox' by default
+ # gets added to the 'Inbox' by default
puts "task id is #{task.task_id}"
#
# enumerating lists
@@ -98,11 +102,13 @@
task.delete!
Note that the methods that change the state of the Remember The Milk dataset have names ending with an exclamation mark.
+Note as well that, there is a 1 second delay before any request to the RTM server, in order to respect their conditions. This may change in future releases.
+
= features yet to implement
* tags modifications
* smart lists
* ...
@@ -125,18 +131,23 @@
http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
== source
-http://rufus.rubyforge.org/svn/trunk/rtm
+http://github.com/jmettraux/rufus-rtm
- svn checkout http://rufus.rubyforge.org/svn/trunk/rtm
+ git clone git://github.com/jmettraux/rufus-rtm.git
== author
John Mettraux, jmettraux@gmail.com
http://jmettraux.wordpress.com
+
+
+== the rest of Rufus
+
+http://rufus.rubyforge.org
== license
MIT