maisonneuve-rtm 0.1.2

data/README.txt

@@ -0,0 +1,133 @@
+
+= maisonneuve-rtm
+  Modified version of the rufus-rtm gem, removing the dependancy of rufus-verbs gem
+
+== getting it
+
+  sudo gem install -y maisonneuve-rtm
+
+
+== credentials
+
+'rufus-rtm' 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 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'
+  >> require 'rufus/rtm'
+
+  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 'rufus-rtm'.
+
+
+== usage
+
+  require 'rubygems'
+  require 'rufus/rtm'
+
+  include Rufus::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 rufus-rtm 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", w.list_id
+
+  #
+  # completing a task
+
+  task.complete!
+
+  #
+  # 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.
+
+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
+* ...
+
+
+
+
+
+
+
+== source
+
+http://github.com/maisonneuve/rufus-rtm
+
+
+
+== author
+ Nicolas Maisonneuve
+version modified from the work of John Mettraux, jmettraux@gmail.com
+http://jmettraux.wordpress.com
+
+
+== license
+
+MIT
+

data/lib/rufus/rtm/base.rb

@@ -0,0 +1,108 @@
+# modified version to remove dependancies from rufus-verb gem
+# author: Nicolas Maisonneuve  n.maisonneuve@gmail.com
+
+#--
+# Copyright (c) 2008-2009, 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+require 'rubygems'
+require 'cgi'
+require 'json'
+require 'md5'
+
+module Rufus
+module RTM
+
+  VERSION = '0.1.2'
+
+  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
+  end
+
+  #
+  # Calls an API method (milk the cow).
+  #
+  def self.milk (params={}) #:nodoc:
+
+    sleep 1
+
+    endpoint = params.delete(:endpoint)
+    endpoint = AUTH_ENDPOINT if endpoint == :auth
+    endpoint = endpoint || REST_ENDPOINT
+
+    ps = params.inject({}) { |r, (k, v)| r[k.to_s] = v; r }
+
+    ps['api_key'] = params[:api_key] || ENV['RTM_API_KEY']
+
+    raise 'API_KEY missing from environment or parameters, cannot proceed' \
+      unless ps['api_key']
+
+    ps['frob'] = params[:frob] || ENV['RTM_FROB']
+    ps.delete('frob') if ps['frob'] == nil
+
+    ps['auth_token'] = params[:auth_token] || ENV['RTM_AUTH_TOKEN']
+    ps.delete('auth_token') if ps['auth_token'] == nil
+
+    ps['format'] = 'json'
+
+    secret = params[:shared_secret] || ENV['RTM_SHARED_SECRET']
+
+    sign(ps, secret)
+
+    res = get(endpoint, :query => ps)
+
+    JSON.parse(res.body)['rsp']
+  end
+
+  #
+  # Requests a timeline from RTM.
+  #
+  def self.get_timeline #:nodoc:
+
+    milk(:method => 'rtm.timelines.create')['timeline']
+  end
+
+  def self.get(endpoint, hash)
+     query=hash.inject(""){|result, item|
+       result+="#{item[0].to_s}=#{CGI.escape(item[1].to_s)}&"
+     }
+     url=endpoint+'?'+query[0..query.length-2]
+     p url
+     Net::HTTP.get(URI.parse(url))
+  end
+
+end
+end
+

data/lib/rufus/rtm/credentials.rb

@@ -0,0 +1,103 @@
+#--
+# Copyright (c) 2008-2009, 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+module Rufus::RTM
+
+  def self.auth_get_frob #:nodoc:
+
+    r = milk(:method => 'rtm.auth.getFrob')
+    r['frob']
+  end
+
+  def self.auth_get_frob_and_url #:nodoc:
+
+    frob = auth_get_frob
+
+    p = {}
+    p['api_key'] = ENV['RTM_API_KEY']
+    p['perms'] = 'delete'
+    p['frob'] = frob
+    sign(p, ENV['RTM_SHARED_SECRET'])
+
+    [
+      frob,
+      AUTH_ENDPOINT + '?' + p.collect { |k, v| "#{k}=#{v}" }.join("&")
+    ]
+  end
+
+  def self.auth_get_token (frob) #:nodoc:
+
+    begin
+      milk(:method => 'rtm.auth.getToken', :frob => frob)['auth']['token']
+    rescue Exception => e
+      nil
+    end
+  end
+
+  #
+  # ensuring the credentials are present...
+
+  unless ENV['RTM_FROB']
+
+    frob, auth_url = auth_get_frob_and_url
+
+    puts <<-EOS
+
+please visit this URL with your browser and then hit 'enter' :
+
+#{auth_url}
+
+    EOS
+
+    STDIN.gets
+    puts "ok, now getting auth token...\n"
+
+    auth_token = auth_get_token frob
+
+    if auth_token
+
+      puts <<-EOS
+
+here are your RTM_FROB and RTM_AUTH_TOKEN, make sure to place them
+in your environment :
+
+export RTM_FROB=#{frob}
+export RTM_AUTH_TOKEN=#{auth_token}
+
+      EOS
+    else
+
+      puts <<-EOS
+
+couldn't get auth token, please retry...
+
+      EOS
+    end
+
+    exit 0
+  end
+
+end
+

data/lib/rufus/rtm/resources.rb

@@ -0,0 +1,337 @@
+#--
+# Copyright (c) 2008-2009, 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+module Rufus::RTM
+
+  #
+  # A parent class for Task, List and co.
+  #
+  # Never use directly.
+  #
+  class MilkResource
+
+    def initialize (hsh)
+
+      @hsh = hsh
+      @operations = []
+    end
+
+    #
+    # Saves the instance back to RTM.
+    #
+    def save!
+
+      # TODO : compact !
+
+      @operations.reverse.each do |method_name, args|
+
+        self.class.execute method_name, args
+      end
+      @operations = []
+    end
+
+    protected
+
+    #
+    # a class method for listing attributes that can be found
+    # in the hash reply coming from RTM...
+    #
+    def self.milk_attr (*att_names) #:nodoc:
+
+      att_names.each do |att_name|
+        class_eval %{
+          def #{att_name}
+            @hsh['#{att_name}']
+          end
+        }
+      end
+    end
+
+    #
+    # Calls the milk() method (interacts with the RTM API).
+    #
+    def self.execute (method_name, args={})
+
+      args[:method] = "rtm.#{resource_name}.#{method_name}"
+
+      Rufus::RTM.milk(args)
+    end
+
+    #
+    # Returns the name of the resource as the API knows it
+    # (for example 'tasks' or 'lists').
+    #
+    def self.resource_name
+
+      self.to_s.split('::')[-1].downcase + 's'
+    end
+
+    #
+    # Simply calls the timeline() class method.
+    #
+    def timeline
+
+      MilkResource.timeline
+    end
+
+    #
+    # Returns the current timeline (fetches one if none has yet
+    # been prepared).
+    #
+    def self.timeline
+
+      @timeline ||= Rufus::RTM.get_timeline
+    end
+
+    def queue_operation (method_name, args)
+
+      @operations << [ method_name, args ]
+    end
+  end
+
+  #
+  # The RTM Task class.
+  #
+  class Task < MilkResource
+
+    def self.task_attr (*att_names) #:nodoc:
+
+      att_names.each do |att_name|
+        class_eval %{
+          def #{att_name}
+            @hsh['task']['#{att_name}']
+          end
+        }
+      end
+    end
+
+    attr_reader \
+      :list_id,
+      :taskseries_id,
+      :task_id,
+      :tags
+
+    milk_attr \
+      :name,
+      :modified,
+      :participants,
+      :url,
+      :notes,
+      :location_id,
+      :created,
+      :source
+
+    task_attr \
+      :completed,
+      :added,
+      :postponed,
+      :priority,
+      :deleted,
+      :has_due_time,
+      :estimate,
+      :due
+
+    def initialize (list_id, h)
+
+      super(h)
+
+      t = h['task']
+
+      @list_id = list_id
+      @taskseries_id = h['id']
+      @task_id = t['id']
+
+      @tags = TagArray.new(self, h['tags'])
+    end
+
+    #
+    # Deletes the task.
+    #
+    def delete!
+
+      self.class.execute('delete', prepare_api_args)
+    end
+
+    #
+    # Marks the task as completed.
+    #
+    def complete!
+
+      self.class.execute('complete', prepare_api_args)
+    end
+
+    #
+    # Sets the tags for the task.
+    #
+    def tags= (tags)
+
+      tags = tags.split(',') if tags.is_a?(String)
+
+      @tags = TagArray.new(list_id, tags)
+
+      queue_operation('setTasks', tags.join(','))
+    end
+
+    def self.find (params={})
+
+      parse_tasks(execute('getList', params))
+    end
+
+    #
+    # Adds a new task (and returns it).
+    #
+    def self.add! (name, list_id=nil)
+
+      args = {}
+      args[:name] = name
+      args[:list_id] = list_id if list_id
+      args[:timeline] = Rufus::RTM.get_timeline
+
+      h = execute('add', args)
+
+      parse_tasks(h)[0]
+    end
+
+    protected
+
+    def prepare_api_args
+      {
+        :timeline => timeline,
+        :list_id => list_id,
+        :taskseries_id => taskseries_id,
+        :task_id => task_id
+      }
+    end
+
+    def self.parse_tasks (o)
+
+      o = if o.is_a?(Hash)
+
+        r = o[resource_name]
+        o = r if r
+        o['list']
+      end
+
+      o = [ o ] unless o.is_a?(Array)
+        # Nota bene : not the same thing as  o = Array(o)
+
+      o.inject([]) do |r, h|
+
+        list_id = h['id']
+        s = h['taskseries']
+        r += parse_taskseries(list_id, s) if s
+        r
+      end
+    end
+
+    def self.parse_taskseries (list_id, o)
+
+      o = [ o ] unless o.is_a?(Array)
+      o.collect { |s| self.new(list_id, s) }
+    end
+  end
+
+  class List < MilkResource
+
+    attr \
+      :list_id
+
+    milk_attr \
+      :name, :sort_order, :smart, :archived, :deleted, :position, :locked
+
+    def initialize (h)
+
+      super
+      @list_id = h['id']
+    end
+
+    def self.find (params={})
+
+      execute('getList', params)[resource_name]['list'].collect do |h|
+        self.new(h)
+      end
+    end
+  end
+
+  #
+  # An array of tasks.
+  #
+  class TagArray #:nodoc:
+    include Enumerable
+
+    def initialize (task, tags)
+
+      @task = task
+
+      @tags = if tags.is_a?(Array)
+        tags
+      else
+        tags['tag']
+      end
+    end
+
+    def << (tag)
+
+      @tags << tag
+
+      args = prepare_api_args
+      args[:tags] = tag
+
+      @task.queue_operation('addTags', args)
+    end
+
+    def delete (tag)
+
+      @tags.delete tag
+
+      args = prepare_api_args
+      args[:tags] = tag
+
+      @task.queue_operation('removeTags', args)
+    end
+
+    def clear
+
+      @tags.clear
+
+      args = prepare_api_args
+      args[:tags] = ''
+
+      @task.queue_operation('setTags', args)
+    end
+
+    def join (s)
+
+      @tags.join(s)
+    end
+
+    def each
+
+      @tags.each { |e| yield e }
+    end
+  end
+
+end
+

data/lib/rufus/rtm.rb

@@ -0,0 +1,29 @@
+#--
+# Copyright (c) 2008-2009, 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
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+require 'rufus/rtm/base'
+require 'rufus/rtm/credentials'
+require 'rufus/rtm/resources'
+

data/lib/rufus-rtm.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/rtm'
+

data/test/test.rb

@@ -0,0 +1,3 @@
+
+Dir["#{File.dirname(__FILE__)}/*_test.rb"].each { |path| load(path) }
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: maisonneuve-rtm
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Nicolas Maisonneuve
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-23 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: n.maisonneuve@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/rufus/rtm/base.rb
+- lib/rufus/rtm/credentials.rb
+- lib/rufus/rtm/resources.rb
+- lib/rufus/rtm.rb
+- lib/rufus-rtm.rb
+- README.txt
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Fork from Rufus RTM gem
+test_files: 
+- test/test.rb