rtmilk 0.0.1 → 0.0.2

data/Manifest.txt

@@ -3,7 +3,9 @@ README.txt
 CHANGELOG.txt
 Manifest.txt
 setup.rb
+lib/rtmilk/api.rb
 lib/rtmilk/version.rb
 lib/rtmilk.rb
 test/test_helper.rb
-test/rtmilk_test.rb
+test/rtm_test.rb
+test/rtm_api_test.rb

data/Rakefile

@@ -24,9 +24,12 @@ REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+
 VERS = ENV['VERSION'] || (Rtmilk::VERSION::STRING + (REV ? ".#{REV}" : ""))
                           CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', "rtmilk documentation",
+    "--exclude", "test",
+    "--exclude", "pkg",
+    "--exclude", "setup.rb",
     "--opname", "index.html",
     "--line-numbers", 
-    "--main", "README",
+    "--main", "README.txt",
     "--inline-source"]
 
 class Hoe
@@ -52,3 +55,21 @@ hoe = Hoe.new(GEM_NAME, VERS) do |p|
   #p.extra_deps     - An array of rubygem dependencies.
   #p.spec_extras    - A hash of extra values to set in the gemspec.
 end
+
+Rake::RDocTask.new do |rdoc|
+   rdoc.rdoc_dir = 'html'
+   rdoc.options += RDOC_OPTS
+   rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+   if ENV['DOC_FILES']
+      rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+   else
+      rdoc.rdoc_files.include('README.txt', 'CHANGELOG.txt')
+      rdoc.rdoc_files.include('lib/**/*.rb')
+   end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+   Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'takayama').upload
+end
+

data/lib/rtmilk/api.rb

@@ -0,0 +1,386 @@
+#
+# for Remember the Milk REST API
+#     http://www.rememberthemilk.com/services/api/overview.rtm
+#
+# $Id: api.rb 11 2007-01-08 04:02:44Z takayama $
+#
+
+require 'net/http'
+require 'digest/md5'
+require 'rubygems'
+require 'xmlsimple'
+require 'uri'
+
+# access the {Remember the Milk}[http://www.rememberthemilk.com/] REST APIs.
+module RTM
+
+# API classes.
+class API
+   RTM_URI   = 'www.rememberthemilk.com'
+   REST_PATH = '/services/rest/'
+   AUTH_PATH = '/services/auth/'
+
+   PERMS = ['read', 'write', 'delete']
+
+   #--
+   # -----------------------------------------------------------------
+   # class methods
+   #++
+   
+   def API.key ; @@key ; end
+   def API.params ; @@params ; end
+   def API.token ; @@token ; end
+
+   # initialize the API context.
+   # make sure to call this before using any API calls.
+   def API.init(h)
+      @@key = h[:key] if h.has_key? :key
+      @@sec = h[:secret] if h.has_key? :secret
+      @@frob = h[:frob] if h.has_key? :frob
+      @@token = h[:token] if h.has_key? :token
+
+      @@params = { 'api_key' => @@key }
+      @@http = Net::HTTP.new(RTM_URI)
+   end
+
+   # tailor parameters into request uri.
+   def API.uri_req(params)
+      r  = REST_PATH + '?' 
+      r += params.collect { |k, v| [k, v].join('=') }.sort.join('&')
+      r += '&api_sig=' + sign(params)
+      URI.escape r
+   end
+
+   # tailor parameters into auth uri.
+   def API.uri_auth(params, h)
+      p = params.dup
+      p[:perms] = h[:perm]
+      p[:frob]  = h[:frob] if h[:frob]
+      p[:callback] = h[:callback] if h[:callback]
+
+      r  = AUTH_PATH + '?'
+      r += p.collect { |k, v| [k, v].join('=') }.sort.join('&')
+
+      r += '&api_sig=' + sign(p)
+      r
+   end
+
+   # construct auth uri from params.
+   def API.auth_uri(params, h)
+      RTM_URI + uri_auth(params, h)
+   end
+
+   # process http request, return response.
+   def API.request(uri)
+      head, body = @@http.get(uri)
+      res = XmlSimple.new.xml_in(body)
+      raise Error, res if 'fail' == res['stat']
+      res
+   end
+
+   private
+
+   # sign parameters.
+   def API.sign(params)
+      sig = @@sec
+      sig += params.collect { |k, v| [k, v].join('') }.sort.join('')
+      sig = Digest::MD5.hexdigest(sig)
+   end
+end # API
+
+#--
+# ---------------------------------------------------------------
+# subclasses
+#++
+
+class API
+   # Exception class, takes msg and code.
+   class Error < StandardError
+      def initialize(h)
+         err = h['err'].first
+         @code = err['code'].to_i
+         msg = err['msg'] + ' (error code=' + err['code'] + ')'
+         super(msg)
+      end
+   end
+
+   # rtm.auth API.
+   class Auth
+      METHOD = 'rtm.auth'
+
+      # see spec[http://www.rememberthemilk.com/services/api/methods/rtm.auth.checkToken.rtm].
+      def Auth.checkToken(token)
+         p = API.params.dup
+         p['method'] = METHOD + '.checkToken'
+         p['auth_token'] = token
+         res = API.request(API.uri_req(p))
+      end
+
+      # see spec[http://www.rememberthemilk.com/services/api/methods/rtm.auth.getFrob.rtm].
+      def Auth.getFrob
+         p = API.params.dup
+         p['method'] = METHOD + '.getFrob'
+
+         res = API.request(API.uri_req(p))
+         res['frob'].first
+      end
+
+      # see {spec}[http://www.rememberthemilk.com/services/api/methods/rtm.auth.getToken.rtm].
+      def Auth.getToken(frob)
+         p = API.params.dup
+         p['method'] = METHOD + '.getToken'
+         p['frob']   = frob
+
+         res = API.request(API.uri_req(p))
+         res['auth'].first['token'].first
+      end
+   end # Auth
+
+   class Contacts
+      def Contacts.add
+      end
+
+      def Contacts.delete
+      end
+
+      def Contacts.getList
+      end
+   end # Contacts
+
+   class Groups
+      def Groups.add
+      end
+
+      def Groups.addContact
+      end
+
+      def Groups.delete
+      end
+
+      def Groups.getList
+      end
+
+      def Groups.removeContact
+      end
+   end # Groups
+
+   class Lists
+      METHOD = 'rtm.lists'
+
+      def Lists.add(timeline, name, filter=nil)
+         p = API.params.dup
+         p['method'] = METHOD + '.add'
+         p['auth_token'] = API.token
+         p['timeline'] = timeline
+         p['name'] = name
+         p['filter'] = filter if filter
+
+         res = API.request(API.uri_req(p))
+      end
+
+      def Lists.archive
+      end
+
+      def Lists.getList(alive_only=true)
+         p = API.params.dup
+         p['method'] = METHOD + '.getList'
+         p['auth_token'] = API.token
+
+         res = API.request(API.uri_req(p))
+         lists = res['lists'].first['list']
+
+         if alive_only
+            lists.collect { |l| l if l['deleted'] == '0' }.compact
+         else
+            lists
+         end
+      end
+
+      def Lists.setDefaultList
+      end
+
+      def Lists.setName
+      end
+
+      def Lists.unarchive
+      end
+   end # Lists
+
+   class Reflection
+      def Reflection.getMethodInfo
+      end
+
+      def Reflection.getMethods
+      end
+   end # Reflection
+
+   class Settings
+      def Settings.getList
+      end
+   end # Settings
+
+   class Tasks
+      METHOD = 'rtm.tasks'
+
+      def Tasks.add(timeline, list, name)
+         p = API.params.dup
+         p['method'] = METHOD + '.add'
+         p['auth_token'] = API.token
+         p['timeline'] = timeline
+         p['name'] = name
+         p['list_id'] = list
+
+         res = API.request(API.uri_req(p))
+         res['list'].first['taskseries'].first
+      end
+
+      def Tasks.addTags
+      end
+
+      def Tasks.complete
+      end
+
+      def Tasks.delete(timeline, list, series, task)
+         p = API.params.dup
+         p['method'] = METHOD + '.delete'
+         p['auth_token'] = API.token
+         p['timeline'] = timeline
+         p['list_id'] = list
+         p['taskseries_id'] = series
+         p['task_id'] = task
+
+         res = API.request(API.uri_req(p))
+         res['list'].first['taskseries'].first
+      end
+
+      def Tasks.getList(list=nil, last_sync=nil)
+         p = API.params.dup
+
+         p['method'] = METHOD + '.getList'
+         p['auth_token'] = API.token
+         p['list_id'] = list if list
+         p['last_sync'] = last_sync if last_sync
+
+         res = API.request(API.uri_req(p))
+         res['tasks'].first['list']
+      end
+
+      def Tasks.moveProiority
+      end
+
+      def Tasks.moveTo
+      end
+
+      def Tasks.postpone
+      end
+
+      def Tasks.removeTags
+      end
+
+      def Tasks.setDueDate
+      end
+
+      def Tasks.setEstimate
+      end
+
+      def Tasks.setName
+      end
+
+      def Tasks.setPriority
+      end
+
+      def Tasks.setRecurrence
+      end
+
+      def Tasks.setTags
+      end
+
+      def Tasks.setURL
+      end
+
+      def Tasks.uncomplete
+      end
+
+      class Notes # TODO
+         def Notes.add # TODO
+         end
+
+         def Notes.delete # TODO
+         end
+
+         def Notes.edit # TODO
+         end
+      end # Notes
+   end # Tasks
+
+   class Test # TODO
+      METHOD = 'rtm.test'
+
+      def Test.echo # TODO
+         req = REST_PATH + '?method=' + METHOD + '.echo' + '&api_key=' + @k
+         puts req
+
+         r, b = @http.get(req)
+         puts r
+         puts b
+      end
+
+      def Test.login # TODO
+         params = {
+            'method' => METHOD + '.login',
+            'api_key' => @k
+         }
+
+         sig = @s
+         sig += params.collect { |k, v| [k, v].join('') }.sort.join('')
+         puts "sig = " + sig
+         sig = Digest::MD5.hexdigest(sig)
+         puts "hexed sig = " + sig
+
+         req = REST_PATH + '?' 
+         req += params.collect { |k, v| [k, v].join('=') }.sort.join('&')
+         req += "&api_sig=" + sig
+
+         puts "\n"
+         puts "req = " + req
+
+         r, b = @http.get(req)
+         puts r
+         puts b
+      end
+   end # Test
+
+   class Time # TODO
+      def Time.convert # TODO
+      end
+
+      def Time.parse # TODO
+      end
+   end # Time
+
+   class TimeLines
+      METHOD = 'rtm.timelines'
+
+      def TimeLines.create
+         p = API.params.dup
+         p['method'] = METHOD + '.create'
+         p['auth_token'] = API.token
+
+         res = API.request(API.uri_req(p))
+         t = res['timeline'].first
+      end
+   end # TimeLines
+
+   class TimeZones # TODO
+      def TimeZones.getList
+      end
+   end # TimeZones
+
+   class Transactions
+      def Transactions.undo
+      end
+   end # Transactions
+end # API
+
+end # RTM
+# vim:fdm=indent

data/lib/rtmilk/version.rb

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

data/test/rtm_api_test.rb

@@ -0,0 +1,164 @@
+#
+# tests for rtm.rb
+#
+# see http://d.hatena.ne.jp/secondlife/20060927/1159334813
+#
+# $Id: test_rtm_api.rb 10 2006-12-30 06:37:24Z takayama $
+#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RTMAPITest < Test::Unit::TestCase
+   CONFIG = File.dirname(__FILE__) + '/../config.dat' # config data file
+
+   KEY   = 'aaa' # XXX specify API key
+   SEC   = 'bbb' # XXX specify shared secret
+   FROB  = 'ccc' # XXX enter some frob
+   TOKEN = 'ddd' # XXX enter some token
+
+   def setup
+      conf = begin
+         Marshal.load(open(CONFIG))
+      rescue
+         { 
+            :key => KEY,
+            :secret => SEC,
+            :frob => FROB,
+            :token => TOKEN }
+      end
+
+      RTM::API.init(conf)
+      # @base  = RTM::API.new(KEY, SIG)
+      # @test  = RTM::TestAPI.new(KEY, SIG)
+      # @auth  = RTM::AuthAPI.new(KEY, SIG)
+      # @lists = RTM::ListsAPI.new(KEY, SIG)
+      # @tasks = RTM::TasksAPI.new(KEY, SIG)
+   end
+
+   def test_init
+      assert_equal(1, RTM::API.params.size)
+   end
+
+   def test_instance
+      # assert_instance_of RTM::API, @base
+      # assert_instance_of RTM::TestAPI, @test
+      # assert_instance_of RTM::AuthAPI, @auth
+      # assert_instance_of RTM::ListsAPI, @lists
+      # assert_instance_of RTM::TasksAPI, @tasks
+   end
+
+# -------------------------------------------------------------------
+# API
+#
+   def test_sign
+     sign = RTM::API.sign(RTM::API.params)
+     assert_equal(32, sign.length)
+   end
+
+   def test_uri_req
+     assert_equal(1, RTM::API.params.keys.size)
+     ur = RTM::API.uri_req(RTM::API.params)
+     assert_not_nil(ur)
+     assert_equal(1, RTM::API.params.keys.size)
+   end
+
+   def test_uri_auth
+     assert_equal(1, RTM::API.params.keys.size)
+     ra = RTM::API.uri_auth(RTM::API.params, 'read')
+     assert_not_nil(ra)
+     assert_equal(1, RTM::API.params.keys.size)
+   end
+
+   def test_auth_uri
+      au = RTM::API.auth_uri(RTM::API.params, 'read')
+      assert_not_nil(au)
+   end
+
+   def test_uri_auth_frob
+      frob = RTM::API::Auth.getFrob
+      assert_not_nil(frob)
+      assert_equal(40, frob.length)
+
+      RTM::API::PERMS.each do |p|
+         ra = RTM::API.uri_auth(RTM::API.params, {'perm'=>p, 'frob'=>frob})
+         assert_not_nil(ra)
+         assert_equal(1, RTM::API::params.keys.size)
+      end
+   end
+
+# -------------------------------------------------------------------
+# Auth
+#
+   def test_authGetFrob
+      frob = RTM::API::Auth.getFrob
+      assert_not_nil(frob)
+      assert_equal(40, frob.length)
+   end
+
+=begin
+   def test_authGetToken
+      frob = @auth.getFrob
+      assert_not_nil(frob)
+      assert_equal(40, frob.length)
+
+      ra = @base.uri_auth('read', frob)
+      assert_not_nil(ra)
+
+      puts 'auth this url : ' + 'http://' + RTM::RTM_URI + ra
+      # @base.auth(ra)
+      gets
+
+      token = @auth.getToken(frob)
+      assert_not_nil(token)
+      p token
+      assert_equal(40, token.length)
+   end
+=end
+
+   def test_authCheckToken
+      assert_raise(RTM::API::Error) {
+         RTM::API::Auth.checkToken(TOKEN + 'a')
+      }
+      assert_nothing_raised {
+         checked = RTM::API::Auth.checkToken(RTM::API.token)
+         assert_not_nil(checked)
+      }
+   end
+
+   def test_taskGetList
+      tasks = RTM::API::Tasks.getList
+      assert_not_nil(tasks)
+   end
+
+
+=begin
+   def test_testEcho
+      @test.echo
+   end
+
+   def test_testLogin
+      @test.login
+   end
+
+   def test_getList
+      @lists.get
+   end
+=end
+
+# -------------------------------------------------------------------
+# API test
+#
+   def test_api_init
+      RTM::API.init(:key => KEY)
+
+      assert_equal(KEY, RTM::API.key)
+   end
+
+# -------------------------------------------------------------------
+# TimeLines API test
+#
+   def test_timelines_create
+      timeline = RTM::API::TimeLines.create
+      assert_not_nil(timeline)
+   end
+end

data/test/rtm_test.rb

@@ -0,0 +1,80 @@
+#
+# tests for rtm.rb
+#
+# see http://d.hatena.ne.jp/secondlife/20060927/1159334813
+#
+# $Id: test_rtm.rb 10 2006-12-30 06:37:24Z takayama $
+#
+
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class RTMTest < Test::Unit::TestCase
+   CONFIG = File.dirname(__FILE__) + '/../config.dat' # config data file
+
+   KEY   = 'aaa' # XXX specify API key
+   SEC   = 'bbb' # XXX specify shared secret
+   FROB  = 'ccc' # XXX enter some frob
+   TOKEN = 'ddd' # XXX enter some token
+
+   def setup
+      conf = begin
+         Marshal.load(open(CONFIG))
+      rescue
+         { 
+            :key => KEY,
+            :secret => SEC,
+            :frob => FROB,
+            :token => TOKEN }
+      end
+
+      RTM::API.init(conf)
+      @contact  = RTM::Contact.new(0)
+      @group    = RTM::Group.new
+      @list     = RTM::List.new(:id => 0)
+      @lists    = RTM::Lists.new
+   end
+
+   def test_instance
+      assert_instance_of RTM::Contact, @contact
+      assert_instance_of RTM::Group, @group
+      assert_instance_of RTM::List, @list
+      assert_instance_of RTM::Lists, @lists
+   end
+
+   # -----------------------------------------------------------------
+   # Lists
+   #
+   def test_lists0
+      assert_not_nil(@list)
+      assert_not_nil(@lists)
+   end
+
+   def test_lists_add
+      l = RTM::Lists.add('rtmilk test')
+      assert_not_nil(l)
+   end
+
+   # -----------------------------------------------------------------
+   # Tasks
+   #
+   def test_tasks_add
+      t = RTM::Tasks.add('rtmilk test task to add', @lists[0].id)
+      assert_not_nil(t)
+   end
+
+   def test_tasks_delete
+      t = RTM::Tasks.add('rtmilk test task to delete', @lists[0].id)
+      assert_not_nil(t)
+
+      deleted = RTM::Tasks.delete(t.id, t.task.first.id, @lists[0].id)
+      assert_not_nil(deleted)
+   end
+
+   # -----------------------------------------------------------------
+   # TimeLine
+   #
+   def test_get_timeline
+      timeline = RTM.get_timeline
+      assert_not_nil(timeline)
+   end
+end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.1
 specification_version: 1
 name: rtmilk
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 date: 2007-02-05 00:00:00 +09:00
 summary: a "Remember the Milk" wrapper library.
 require_paths: 
@@ -34,12 +34,15 @@ files:
 - CHANGELOG.txt
 - Manifest.txt
 - setup.rb
+- lib/rtmilk/api.rb
 - lib/rtmilk/version.rb
 - lib/rtmilk.rb
 - test/test_helper.rb
-- test/rtmilk_test.rb
+- test/rtm_test.rb
+- test/rtm_api_test.rb
 test_files: 
-- test/rtmilk_test.rb
+- test/rtm_api_test.rb
+- test/rtm_test.rb
 rdoc_options: []
 
 extra_rdoc_files: []

data/test/rtmilk_test.rb

@@ -1,11 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class RtmilkTest < Test::Unit::TestCase
-
-  def setup
-  end
-  
-  def test_truth
-    assert true
-  end
-end