milk_cap 0.5.1 → 0.5.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTA1NGE1OTViOTc2NDBkMDdlNjY0ZDkxNjJlYjIxYzM4YzU3NGJiNQ==
+    MzIzYTI4ZjQ3M2IxOTBhNzUwNmQxZjc4ZTZiNjRkM2M1Y2UzNDU1ZA==
   data.tar.gz: !binary |-
-    OTA0NmMxYjUxZjViY2FhZTUxMTViMDg0NDQ5YTlkZWVhNDQ2MjEwNQ==
+    YzE1NGNhZjk2NjQ5ZjFjMWViYTJlMzM3NGJhNDIxNGNkNjJiOGRhNA==
 SHA512:
   metadata.gz: !binary |-
-    NmYwMWQ4MGQ5Y2QwMjE1NmE0MTFiOTM2OTY5OGQzMmYyMzE0OThjNzcxZjBl
-    Njg4ODgxZTE0NGMxZWUzYWNiZGQ2YzZjMTk3NDhlZjVjYjEwNGU3YTczOWEz
-    ZDIxZTk4MGQ1YTRlNzM2YzIyZGE5ZDQzODZhYTA3ZWFhNmQ0NjU=
+    NWE4OThhYmUzMWViMTA3MzNmNDRhNTYyZTA5ZWQwMjEwOTc3YTU4MzI1N2I1
+    NWVhYmRiNTAwNWQ2OWU1MThjMTQxZmRmYjE0MjA5OTJlMTJjNWMyMWI5ODMw
+    YWY4YjQ0YmZiMzcyOTE1N2I2MmM4ODJlMTYyZDI4MDU4MTMyZWI=
   data.tar.gz: !binary |-
-    OGQzYzQ0ODMzMGIwODhhNjkwYWJmYmQ1ZTM4MGZmN2E0YzcyMDAyYThkZDM2
-    NjY5OWQxYzg4MDFkNzE2MzFkMDBjNDdlN2M2ZmI5YjY1ZDUyMGNiMDRhNDll
-    YTIwNGFhM2M3NGYzNjkyMWE2OTk5MjhlNWMyN2NmMmQ5ODYwNzU=
+    ZTM3NDM3ZTRlYWExMWVjYzI2ZDZjMDFlM2JmYzY1MzVhNmI2MzllOTlmODI3
+    ZjRmNjc3MTMxYTNmMjQ1YjIwOGNhMzE3NjViMTVkNmJlMTBjMGJiMGU5NzMw
+    YTcwMDBiMGE1MGRhYjczODJjNjk4OTE5MTJkNWQ1NDQzMGE5OWM=

data/CHANGELOG.txt

@@ -1,6 +1,15 @@
 
 = milk_cap CHANGELOG.txt
 
+== milk_cap - 0.5.2     released 2014/03/06
+
+- converted from test/unit to rspec, removed test files from gem distribution
+- removed forced 1 second sleep in RTM API calls
+- removed new timeline creation for each #add! call, now reuses single timeline
+- supports setting task tags
+- BUGFIX: correctly parse taskseries with tasks array
+
+
 == milk_cap - 0.5.1     released 2014/01/03
 
 - removed rufus-verbs dependency (and rufus-lru)

data/README.rdoc

@@ -96,6 +96,13 @@ make then sure that all the 4 variables are set in the environment you use for r
 
   task.complete!
 
+  #
+  # set tags for a task
+
+  task.tags = 'tag1,tag2'
+  task.tags = ['tag1', 'tag2']  # alternative
+  task.save!
+
   #
   # deleting a task
 
@@ -104,14 +111,10 @@ make then sure that all the 4 variables are set in the environment you use for r
 
 Note that the methods that change the state of the Remember The Milk dataset have names ending with an exclamation mark.
 
-Note as well that, there is a 1 second delay before any request to the RTM server, in order to respect their conditions. This may change in future releases.
-
 
-== features yet to implement
+== development
 
-* tags modifications
-* smart lists
-* ...
+* Testing with rspec -- run suite with 'rspec', 'rake' or 'rake spec'.
 
 
 == issue tracker

data/Rakefile

@@ -7,12 +7,19 @@ require 'rubygems'
 require 'rake'
 
 
+#
+# TEST
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+
 #
 # CLEAN
 
 require 'rake/clean'
 CLEAN.include('pkg', 'tmp', 'html')
-task :default => [ :clean ]
 
 
 #
@@ -34,9 +41,11 @@ Jeweler::Tasks.new do |gem|
   gem.authors = [ 'John Mettraux', 'Jeff Leverenz' ]
   gem.licenses = 'MIT'
 
-  gem.test_file = 'test/test.rb'
+  gem.files.exclude 'spec/**'
 
   gem.add_development_dependency 'yard', '>= 0'
+  gem.add_development_dependency 'rspec', '~> 2.14'
+  gem.add_development_dependency 'jeweler', '~> 2.0.1'
 end
 Jeweler::GemcutterTasks.new
 

data/lib/milk_cap/rtm/base.rb

@@ -45,7 +45,7 @@ end
 module MilkCap
 module RTM
 
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 
   AUTH_ENDPOINT = "http://www.rememberthemilk.com/services/auth/"
   REST_ENDPOINT = "http://api.rememberthemilk.com/services/rest/"
@@ -63,8 +63,6 @@ module RTM
   #
   def self.milk (params={}) #:nodoc:
 
-    sleep 1
-
     endpoint = params.delete(:endpoint)
     endpoint = AUTH_ENDPOINT if endpoint == :auth
     endpoint = endpoint || REST_ENDPOINT

data/lib/milk_cap/rtm/data_normalization.rb

@@ -0,0 +1,44 @@
+module MilkCap::RTM
+
+  # Helper methods to normalize incoming data
+  module DataNormalization
+
+    # Converts various forms of tag lists into an Array of strings.
+    #
+    # +tags+ can be nil, a string of one or more comma separated tags, or an
+    # array.  Returns an array of stripped strings.
+    def normalize_tags_array(tags)
+      return [] if tags.nil?
+
+      if tags.kind_of? String
+        tags = tags.split(",")
+      end
+      return tags.map { |i| i.strip }
+    end
+
+    # Normalize data values returned in RTM's json 'tags' keys to an Array of strings.
+    #
+    # RTM returns the value for it's 'tags' key in a few formats:
+    #
+    # When there are no tags, an empty JSON array: []
+    #
+    # When there is one tag, a hash with "tag" key, set to a string for the tagname:
+    # { "tag": "tagname" }
+    #
+    # When there are multiple tags, a hash with "tag" key, set to a JSON array of strings:
+    # { "tag": ["tagname1", "tagname2"] }
+    #
+    def normalize_rtm_tags_hash(tags_hash)
+      if tags_hash.is_a?(Array)
+        tags_hash
+      else
+        if tags_hash['tag'].is_a?(Array)
+          tags_hash['tag']
+        else
+          [tags_hash['tag']]
+        end
+      end
+    end
+  end
+
+end

data/lib/milk_cap/rtm/resources.rb

@@ -33,20 +33,6 @@ module MilkCap::RTM
     def initialize (hsh)
 
       @hsh = hsh
-      @operations = []
-    end
-
-    # Saves the instance back to RTM.
-    #
-    def save!
-
-      # TODO : compact !
-
-      @operations.reverse.each do |method_name, args|
-
-        self.class.execute method_name, args
-      end
-      @operations = []
     end
 
     protected
@@ -94,12 +80,7 @@ module MilkCap::RTM
     #
     def self.timeline
 
-      @timeline ||= MilkCap::RTM.get_timeline
-    end
-
-    def queue_operation (method_name, args)
-
-      @operations << [ method_name, args ]
+      @@timeline ||= MilkCap::RTM.get_timeline
     end
   end
 
@@ -107,13 +88,14 @@ module MilkCap::RTM
   # The RTM Task class.
   #
   class Task < MilkResource
+    include DataNormalization
 
     def self.task_attr (*att_names) #:nodoc:
 
       att_names.each do |att_name|
         class_eval %{
           def #{att_name}
-            @hsh['task']['#{att_name}']
+            @task_hash['#{att_name}']
           end
         }
       end
@@ -145,17 +127,27 @@ module MilkCap::RTM
       :estimate,
       :due
 
-    def initialize (list_id, h)
-
-      super(h)
+    # Task series may have multiple tasks. task_hash used to specify which task
+    # in series.
+    def initialize (list_id, task_series_hash, task_hash)
 
-      t = h['task']
+      super(task_series_hash)
+      @task_hash = task_hash
 
       @list_id = list_id
-      @taskseries_id = h['id']
-      @task_id = t['id']
+      @taskseries_id = task_series_hash['id']
+      @task_id = @task_hash['id']
 
-      @tags = TagArray.new(self, h['tags'])
+      # Normalize the RTM structure and put it in TagArray
+      tags = normalize_rtm_tags_hash( task_series_hash['tags'] )
+      @tags = TagArray.new(self, tags)
+    end
+
+    def save!
+      if self.tags.dirty?
+        args = prepare_api_args.merge( tags: self.tags.join(",") )
+        self.class.execute('setTags', args)
+      end
     end
 
     # Deletes the task.
@@ -175,12 +167,8 @@ module MilkCap::RTM
     # Sets the tags for the task.
     #
     def tags= (tags)
-
-      tags = tags.split(',') if tags.is_a?(String)
-
-      @tags = TagArray.new(list_id, tags)
-
-      queue_operation('setTasks', tags.join(','))
+      @tags = TagArray.new(self, normalize_tags_array(tags))
+      @tags.dirty!
     end
 
     def self.find (params={})
@@ -196,7 +184,7 @@ module MilkCap::RTM
       args = {}
       args[:name] = name
       args[:list_id] = opts[:list_id] if opts[:list_id]
-      args[:timeline] = MilkCap::RTM.get_timeline
+      args[:timeline] = timeline
       args[:parse] = 1 unless !opts[:parse]
 
       h = execute('add', args)
@@ -237,9 +225,15 @@ module MilkCap::RTM
     end
 
     def self.parse_taskseries (list_id, o)
-
       o = [ o ] unless o.is_a?(Array)
-      o.collect { |s| self.new(list_id, s) }
+
+      # o is an array of taskseries.  Collect flattened array of tasks out of
+      # all taskseries
+      o.inject([]) do |m,s|
+        tasks = s['task']
+        tasks = [ tasks ] unless tasks.is_a?(Array)
+        m + tasks.collect { |t| self.new(list_id, s, t) }
+      end
     end
   end
 
@@ -271,54 +265,42 @@ module MilkCap::RTM
   class TagArray #:nodoc:
     include Enumerable
 
-    def initialize (task, tags)
+    # TODO introduce method to return state change between clean & dirty tags
+    # in order to use addTags or removeTags instead of just setTags.
 
-      @task = task
+    def initialize (task, tags)
+      @dirty = false
+      @prev = @tags = tags
+    end
 
-      @tags = if tags.is_a?(Array)
-        tags
-      else
-        tags['tag']
-      end
+    def dirty=(dirty_state)
+      @dirty = dirty_state
+      @prev = @tags if !dirty_state
     end
+    def dirty!; self.dirty=true; end
+    def dirty?; @dirty; end
 
     def << (tag)
-
       @tags << tag
-
-      args = prepare_api_args
-      args[:tags] = tag
-
-      @task.queue_operation('addTags', args)
+      self.dirty!
     end
 
     def delete (tag)
-
       @tags.delete tag
-
-      args = prepare_api_args
-      args[:tags] = tag
-
-      @task.queue_operation('removeTags', args)
+      self.dirty!
     end
 
     def clear
 
       @tags.clear
-
-      args = prepare_api_args
-      args[:tags] = ''
-
-      @task.queue_operation('setTags', args)
+      self.dirty!
     end
 
     def join (s)
-
       @tags.join(s)
     end
 
     def each
-
       @tags.each { |e| yield e }
     end
   end

data/lib/milk_cap/rtm.rb

@@ -22,4 +22,5 @@
 
 require 'milk_cap/rtm/base'
 require 'milk_cap/rtm/credentials'
+require 'milk_cap/rtm/data_normalization'
 require 'milk_cap/rtm/resources'

data/milk_cap.gemspec

@@ -2,15 +2,15 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: milk_cap 0.5.1 ruby lib
+# stub: milk_cap 0.5.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "milk_cap"
-  s.version = "0.5.1"
+  s.version = "0.5.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Jeff Leverenz"]
-  s.date = "2014-01-03"
+  s.date = "2014-03-06"
   s.description = "\n    Yet another RememberTheMilk wrapper, successor to rufus-rtm.\n  "
   s.email = "jeff.leverenz@gmail.com"
   s.extra_rdoc_files = [
@@ -26,28 +26,32 @@ Gem::Specification.new do |s|
     "lib/milk_cap/rtm.rb",
     "lib/milk_cap/rtm/base.rb",
     "lib/milk_cap/rtm/credentials.rb",
+    "lib/milk_cap/rtm/data_normalization.rb",
     "lib/milk_cap/rtm/resources.rb",
-    "milk_cap.gemspec",
-    "test/tasks_test.rb",
-    "test/test.rb"
+    "milk_cap.gemspec"
   ]
   s.homepage = "http://github.com/jleverenz/milk_cap/"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "2.1.11"
   s.summary = "Yet another RememberTheMilk wrapper, successor to rufus-rtm."
-  s.test_files = ["test/test.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
     else
       s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.14"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
     end
   else
     s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.14"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milk_cap
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - John Mettraux
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -25,6 +25,34 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 description: ! "\n    Yet another RememberTheMilk wrapper, successor to rufus-rtm.\n
   \ "
 email: jeff.leverenz@gmail.com
@@ -42,10 +70,9 @@ files:
 - lib/milk_cap/rtm.rb
 - lib/milk_cap/rtm/base.rb
 - lib/milk_cap/rtm/credentials.rb
+- lib/milk_cap/rtm/data_normalization.rb
 - lib/milk_cap/rtm/resources.rb
 - milk_cap.gemspec
-- test/tasks_test.rb
-- test/test.rb
 homepage: http://github.com/jleverenz/milk_cap/
 licenses:
 - MIT
@@ -70,5 +97,4 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Yet another RememberTheMilk wrapper, successor to rufus-rtm.
-test_files:
-- test/test.rb
+test_files: []

data/test/tasks_test.rb

@@ -1,113 +0,0 @@
-require 'rubygems'
-
-require 'test/unit'
-
-$: << File.dirname(__FILE__) + '/../lib'
-
-require 'milk_cap/rtm'
-
-include MilkCap::RTM
-
-
-class TasksTest < Test::Unit::TestCase
-
-  #def setup
-  #end
-
-  #def teardown
-  #end
-
-  def test_0
-
-    taskname = "milk the cow #{Time.now.to_i}"
-
-    t0 = Task.add!(taskname)
-
-    assert_kind_of Task, t0
-    assert_equal taskname, t0.name
-
-    ts = Task.find
-
-    #puts "tasks : #{ts.size}"
-
-    t1 = ts.find { |t| t.task_id == t0.task_id }
-    assert_equal taskname, t1.name
-    assert_equal '', t1.tags.join(',')
-
-    ts = Task.find :filter => "status:incomplete"
-
-    #puts "incomplete tasks : #{ts.size}"
-
-    t1 = ts.find { |t| t.task_id == t0.task_id }
-    assert_equal taskname, t1.name
-
-    t1.delete!
-
-    ts = Task.find :filter => "status:incomplete"
-
-    t1 = ts.find { |t| t.task_id == t0.task_id }
-    assert_nil t1
-  end
-
-  def test_1
-
-    lists = List.find
-    assert_not_nil(lists.find { |e| e.name == 'Inbox' })
-
-    work = lists.find { |e| e.name == 'Work' }
-
-    taskname = "more work #{Time.now.to_i}"
-
-    t0 = Task.add! taskname, :list_id => work.list_id
-
-    tasks = Task.find :list_id => work.list_id, :filer => 'status:incomplete'
-
-    assert_not_nil(tasks.find { |t| t.task_id == t0.task_id })
-
-    t0.complete!
-
-    tasks = Task.find :list_id => work.list_id, :filer => 'status:completed'
-    assert_not_nil(tasks.find { |t| t.task_id == t0.task_id })
-
-    t0.delete!
-  end
-
-  def test_2
-
-    key = ENV.delete('RTM_API_KEY')
-    secret = ENV.delete('RTM_SHARED_SECRET')
-
-    assert_raise RuntimeError do
-      lists = List.find
-    end
-
-    assert_not_nil List.find(:api_key => key, :shared_secret => secret)
-
-    ENV['RTM_API_KEY'] = key
-    ENV['RTM_SHARED_SECRET'] = secret
-  end
-
-  def test_smart_add
-    taskname = "more work #{Time.now.to_i}"
-    smart_add_string = "#{taskname} tomorrow"
-    task = Task.add! smart_add_string
-
-    tasks = Task.find
-
-    task_created = tasks.find { |t| t.task_id == task.task_id }
-    assert !task_created.due.empty?
-    assert_equal taskname, task_created.name  # 'tomorrow' is stripped as due date
-  end
-
-  def test_turn_smart_add_off
-    taskname = "more work #{Time.now.to_i} tomorrow"
-    task = Task.add! taskname, :parse => false
-
-    tasks = Task.find
-
-    task_created = tasks.find { |t| t.task_id == task.task_id }
-    assert task_created.due.empty?
-    assert_equal taskname, task_created.name
-  end
-
-end

data/test/test.rb

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