todoist 0.0.1 → 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009-2009 Jonathan Stott
+
+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.

data/README

@@ -0,0 +1,22 @@
+todoist
+=======
+
+The todoist gem is intended to facilitate access to the todoist (http://todoist.com)
+task management service, offering methods to directly query the API and also
+convinient wrapper objects around the responses.
+
+
+example
+-------
+
+
+Todoist::Base.setup(api_token)
+
+Todoist::Task.all.each do |task|
+  puts task
+end
+
+COPYRIGHT
+=========
+
+Copyright (c) 2008 Jonathan Stott. See LICENSE for details.

data/Rakefile

@@ -1,4 +1,38 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
-
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "todoist"
+    s.summary = "a library for interacting with the Todoist public API"
+    s.email = "jonathan.stott@gmail.com"
+    s.homepage = "http://github.com/namelessjon/todoist"
+    s.description = "The todoist gem offers convinience methods and wrappers for the todoist list management service, easing retrival and parsing of the responses.  It also offers a simple command-line client."
+    s.authors = ["Jonathan Stott"]
+    s.files   = FileList["lib/**/*.rb", "spec/**/*.rb", 'Rakefile', "[A-Z]+"]
+    s.add_dependency('highline', '~> 1.5')
+    s.add_dependency('thor', '~> 0.9')
+    s.add_dependency('httparty', '~> 0.3')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Todoist'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :spec

data/bin/todoist

@@ -0,0 +1,91 @@
+require 'thor'
+require 'highline'
+
+HighLine.track_eof = false
+
+dir = File.dirname(__FILE__)
+require File.join(dir, '..', 'lib', 'todoist')
+
+class TodoistCLI < Thor
+
+  desc "tasks", "list of projects with uncompleted tasks, and their tasks"
+  def tasks(name=nil)
+    setup_todoist_base
+
+    Todoist::Project.all.each do |project|
+      next if name and project.name !~ /#{name}/
+
+      if project.task_count > 0
+        print_project(project)
+      end
+    end
+  end
+
+  desc "complete", "Completes the task with the given content"
+  method_options :all => :boolean
+  def complete(content)
+    setup_todoist_base
+
+    @h = HighLine.new
+
+    to_complete = []
+    Todoist::Task.all.each do |task|
+      next if task.content !~ /#{content}/
+      to_complete << task
+    end
+
+    tasks = []
+    if to_complete.size > 1 and !options[:all]
+      @h.say("Choose tasks to delete:")
+      to_complete.each do |task|
+        if @h.agree("Delete #{task} (#{task.project})?")
+          tasks << task
+        end
+      end
+    else
+      tasks = to_complete
+    end
+
+    Todoist::Task.complete(tasks)
+  end
+
+  desc "overdue", "Fetch all overdue tasks"
+  def overdue
+    setup_todoist_base
+    Todoist::Task.overdue.each do |task|
+      puts task
+    end
+  end
+
+  protected
+  def print_project(project)
+    puts project
+    project.tasks.each do |task|
+      next if task.complete?
+      print "  " * (task.indent.to_i - 1)
+      print (task.content =~ /\* /) ? '' : '- '
+      puts task
+    end
+    puts ""
+  end
+
+  def setup_todoist_base
+    if File.file?(File.expand_path('~/.todoistrc'))
+      require 'yaml'
+      conf = YAML.load_file(File.expand_path('~/.todoistrc'))
+      Todoist::Base.setup(conf['token'], conf['premium'])
+    else
+      puts <<-eos
+You need to setup ~/.todoistrc, for example:
+token: 91b1ce9e153fc5390ac3db4f0ded9f31a1a7ba23 # use your api key
+premium: false # if this is true, ssl will be used.
+eos
+      exit(1)
+    end
+  end
+
+end
+
+TodoistCLI.start
+
+# vim: set ft=ruby:

data/lib/todoist.rb

@@ -1,20 +1,8 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 module Todoist
-  
 end
 
-begin
-  require 'json'
-rescue LoadError
-  require 'rubygems'
-  require 'json'
-end
+dir = File.dirname(__FILE__)
 
-require 'cgi'
-require 'net/http'
-require 'net/https'
-require 'todoist/errors'
-require 'todoist/connection'
-require 'todoist/project'
+require File.join(dir, 'todoist', 'base')
+require File.join(dir, 'todoist', 'project')
+require File.join(dir, 'todoist', 'task')

data/lib/todoist/base.rb

@@ -0,0 +1,38 @@
+require 'httparty'
+require 'json'
+module Todoist
+  ##
+  # The Todoist::Base class is responsible for making all queries to the
+  # todoist web API.
+  class Base
+    include HTTParty
+    format :json
+
+    ##
+    # Sets up the Todoist::Base class for making requests, setting the API key
+    # and if the account is a premium one or not.
+    def self.setup(token, premium = false)
+      self.default_params :token => token
+      @@premium = premium
+      set_base_uri
+    end
+
+    private
+    def self.set_base_uri
+      if premium?
+        base_uri 'https://todoist.com/API'
+      else
+        base_uri 'http://todoist.com/API'
+      end
+    end
+
+    def self.premium?
+      (@@premium) ? true : false
+    end
+
+    def id_array(ids)
+      ids.flatten.map {|i| i.to_i }.to_json
+    end
+
+  end
+end

data/lib/todoist/project.rb

@@ -0,0 +1,126 @@
+module Todoist
+  ##
+  # Project
+  #
+  # A todoist project.
+  class Project
+    attr_reader :name, :id, :user_id, :color, :collapsed, :order, :indent
+
+    ##
+    # Get all projects
+    #
+    # Fetches all the user's todist projects.
+    #
+    # @return [Array] An Array of todoist project instances.
+    def self.all
+      projects = []
+      Base.get('/getProjects').each do |project|
+        projects << new_from_api_request(project)
+      end
+      projects
+    end
+
+    ##
+    # Get a project
+    #
+    # Fetches a todoist project
+    #
+    # @param [Integer,Todoist::Project] id The id, or project, to fetch
+    #
+    # @return [Todoist::Project] The fetched project.
+    def self.get(id)
+      new_from_api_request(get_project(id))
+    end
+
+    ##
+    # Create a new project
+    #
+    # Creates a new Todoist project.
+    #
+    # @param [String] name The name of the project
+    #
+    # @param [Hash]   parameters The other parameters which make up the project.
+    #
+    # @return [Todoist::Project] The new todoist project.
+    def initialize(name, parameters={})
+      @name       = name
+      @id         = parameters['id']
+      @user_id    = parameters['user_id']
+      @color      = parameters['color']
+      @collapsed  = parameters['collapsed']
+      @order      = parameters['item_order']
+      @count      = parameters['cache_count']
+      @indent     = parameters['indent']
+    end
+
+
+    def to_s
+      "#{name}"
+    end
+
+    def to_i
+      id
+    end
+
+    def inspect
+      "<Project:#{name}:#{id}:#{task_count}:user_id=#{user_id} color='#{color}' collapsed=#{collapsed?} order=#{order} indent=#{indent}>"
+    end
+
+    def collapsed?
+      (collapsed == 1) ? true : false
+    end
+
+
+    ##
+    # The task count
+    #
+    # The number of tasks a project has, according to its cache_count when it was fetched
+    #
+    # @return [Integer] The number of tasks this project has
+    def task_count
+      @count
+    end
+
+    ##
+    # Get uncompleted tasks for the project
+    #
+    # @return [Array] An Array of Todoist::Tasks
+    def tasks
+      Task.uncompleted(self)
+    end
+
+    ##
+    # Get completed tasks for the project
+    #
+    # @return [Array] An Array of completed Todoist::Tasks
+    def completed_tasks
+      Task.completed(self)
+    end
+
+    ##
+    # Add task
+    #
+    # Adds a task to the project.
+    #
+    # @param [String] content The content of the new task
+    #
+    # @param [Hash] opts The options for the new task
+    #
+    # @return [Todoist::Task] The new task.
+    def add_task(content, opts={})
+      Task.new(content, self, opts).save
+    end
+
+    private
+
+    def self.new_from_api_request(project)
+      name = project.delete('name')
+      new(name, project)
+    end
+
+    def self.get_project(id)
+      Base.get('/getProject', :query => {:project_id => id.to_i })
+    end
+
+  end
+end

data/lib/todoist/task.rb

@@ -0,0 +1,252 @@
+require 'time'
+module Todoist
+  ##
+  # Todoist Task
+  #
+  # A todoist task.
+  class Task
+    attr_accessor :content, :priority, :task_details, :project_id
+    attr_reader   :date, :id
+    ##
+    # Get tasks for a project
+    #
+    # Retrieves all uncompleted tasks from the todoist service for the project id.
+    #
+    # @param [Integer,Todoist::Project] project The project to get tasks for
+    #
+    # @return [Array] An array of todoist tasks.
+    def self.uncompleted(project)
+      make_tasks(Base.get('/getUncompletedItems', :query => { :project_id => project.to_i }))
+    end
+
+    ##
+    # Get completed tasks for project
+    #
+    # Retrieves completed tasks from the todoist service for the project id.
+    #
+    # @param [Integer,Todoist::Project] project The project to get tasks for
+    #
+    # @return [Array] An array of todoist tasks.
+    def self.completed(project)
+      make_tasks(Base.get('/getCompletedItems', :query => { :project_id => project.to_i }))
+    end
+
+    ##
+    # Complete tasks
+    #
+    # Completes a list of tasks
+    #
+    # @param [Array,Integer,Todist::Task] ids A list of tasks to complete.
+    def self.complete(*ids)
+      make_tasks(Base.get('/completeItems', :query => {:ids => id_array(ids)}))
+    end
+
+    ##
+    # Get Tasks by ID
+    #
+    # Retrives a list of tasks from the todoist service.
+    #
+    # @param [Array,Integer,Todist::Task] ids A list of tasks to retrieve
+    #
+    # @return [Array] An array of Todist::Tasks
+    def self.get(*ids)
+      make_tasks(Base.get('/getItemsById', :query => {:ids => id_array(ids)}))
+    end
+
+    ##
+    # Get all tasks
+    #
+    # Retrieves all the uncompleted tasks
+    #
+    # @return [Array] An array of Todist::Tasks
+    def self.all
+      query('viewall')['viewall']
+    end
+
+    ##
+    # Get overdue tasks
+    #
+    # Retrieves all the overdue tasks
+    #
+    # @return [Array] An array of overdue Todist::Tasks
+    def self.overdue
+      query('overdue')['overdue']
+    end
+
+
+    ##
+    # Query
+    #
+    # Use the task query API to get back several arrays of tasks.
+    #
+    # @param [String,Array] query A query or a list of queries to perform
+    #
+    # @return [Hash] a hash keyed on query, containing arrays of tasks.
+    #
+    # Allowed queries
+    #   viewall:: All tasks
+    #   overdue:: All overdue tasks
+    #   p[123]::      All tasks of priority 1, 2 ,3
+    def self.query(*queries)
+      query = '["' + queries.flatten.map { |q| q.to_s }.join('","') + '"]'
+      results = {}
+      response = Base.get('/query', :query => { :queries => query })
+
+      response.each do |q|
+        if q['type'] == 'viewall'
+          tasks = []
+          q['data'].each do |stuff|
+            tasks << make_tasks(stuff['uncompleted'])
+          end
+          results[q['type']] = tasks.flatten
+        else
+          results[q['type']] = make_tasks(q['data'])
+        end
+      end
+      results
+    end
+
+    ##
+    # Create a new task
+    #
+    # @param [String] content The content of the new task.
+    #
+    # @param [Integer,Todoist::Project] project The project to create the new task in
+    #
+    # @param [Hash] opts Optional priority and due date for creation.
+    def self.create(content, project, opts={})
+      query = {:project_id => project.to_i, :content => content.to_s }
+      query['priority'] = opts.delete('priority') if opts.has_key?('priority')
+      query['date_string'] = opts.delete('date_string') if opts.has_key?('date_string')
+
+      new_from_api(Base.get('/addItem', :query => query))
+    end
+
+    ##
+    # Updates a task
+    #
+    # @param [String] content The new content of the task.
+    #
+    # @param [Integer,Todoist::Task] id The task to update
+    #
+    # @param [Hash] opts Optional priority and due date for creation.
+    def self.update(content, id, opts={})
+      query = {:id => project.to_i, :content => content.to_s }
+      query['priority'] = opts.delete('priority') if opts.has_key?('priority')
+      query['date_string'] = opts.delete('date_string') if opts.has_key?('date_string')
+
+      new_from_api(Base.get('/updateItem', :query => query))
+    end
+
+
+
+    def initialize(content, project_id, d={})
+      @content    = content
+      @project_id = project_id.to_i
+      @date       = d.delete('date') || d.delete('date_string')
+      @priority   = d.delete('priority')
+      @id         = d.delete('id')
+      @task_details = d
+    end
+
+    ##
+    # Is the task complete
+    def complete?
+      (@task_details['in_history'] == 1) ? true : false
+    end
+
+
+    ##
+    # Complete
+    #
+    # Completes the todoist task
+    def complete
+      self.class.complete(self) unless complete?
+      @task_details['in_history'] = 1
+    end
+
+    ##
+    # Is the task overdue?
+    def overdue?
+      return false unless due_date
+      Time.now > Time.parse(due_date)
+    end
+
+    ##
+    # Project
+    #
+    # Retreives the project for the task
+    def project
+      Project.get(project_id)
+    end
+
+    ##
+    # Saves the task
+    #
+    # Save the task, either creating a new task on the todoist service, or
+    # updating a previously retrieved task with new content, priority etc.
+    def save
+      opts = {}
+      opts['priority'] = priority if priority
+      opts['date_string'] = date if date
+      # if we don't have an id, then we can assume this is a new task.
+      unless (task_details.has_key?('id'))
+        result = self.class.create(self.content, self.project_id, opts)
+      else
+        result = self.class.update(self.content, self.id, opts)
+      end
+
+      self.content      = result.content
+      self.project_id   = result.project_id
+      self.task_details = result.task_details
+      self
+    end
+
+
+
+    def to_s
+      @content
+    end
+
+    def to_i
+      id
+    end
+
+    def inspect
+      "<Todoist::Task:#{content}:#{id}:#{project_id}:#{task_details.inspect}>"
+    end
+
+    def method_missing(*args, &block)
+      # the method name
+      m = args.shift
+      if @task_details.has_key?(m.to_s)
+        return @task_details[m.to_s]
+      else
+        raise NoMethodError, "undefined method `#{m}' for #{self.inspect}"
+      end
+    end
+
+    private
+
+    def self.new_from_api(task)
+      content = task.delete('content')
+      project_id = task.delete('project_id')
+      new(content, project_id, task)
+    end
+
+    def self.make_tasks(tasks)
+      new_tasks = []
+      tasks.each do |task|
+        new_tasks << new_from_api(task)
+      end
+      new_tasks
+    end
+
+    def self.id_array(*ids)
+      "[" + ids.flatten.map { |q| q.to_i }.join(",") + "]"
+    end
+
+
+# {"due_date": null, "collapsed": 0, "labels": [], "is_dst": 0, "has_notifications": 0, "checked": 0, "indent": 1, "children": null, "content": "Finish this gem", "user_id": 34615, "mm_offset": 0, "in_history": 0, "id": 4152190, "priority": 4, "item_order": 1, "project_id": 528294, "chains": null, "date_string": ""}
+  end
+end