dobedobedo 0.0.2 → 0.0.3

data/README.md

@@ -1,15 +1,20 @@
 # Dobedobedo
 
-Dobedobedo is a Do.com client for ruby. It's in its early stages and currently supports basic crud on:
-* comments
-* projects
-* notes
-* tasks
-
-But does not currently support creation of:
-* workspaces
-* users
-* alerts
+## Key features:
+Objects are reflective of API results. Future field changes to the API are automatically accounted for.
+* Full CRUD to Projects
+* Full CRUD to Tasks
+* Full CRUD to Notes
+* Full CRUD to Comments
+* Full CRUD to Projects
+* Read access to Alerts
+* Read access to Workspaces
+* Read access to User
+* macRuby compatibility
+
+## Todo: i.e. Notable issues and limitations:
+* Nothing requiring the use of Client-Credential Grant type / Provisioning Scope is functional. Primarily this means you cannot create new workspaces, invite someone to a workspace, or Create a new user
+* Put/Update calls to Task resource are not fully reflective as full reflection of the object back to Do.com currently closes the task automatically.
 
 ## Installation
 
@@ -29,18 +34,33 @@ Or install it yourself as:
 
 Dobedobedo is modeled on the notion of establishing a secure connection and establishing model objects that reflect your do.com workspaces, projects, tasks, comments, etc. As such, usage is pretty simple.
 
-	require 'dobedobedo' # please do this with the bundler.
-	include Dobedobedo   # gives you access to the top level models.
-
-	connection = Dobedobedo::Connection.new(:client_id => 'Your Client Id', :client_secret => 'Your Client Secret', :username => 'Your Email Address', :password => 'Your Passsord Here')
-	workspace = connection.by_name('workspace name here') #by_name is an alias to find_workspace_by_name
-	projects = workspace.projects #array of Dobedobedo::Project objects reflecting each of the projects
-	projects.first.tasks #array of task objects from the first project in the workspace
-
-	task = projects.first.tasks.first
-	task.name = 'new name'
-	task.update
-	#updated task!
+```ruby
+require 'dobedobedo' # please do this with the bundler.
+include Dobedobedo   # gives you access to the top level models.
+
+#Dobedobedo does not use the web-flow for oAuth integration, instead relying on username and password, in 
+# conjunction with the oAuth client id / secret
+connection = Dobedobedo::Connection.new(:client_id => 'Your Client Id', 
+                                        :client_secret => 'Your Client Secret', 
+                                        :username => 'Your Email Address', 
+                                        :password => 'Your Passsord Here')
+#by_name is an alias to find_workspace_by_name
+workspace = connection.by_name('workspace name here') 
+
+#array of Dobedobedo::Project objects reflecting each of the projects
+projects = workspace.projects
+
+#array of task objects from the first project in the workspace
+projects.first.tasks # you could also use projects[2].tasks to get the tasks from the third project of the 
+		     # workspace selected above.
+
+#This will grab the first task of the first project of the workspace selected.
+task = projects.first.tasks.first
+task.name = 'new name' #give the task a new name
+task.description = 'this is a new description of awesomeness'
+task.closed = True #mark the task as done
+task.update
+```
 
 ## Contributing
 

data/lib/dobedobedo/project.rb

@@ -7,7 +7,7 @@ module Dobedobedo
     def initialize(token, workspace_id, h={})
       @token = token
       @workspace_id = workspace_id
-      if h.nil?
+      if h.nil? #if we're creating a new project object without a hash of data, hit the post resource to create an empty obj
         h = token.post("/workspaces/#{workspace_id}/projects").parsed
       end
       h.each do |k,v|
@@ -26,7 +26,7 @@ module Dobedobedo
     end
 
     def tasks
-      @token.get("/workspaces/#{@workspace_id}/projects/#{@id}/tasks").parsed.map {|t| Dobedobedo::Task.new(@token, @id, t)}
+      @token.get("/workspaces/#{@workspace_id}/projects/#{@id}/tasks").parsed.map {|t| Dobedobedo::Task.new(@token, @id, nil, t)}
     end
 
     def update()

data/lib/dobedobedo/version.rb

@@ -1,3 +1,3 @@
 module Dobedobedo
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/dobedobedo/workspace.rb

@@ -21,11 +21,11 @@ module Dobedobedo
     end
 
     def tasks
-      @token.get("/workspaces/#{@id}/tasks").parsed.map {|t| Dobedobedo::Task.new(@token, @id, t)}
+      @token.get("/workspaces/#{@id}/tasks/").parsed.map {|t| Dobedobedo::Task.new(@token, @id, nil, t)}
     end
 
     def notes
-      @token.get("/workspaces/#{@id}/notes").parsed.map {|n| Dobedobedo::Note.new(@token, n)}
+      @token.get("/workspaces/#{@id}/notes").parsed.map {|n| Dobedobedo::Note.new(@token, @id, n)}
     end
 
     def alerts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dobedobedo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2