ruby-wunderlist 0.3 → 0.4

data/lib/wunderlist/api.rb

@@ -31,8 +31,24 @@ require "wunderlist/list"
 require "wunderlist/task"
 
 module Wunderlist
+  ##
+  # The API class provides access to the Wunderlist API over HTTP.
   class API
-    attr_reader :domain, :path, :email, :session
+    ##
+    # Domain of the Wunderlist API
+    attr_reader :domain
+    
+    ##
+    # Path of the Wunderlist API
+    attr_reader :path
+    
+    ##
+    # Your email address from login
+    attr_reader :email
+    
+    ##
+    # Wunderlist Session ID
+    attr_reader :session
 
     def initialize(domain = "www.wunderlist.com", path = "/")
       @domain = domain
@@ -41,6 +57,8 @@ module Wunderlist
       @logged_in = false
     end
 
+    ##
+    # Request new session and connects it with your login credentials
     def login(email, password)
       get_session if @session == nil
       return true if @logged_in
@@ -54,25 +72,35 @@ module Wunderlist
       @logged_in
     end
 
+    ##
+    # Login with a session ID without login credentials
     def login_by_session(sessid)
       return if @logged_in
       @logged_in = true
       @session = sessid
     end
 
+    ##
+    # Delete internal list caching
     def flush
       @lists = nil
     end
 
+    ##
+    # Return all lists
     def lists
       @lists = load_lists if @lists == nil
       @lists
     end
 
+    ##
+    # Get INBOX list
     def inbox
       lists.values.detect { |list| list.inbox }
     end
 
+    ##
+    # Load and parse tasks from Wunderlist API
     def tasks(list)
       list_obj = list.is_a?(Wunderlist::List) ? list : lists[list]
       list = list.id if list.is_a? Wunderlist::List
@@ -99,10 +127,14 @@ module Wunderlist
       result
     end
 
+    ##
+    # Create new empty List
     def create_list(name)
       Wunderlist::List.new(name, false, self).save
     end
 
+    ##
+    # Save List or Task
     def save(obj)
       if obj.is_a? Wunderlist::List
         return save_list obj
@@ -111,6 +143,8 @@ module Wunderlist
       end
     end
 
+    ##
+    # Destroy List or Task
     def destroy(obj)
       if obj.is_a? Wunderlist::List
         return destroy_list obj

data/lib/wunderlist/list.rb

@@ -22,49 +22,68 @@
 # SOFTWARE.
 
 module Wunderlist
+  ##
+  # A FilterableList represents an array of Tasks and provides methods to
+  # filter the list by the tasks
   class FilterableList
+    ##
+    # Array of tasks
     attr_accessor :tasks
 
     def initialize(tasks = [])
       @tasks = tasks
     end
 
+    ##
+    # Get all tasks whose date is today
     def today
       FilterableList.new(tasks.clone.keep_if do |t|
         t.date == Date.today && !t.done
       end)
     end
 
+    ##
+    # Get all tasks which are important
     def priority
       FilterableList.new(tasks.clone.keep_if do |t|
         t.important && !t.done
       end)
     end
 
+    ##
+    # Get all tasks which are not important
     def not_priority
       FilterableList.new(tasks.clone.keep_if do |t|
         !t.important && !t.done
       end)
     end
 
+    ##
+    # Get all done tasks
     def done
       FilterableList.new(tasks.clone.keep_if do |t|
         t.done == true
       end)
     end
 
+    ##
+    # Get all non-done tasks
     def not_done
       FilterableList.new(tasks.clone.keep_if do |t|
         t.done != true
       end)
     end
 
+    ##
+    # Get all overdue tasks
     def overdue
       FilterableList.new(tasks.clone.keep_if do |t|
         t.date && t.date < Date.today && !t.done
       end)
     end
 
+    ##
+    # Get all non-overdue tasks
     def not_overdue
       FilterableList.new(tasks.clone.keep_if do |t|
         (!t.date || t.date < Date.today) && !t.done
@@ -83,8 +102,28 @@ module Wunderlist
     end
   end
 
+  ##
+  # A List is a FilterableList which can be synchronized with an API object
   class List < FilterableList
-    attr_accessor :id, :name, :inbox, :shared, :api
+    ##
+    # ID of the list on the Wunderlist server
+    attr_accessor :id
+
+    ##
+    # Name of the list
+    attr_accessor :name
+
+    ##
+    # Value which determines whether this list is a INBOX or or not
+    attr_accessor :inbox
+
+    ##
+    # true, if list is shared, otherwise false
+    attr_accessor :shared
+
+    ##
+    # Reference to the associated API object. Necessary for many methods.
+    attr_accessor :api
 
     def initialize(name = nil, inbox = nil, api = nil)
       @name = name
@@ -92,25 +131,35 @@ module Wunderlist
       @api = api
     end
     
+    ##
+    # Get all tasks
     def tasks
       @tasks = @api.tasks self if @tasks == nil
       @tasks
     end
 
+    ##
+    # Create task with specified name and date
     def create_task(name, date = nil)
       Wunderlist::Task.new(name, date, self, @api).save
     end
 
+    ##
+    # Save list with api
     def save(api = nil)
       @api ||= api
       @api.save(self)
     end
 
+    ##
+    # Destroy list with api
     def destroy(api = nil)
       @api ||= api
       @api.destroy(self)
     end
 
+    ##
+    # Remove tasks cache
     def flush
       @tasks = nil
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-wunderlist
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000 Z
+date: 2012-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &13927660 !ruby/object:Gem::Requirement
+  requirement: &16374580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13927660
+  version_requirements: *16374580
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &13926500 !ruby/object:Gem::Requirement
+  requirement: &16372620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13926500
+  version_requirements: *16372620
 description: 
 email: fritz+wunderlist@grimpen.net
 executables: []
@@ -40,9 +40,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/wunderlist.rb
-- lib/wunderlist/list.rb
 - lib/wunderlist/task.rb
 - lib/wunderlist/api.rb
+- lib/wunderlist/list.rb
 homepage: http://grimpen.net/wunderlist
 licenses:
 - MIT
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: Wunderlist Bindings for Ruby