things-client 0.2.0 → 0.2.1

data/README.textile

@@ -0,0 +1,49 @@
+*things-client* is a ruby-base client for API of the popular GTD app Things, available on the Mac.
+
+h2. Requirements
+
+To use *things-client* you need Things which is version 1.2.0 or greater.
+
+h2. Installation
+
+The gem is hosted on Gemcutter. To install it, use the following command:
+
+bc. sudo gem install things-client --source http://gemcutter.org
+  
+To get the latest version, clone the gem from github and run rake install:
+
+bc. git clone http://github.com/marcinbunsch/things-client
+cd things-client
+rake check_dependencies:runtime
+sudo rake install
+
+h2. Usage
+
+Before using this gem you must require it by calling:
+
+bc. require 'things'
+
+From then on you can manipulate Todos, Projects, Areas, Tags, People and Lists, like this:
+
+bc. todo = Things::Todo.create(:name => 'Take out the garbage')
+todo.name = 'Take out the garbage and old boxes'  
+todo.save
+
+For more information, see the wiki at "http://wiki.github.com/marcinbunsch/things-client/":http://wiki.github.com/marcinbunsch/things-client/
+
+h2. Contribution
+
+You're more than welcome to fork and improve this gem. Usual rules:
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request.
+
+h2. Copyright
+
+Copyright (c) 2010 Marcin Bunsch. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/things/area.rb

@@ -8,6 +8,12 @@ module Things
     # collection is used for findings
     collection :areas
    
+    class << self
+      def all
+        convert(Things::App.instance.areas.get)
+      end
+    end
+   
     def todos
       Things::Todo.convert(reference.todos.get)
     end

data/lib/things/person.rb

@@ -10,13 +10,16 @@ module Things
     # collection is used for findings
     collection :people
     
-    # Find a Person in Address Book and add a teammate in Things
-    #
-    # Returns a Things::Person object
-    def self.create(address_book_name)
-      reference = Things::App.instance.add_teammate_named(address_book_name)
-      raise 'Could not find person in Address Book' if reference == :missing_value
-      build(reference)
+    class << self
+      # Find a Person in Address Book and add a teammate in Things
+      #
+      # Returns a Things::Person object
+      def self.create(address_book_name)
+        reference = Things::App.instance.add_teammate_named(address_book_name)
+        raise 'Could not find person in Address Book' if reference == :missing_value
+        build(reference)
+      end
+
     end
     
     def todos
@@ -30,9 +33,7 @@ module Things
       raise 'Currently Things does not support this method'
     end
     
-    # Not supported by Things::Person
-    # 
-    # Raises a RuntimeError when called
+    # Deletes a Person
     def delete
       reference.delete
     end

data/lib/things/project.rb

@@ -8,6 +8,12 @@ module Things
     # collection is used for findings
     collection :projects
    
+    class << self
+      def all
+        convert(Things::App.instance.projects.get)
+      end
+    end
+    
     def todos
       Things::Todo.convert(reference.todos.get)
     end

data/lib/things/reference/record.rb

@@ -101,6 +101,11 @@ module Things
         todo.reference = reference
         todo
       end
+      
+      # Converts a collection of reference into a collection of objects
+      def self.convert(references)
+        references.to_a.collect { |todo| build(todo) }
+      end
 
       # find a todo by a name or id
       #

data/lib/things/tag.rb

@@ -8,5 +8,11 @@ module Things
     # collection is used for findings
     collection :tags
    
+    class << self
+      def all
+        convert(Things::App.instance.tags.get)
+      end
+    end
+    
   end
 end

data/lib/things/todo.rb

@@ -63,11 +63,6 @@ module Things
         Things::App.instance.todos
       end
       
-      # Converts a collection of reference into a collection of objects
-      def convert(references)
-        references.to_a.collect { |todo| build(todo) }
-      end
-      
       # these are references and should be stored somewhere else...
       Things::List::DEFAULTS.each do |list|
         class_eval <<-"eval"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: things-client
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Marcin Bunsch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-23 00:00:00 +01:00
+date: 2010-02-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -40,12 +40,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.textile
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - lib/appscript/reference.rb

data/README.rdoc

@@ -1,121 +0,0 @@
-= Things
-
-Things is a Ruby API for the popular GTD app Things, available on the Mac.
-
-== Installation
-
-The gem is hosted on Gemcutter. To install it, use the following command:
-
-  sudo gem install things-client --source http://gemcutter.org
-  
-To get the latest version, clone the gem from github and run rake install:
-
-  git clone http://github.com/marcinbunsch/things-client
-  cd things-client
-  rake check_dependencies:runtime
-  sudo rake install
-
-== Usage
-
-Before using this gem you must require it by calling:
-
-  require 'things'
-
-=== Application
-
-The Application can be accessed at all times by calling Things::App. It has a few useful methods which will be described below. If you want Things to gain focus and move to the front of the window stack, you can call the Things::App.activate method.
-
-=== Todos
-
-Todos are accessed via the Things::Todo class.
-
-==== Create
-
-If you want to create a new Todo, you simple create a new instance of the Things::Todo class, supplying the parameters:
-
-  Things::Todo.new(:name => 'Take out the garbage')
-
-When you're ready to send it to Things, simply call the save method on the instance:
-
-  todo = Things::Todo.new(:name => 'Take out the garbage')
-  todo.save # the Todo will appear in the Inbox
-  
-If you want to send the Todo to Things during the instantiation process, simply call create:
-
-  Things::Todo.create(:name => 'Take out the garbage') # the Todo will appear in the Inbox
-
-==== Read
-
-===== Collections
-
-If you want to fetch a list of todos, there is a set of collections you can use.
-
-The largest one is the collection of all Todos. You fetch it by calling:
- 
-   Things::App.todos
-   
-It will return an array of Things::Todo instances.
-
-If you only want the active (so non-finished) Todos, you can fetch a collection by calling:
-
-  Things::App.todos.active
-  
-It will return an array of Things::Todo instances.
-
-As the gem will grow, more methods will follow.
-
-===== Single Todos
-
-Things::Todo has a few useful methods if you want to fetch a single Todo.
-
-The smartest is the Things::Todo.find method, which will accept either a name or an id.
-
-  Things::Todo.find('Take out the garbage') # => #<Things::Todo:0x115dd84>
-  Things::Todo.find('11111111-1111-1111-1111-111111111111') # => #<Things::Todo:0x115dd84>
-
-If you want a more targeted approach, you can use Things::Todo.find_by_name or Things::Todo.find_by_id
-
-==== Update
-
-To update a Todo, you need to fetch it, change the desired properties and save it. The following example illustrates this:
-
-  todo = Things::Todo.find('Take out the garbage') # => #<Things::Todo:0x115dd84>
-  todo.name = 'Take out the garbage and old boxes'  
-  todo.save
-
-When you open up a Things window, you'll notice that the name has changed.
-
-==== Delete
-
-To delete a todo, simply call the delete method. The Todo will bo moved to Trash.
-
-  todo = Things::Todo.find('Take out the garbage') # => #<Things::Todo:0x115dd84>
-  todo.delete
-
-== Roadmap
-
-Currently Todos are fully supported, which is the core functionality of Todos, but leaves a lot of room for improvement. The first step is to create a unified API for handling AppleScript objects which behave in a similar way.
-
-Planned features:
-
-* Support for Projects
-* Support for Areas
-* Support for Tags
-* Support for Scheduled Todos
-
-== Contribution
-
-You're more than welcome to fork and improve this gem. Usual rules:
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-  bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request.
-
-== Copyright
-
-Copyright (c) 2010 Marcin Bunsch. See LICENSE for details.