toodledo 1.3.1 → 1.3.2

data/History.txt

@@ -1,6 +1,12 @@
-== 1.3.1 / 2008-06-07
+== 1.3.2 / 2010-02-16
 
-* Left file out of the manifest...
+* Added file caching for token (will write to $HOME/.toodledo/tokens/<user_id> file)
+* Added patch for the app_id (thx to Greg Miller)
+* Added serveroffset to get_server_info call.
+
+== 1.3.1 / ?
+
+* Fix some bugs.
 
 == 1.3.0 / 2008-05-31
 

data/Manifest.txt

@@ -18,8 +18,8 @@ lib/toodledo/command_line/interactive_command.rb
 lib/toodledo/command_line/list_contexts_command.rb
 lib/toodledo/command_line/list_folders_command.rb
 lib/toodledo/command_line/list_goals_command.rb
-lib/toodledo/command_line/list_tasks_command.rb
 lib/toodledo/command_line/list_tasks_by_context_command.rb
+lib/toodledo/command_line/list_tasks_command.rb
 lib/toodledo/command_line/parser_helper.rb
 lib/toodledo/command_line/setup_command.rb
 lib/toodledo/command_line/stdin_command.rb

data/Rakefile

@@ -5,17 +5,20 @@ require 'hoe'
 $:.unshift(File.dirname(__FILE__) + "/lib")
 require 'toodledo'
 
-Hoe.new('toodledo', Toodledo::VERSION) do |p|
+Hoe.spec('toodledo') do |p|
   p.rubyforge_name = 'toodledo'
+  p.version = Toodledo::VERSION
   p.author = 'Will Sargent'
   p.email = 'will@tersesystems.com'
   p.summary = 'A command line client and API to Toodledo'
   p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
-  p.url = 'http://rubyforge.org/projects/toodledo'
+  p.url = "http://gemcutter.org/gems/toodledo"
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.rsync_args << ' --exclude=statsvn/'
   p.test_globs = ["test/**/*_test.rb"]
-  p.extra_deps = ['cmdparse', 'highline']
+  p.extra_deps << ['cmdparse', '>= 0']
+  p.extra_deps << ['highline', '>= 0']
+  p.extra_dev_deps << [ 'flexmock', '>= 0']
 end
 
 # vim: syntax=Ruby

data/lib/toodledo.rb

@@ -5,7 +5,7 @@
 module Toodledo
 
   # Required for gem  
-  VERSION = '1.3.1'
+  VERSION = '1.3.2'
   
   # Returns the configuration object.
   def self.get_config()
@@ -49,8 +49,9 @@ module Toodledo
     base_url = connection['url']
     user_id = connection['user_id']
     password = connection['password']
-    
-    session = Session.new(user_id, password, logger)
+    app_id = connection['app_id'] || 'ruby_app'
+
+    session = Session.new(user_id, password, logger, app_id)
 
     base_url = Session::DEFAULT_API_URL if (base_url == nil)
     session.connect(base_url, proxy)

data/lib/toodledo/session.rb

@@ -7,6 +7,7 @@ require 'net/https'
 require 'openssl/ssl'
 require 'rexml/document'
 require 'logger'
+require 'fileutils'
 
 module Toodledo
   
@@ -25,8 +26,9 @@ module Toodledo
       'Connection' => 'keep-alive',
       'Keep-Alive' => '300'
     }
-    
-    EXPIRATION_TIME_IN_SECS = 60 * 60
+
+    # The key should be good for four hours.
+    EXPIRATION_TIME_IN_SECS = 60 * 60 * 4
     
     DATE_FORMAT = '%Y-%m-%d'
     
@@ -34,18 +36,19 @@ module Toodledo
     
     TIME_FORMAT = '%I:%M %p'
     
-    attr_accessor :logger 
-      
-    attr_reader :base_url, :user_id, :proxy
+    attr_accessor :logger
+    
+    attr_reader :base_url, :user_id, :proxy, :app_id
 
     # Creates a new session, using the given user name and password.
     # throws InvalidConfigurationError if user_id or password are nil.
-    def initialize(user_id, password, logger = nil)
+    def initialize(user_id, password, logger = nil, app_id = nil)
       raise InvalidConfigurationError.new("Nil user_id") if (user_id == nil)
       raise InvalidConfigurationError.new("Nil password") if (password == nil)
     
       @user_id = user_id
       @password = password
+      @app_id = app_id
       
       @folders = nil
       @contexts = nil
@@ -87,7 +90,7 @@ module Toodledo
       # Get the proxy information if it exists.
       @proxy = proxy
       
-      session_token = get_token(@user_id)
+      session_token = get_token(@user_id, @app_id)
       key = md5(md5(@password).to_s + session_token + @user_id);
       
       @key = key
@@ -105,12 +108,13 @@ module Toodledo
 
     # Returns true if the session has expired.
     def expired?
+      return false
       #logger.debug("expired?") too annoying
       
       # The key is only good for an hour.  If it's been over an hour, 
       # then we count it as expired.
-      return true if (@start_time == nil)
-      return (Time.now - @start_time > EXPIRATION_TIME_IN_SECS)
+      #return true if (@start_time == nil)
+      #return (Time.now - @start_time > EXPIRATION_TIME_IN_SECS)
     end
 
     # Returns a parsable URI object from the base API URL and the parameters.
@@ -221,11 +225,80 @@ module Toodledo
     end
 
     # Gets the token method, given the id.
-    def get_token(user_id)
+    def get_token(user_id, app_id)
       raise "Nil user_id" if (user_id == nil || user_id.empty?)
 
+      # If there is no token file, or the token file is out of date, pull in
+      # a fresh token from the server and write it to the file system.
+      token = read_token(user_id)
+      unless token
+        token = get_uncached_token(user_id, app_id)
+        write_token(user_id, token)
+      end
+
+      return token
+    end
+
+    # Reads a token from the file system, if the given user_id exists and the
+    # token is not too old.
+    def read_token(user_id)
+      token_path = get_token_file(user_id)
+      unless token_path
+        logger.debug("read_token: no token found for #{user_id.inspect}, returning nil")
+        return nil
+      end
+
+      if is_too_old(token_path)
+        File.delete(token_path)
+        return nil
+      end
+
+      token = File.read(token_path)
+      token
+    end
+
+    # Returns true if the file is more than an hour old, false otherwise.
+    def is_too_old(token_path)
+      last_modified_time = File.new(token_path).mtime
+      expiration_time = Time.now - EXPIRATION_TIME_IN_SECS
+      too_old = expiration_time - last_modified_time > 0
+
+      logger.debug "is_too_old: time = #{last_modified_time}, expires = #{expiration_time}, too_old = #{too_old}"
+      
+      return too_old
+    end
+
+    # Gets there full path of the token file.
+    def get_token_file(user_id)
+      tokens_dir = get_tokens_directory()
+      token_path = File.expand_path(File.join(tokens_dir, user_id))
+      unless File.exist?(token_path)
+        return nil
+      end
+      token_path
+    end
+
+    # Make sure that there is a ".toodledo/tokens" directory.
+    def get_tokens_directory()
+      toodledo_dir = "~/.toodledo"
+      tokens_path = File.expand_path(File.join(toodledo_dir, "tokens"))
+      FileUtils.mkdir_p tokens_path
+      tokens_path
+    end
+
+    # Writes the token file to the filesystem.
+    def write_token(user_id, token)
+      logger.debug("write_token: user_id = #{user_id.inspect}, token = #{token.inspect}")
+      token_path = File.expand_path(File.join(get_tokens_directory(), user_id))
+      File.open(token_path, 'w') {|f| f.write(token) }
+    end
+
+    # Calls the server to get a token.
+    def get_uncached_token(user_id, app_id)
       params = { :userid => user_id }
-      result = call('getToken', params)    
+      params.merge!({:appid => app_id}) unless app_id.nil?
+      result = call('getToken', params)
+
       return result.text
     end
 
@@ -314,11 +387,13 @@ module Toodledo
       
       unixtime = result.elements['unixtime'].text.to_i
       server_date = Time.at(unixtime)
-      token_expires = result.elements['tokenexpires'].text.to_i
+      server_offset = result.elements['serveroffset'].text.to_i
+      token_expires = result.elements['tokenexpires'].text.to_f
       hash = {
         :unixtime => unixtime,
         :date => server_date,
-        :tokenexpires => token_expires
+        :tokenexpires => token_expires,
+        :serveroffset => server_offset,
       }
       
       return hash
@@ -574,6 +649,9 @@ module Toodledo
       # Handle completion.
       handle_boolean(myhash, params, :completed)
 
+      # Handle star
+      handle_boolean(myhash, params, :star)
+
       # repeat: use the map to change from the symbol to the raw numeric value.
       handle_repeat(myhash, params)
 

data/test/session_test.rb

@@ -24,6 +24,14 @@ class SessionTest < Test::Unit::TestCase
   def teardown
     @session.disconnect()
   end
+  
+  def test_handle_app_id_in_session
+    new_sess = Toodledo::Session.new('userid', 'password', nil, 'appid')
+    flexmock(new_sess, :get_token => 'token')
+    new_sess.connect()
+    assert_not_nil new_sess.app_id
+  end
+
 
   def test_handle_goal_with_name()
     params = { :goal => 'goal_name' }

data/test/toodledo_functional_test.rb

@@ -18,14 +18,15 @@ class ToodledoFunctionalTest < Test::Unit::TestCase
     @email = 'will.sargent+toodledo_ruby_api@gmail.com'
     @user_id = 'td479be708d8bd7'
     @password = 'toodledo'
+    @app_id = 'ruby-functional-test'
     
     # proxy = { 'host' => '127.0.0.1', 'port' => '8080'}
     proxy = nil
     
     logger = Logger.new(STDOUT)
     logger.level = Logger::DEBUG
-    
-    @session = Session.new(@user_id, @password, logger)
+
+    @session = Session.new(@user_id, @password, logger, @app_id)
     @session.connect(base_url, proxy)
   end
   
@@ -149,14 +150,14 @@ class ToodledoFunctionalTest < Test::Unit::TestCase
     assert info_hash[:alias] == 'will.sargent+toodledo_rub'
     assert info_hash[:pro] == false
     assert info_hash[:dateformat] == 0
-    assert info_hash[:timezone] == 0
+    assert info_hash[:timezone] == -2
     assert info_hash[:hidemonths] == 6
     assert info_hash[:hotlistpriority] == 3
     assert info_hash[:hotlistduedate] == 14   
     
     # Doesn't seem to work.
-    # assert info_hash[:lastaddedit] != nil
-    assert info_hash[:lastdelete] != nil
+    #assert info_hash[:lastaddedit] != nil
+    #assert info_hash[:lastdelete] == nil
   end
   
   def test_get_deleted()

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: toodledo
 version: !ruby/object:Gem::Version 
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors: 
 - Will Sargent
@@ -9,11 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-07 00:00:00 -07:00
+date: 2010-02-16 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cmdparse
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -23,6 +24,17 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -32,14 +44,28 @@ dependencies:
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.3
+        version: 2.4.0
     version: 
-description: "== DESCRIPTION:  This is a Ruby API and client for http://toodledo.com, a task management  website. It implements all of the calls from Toodledo's developer API, and  provides a nice wrapper around the functionality.  The client allows you to work with Toodledo from the command line. It will work in either interactive or command line mode.  You can also use the client in your shell scripts, or use the API directly as part of a web application.  Custom private RSS feed?  Want to have the Mac  read out your top priority?  Input tasks through Quicksilver?  Print out tasks with a BetaBrite?  It can all happen."
+description: |-
+  == DESCRIPTION:
+  
+  This is a Ruby API and client for http://toodledo.com, a task management 
+  website. It implements all of the calls from Toodledo's developer API, and 
+  provides a nice wrapper around the functionality.
+  
+  The client allows you to work with Toodledo from the command line. It will
+  work in either interactive or command line mode.
+  
+  You can also use the client in your shell scripts, or use the API directly
+  as part of a web application.  Custom private RSS feed?  Want to have the Mac 
+  read out your top priority?  Input tasks through Quicksilver?  Print out
+  tasks with a BetaBrite?  It can all happen.
 email: will@tersesystems.com
 executables: 
 - toodledo
@@ -70,8 +96,8 @@ files:
 - lib/toodledo/command_line/list_contexts_command.rb
 - lib/toodledo/command_line/list_folders_command.rb
 - lib/toodledo/command_line/list_goals_command.rb
-- lib/toodledo/command_line/list_tasks_command.rb
 - lib/toodledo/command_line/list_tasks_by_context_command.rb
+- lib/toodledo/command_line/list_tasks_command.rb
 - lib/toodledo/command_line/parser_helper.rb
 - lib/toodledo/command_line/setup_command.rb
 - lib/toodledo/command_line/stdin_command.rb
@@ -92,7 +118,9 @@ files:
 - test/session_test.rb
 - test/toodledo_functional_test.rb
 has_rdoc: true
-homepage: http://rubyforge.org/projects/toodledo
+homepage: http://gemcutter.org/gems/toodledo
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -114,9 +142,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: toodledo
-rubygems_version: 1.1.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A command line client and API to Toodledo
 test_files: 
 - test/client_test.rb