Class: Toodledo::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/toodledo/session.rb

Overview

The Session. This is responsible for calling to the server and handling most functionality.

Constant Summary collapse

INVALID_ID_MESSAGE = 
'Invalid ID number'
INVALID_KEY_MESSAGE = 
'key did not validate'
NO_KEY_SPECIFIED_MESSAGE = 
'No Key Specified'
EXCESSIVE_TOKEN_MESSAGE = 
'Excessive API token requests over the last 1 hour.  This user is temporarily blocked.'
DEFAULT_API_URL = 
'http://www.toodledo.com/api.php'
USER_AGENT = 
"Ruby/#{Toodledo::VERSION} (#{RUBY_PLATFORM})"
HEADERS = 
{
  'User-Agent' => USER_AGENT,
  'Connection' => 'keep-alive',
  'Keep-Alive' => '300'
}
FILE_EXPIRATION_TIME_IN_SECS =

Make file expiration be 4 hours.

(60 * 60 * 4)
DATE_FORMAT = 
'%Y-%m-%d'
DATETIME_FORMAT = 
'%Y-%m-%d %H:%M:%S'
TIME_FORMAT = 
'%I:%M %p'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(user_id, password, logger = nil, app_id = nil) ⇒ Session

Creates a new session, using the given user name and password. throws InvalidConfigurationError if user_id or password are nil.

Raises:



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/toodledo/session.rb', line 50

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
  @goals = nil
  @key = nil
  @folders_by_id = nil
  @goals_by_id = nil
  @contexts_by_id = nil
  @expiration_time = nil
  
  @logger = logger
end

Instance Attribute Details

#app_id ⇒ Object (readonly)

Returns the value of attribute app_id.



46
47
48
 
# File 'lib/toodledo/session.rb', line 46

def app_id
  @app_id
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url.



46
47
48
 
# File 'lib/toodledo/session.rb', line 46

def base_url
  @base_url
end

#logger ⇒ Object

Returns the value of attribute logger.



44
45
46
 
# File 'lib/toodledo/session.rb', line 44

def logger
  @logger
end

#proxy ⇒ Object (readonly)

Returns the value of attribute proxy.



46
47
48
 
# File 'lib/toodledo/session.rb', line 46

def proxy
  @proxy
end

#user_id ⇒ Object (readonly)

Returns the value of attribute user_id.



46
47
48
 
# File 'lib/toodledo/session.rb', line 46

def user_id
  @user_id
end

Instance Method Details

#add_context(title) ⇒ Object

Adds the context to Toodledo, with the title.



811
812
813
814
815
816
817
818
819
820
 
# File 'lib/toodledo/session.rb', line 811

def add_context(title)
  logger.debug("add_context(#{title})") if logger
  raise "Nil title" if (title == nil)
  
  result = call('addContext', { :title => title }, @key)
  
  flush_contexts()
  
  return result.text
end

#add_folder(title, is_private = 1) ⇒ Object

Adds a folder.

  • title : A text string up to 32 characters.

  • private : A boolean value that describes if this folder can be shared.

Returns the id of the newly added folder.



1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/toodledo/session.rb', line 1015

def add_folder(title, is_private = 1)
  logger.debug("add_folder(#{title}, #{is_private})") if logger
  raise "Nil title" if (title == nil)
  
  if (is_private.kind_of? TrueClass)
    is_private = 1
  elsif (is_private.kind_of? FalseClass)
    is_private = 0
  end
  
  myhash = { :title => title, :private => is_private}
  
  result = call('addFolder', myhash, @key)
  
  flush_folders()
  
  return result.text
end

#add_goal(title, level = 0, contributes = 0) ⇒ Object

Adds a new goal with the given title, the level (short to long term) and the contributing goal id.



914
915
916
917
918
919
920
921
922
923
924
 
# File 'lib/toodledo/session.rb', line 914

def add_goal(title, level = 0, contributes = 0)
  logger.debug("add_goal(#{title}, #{level}, #{contributes})") if logger
  raise "Nil title" if (title == nil)

  params = { :title => title, :level => level, :contributes => contributes }
  result = call('addGoal', params, @key)
  
  flush_goals()

  return result.text
end

#add_task(title, params = {}) ⇒ Object

Adds a task to Toodledo.

Required Parameters:

title: a String.  This is the only required property.

Optional Parameters:

tag: a String
folder: folder id or String matching the folder name
context: context id or String matching the context name
goal: goal id or String matching the Goal Name
duedate: Time or String object "YYYY-MM-DD".  If this is a string, it 
may take an optional modifier.
duetime: Time or String object "MM:SS p"}    
parent: parent id }
repeat: one of { :none, :weekly, :monthly :yearly :daily :biweekly, 
      :bimonthly, :semiannually, :quarterly }
length: a Number, number of minutes
priority: one of { :negative, :low, :medium, :high, :top }
tag: an Array of strings

Returns: the id of the added task as a String.



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/toodledo/session.rb', line 607

def add_task(title, params={})
  logger.debug("add_task(#{title}, #{params.inspect})") if logger
  raise "Nil id" if (title == nil)

  myhash = {:title => title}      
  
  handle_string(myhash, params, :tag)

  # If the folder is a string, then we assume we're supposed to find out what
  # the id is.
  handle_folder(myhash, params)

  # Context handling
  handle_context(myhash, params)

  # Goal handling
  handle_goal(myhash, params)
  
  # Add the start date if it's been added.
  handle_date(myhash, params, :startdate)

  # duedate handling.  Take either a string or a Time object.'YYYY-MM-DD'
  handle_date(myhash, params, :duedate)

  # duetime handling.  Take either a string or a Time object. 
  handle_time(myhash, params, :duetime)

  # parent handling.
  handle_parent(myhash, params)

  # repeat: use the map to change from the symbol to the raw numeric value.
  handle_repeat(myhash, params)
   
  # priority use the map to change from the symbol to the raw numeric value.
  handle_priority(myhash, params)
  
  handle_tag(myhash, params)
  
  # Handle the star.
  handle_boolean(myhash, params, :star)

  # Handle the status date.
  handle_status(myhash, params)
  
  # Handle the note.
  handle_string(myhash, params, :note)

  result = call('addTask', myhash, @key)
    
  return result.text
end

#call(method, params, key = nil) ⇒ Object

Calls Toodledo with the method name, the parameters and the session key. Returns the text inside the document root, if any.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/toodledo/session.rb', line 169

def call(method, params, key = nil)  
  raise 'Nil method' if (method == nil)
  raise 'Nil params' if (params == nil)
  raise 'Wrong type of params' if (! params.kind_of? Hash)
  raise 'Wrong method type' if (! method.kind_of? String)

  if (@base_url == nil)
    raise 'Must call connect() before this method'        
  end

  # If it's been more than an hour, then ask for a new key.
  if (@key && expired? && method != "getServerInfo")
    logger.info("call(#{method}) connection expired, reconnecting...") if logger

    # Save the connection information (we'll need it)
    base_url = @base_url
    proxy = @proxy
    reconnect(base_url, proxy)
    
    # swap out the key (if any) before we start assembling the request
    if (key)
      key = @key
    end
  end

  # Break all the parameters down into key=value seperated by semi colons
  stringified_params = (key != nil) ? ';key=' + key : ''

  params.each { |k, v| 
    stringified_params += ';' + k.to_s + '=' + escape_text(v) 
  }
  url = make_uri(method, stringified_params)

  # Establish the proxy
  if (@proxy != nil)
    logger.debug("call(#{method}) establishing proxy...") if logger
    
    proxy_host = @proxy['host']
    proxy_port = @proxy['port']
    proxy_user = @proxy['user']
    proxy_password = @proxy['password']
    
    if (proxy_user == nil || proxy_password == nil)
      http = Net::HTTP::Proxy(proxy_host, proxy_port).new(url.host, url.port)
    else 
      http = Net::HTTP::Proxy(proxy_host, proxy_port, proxy_user, proxy_password).new(url.host, url.port)
    end        
  else 
    http = Net::HTTP.new(url.host, url.port)
  end       
  
  if (url.scheme == 'https')        
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
    http.use_ssl = true
  end
        
  if logger
    logger.debug("call(#{method}) request: #{url.path}?#{url.query}#{url.fragment}")
  end
  start_time = Time.now
  
  # make the call
  response = http.request_get(url.request_uri, HEADERS)
  unless response
    raise Toodledo::ServerError.new("No HTTP response found from request #{url.path}");
  end
  body = response.body

  # body = url.read
  end_time = Time.now
  doc = REXML::Document.new body

  if logger
    logger.debug("call(#{method}) response: " + doc.to_s)
    logger.debug("call(#{method}) time: " + (end_time - start_time).to_s + ' seconds')
  end

  root_node = doc.root
  retry_error = nil
  if (root_node.name == 'error')
    error_text = root_node.text        
    case error_text
    when INVALID_ID_MESSAGE then
      raise Toodledo::ItemNotFoundError.new(error_text)
    when INVALID_KEY_MESSAGE then
      disconnect()
      raise Toodledo::InvalidKeyError.new(error_text)    
    when NO_KEY_SPECIFIED_MESSAGE then
      disconnect()
      raise Toodledo::NoKeySpecifiedError.new(error_text)              
    when EXCESSIVE_TOKEN_MESSAGE
      disconnect()
      raise Toodledo::ExcessiveTokenRequestsError.new(error_text)
    else
      raise Toodledo::ServerError.new(error_text)
    end
  end
  
  return root_node
end

#connect(base_url = DEFAULT_API_URL, proxy = nil) ⇒ Object

Connects to the server, asking for a new key that’s good for four hours. Optionally takes a base URL as a parameter. Defaults to DEFAULT_API_URL.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/toodledo/session.rb', line 77

def connect(base_url = DEFAULT_API_URL, proxy = nil)
  logger.debug("connect(#{base_url}, #{proxy.inspect})") if logger

  # XXX It looks like get_user_id doesn't work reliably.  It always
  # returns 1 even when we pass in a valid email and password.
  # @user_id = get_user_id(@email, @password)
  # logger.debug("user_id = #{@user_id}, #{@email} #{@password}")

  if (@user_id == '1')
    raise InvalidConfigurationError.new("Invalid user_id")
  end
  
  if (@user_id == '0')
    raise InvalidConfigurationError.new("Invalid password")
  end
  
  # Set the base URL.
  @base_url = base_url
  
  # Get the proxy information if it exists.
  @proxy = proxy
  
  session_token = get_token(@user_id, @app_id)
  key = md5(md5(@password).to_s + session_token + @user_id);
  
  @key = key
  @start_time = Time.now 
  
  server_info = get_server_info()
  @expiration_time = find_expiration_time(server_info[:tokenexpires])      
end

#delete_context(id) ⇒ Object

Deletes the context from Toodledo, using the id.



825
826
827
828
829
830
831
832
833
834
 
# File 'lib/toodledo/session.rb', line 825

def delete_context(id)
  logger.debug("delete_context(#{id})") if logger
  raise "Nil id" if (id == nil)
  
  result = call('deleteContext', { :id => id }, @key)
  
  flush_contexts();
  
  return (result.text == '1')
end

#delete_folder(id) ⇒ Object

Deletes the folder with the id. id : The folder id.

Returns true if the delete was successful.



1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
 
# File 'lib/toodledo/session.rb', line 1076

def delete_folder(id)
  logger.debug("delete_folder(#{id})") if logger
  raise "Nil id" if (id == nil)
  
  result = call('deleteFolder', { :id => id }, @key)
  
  flush_folders()
  
  return (result.text == '1')
end

#delete_goal(id) ⇒ Object

Delete the goal with the given id.



929
930
931
932
933
934
935
936
937
938
 
# File 'lib/toodledo/session.rb', line 929

def delete_goal(id)
  logger.debug("delete_goal(#{id})") if logger
  raise "Nil id" if (id == nil)
  
  result = call('deleteGoal', { :id => id }, @key)
  
  flush_goals()
  
  return (result.text == '1')
end

#delete_task(id) ⇒ Object

Deletes the task, using the task id.



725
726
727
728
729
730
731
732
 
# File 'lib/toodledo/session.rb', line 725

def delete_task(id)
  logger.debug("delete_task(#{id})") if logger
  raise "Nil id" if (id == nil)

  result = call('deleteTask', { :id => id }, @key)

  return (result.text == '1')    
end

#disconnect ⇒ Object

Disconnects from the server.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/toodledo/session.rb', line 110

def disconnect()
  logger.debug("disconnect()") if logger
  
  if expired?
    token_path = get_token_file(user_id)
    if token_path
      logger.debug("deleting token path(#{token_path})") if logger
      File.delete(token_path)
    end
  end
  
  @key = nil
  @start_time = nil
  @expiration_time = nil
  @base_url = nil
  @proxy = nil
end

#edit_folder(id, params = {}) ⇒ Object

Edits a folder.

  • id : The id number of the folder to edit.

  • title : A text string up to 32 characters.

  • private : A boolean value (0 or 1) that describes if this folder can be shared. A value of 1 means that this folder is private.

  • archived : A boolean value (0 or 1) that describes if this folder is archived.

Returns true if the edit was successful.



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/toodledo/session.rb', line 1053

def edit_folder(id, params = {})
  logger.debug("edit_folder(#{id}, #{params.inspect})") if logger
  raise "Nil id" if (id == nil)
  
  myhash = { :id => id }
  
  handle_string(myhash, params, :title)
  
  handle_boolean(myhash, params, :private)
  
  handle_boolean(myhash, params, :archived)
  
  result = call('editFolder', myhash, @key)
  
  flush_folders()
  
  return (result.text == '1')
end

#edit_task(id, params = {}) ⇒ Object

  • id : The id number of the task to edit.

  • title : A text string up to 255 characters representing the name of the task.

  • folder : The id number of the folder.

  • context : The id number of the context.

  • goal : The id number of the goal.

  • completed : true or false.

  • duedate : A date formatted as YYYY-MM-DD with an optional modifier attached to the front. Examples: “2007-01-23” , “=2007-01-23” , “>2007-01-23”. To unset the date, set it to ‘0000-00-00’.

  • duetime : A date formated as HH:MM MM.

  • repeat : Use the REPEAT_MAP with the relevant symbol here.

  • length : An integer representing the number of minutes that the task will take to complete.

  • priority : Use the PRIORITY_MAP with the relevant symbol here.

  • note : A text string.

  • tag: An Array of Strings (tags)



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
 
# File 'lib/toodledo/session.rb', line 674

def edit_task(id, params = {})
  logger.debug("edit_task(#{id}, #{params.inspect})") if logger
  raise "Nil id" if (id == nil)
  
  myhash = { :id => id }
  
  handle_string(myhash, params, :tag)

  # If the folder is a string, then we assume we're supposed to find out what
  # the id is.
  handle_folder(myhash, params)

  # Context handling
  handle_context(myhash, params)

  # Goal handling
  handle_goal(myhash, params)

  # duedate handling.  Take either a string or a Time object.'YYYY-MM-DD'
  handle_date(myhash, params, :duedate)

  # duetime handling.  Take either a string or a Time object. 
  handle_time(myhash, params, :duetime)

  # parent handling.
  handle_parent(myhash, params)
  
  # 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)

  # priority use the map to change from the symbol to the raw numeric value.
  handle_priority(myhash, params)
  
  handle_tag(myhash, params)
  
  handle_string(myhash, params, :note)

  result = call('editTask', myhash, @key)

  return (result.text == '1')
end

#escape_text(input) ⇒ Object

escape the & character as %26 and the ; character as %3B. throws an exception if input is nil.



153
154
155
156
157
158
159
160
 
# File 'lib/toodledo/session.rb', line 153

def escape_text(input)
  raise "Nil input" if (input == nil)
  return input.to_s if (! input.kind_of? String)
  
  output_string = input.gsub('&', '%26')
  output_string = output_string.gsub(';', '%3B')
  return output_string
end

#expired? ⇒ Boolean

Returns true if the session has expired.

Returns:

  • (Boolean) 


135
136
137
138
139
140
141
142
143
 
# File 'lib/toodledo/session.rb', line 135

def expired?
  logger.debug("Expiration time #{@expiration_time} ") if logger
  current_time = Time.now
  has_expired = (@expiration_time != nil) && (current_time > @expiration_time)
  if (has_expired) 
    logger.debug("Expiration time #{@expiration_time} > current time #{current_time}, expired == true") if logger
  end
  has_expired
end

#find_expiration_time(expiration_in_mins) ⇒ Object 



128
129
130
131
132
 
# File 'lib/toodledo/session.rb', line 128

def find_expiration_time(expiration_in_mins) 
  # Expiration time is measured in minutes, i.e. 49.4
  exp_mins = expiration_in_mins.to_i # drop the fractional bit
  @start_time + (exp_mins * 60)
end

#flush_contexts ⇒ Object

Deletes the cached contexts.



839
840
841
842
843
844
845
 
# File 'lib/toodledo/session.rb', line 839

def flush_contexts()
  logger.debug('flush_contexts()') if logger

  @contexts_by_id = nil
  @contexts_by_name = nil
  @contexts = nil
end

#flush_folders ⇒ Object

Nils out the cached folders.



1037
1038
1039
1040
1041
1042
1043
 
# File 'lib/toodledo/session.rb', line 1037

def flush_folders()      
  logger.debug("flush_folders()") if logger
  
  @folders = nil
  @folders_by_name = nil
  @folders_by_id = nil      
end

#flush_goals ⇒ Object

Nils the cached goals.



943
944
945
946
947
948
949
 
# File 'lib/toodledo/session.rb', line 943

def flush_goals()
  logger.debug('flush_goals()') if logger
  
  @goals = nil
  @goals_by_name = nil
  @goals_by_id = nil
end

#get_account_info ⇒ Object

Returns the information associated with this account.

pro : Whether or not the user is a Pro member. You need to know this if you want to use subtasks.
dateformat : The user's prefered format for representing dates. (0=M D, Y, 1=M/D/Y, 2=D/M/Y, 3=Y-M-D)
timezone : The number of half hours that the user's timezone is offset from the server's timezone. A value of -4 means that the user's timezone is 2 hours earlier than the server's timezone.
hidemonths : If the task is due this many months into the future, the user wants them to be hidden.
hotlistpriority : The priority value above which tasks should appear on the hotlist.
hotlistduedate : The due date lead-time by which tasks should will appear on the hotlist.
lastaddedit: last time this was edited 
lastdelete:



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/toodledo/session.rb', line 375

def ()
  result = call('getAccountInfo', {}, @key)
  
  pro = (result.elements['pro'].text.to_i == 1) ? true : false
  
  #<lastaddedit>2008-01-24 12:26:45</lastaddedit>
  #<lastdelete>2008-01-23 15:45:55</lastdelete>
  fmt = DATETIME_FORMAT
  
  lastaddedit = result.elements['lastaddedit'].text
  if (lastaddedit != nil)
    last_modified_date = DateTime.strptime(lastaddedit, fmt)
  else
    last_modified_date = nil
  end
  
  lastdelete = result.elements['lastdelete'].text      
  if (lastdelete != nil)
    logger.debug("lastdelete = #{lastdelete}") if logger
    last_deleted_date = DateTime.strptime(lastdelete, fmt)
  else
    last_deleted_date = nil
  end
  
  hash = {
    :userid => result.elements['userid'].text,
    :alias => result.elements['alias'].text,
    :pro => pro,
    :dateformat => result.elements['dateformat'].text.to_i,
    :timezone => result.elements['timezone'].text.to_i,
    :hidemonths => result.elements['hidemonths'].text.to_i,
    :hotlistpriority => result.elements['hotlistpriority'].text.to_i,
    :hotlistduedate => result.elements['hotlistduedate'].text.to_i,
    :lastaddedit => last_modified_date,
    :lastdelete => last_deleted_date
  }
  
  return hash
end

#get_context_by_id(context_id) ⇒ Object

Returns the context with the given id.



773
774
775
776
777
778
779
780
781
782
 
# File 'lib/toodledo/session.rb', line 773

def get_context_by_id(context_id)
  logger.debug("get_context_by_id(#{context_id})") if logger

  if (@contexts_by_id == nil)
    get_contexts(true)  
  end

  context = @contexts_by_id[context_id]
  return context      
end

#get_context_by_name(context_name) ⇒ Object

Returns the context with the given name.



759
760
761
762
763
764
765
766
767
768
 
# File 'lib/toodledo/session.rb', line 759

def get_context_by_name(context_name)
  logger.debug("get_context_by_name(#{context_name})") if logger
  
  if (@contexts_by_name == nil)
    get_contexts(true)  
  end

  context = @contexts_by_name[context_name.downcase]
  return context
end

#get_contexts(flush = false) ⇒ Object

Gets the array of contexts.



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/toodledo/session.rb', line 787

def get_contexts(flush = false)
  logger.debug("get_contexts(#{flush})") if logger
  return @contexts unless (flush || @contexts == nil)
  
  result = call('getContexts', {}, @key)
  contexts_by_name = {} 
  contexts_by_id = {}    
  contexts = []
  
  result.elements.each { |el|
    context = Context.parse(self, el)
    contexts << context
    contexts_by_id[context.server_id] = context
    contexts_by_name[context.name.downcase] = context
  }
  @contexts_by_id = contexts_by_id
  @contexts_by_name = contexts_by_name
  @contexts = contexts
  return contexts
end

#get_deleted(after) ⇒ Object

Returns deleted tasks.

after: a datetime object that indicates the start date after which deletes should be shown.



739
740
741
742
743
744
745
746
747
748
749
750
 
# File 'lib/toodledo/session.rb', line 739

def get_deleted(after )
  logger.debug("get_deleted(#{after})") if logger
  
  formatted_after = after.strftime(Session::DATETIME_FORMAT)
  result = call('getDeleted', { :after => formatted_after }, @key)
  deleted_tasks = []
  result.elements.each do |el| 
    deleted_task = Task.parse_deleted(self, el)
    deleted_tasks << deleted_task
  end
  return deleted_tasks
end

#get_folder_by_id(folder_id) ⇒ Object

Gets the folder with the given id.



971
972
973
974
975
976
977
978
979
980
 
# File 'lib/toodledo/session.rb', line 971

def get_folder_by_id(folder_id)
  logger.debug("get_folder_by_id(#{folder_id})") if logger
  raise "Nil folder_id" if (folder_id == nil)
  
  if (@folders_by_id == nil)
    get_folders(true)
  end

  return @folders_by_id[folder_id]
end

#get_folder_by_name(folder_name) ⇒ Object

Gets the folder by the name. Case insensitive.



957
958
959
960
961
962
963
964
965
966
 
# File 'lib/toodledo/session.rb', line 957

def get_folder_by_name(folder_name)
  logger.debug("get_folders_by_name(#{folder_name})") if logger
  raise "Nil folder name" if (folder_name == nil)
  
  if (@folders_by_name == nil)
    get_folders(true)
  end

  return @folders_by_name[folder_name.downcase]
end

#get_folders(flush = false) ⇒ Object

Gets all the folders.



983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/toodledo/session.rb', line 983

def get_folders(flush = false)
  logger.debug("get_folders(#{flush})") if logger
  return @folders unless (flush || @folders == nil)

  result = call('getFolders', {}, @key)      
  # <folders>
  #   <folder id="123" private="0" archived="0">Shopping</folder>
  #   <folder id="456" private="0" archived="0">Home Repairs</folder>
  #   <folder id="789" private="0" archived="0">Vacation Planning</folder>
  #   <folder id="234" private="0" archived="0">Chores</folder>
  #   <folder id="567" private="1" archived="0">Work</folder>
  # </folders>
  folders = []
  folders_by_name = {}
  folders_by_id = {}
  result.elements.each { |el| 
      folder = Folder.parse(self, el)
      folders.push(folder)
      folders_by_name[folder.name.downcase] = folder # lowercase the key search
      folders_by_id[folder.server_id] = folder
  }
  @folders = folders
  @folders_by_name = folders_by_name
  @folders_by_id = folders_by_id
  return @folders
end

#get_goal_by_id(goal_id) ⇒ Object

Returns the goal with the given id.



867
868
869
870
871
872
873
874
875
 
# File 'lib/toodledo/session.rb', line 867

def get_goal_by_id(goal_id)
  logger.debug("get_goal_by_id(#{goal_id})") if logger
  if (@goals_by_id == nil)
    get_goals(true)
  end

  goal = @goals_by_id[goal_id]
  return goal
end

#get_goal_by_name(goal_name) ⇒ Object

Returns the goal with the given name. Case insensitive.



854
855
856
857
858
859
860
861
862
 
# File 'lib/toodledo/session.rb', line 854

def get_goal_by_name(goal_name)
  logger.debug("get_goal_by_name(#{goal_name})") if logger
  if (@goals_by_name == nil)
    get_goals(true)
  end

  goal = @goals_by_name[goal_name.downcase]
  return goal
end

#get_goals(flush = false) ⇒ Object

Returns the array of goals.



880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
 
# File 'lib/toodledo/session.rb', line 880

def get_goals(flush = false)
  logger.debug("get_goals(#{flush})") if logger
  return @goals unless (flush || @goals == nil)
 
  result = call('getGoals', {}, @key)
   
  goals_by_name = {}
  goals_by_id = {}
  goals = []
  result.elements.each do |el|        
     goal = Goal.parse(self, el)
     goals << goal
     goals_by_id[goal.server_id] = goal
     goals_by_name[goal.name.downcase] = goal
  end
  
  # Loop through and make sure we've got a reference for every contributing 
  # goal.
  for goal in goals
    next if (goal.contributes_id == Goal::NO_GOAL.server_id)
    parent_goal = goals_by_id[goal.contributes_id]
    goal.contributes = parent_goal
  end
  
  @goals = goals
  @goals_by_name = goals_by_name
  @goals_by_id = goals_by_id
  return goals
end

#get_server_info ⇒ Object

The “getServerInfo” API call will return some information about the server and your current API session.

unixtime: the time since epoch of the server.
date: the date of the server.
tokenexpires: how long in minutes before the current token expires.



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/toodledo/session.rb', line 422

def get_server_info()
  result = call('getServerInfo', {}, @key)
  
  # <server>
  #<unixtime>1204569838</unixtime>
  #<date>Mon,  3 Mar 2008 12:43:58 -0600</date>
  #<tokenexpires>45.4</tokenexpires>
  #</server>
  
  unixtime = result.elements['unixtime'].text.to_i
  server_date = Time.at(unixtime)
  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,
    :serveroffset => server_offset,
  }
  
  return hash
end

#get_task_by_id(id) ⇒ Object

Gets a single task by its id, and returns the task.



578
579
580
581
582
583
584
 
# File 'lib/toodledo/session.rb', line 578

def get_task_by_id(id)
  result = call('getTasks', {:id => id}, @key)
  result.elements.each do |el| 
    task = Task.parse(self, el)
    return task
  end
end

#get_tasks(params = {}) ⇒ Object

  • title:

  • folder:

  • context:

  • goal:

  • duedate:

  • duetime

  • repeat:

  • priority:

  • parent:

  • shorter:

  • longer:

  • before

  • after

  • modbefore

  • modafter

  • compbefore

  • compafter

  • notcomp

  • star

  • status

  • startdate

  • tag

Returns an array of tasks. This information is never cached.



477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/toodledo/session.rb', line 477

def get_tasks(params={})
  logger.debug("get_tasks(#{params.inspect})") if logger
  myhash = {}
  
  # TODO Very repetitious. Refactor

  # * title : A text string up to 255 characters.
  handle_string(myhash, params, :title)

  # If the folder is a string, then we assume we're supposed to find out what
  # the id is.
  handle_folder(myhash, params)

  # Context handling
  handle_context(myhash, params)

  # Goal handling
  handle_goal(myhash, params)

  # duedate handling.  Take either a string or a Time object.'YYYY-MM-DD'
  # This does not need special handling, because if it's not a time object
  # then we don't pass through anything at all.
  handle_date(myhash, params, :duedate)

  # duetime handling.  Take either a string or a Time object. 
  handle_time(myhash, params, :duetime)

  # repeat: takes in an integer in the proper range..
  handle_repeat(myhash, params)
   
  # priority: takes in an integer in the proper range.
  handle_priority(myhash, params)
      
  # * parent : This is used to Pro accounts that have access to subtasks. 
  # Set this to the id number of the parent task and you will get its 
  # subtasks. The default is 0, which is a special number that returns 
  # tasks that do not have a parent.
  handle_parent(myhash, params)

  # * shorter : An integer representing minutes. This is used for finding 
  # tasks with a duration that is shorter than the specified number of minutes.
  handle_number(myhash, params, :shorter)

  # * longer : An integer representing minutes. This is used for finding 
  # tasks with a duration that is longer than the specified number of minutes.
  handle_number(myhash, params, :longer)

  # * before : A date formated as YYYY-MM-DD. Used to find tasks with
  # due-dates before this date.
  handle_date(myhash, params, :before)

  # * after : A date formated as YYYY-MM-DD. Used to find tasks with 
  # due-dates after this date.
  handle_date(myhash, params, :after)

  # * modbefore : A date-time formated as YYYY-MM-DD HH:MM:SS. Used to find 
  # tasks with a modified date and time before this dateand time.
  handle_datetime(myhash, params, :modbefore)

  # * modafter : A date-time formated as YYYY-MM-DD HH:MM:SS. Used to find 
  # tasks with a modified date and time after this dateand time.
  handle_datetime(myhash, params, :modafter)

  # * compbefore : A date formated as YYYY-MM-DD. Used to find tasks with a
  # completed date before this date.
  handle_date(myhash, params, :compbefore)

  # * compafter : A date formated as YYYY-MM-DD. Used to find tasks with a 
  # completed date after this date.
  handle_date(myhash, params, :compafter)
  
  # startbefore:
  handle_date(myhash, params, :startbefore)
  
  # startafter:
  handle_date(myhash, params, :startafter)
  
  # star
  handle_boolean(myhash, params, :star)
  
  # status
  handle_status(myhash, params)
  
  # * notcomp : Set to 1 to omit completed tasks. Omit variable, or set to 0
  # to retrieve both completed and uncompleted tasks.
  handle_boolean(myhash, params, :notcomp)
  
  handle_tag(myhash, params)

  result = call('getTasks', myhash, @key)
  tasks = []
  result.elements.each do |el| 
    task = Task.parse(self, el)
    tasks << task
  end
  return tasks
end

#get_token(user_id, app_id) ⇒ Object

Gets the token method, given the id.



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/toodledo/session.rb', line 271

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

#get_token_file(user_id) ⇒ Object

Gets there full path of the token file.



315
316
317
318
319
320
321
322
 
# File 'lib/toodledo/session.rb', line 315

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

#get_tokens_directory ⇒ Object

Make sure that there is a “.toodledo/tokens” directory.



325
326
327
328
329
330
 
# File 'lib/toodledo/session.rb', line 325

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

#get_uncached_token(user_id, app_id) ⇒ Object

Calls the server to get a token.



340
341
342
343
344
345
346
 
# File 'lib/toodledo/session.rb', line 340

def get_uncached_token(user_id, app_id)
  params = { :userid => user_id }
  params.merge!({:appid => app_id}) unless app_id.nil?
  result = call('getToken', params)

  return result.text
end

#get_user_id(email, password) ⇒ Object

Returns the user id. As far as I can tell, this method is broken and always returns false.

If the userid comes back as 0, it means that either the email or password that you sent was blank. If the userid comes back as 1, it means that the lookup failed. A valid userid will always be a 15 or 16 character hexadecimal string.



355
356
357
358
359
360
361
362
 
# File 'lib/toodledo/session.rb', line 355

def get_user_id(email, password)
  raise "Nil email" if (email == nil)
  raise "Nil password" if (password == nil)

  params = { :email => email, :pass => password }
  result = call('getUserid', params)  
  return result.text
end

#handle_boolean(myhash, params, symbol) ⇒ Object 



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
 
# File 'lib/toodledo/session.rb', line 1104

def handle_boolean(myhash, params, symbol)
  value = params[symbol]
  if (value == nil)
    return
  end
  
  case value
  when TrueClass, FalseClass
    bool = (value == true) ? '1' : '0'           
  when String
    bool = ('true' == value.downcase) ? '1' : '0' 
  when Fixnum
    bool = (value == 1) ? '1' : '0'
  else
    bool = value
  end
  
  myhash.merge!({ symbol => bool }) 
end

#handle_context(myhash, params) ⇒ Object

Takes in a context (in the form of a string, a Context object or a context id) and adds it to myhash as a context_id.



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
 
# File 'lib/toodledo/session.rb', line 1235

def handle_context(myhash, params)
  context = params[:context]
  if (context == nil)
    return 
  end      
  
  case context
  when String
    context_obj = get_context_by_name(context)
    if (context_obj == nil)
      raise Toodledo::ItemNotFoundError.new("No context found with name '#{context}'")
    end
    context_id = context_obj.server_id
  when Context
    context_id = context.server_id
  else
    context_id = context
  end
  
  myhash.merge!({ :context => context_id })
end

#handle_date(myhash, params, symbol) ⇒ Object 



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/toodledo/session.rb', line 1131

def handle_date(myhash, params, symbol)
  value = params[symbol]
  if (value == nil)
    return
  end
  
  case value
  when Time
    value = value.strftime('%Y-%m-%d')    
  end
  
  myhash.merge!({ symbol => value }) 
end

#handle_datetime(myhash, params, symbol) ⇒ Object

Handles a generic date time value.



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/toodledo/session.rb', line 1175

def handle_datetime(myhash, params, symbol)
  # YYYY-MM-DD HH:MM:SS
  value = params[symbol]
  if (value == nil)
    return
  end
  
  case value
  when Time
    value = value.strftime(DATETIME_FORMAT)     
  end
  
  myhash.merge!({ symbol => value })                              
end

#handle_folder(myhash, params) ⇒ Object

Handles a folder (in the form of a folder name, object or id) and puts the folder_id in myhash.



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
 
# File 'lib/toodledo/session.rb', line 1210

def handle_folder(myhash, params)      
  folder = params[:folder]
  if (folder == nil) 
    return
  end
  
  folder_id = nil
  case folder
  when String
    folder_obj = get_folder_by_name(folder)
    if (folder_obj == nil)
      raise Toodledo::ItemNotFoundError.new("No folder found with name #{folder}")   
    end
    folder_id = folder_obj.server_id
  when Folder
    folder_id = folder.server_id
  else
    folder_id = folder
  end
  
  myhash.merge!({ :folder => folder_id })          
end

#handle_goal(myhash, params) ⇒ Object

Takes a goal (as a goal title, a goal object or a goal id) and sets it in myhash.



1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/toodledo/session.rb', line 1259

def handle_goal(myhash, params)
  goal = params[:goal]
  if (goal == nil)
    return
  end

  case goal
  when String
    goal_obj = get_goal_by_name(goal)
    if (goal_obj == nil)
      raise Toodledo::ItemNotFoundError.new("No goal found with name '#{goal}'")
    end
    goal_id = goal_obj.server_id
  when Goal
    goal_id = goal.server_id
  else
    goal_id = goal
  end
  
  # Otherwise, assume it's a number.
  myhash.merge!({ :goal => goal_id })
end

#handle_number(myhash, params, symbol) ⇒ Object

Helper methods follow.

These methods will convert the appropriate format for talking to the Toodledo server. They do not parse the XML that comes back from the server.



1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/toodledo/session.rb', line 1095

def handle_number(myhash, params, symbol)
  value = params[symbol]
  if (value != nil)
    if (value.kind_of? Integer)
      myhash.merge!({ symbol => value.to_s})
    end
  end        
end

#handle_parent(myhash, params) ⇒ Object

Handles the parent task object. Only takes a task object or id.



1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/toodledo/session.rb', line 1191

def handle_parent(myhash, params)
  parent = params[:parent]
  if (parent == nil)        
    return
  end
  
  parent_id = nil
  case parent
  when Task
    parent_id = parent.server_id
  else
    parent_id = parent
  end
  
  myhash.merge!({ :parent => parent_id })
end

#handle_priority(myhash, params) ⇒ Object

Handles the priority. This must be one of several values.



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
 
# File 'lib/toodledo/session.rb', line 1311

def handle_priority(myhash, params)
  priority = params[:priority]
  
  if (priority == nil)
    return nil
  end

  if (! Priority.valid?(priority))
    raise "Invalid priority value: #{priority}"
  end
  
  myhash.merge!({ :priority => priority })        
end

#handle_repeat(myhash, params) ⇒ Object

Handles the repeat parameter.



1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'lib/toodledo/session.rb', line 1283

def handle_repeat(myhash, params)
  repeat = params[:repeat]
  
  if (repeat == nil)   
    return
  end
  
  if (! Repeat.valid?(repeat))
    raise "Invalid repeat value: #{repeat}"
  end
  
  myhash.merge!({ :repeat => repeat })
end

#handle_status(myhash, params) ⇒ Object

Handles the status parameter



1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/toodledo/session.rb', line 1298

def handle_status(myhash, params)
  status = params[:status]
  
  return if (status == nil)
  
  if (! Status.valid?(status))
    raise "Invalid status value: #{status}"
  end
  
  myhash.merge!({ :status => status })
end

#handle_string(myhash, params, symbol) ⇒ Object 



1124
1125
1126
1127
1128
1129
 
# File 'lib/toodledo/session.rb', line 1124

def handle_string(myhash, params, symbol)
  value = params[symbol]
  if (value != nil)
    myhash.merge!({ symbol => value })
  end
end

#handle_tag(myhash, params) ⇒ Object 



1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
 
# File 'lib/toodledo/session.rb', line 1146

def handle_tag(myhash, params)
  value = params[:tag]
  if (value == nil)
    return
  end

  case value
  when Array
    value = value.join(' ')   
  end

  myhash.merge!({ :tag => value }) 
end

#handle_time(myhash, params, symbol) ⇒ Object 



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
 
# File 'lib/toodledo/session.rb', line 1160

def handle_time(myhash, params, symbol)      
  value = params[symbol]
  if (value == nil)
    return
  end
  
  case value
  when Time
    value = value.strftime(TIME_FORMAT) 
  end
  
  myhash.merge!({ symbol => value })
end

#is_too_old(token_path) ⇒ Object

Returns true if the file is more than an hour old, false otherwise.



304
305
306
307
308
309
310
311
312
 
# File 'lib/toodledo/session.rb', line 304

def is_too_old(token_path)
  last_modified_time = File.new(token_path).mtime.to_i
  expiration_time = Time.now.to_i - FILE_EXPIRATION_TIME_IN_SECS
  too_old_by = last_modified_time - expiration_time
  
  logger.debug "is_too_old: expires in #{too_old_by} seconds" if logger
  
  return too_old_by < 0
end

#make_uri(method, params) ⇒ Object

Returns a parsable URI object from the base API URL and the parameters.



146
147
148
149
 
# File 'lib/toodledo/session.rb', line 146

def make_uri(method, params)
  url_string = URI.escape(@base_url + '?method=' + method + params)
  return URI.parse(url_string)
end

#md5(input_string) ⇒ Object

Hashes the input string and returns a string hex digest.



71
72
73
 
# File 'lib/toodledo/session.rb', line 71

def md5(input_string)
  return Digest::MD5.hexdigest(input_string)
end

#read_token(user_id) ⇒ Object

Reads a token from the file system, if the given user_id exists and the token is not too old.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/toodledo/session.rb', line 287

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") if logger
    return nil
  end

  if is_too_old(token_path)
    File.delete(token_path)
    return nil
  end

  token = File.read(token_path)
  token
end

#reconnect(base_url, proxy) ⇒ Object 



162
163
164
165
 
# File 'lib/toodledo/session.rb', line 162

def reconnect(base_url, proxy) 
  disconnect()
  connect(base_url, proxy)
end

#write_token(user_id, token) ⇒ Object

Writes the token file to the filesystem.



333
334
335
336
337
 
# File 'lib/toodledo/session.rb', line 333

def write_token(user_id, token)
  logger.debug("write_token: user_id = #{user_id.inspect}, token = #{token.inspect}") if logger
  token_path = File.expand_path(File.join(get_tokens_directory(), user_id))
  File.open(token_path, 'w') {|f| f.write(token) }
end