milkmaid 0.2.1 → 0.3.0

data/Gemfile.lock

@@ -8,7 +8,7 @@ GEM
     fattr (2.2.0)
     git (1.2.5)
     gli (1.3.3)
-    httparty (0.8.0)
+    httparty (0.8.1)
       multi_json
       multi_xml
     jeweler (1.6.4)

data/README.rdoc

@@ -1,20 +1,16 @@
-
 = Milkmaid
-
 Milkmaid is a command-line client for Remember the Milk.
 
 ==Features
-* View a list of incomplete tasks, and their due dates
+* View a list of incomplete tasks, their due dates, and their priorities by list
 * Complete a task
 * Postpone a task
 * Add a new task, setting properties using the Smart Add feature
 
 == Installing
-
-$ gem install milkmaid
+  $ gem install milkmaid
 
 == Authorizing
-
 Before you can connect to your tasks you must authorize the client.
 
 1. $ milkmaid auth start
@@ -24,58 +20,43 @@ Before you can connect to your tasks you must authorize the client.
 Now you are ready to work with your tasks.
 
 == Commands
+Use the -h option to view a list of commands and options for each command.
 
-View a list of incomplete tasks and get task numbers. You will need a task
-number to do things to tasks like completing or postponing them. The task
-number appears at the beginning.
-
-$ milkmaid list
-
-
-Complete a task
-
-$ milkmaid complete <task number>
-
-
-Postpone a task
-
-$ milkmaid postpone <task number>
+  $ milkmaid -h
+  $ milkmaid task -h
 
+== Working with tasks and lists
+Whenever you want to reference a task or list, such as when completing a task or
+viewing tasks within a specific list you must first view the tasks or lists in order
+to load their ID numbers and assign them to a much easier to use local ID.
 
-Delete a task
-
-$ milkmaid delete <task number>
-
-Add a task (Use single quotes to contain the task name)
-
-Adding a task supports Remember the Milk's Smart Add feature. With it you
-can set properties such as the due date, priority, etc.
-
-$ milkmaid add '<task name>'
+  $ milkmaid list
+  $ milkmaid task
 
 == Version history
+=== 0.3.0
+* See a list of available lists with the list command
+* View incomplete tasks by list with the -l option
+* Updated command structure. Use the -h option to see commands.
+* Friendly message when unable to connect to server
 
 === 0.2.1
-
 * Fixed auth scenarios
 
-
 === 0.2.0
-
 * New delete command
 * Friendlier usage information
 
 === 0.1.1
-
 * Fixed an issue when listing tasks with recurrences that were completed
 
 === 0.1.0
-
 * Initial version
 
+== Contact me
+Follow me on twitter: @mariusgrigoriu
 
 == Contributing to Milkmaid
- 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -85,7 +66,6 @@ $ milkmaid add '<task name>'
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 == Copyright
-
 Copyright (c) 2011 Marius Grigoriu. See LICENSE.txt for
 further details.
 

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/bin/milkmaid

@@ -10,6 +10,22 @@ def milkmaid
   @milkmaid ||= Milkmaid.new
 end
 
+def handle_exceptions
+  begin
+    yield
+  rescue RTM::NoTokenException
+    puts "Authentication token not found. Run `#{__FILE__} auth start`"
+  rescue Milkmaid::TaskNotFound
+    puts "Task ##{params['tasknum'].value} not found. Run `#{__FILE__} task` " +
+      "to load a list of tasks."
+  rescue Milkmaid::ListNotFound
+    puts "List ##{params['listnum'].value} not found. Run `#{__FILE__} list` " +
+      "to load lists."
+  rescue Errno::ETIMEDOUT
+    puts "Unable to connect to the server. Please try again later."
+  end
+end
+
 Main {
   description "Milkmaid command-line client for Remember the Milk\n" +
     "If this is your first time running this, use the auth command to connect to your account."
@@ -19,20 +35,39 @@ Main {
   end
 
   mode :list do
-    description "Lists all inactive tasks. Tasks that repeat are marked with a (R).\n" +
+    description "Display the available lists."
+
+    def run
+      handle_exceptions do
+        milkmaid.lists.each_with_index { |list, i| puts "#{i+1}: #{list['name']}" }
+      end
+    end
+  end
+
+  mode :task do
+    description "Lists inactive tasks. Tasks that repeat are marked with a (R).\n" +
       "If there is a due date, it appears to the right of the task. Tasks are color\n" +
       "coded by priority the same when viewed on the web. Tasks due today are in bold\n" +
       "while tasks that are overdue are underlined.\n" +
       "Use this command to assign a number to tasks so you may perform other actions."
-
+    
+    option('listnum','l') {
+      argument :optional
+      cast :int
+      description <<-EOD
+      Show tasks that belong to the given list. Use the number as printed by the
+      list command.
+      EOD
+    }
+    
     def run
-      begin
-        milkmaid.incomplete_tasks.each_with_index do |taskseries, i|
-          task = Milkmaid::last_task taskseries
-          text = "#{i+1}: #{taskseries['name']}"
-          text << "(R)" unless taskseries['rrule'].nil?
-          text << " #{Time.parse(Milkmaid::last_task(taskseries)['due']).getlocal.strftime(
-          "%A %b %d, %Y %I:%M %p")}" unless task['due'].empty?
+      handle_exceptions do
+        milkmaid.incomplete_tasks(params['listnum'].value).each_with_index do |ts, i|
+          task = Milkmaid::last_task ts
+          text = "#{i+1}: #{ts['name']}"
+          text << "(R)" unless ts['rrule'].nil?
+          text << " #{Time.parse(Milkmaid::last_task(ts)['due']).getlocal.strftime(
+            "%A %b %d, %Y %I:%M %p")}" unless task['due'].empty?
           color = {
             '1'=>[234, 82, 0], 
             '2'=>[0, 96, 191], 
@@ -49,83 +84,57 @@ Main {
           end unless task['due'].empty?
           puts Paint[text, color[task['priority']], mode1, mode2]
         end
-      rescue RTM::NoTokenException
-        puts "Authentication token not found. Run `#{__FILE__} auth start`"
       end
     end
-  end
+    
+    mode :complete do
+      description "Marks a task as complete."
 
-  mode :complete do
-    description "Marks a task as complete."
+      argument(:tasknum) {
+        cast :int
+        description "The number of the task as printed by the list command."
+      }
 
-    argument(:tasknum) {
-      cast :int
-      description "The number of the task as printed by the list command."
-    }
-
-    def run
-      begin
-        milkmaid.complete_task params['tasknum'].value
-      rescue Milkmaid::TaskNotFound
-        puts "Task ##{params['tasknum'].value} not found. Run `#{__FILE__} list` " +
-          "to load a list of tasks."
-      rescue RTM::NoTokenException
-        puts "Authentication token not found. Run `#{__FILE__} auth start`"
+      def run
+        handle_exceptions { milkmaid.complete_task params['tasknum'].value }
       end
     end
-  end
 
-  mode :postpone do
-    description "Extends the due date of a task."
+    mode :postpone do
+      description "Extends the due date of a task."
 
-    argument(:tasknum) {
-      cast :int
-      description "The number of the task as printed by the list command."
-    }
+      argument(:tasknum) {
+        cast :int
+        description "The number of the task as printed by the list command."
+      }
 
-    def run
-      begin
-        milkmaid.postpone_task params['tasknum'].value
-      rescue Milkmaid::TaskNotFound
-        puts "Task ##{params['tasknum'].value} not found. Run `#{__FILE__} list` " +
-          "to load a list of tasks."
-      rescue RTM::NoTokenException
-        puts "Authentication token not found. Run `#{__FILE__} auth start`"
+      def run
+        handle_exceptions { milkmaid.postpone_task params['tasknum'].value }
       end
     end
-  end
 
-  mode :delete do
-    description "Gets rid of a task."
+    mode :delete do
+      description "Gets rid of a task."
 
-    argument(:tasknum) {
-      cast :int
-      description "The number of the task as printed by the list command."
-    }
+      argument(:tasknum) {
+        cast :int
+        description "The number of the task as printed by the list command."
+      }
 
-    def run
-      begin
-        milkmaid.delete_task params['tasknum'].value
-      rescue Milkmaid::TaskNotFound
-        puts "Task ##{params['tasknum'].value} not found. Run `#{__FILE__} list` " +
-          "to load a list of tasks."
-      rescue RTM::NoTokenException
-        puts "Authentication token not found. Run `#{__FILE__} auth start`"
+      def run
+        handle_exceptions { milkmaid.delete_task params['tasknum'].value }
       end
     end
-  end
 
-  mode :add do
-    argument(:taskname) 
+    mode :add do
+      argument(:taskname) 
 
-    def run
-      begin
-        milkmaid.add_task params['taskname'].value
-      rescue RTM::NoTokenException
-        puts "Authentication token not found. Run `#{__FILE__} auth start`"
+      def run
+        handle_exceptions { milkmaid.add_task params['taskname'].value }
       end
     end
   end
+
         
   mode :auth do
     description "Auth commands are used to connect Milkmaid to your account."
@@ -157,4 +166,12 @@ Main {
       end
     end
   end
+
+  mode :clean do
+    description "Cleans cached data out of the config file."
+
+    def run
+      milkmaid.clean
+    end
+  end
 }

data/lib/milkmaid.rb

@@ -15,10 +15,27 @@ class Milkmaid
     end
   end
 
-  def incomplete_tasks
+  def lists
+    entries = @rtm.lists.get_list['lists']['list'].as_array
+    list_ids = entries.map { |list| list['id'] }
+    @config[:lists] = list_ids
+    save_config
+    entries
+  end
+  
+  def incomplete_tasks(list=nil)
+    params = {}
+    unless list.nil?
+      if @config[:lists]
+        list = @config[:lists][list-1]
+        params[:list_id] = list unless list.nil?
+      end
+      raise ListNotFound if params.empty?
+    end
     entries = []
     list_id = nil
-    @rtm.tasks.get_list['tasks']['list'].as_array.each do |items|
+    @rtm.tasks.get_list(params)['tasks']['list'].
+      as_array.each do |items|
       list_id = items['id']
       if !items['taskseries'].nil?
         items['taskseries'].as_array.each do |taskseries|
@@ -43,10 +60,10 @@ class Milkmaid
         result
       end
     end
-    entries.each_with_index do |taskseries, i|
-      @config["#{i+1}list_id"] = taskseries['list_id']
-      @config["#{i+1}taskseries_id"] = taskseries['id']
-      @config["#{i+1}task_id"] = Milkmaid::last_task(taskseries)['id']
+    @config[:tasks] = entries.map do |taskseries|
+      {:list_id => taskseries['list_id'], 
+      :taskseries_id => taskseries['id'],
+      :task_id => Milkmaid::last_task(taskseries)['id']}
     end
     save_config
     entries
@@ -83,28 +100,31 @@ class Milkmaid
     save_config
   end
 
+  def clean
+    @config.delete_if { |k| k != :token }
+    save_config
+  end
+
   class TaskNotFound < StandardError
   end
 
+  class ListNotFound < StandardError
+  end
+
+  private
   def self.last_task(taskseries)
     taskseries['task'].as_array.last
   end
 
-  private
   def save_config
     File.open(@config_file, 'w') { |f| YAML.dump(@config, f) }
   end
 
   def check_task_ids(tasknum)
-    raise TaskNotFound if @config["#{tasknum}list_id"].nil? || 
-                          @config["#{tasknum}taskseries_id"].nil? ||
-                          @config["#{tasknum}task_id"].nil?
+    raise TaskNotFound if @config[:tasks].nil? || @config[:tasks][tasknum-1].nil? 
   end
 
   def call_rtm_api(method, tasknum)
-    @rtm.tasks.send method, :list_id=>@config["#{tasknum}list_id"],
-                        :taskseries_id=>@config["#{tasknum}taskseries_id"],
-                        :task_id=>@config["#{tasknum}task_id"],
-                        :timeline=>@timeline
+    @rtm.tasks.send method, @config[:tasks][tasknum-1].merge(:timeline=>@timeline)
   end
 end

data/milkmaid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "milkmaid"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marius Grigoriu"]
-  s.date = "2011-10-03"
+  s.date = "2011-10-10"
   s.description = "Milkmaid is a command-line client for Remember the Milk"
   s.email = "marius.grigoriu@live.com"
   s.executables = ["milkmaid"]
@@ -35,7 +35,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/mariusgrigoriu/milkmaid"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.11"
   s.summary = "Milkmaid is a command-line client for Remember the Milk"
 
   if s.respond_to? :specification_version then

data/spec/milkmaid_spec.rb

@@ -41,6 +41,23 @@ describe "Milkmaid" do
     end
   end
 
+  describe 'listing lists' do
+    let(:a) {{"id"=>"21242147", "name"=>"Inbox", "deleted"=>"0", "locked"=>"1", "archived"=>"0", "position"=>"-1", "smart"=>"0", "sort_order"=>"0"}}
+
+    before do
+      rtm_double.stub_chain(:lists, :get_list) {{"stat"=>"ok", "lists"=>{"list"=>a}}}
+    end
+
+    it 'returns all lists' do
+      lib.lists.should == [a]
+    end
+
+    it 'assigns and stores a local ID number for each list' do
+      should_store_in_configuration({ :token=>'tsttoken', :lists=>['21242147'] })
+      lib.lists
+    end
+  end
+    
   describe "listing tasks" do
     let(:a) {{"name"=>"a", "id"=>"ats", "task"=>{"completed"=>"", "priority"=>"1", 
                                       "id"=>"at", "due"=>""}}}
@@ -53,8 +70,7 @@ describe "Milkmaid" do
                                       "id"=>"ct", "due"=>"2012-10-02T02:52:58Z"}}}
     let(:d) {{"name"=>"d", "id"=>"dts", "task"=>{"completed"=>"", "priority"=>"N",
                                       "id"=>"dt", "due"=>"2011-10-02T02:52:58Z"}}}
-    before do
-      RTM::RTM.stub_chain(:new, :tasks, :get_list) { 
+    let(:response) {
         {"tasks"=>{"list"=>[{"id"=>"21242147", "taskseries"=>[
           a, b, c, d,
           {"name"=>"done task", "task"=>{"completed"=>"2011-10-02T02:52:58Z"}}
@@ -66,7 +82,40 @@ describe "Milkmaid" do
         {"id"=>"21242152"}], 
         "rev"=>"4k555btb3vcwscc8g44sog8kw4ccccc"}, 
         "stat"=>"ok"}
-      }
+    }
+
+    before do
+      tasks_double.stub(:get_list).and_return(response)
+    end
+
+    context 'when a list number is provided' do
+      it 'passes in a list_id if the list number is found' do
+        YAML.stub(:load_file) {{
+          :token=>'tsttoken',
+          :lists=>['tstlistid']
+        }}
+        tasks_double.should_receive(:get_list).with(:list_id=>'tstlistid')
+        lib.incomplete_tasks 1
+      end
+
+      it 'does not pass in a list_id if the list number is not found' do
+        YAML.stub(:load_file) {{
+          :token=>'tsttoken',
+          :lists=>['tstlistid']
+        }}
+        lambda { lib.incomplete_tasks 2 }.should raise_error(Milkmaid::ListNotFound)
+      end
+
+      it 'does not pass in a list_id if the list cache does not exist' do
+        lambda { lib.incomplete_tasks 2 }.should raise_error(Milkmaid::ListNotFound)
+      end
+    end
+
+    context 'when a list number is not provided' do
+      it 'does not pass in a list_id' do
+        tasks_double.should_receive(:get_list).with({})
+        lib.incomplete_tasks
+      end
     end
 
     it "returns all incomplete tasks in order of priority then due date" do
@@ -76,10 +125,12 @@ describe "Milkmaid" do
     it "assigns and stores a local ID number to each task for easy addressing" do
       should_store_in_configuration({
         :token=>'tsttoken',
-        '1list_id'=>'21242147', '1taskseries_id'=>'bts', '1task_id'=>'bt',
-        '2list_id'=>'21242147', '2taskseries_id'=>'ats', '2task_id'=>'at',
-        '3list_id'=>'21242147', '3taskseries_id'=>'dts', '3task_id'=>'dt',
-        '4list_id'=>'21242147', '4taskseries_id'=>'cts', '4task_id'=>'ct'
+        :tasks=>[
+          {:list_id=>'21242147', :taskseries_id=>'bts', :task_id=>'bt'},
+          {:list_id=>'21242147', :taskseries_id=>'ats', :task_id=>'at'},
+          {:list_id=>'21242147', :taskseries_id=>'dts', :task_id=>'dt'},
+          {:list_id=>'21242147', :taskseries_id=>'cts', :task_id=>'ct'}
+        ]
       })
       lib.incomplete_tasks
     end
@@ -148,6 +199,12 @@ describe "Milkmaid" do
       end
     end
   end
+
+  it 'cleans out the cache' do
+    YAML.stub(:load_file) {{ :token=>'tsttoken', 'junk'=>'trash' }}
+    should_store_in_configuration({:token=>'tsttoken'})
+    lib.clean
+  end
 end
 
 def should_store_in_configuration(config)
@@ -159,9 +216,9 @@ end
 def should_call_rtm_api(method, tasknum)
   YAML.stub(:load_file) {{
     :token=>'tsttoken',
-    "#{tasknum}list_id"=>"#{tasknum}l",
-    "#{tasknum}taskseries_id"=>"#{tasknum}ts",
-    "#{tasknum}task_id"=>"#{tasknum}t"
+    :tasks=>(0...tasknum).collect do |n| 
+      {:list_id=>"#{n+1}l", :taskseries_id=>"#{n+1}ts", :task_id=>"#{n+1}t"}
+    end
   }}
   tasks_double.should_receive(method).with(
     :list_id=>"#{tasknum}l", :taskseries_id=>"#{tasknum}ts", 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milkmaid
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-03 00:00:00.000000000Z
+date: 2011-10-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: main
-  requirement: &70334228913400 !ruby/object:Gem::Requirement
+  requirement: &70207460096000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 4.7.7
   type: :runtime
   prerelease: false
-  version_requirements: *70334228913400
+  version_requirements: *70207460096000
 - !ruby/object:Gem::Dependency
   name: moocow
-  requirement: &70334228912900 !ruby/object:Gem::Requirement
+  requirement: &70207460095400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *70334228912900
+  version_requirements: *70207460095400
 - !ruby/object:Gem::Dependency
   name: paint
-  requirement: &70334228878440 !ruby/object:Gem::Requirement
+  requirement: &70207460094800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.8.3
   type: :runtime
   prerelease: false
-  version_requirements: *70334228878440
+  version_requirements: *70207460094800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70334228877960 !ruby/object:Gem::Requirement
+  requirement: &70207460094200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334228877960
+  version_requirements: *70207460094200
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70334228798560 !ruby/object:Gem::Requirement
+  requirement: &70207460093620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334228798560
+  version_requirements: *70207460093620
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70334228798000 !ruby/object:Gem::Requirement
+  requirement: &70207460093040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334228798000
+  version_requirements: *70207460093040
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70334228797480 !ruby/object:Gem::Requirement
+  requirement: &70207460092460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334228797480
+  version_requirements: *70207460092460
 description: Milkmaid is a command-line client for Remember the Milk
 email: marius.grigoriu@live.com
 executables:
@@ -125,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1264874012981768680
+      hash: 4484778310645484132
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Milkmaid is a command-line client for Remember the Milk