rufus-rtm 0.1.2 → 0.1.3

data/CHANGELOG.txt

@@ -2,10 +2,12 @@
 = rufus-rtm CHANGELOG.txt
 
 
-== rufus-rtm - 0.2    not yet released
+== rufus-rtm - 0.1.3    released 2010/01/24
 
-- todo  #23665 : can now pass rtm key and secret via method params (Giorgio's
-                 request)
+- removed ugly World.include(Rufus::Verbs) (shame on me)
+- ruby 1.9.x friendly
+- removed evil "require 'rubygems'" from rufus/rtm/base.rb
+- can now pass rtm key and secret via method params (Giorgio's request)
 
 
 == rufus-rtm - 0.1    released 2008/02/14

data/LICENSE.txt

@@ -1,5 +1,5 @@
 
-Copyright (c) 2008, John Mettraux, jmettraux@gmail.com
+Copyright (c) 2008-2010, John Mettraux, jmettraux@gmail.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.txt

@@ -4,7 +4,7 @@
 
 == getting it
 
-    sudo gem install -y rufus-rtm
+  gem install rufus-rtm
 
 or at
 
@@ -26,80 +26,80 @@ You have to apply for the first two ones at http://www.rememberthemilk.com/servi
 
 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 'rufus/rtm'
+  >> require 'rubygems'
+  >> require 'rufus/rtm'
 
-    please visit this URL with your browser and then hit 'enter' :
+  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
+  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...
+  ok, now getting auth token...
 
-    here are your RTM_FROB and RTM_AUTH_TOKEN, make sure to place them
-    in your environment :
+  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
+  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 'rufus-rtm'.
 
 
 == usage
 
-    require 'rubygems'
-    require 'rufus/rtm'
+  require 'rubygems'
+  require 'rufus/rtm'
 
-    include Rufus::RTM
+  include Rufus::RTM
 
-    #
-    # listing tasks
+  #
+  # listing tasks
 
-    tasks = Task.find
-      # finding all the tasks
+  tasks = Task.find
+    # finding all the tasks
 
-    tasks = Task.find :filter => "status:incomplete"
-      # finding all the incomplete tasks
+  tasks = Task.find :filter => "status:incomplete"
+    # finding all the incomplete tasks
 
-    tasks.each do |task|
+  tasks.each do |task|
 
-      puts "task id #{task.task_id}"
-      puts "   #{task.name} (#{task.tags.join(",")})"
-      puts
-    end
+    puts "task id #{task.task_id}"
+    puts "   #{task.name} (#{task.tags.join(",")})"
+    puts
+  end
 
-    #
-    # adding a task
+  #
+  # adding a task
 
-    task = Task.add! "study this rufus-rtm gem"
-      # gets added to the 'Inbox' by default
+  task = Task.add! "study this rufus-rtm gem"
+    # gets added to the 'Inbox' by default
 
-    puts "task id is #{task.task_id}"
+  puts "task id is #{task.task_id}"
 
-    #
-    # enumerating lists
+  #
+  # enumerating lists
 
-    lists = List.find
+  lists = List.find
 
-    w = lists.find { |l| l.name == 'Work' }
+  w = lists.find { |l| l.name == 'Work' }
 
-    puts "my Work list id is #{w.list_id}"
+  puts "my Work list id is #{w.list_id}"
 
-    #
-    # adding a task to a list
+  #
+  # adding a task to a list
 
-    task = Task.add! "work, more work", w.list_id
+  task = Task.add! "work, more work", w.list_id
 
-    #
-    # completing a task
+  #
+  # completing a task
 
-    task.complete!
+  task.complete!
 
-    #
-    # deleting a task
+  #
+  # deleting a task
 
-    task.delete!
+  task.delete!
 
 
 Note that the methods that change the state of the Remember The Milk dataset have names ending with an exclamation mark.
@@ -123,19 +123,19 @@ The gem 'rufus-verbs' (http://rufus.rubyforge.org/rufus-verbs)
 
 On the rufus-ruby list[http://groups.google.com/group/rufus-ruby] :
 
-    http://groups.google.com/group/rufus-ruby
+http://groups.google.com/group/rufus-ruby
 
 
 == issue tracker
 
-http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
+http://github.com/jmettraux/rufus-rtm/issues
 
 
 == source
 
 http://github.com/jmettraux/rufus-rtm
 
-    git clone git://github.com/jmettraux/rufus-rtm.git
+  git clone git://github.com/jmettraux/rufus-rtm.git
 
 
 == author

data/Rakefile

@@ -0,0 +1,78 @@
+
+
+require 'lib/rufus/rtm/base.rb'
+
+require 'rubygems'
+require 'rake'
+
+
+#
+# CLEAN
+
+require 'rake/clean'
+CLEAN.include('pkg', 'tmp', 'html')
+task :default => [ :clean ]
+
+
+#
+# GEM
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+
+  gem.version = Rufus::RTM::VERSION
+  gem.name = 'rufus-rtm'
+  gem.summary = 'yet another RememberTheMilk wrapper'
+
+  gem.description = %{
+    yet another RememberTheMilk wrapper
+  }
+  gem.email = 'jmettraux@gmail.com'
+  gem.homepage = 'http://github.com/jmettraux/rufus-rtm/'
+  gem.authors = [ 'John Mettraux' ]
+  gem.rubyforge_project = 'rufus'
+
+  gem.test_file = 'test/test.rb'
+
+  gem.add_dependency 'rufus-verbs', '>= 1.0.0'
+  gem.add_development_dependency 'yard', '>= 0'
+
+  # gemspec spec : http://www.rubygems.org/read/chapter/20
+end
+Jeweler::GemcutterTasks.new
+
+
+#
+# DOC
+
+begin
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |doc|
+    doc.options = [
+      '-o', 'html/rufus-rtm', '--title',
+      "rufus-rtm #{Rufus::RTM::VERSION}"
+    ]
+  end
+
+rescue LoadError
+
+  task :yard do
+    abort "YARD is not available : sudo gem install yard"
+  end
+end
+
+
+#
+# TO THE WEB
+
+task :upload_website => [ :clean, :yard ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = '/var/www/gforge-projects/rufus'
+
+  sh "rsync -azv -e ssh html/rufus-rtm #{account}:#{webdir}/"
+end
+

data/TODO.txt

@@ -0,0 +1,4 @@
+
+[ ] use rufus-json
+[ ] use rufus-jig (patron, ...)
+

data/lib/rufus/rtm.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2008-2010, John Mettraux, jmettraux@gmail.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/rufus/rtm/base.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2008-2010, John Mettraux, jmettraux@gmail.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -23,36 +23,45 @@
 #++
 
 
-require 'rubygems'
 require 'rufus/verbs'
 
-require 'json'
-require 'md5'
+require 'json' # gem install 'json' or 'json_pure'
 
-include Rufus::Verbs
+begin
+
+  require 'md5'
+
+  def md5 (s)
+    MD5.md5(s).to_s
+  end
+
+rescue LoadError # ruby 1.9.x
+
+  require 'digest/md5'
+
+  def md5 (s)
+    Digest::MD5.hexdigest(s)
+  end
+end
 
 
 module Rufus
 module RTM
 
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 
   AUTH_ENDPOINT = "http://www.rememberthemilk.com/services/auth/"
   REST_ENDPOINT = "http://api.rememberthemilk.com/services/rest/"
 
-  #
   # Signs the RTM request (sets the 'api_sig' parameter).
   #
   def self.sign (params, secret) #:nodoc:
 
-    sig = MD5.md5(secret + params.sort.flatten.join)
-
-    params['api_sig'] = sig.to_s
+    params['api_sig'] = md5(secret + params.sort.flatten.join)
 
     params
   end
 
-  #
   # Calls an API method (milk the cow).
   #
   def self.milk (params={}) #:nodoc:
@@ -82,12 +91,11 @@ module RTM
 
     sign(ps, secret)
 
-    res = get(endpoint, :query => ps)
+    res = Rufus::Verbs.get(endpoint, :query => ps)
 
     JSON.parse(res.body)['rsp']
   end
 
-  #
   # Requests a timeline from RTM.
   #
   def self.get_timeline #:nodoc:

data/lib/rufus/rtm/credentials.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2008-2010, John Mettraux, jmettraux@gmail.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal

data/lib/rufus/rtm/resources.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008-2009, John Mettraux, jmettraux@gmail.com
+# Copyright (c) 2008-2010, John Mettraux, jmettraux@gmail.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -38,7 +38,6 @@ module Rufus::RTM
       @operations = []
     end
 
-    #
     # Saves the instance back to RTM.
     #
     def save!
@@ -54,7 +53,6 @@ module Rufus::RTM
 
     protected
 
-    #
     # a class method for listing attributes that can be found
     # in the hash reply coming from RTM...
     #
@@ -69,7 +67,6 @@ module Rufus::RTM
       end
     end
 
-    #
     # Calls the milk() method (interacts with the RTM API).
     #
     def self.execute (method_name, args={})
@@ -79,7 +76,6 @@ module Rufus::RTM
       Rufus::RTM.milk(args)
     end
 
-    #
     # Returns the name of the resource as the API knows it
     # (for example 'tasks' or 'lists').
     #
@@ -88,7 +84,6 @@ module Rufus::RTM
       self.to_s.split('::')[-1].downcase + 's'
     end
 
-    #
     # Simply calls the timeline() class method.
     #
     def timeline
@@ -96,7 +91,6 @@ module Rufus::RTM
       MilkResource.timeline
     end
 
-    #
     # Returns the current timeline (fetches one if none has yet
     # been prepared).
     #
@@ -166,7 +160,6 @@ module Rufus::RTM
       @tags = TagArray.new(self, h['tags'])
     end
 
-    #
     # Deletes the task.
     #
     def delete!
@@ -174,7 +167,6 @@ module Rufus::RTM
       self.class.execute('delete', prepare_api_args)
     end
 
-    #
     # Marks the task as completed.
     #
     def complete!
@@ -182,7 +174,6 @@ module Rufus::RTM
       self.class.execute('complete', prepare_api_args)
     end
 
-    #
     # Sets the tags for the task.
     #
     def tags= (tags)
@@ -199,7 +190,6 @@ module Rufus::RTM
       parse_tasks(execute('getList', params))
     end
 
-    #
     # Adds a new task (and returns it).
     #
     def self.add! (name, list_id=nil)

data/rufus-rtm.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rufus-rtm}
+  s.version = "0.1.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux"]
+  s.date = %q{2010-01-24}
+  s.description = %q{
+    yet another RememberTheMilk wrapper
+  }
+  s.email = %q{jmettraux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.txt"
+  ]
+  s.files = [
+    "CHANGELOG.txt",
+     "LICENSE.txt",
+     "README.txt",
+     "Rakefile",
+     "TODO.txt",
+     "lib/rufus-rtm.rb",
+     "lib/rufus/rtm.rb",
+     "lib/rufus/rtm/base.rb",
+     "lib/rufus/rtm/credentials.rb",
+     "lib/rufus/rtm/resources.rb",
+     "rufus-rtm.gemspec",
+     "test/tasks_test.rb",
+     "test/test.rb"
+  ]
+  s.homepage = %q{http://github.com/jmettraux/rufus-rtm/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rufus}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{yet another RememberTheMilk wrapper}
+  s.test_files = [
+    "test/test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rufus-verbs>, [">= 1.0.0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<rufus-verbs>, [">= 1.0.0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rufus-verbs>, [">= 1.0.0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/test/tasks_test.rb

@@ -0,0 +1,99 @@
+
+#
+# Testing rufus-rtm
+#
+# John Mettraux at openwfe.org
+#
+# Tue Feb  5 18:16:55 JST 2008
+#
+
+require 'rubygems'
+
+require 'test/unit'
+
+$: << File.dirname(__FILE__) + '/../lib'
+
+require 'rufus/rtm'
+
+include Rufus::RTM
+
+
+class TasksTest < Test::Unit::TestCase
+
+  #def setup
+  #end
+
+  #def teardown
+  #end
+
+  def test_0
+
+    taskname = "milk the cow #{Time.now.to_i}"
+
+    t0 = Task.add!(taskname)
+
+    assert_kind_of Task, t0
+    assert_equal taskname, t0.name
+
+    ts = Task.find
+
+    #puts "tasks : #{ts.size}"
+
+    t1 = ts.find { |t| t.task_id == t0.task_id }
+    assert_equal taskname, t1.name
+    assert_equal '', t1.tags.join(',')
+
+    ts = Task.find :filter => "status:incomplete"
+
+    #puts "incomplete tasks : #{ts.size}"
+
+    t1 = ts.find { |t| t.task_id == t0.task_id }
+    assert_equal taskname, t1.name
+
+    t1.delete!
+
+    ts = Task.find :filter => "status:incomplete"
+
+    t1 = ts.find { |t| t.task_id == t0.task_id }
+    assert_nil t1
+  end
+
+  def test_1
+
+    lists = List.find
+    assert_not_nil(lists.find { |e| e.name == 'Inbox' })
+
+    work = lists.find { |e| e.name == 'Work' }
+
+    taskname = "more work #{Time.now.to_i}"
+
+    t0 = Task.add! taskname, work.list_id
+
+    tasks = Task.find :list_id => work.list_id, :filer => 'status:incomplete'
+
+    assert_not_nil(tasks.find { |t| t.task_id == t0.task_id })
+
+    t0.complete!
+
+    tasks = Task.find :list_id => work.list_id, :filer => 'status:completed'
+    assert_not_nil(tasks.find { |t| t.task_id == t0.task_id })
+
+    t0.delete!
+  end
+
+  def test_2
+
+    key = ENV.delete('RTM_API_KEY')
+    secret = ENV.delete('RTM_SHARED_SECRET')
+
+    assert_raise RuntimeError do
+      lists = List.find
+    end
+
+    assert_not_nil List.find(:api_key => key, :shared_secret => secret)
+
+    ENV['RTM_API_KEY'] = key
+    ENV['RTM_SHARED_SECRET'] = secret
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-rtm
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,43 +9,59 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-27 00:00:00 +09:00
+date: 2010-01-24 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rufus-verbs
   type: :runtime
   version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: 
+description: "\n    yet another RememberTheMilk wrapper\n  "
 email: jmettraux@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE.txt
 - README.txt
+files: 
 - CHANGELOG.txt
 - LICENSE.txt
-files: 
+- README.txt
+- Rakefile
+- TODO.txt
+- lib/rufus-rtm.rb
+- lib/rufus/rtm.rb
 - lib/rufus/rtm/base.rb
 - lib/rufus/rtm/credentials.rb
 - lib/rufus/rtm/resources.rb
-- lib/rufus/rtm.rb
-- lib/rufus-rtm.rb
-- CHANGELOG.txt
-- LICENSE.txt
-- README.txt
+- rufus-rtm.gemspec
+- test/tasks_test.rb
+- test/test.rb
 has_rdoc: true
-homepage: http://rufus.rubyforge.org/rufus-rtm/
-post_install_message: 
-rdoc_options: []
+homepage: http://github.com/jmettraux/rufus-rtm/
+licenses: []
 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -60,12 +76,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version 
       version: "0"
   version: 
-requirements: 
-- rufus-verbs
+requirements: []
+
 rubyforge_project: rufus
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: yet another RememberTheMilk wrapper
 test_files: 
 - test/test.rb