rtmilk 0.0.2 → 0.3.0

data/lib/rtmilk/api/timelines.rb

@@ -0,0 +1,34 @@
+#
+# rtm.timelines : Timelines API
+#
+module RTM
+module Timelines
+
+class Create < RTM::API
+   def parse_result(result)
+      super
+      result['timeline'].first
+   end
+
+   def initialize(token)
+      super 'rtm.timelines.create', token
+   end
+end # Create
+
+end # Timelines
+
+class Timeline
+   def initialize(token)
+      @timeline = RTM::Timelines::Create.new(token).invoke
+   end
+
+   def to_s
+      @timeline
+   end
+
+   def length
+      @timeline.length
+   end
+end # Timeline
+end # RTM
+# vim:fdm=indent

data/lib/rtmilk/error.rb

@@ -0,0 +1,8 @@
+#
+# Error class
+#
+
+module RTM
+# RTM API Eror.
+class Error < StandardError; end
+end # RTM

data/lib/rtmilk/version.rb

@@ -1,8 +1,8 @@
 module Rtmilk #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY  = 2
+    MINOR = 3
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/Rakefile

@@ -0,0 +1,7 @@
+task :default => [:test]
+
+task :test do
+   ruby 'make_config.rb'
+   # ruby 'rtm_api_test.rb'
+   # ruby 'rtm_test.rb'
+end

data/test/auth_api_test.rb

@@ -0,0 +1,82 @@
+#
+# tests for RTM::Auth API.
+#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RTMAuthAPITest < Test::Unit::TestCase
+   CONFIG = File.dirname(__FILE__) + '/../config.dat' # config data file
+
+   def setup
+      conf = begin
+         Marshal.load(open(CONFIG))
+      rescue
+         puts 'please run make_config.rb first.'
+         exit
+      end
+
+      RTM::API.init(conf[:key], conf[:sec], conf)
+      @perms = 'delete'
+   end
+
+   def teardown
+   end
+
+   # -----------------------------------------------------------------
+   # helper
+   #
+   def prompt_for_auth(url)
+      puts 'authorize this url : ' + url
+      puts 'then, push enter here.'
+      gets
+   end
+
+   def get_frob
+      frob = RTM::Auth::GetFrob.new.invoke
+      assert_equal(40, frob.length)
+      return frob
+   end
+
+   def get_token(frob)
+      res = RTM::Auth::GetToken.new(frob).invoke
+      assert_equal(40, res[:token].length)
+      assert_equal(@perms, res[:perms])
+      return res[:token]
+   end
+
+   def get_token_interactive
+      frob = get_frob
+      url = RTM::API.get_auth_url(@perms, frob)
+      prompt_for_auth(url)
+
+      get_token(frob)
+   end
+
+
+   # -----------------------------------------------------------------
+   # tests
+   #
+   def test_getFrob
+      get_frob
+   end
+
+   def test_invalidToken
+      assert_raise(RTM::Error) {
+         RTM::Auth::GetToken.new('detarame').invoke
+      }
+   end
+
+   # this test requires user authentication manually, so disabed normally.
+   def not_test_getToken
+      get_token_interactive
+   end
+
+   # this test requires user authentication manually, so disabed normally.
+   def not_test_checkToken
+      token = get_token_interactive
+
+      auth = RTM::Auth::CheckToken.new(token).invoke
+      assert_equal(@perms, auth[:perms])
+   end
+end
+# vim:fdm=indent

data/test/error_test.rb

@@ -0,0 +1,21 @@
+#
+# tests for RTM::Auth API.
+#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RTMErrorTest < Test::Unit::TestCase
+   CONFIG = File.dirname(__FILE__) + '/../config.dat' # config data file
+
+   def setup
+   end
+
+   def teardown
+   end
+
+   def test_raise
+      assert_raise(RTM::Error) { raise RTM::Error, "login failed" }
+   end
+
+end
+# vim:fdm=indent

data/test/lists_api_test.rb

@@ -0,0 +1,82 @@
+#
+# tests for RTM::Lists API.
+#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RTMListsAPITest < Test::Unit::TestCase
+   CONFIG = File.dirname(__FILE__) + '/../config.dat' # config data file
+
+   def setup
+      conf = begin
+         Marshal.load(open(CONFIG))
+      rescue
+         puts 'please run make_config.rb first.'
+         exit
+      end
+
+      RTM::API.init(conf[:key], conf[:sec], conf)
+      @perms = 'read'
+      @token = conf[:token]
+   end
+
+   def teardown
+   end
+
+   # -----------------------------------------------------------------
+   # helper
+   #
+
+   # -----------------------------------------------------------------
+   # tests
+   #
+   def test_getList
+      lists = RTM::Lists::GetList.new(@token).invoke
+      assert_instance_of(Array, lists)
+      lists.each do |list|
+         assert_instance_of(Hash, list)
+         assert_equal(true, list.has_key?('name'))
+         assert_equal(true, list.has_key?('id'))
+         assert_equal(true, list.has_key?('deleted'))
+         assert_equal(true, list.has_key?('smart'))
+      end
+   end
+
+   def not_test_add
+      name = 'testAddList'
+      added = RTM::Lists::Add.new(@token, name).invoke
+      assert_equal(added['name'], name)
+
+      # TODO: do filter test
+   end # add
+
+   def not_test_delete
+      name = 'testAddList'
+      added = RTM::Lists::Add.new(@token, name).invoke
+      assert_equal(added['name'], name)
+
+      deleted = RTM::Lists::Delete.new(@token, added['id']).invoke
+      assert_equal(added['name'], deleted['name'])
+      assert_equal(added['id'], deleted['id'])
+      assert_equal('1', deleted['deleted'])
+   end # delete
+
+   def test_setName
+      # add
+      name = 'testSetName'
+      new_name = 'testSetNameNew'
+      added = RTM::Lists::Add.new(@token, name).invoke
+      assert_equal(added['name'], name)
+
+      # setName
+      named = RTM::Lists::SetName.new(@token, added['id'], new_name).invoke
+      assert_equal(new_name, named['name'])
+
+      # delete
+      deleted = RTM::Lists::Delete.new(@token, added['id']).invoke
+      assert_equal(named['name'], deleted['name'])
+      assert_equal(named['id'], deleted['id'])
+      assert_equal('1', deleted['deleted'])
+   end
+end
+# vim:fdm=indent

data/test/make_config.rb

@@ -0,0 +1,75 @@
+#
+# make config.dat to store API_KEY, SHARED_SECRET, TOKENs.
+#
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+CONFIG = File.dirname(__FILE__) + '/../config.dat' # config data file
+
+# if file exists, exit
+if FileTest.readable?(CONFIG)
+   exit
+end
+
+done = false
+
+def getToken(perms, frob)
+   url = RTM::API.get_auth_url(perms, frob)
+   puts "follow this link to acqure token (#{perms}) : " + url
+   puts ', then press enter here.'
+   gets
+
+   res = RTM::Auth::GetToken.new(frob).invoke
+   return res[:token]
+end
+
+fh = open(CONFIG, 'w')
+begin
+   hash = {}
+   puts 'Enter your API key.'
+   hash[:key] = gets.chomp
+
+   puts 'Enter your shared secret.'
+   hash[:sec] = gets.chomp
+
+   RTM::API.init(hash[:key], hash[:sec])
+
+   # get a frob
+   frob = RTM::Auth::GetFrob.new.invoke
+   puts 'acquired frob : ' + frob
+
+   #
+   # choose permission
+   #
+   puts 'choose permission: [R]ead, [W]rite, or [D]elete .'
+   selected = gets.chomp
+
+   perms = {
+      'r' => 'read',
+      'R' => 'read',
+      'w' => 'write',
+      'W' => 'write',
+      'd' => 'delete',
+      'D' => 'delete' }
+
+   #
+   # get tokens
+   #
+   token = getToken(perms[selected], frob)
+   hash[:token] = token
+
+   puts 'acquired token is ' + token
+
+   #
+   # save
+   #
+   Marshal.dump(hash, fh)
+   puts 'all done !!!'
+   puts "your informations stored to #{CONFIG}."
+   done = true
+ensure
+   fh.close
+
+   unless done
+      File.unlink(CONFIG)
+   end
+end

data/test/notes_api_test.rb

@@ -0,0 +1,125 @@
+#
+# tests for RTM::Tasks::Notes API.
+#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RTMTasksNotesAPITest < Test::Unit::TestCase
+   CONFIG = File.dirname(__FILE__) + '/../config.dat' # config data file
+
+   def setup
+      conf = begin
+         Marshal.load(open(CONFIG))
+      rescue
+         puts 'please run make_config.rb first.'
+         exit
+      end
+
+      RTM::API.init(conf[:key], conf[:sec], conf)
+      @perms = 'read'
+      @token = conf[:token]
+   end
+
+   def teardown
+   end
+
+   # -----------------------------------------------------------------
+   # helper
+   #
+
+   # -----------------------------------------------------------------
+   # tests
+   #
+   def not_test_add
+      timeline, err = RTM::Timelines::Create.new(@token).invoke
+      assert_equal('ok', err)
+      assert_equal(7, timeline.length)
+
+      lists, err = RTM::Lists::GetList.new(@token).invoke
+      assert_equal('ok', err)
+      assert_instance_of(Array, lists)
+      list = lists.first['id']
+
+      list_a, err, transaction_add = RTM::Tasks::Add.new(
+         @token, timeline, list, 'testTaskAdd').invoke
+      assert_equal('ok', err)
+
+      taskseries = list_a['taskseries'].first['id']
+      task = list_a['taskseries'].first['task'].first['id']
+
+      puts 'creating Note with ' +
+         'timeline=' + timeline +
+         ', list=' + list +
+         ', taskseries=' + taskseries +
+         ', task=' + task
+      note, err, transaction = RTM::Tasks::Notes::Add.new(
+         @token, timeline, list, taskseries, task, 'testNote', 'testNote body.').invoke
+      assert_equal('ok', err)
+      assert_instance_of(Hash, note)
+      assert_not_equal('', note['id'])
+   end
+
+   def not_test_add_delete
+      timeline, err = RTM::Timelines::Create.new(@token).invoke
+      assert_equal('ok', err)
+      assert_equal(7, timeline.length)
+
+      lists, err = RTM::Lists::GetList.new(@token).invoke
+      assert_equal('ok', err)
+      assert_instance_of(Array, lists)
+      list = lists.first['id']
+
+      list_a, err, transaction_add = RTM::Tasks::Add.new(
+         @token, timeline, list, 'testTaskAdd').invoke
+      assert_equal('ok', err)
+
+      taskseries = list_a['taskseries'].first['id']
+      task = list_a['taskseries'].first['task'].first['id']
+
+      note, err, transaction = RTM::Tasks::Notes::Add.new(
+         @token, timeline, list, taskseries, task, 'testNote', 'testNote body.').invoke
+      assert_equal('ok', err)
+      assert_instance_of(Array, lists)
+
+      raise Error if note['id'] == ''
+
+      err = RTM::Tasks::Notes::Delete.new(@token, timeline, note['id']).invoke
+      assert_equal('ok', err.first)
+
+      list_d, err, transaction = RTM::Tasks::Delete.new(
+         @token, timeline, lists.first['id'], taskseries, task).invoke
+      assert_equal('ok', err)
+      assert_equal(list_a['id'], list_d['id'])
+   end
+
+   def test_edit
+      timeline = RTM::Timelines::Create.new(@token).invoke
+      assert_equal(7, timeline.length)
+
+      lists = RTM::Lists::GetList.new(@token).invoke
+      assert_instance_of(Array, lists)
+      list = lists.first['id']
+
+      list_a, transaction_add = RTM::Tasks::Add.new(
+         @token, timeline, list, 'testTaskAdd').invoke
+
+      taskseries = list_a['taskseries'].first['id']
+      task = list_a['taskseries'].first['task'].first['id']
+
+      note, transaction = RTM::Tasks::Notes::Add.new(
+         @token, timeline, list, taskseries, task, 'testNote', 'testNote body.').invoke
+
+      raise Error if note['id'] == ''
+
+      editted, transaction = RTM::Tasks::Notes::Edit.new(
+         @token, timeline, note['id'], 'testNote editted', 'testNote body edditted.').invoke
+      assert_equal(note['id'], editted['id'])
+
+      RTM::Tasks::Notes::Delete.new(@token, timeline, note['id']).invoke
+
+      list_d, transaction = RTM::Tasks::Delete.new(
+         @token, timeline, lists.first['id'], taskseries, task).invoke
+      assert_equal(list_a['id'], list_d['id'])
+   end
+end
+# vim:fdm=indent