asana 0.0.1 → 0.0.2

data/.gitignore

@@ -1,5 +1,7 @@
 *.gem
 *.rbc
+*.un~
+.DS_Store
 .bundle
 .config
 .yardoc
@@ -11,9 +13,8 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+spec/fixtures/cassettes
 spec/reports
 test/tmp
 test/version_tmp
 tmp
-.DS_Store
-*.un~

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  watch(%r|^lib/(.*/)?([^/]+)\.rb$|) { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|) { "spec" }
+  watch(%r|^spec/(.*)\/?(.*)_spec\.rb|)
+end

data/README.md

@@ -1,6 +1,10 @@
 # Asana
 
-TODO: Write a gem description
+This gem is a simple Ruby wrapper for the Asana REST API. It uses
+[ActiveResource][] to provide a simple, familiar interface for accessing
+your Asana account.
+
+To learn more, check out the [Asana API Documentation][].
 
 ## Installation
 
@@ -18,7 +22,140 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In order to access Asana, you need to provide your [API key][].
+
+
+```ruby
+Asana.configure do |client|
+  client.api_key = 'your_asana_api_key'
+end
+```
+
+As a sanity check, you can fetch the object representing your user.
+
+```ruby
+Asana::User.me
+```
+
+### [Users][]
+
+> A user object represents an account in Asana that can be given access to
+> various workspaces, projects, and tasks.
+> 
+> Like other objects in the system, users are referred to by numerical IDs.
+> However, the special string identifier me can be used anywhere a user ID is
+> accepted, to refer to the current authenticated user.
+
+**Note:** It is not possible to create, update, or delete a user from
+the API.
+
+```ruby
+# Get users from all of your workspaces
+users = Asana::User.all
+
+# Get a specific user
+user = Asana::User.find(:id)
+
+# Get the user associated with the API key being used
+user = Asana::User.me
+
+# Get all users in a given workspace
+workspace = Asana::Workspace.find(:workspace_id)
+users = workspace.users
+```
+
+### [Workspaces][]
+
+> A workspace is the most basic organizational unit in Asana. All projects
+> and tasks have an associated workspace.
+
+**Note:** It is not possible to create or delete a workspace from the API.
+
+```ruby
+# Get all workspaces
+workspaces = Asana::Workspace.all
+
+# Get a specific workspace
+workspace = Asana::Workspace.find(:id)
+
+# Get all projects in a given workspace
+projects = workspace.projects
+
+# Get all tasks in a given workspace and assigned to the given user
+tasks = workspace.tasks(:user_id)
+
+# Get all users with access to a given workspace
+users = workspace.users
+
+# Create a new task in a given workspace and assign it to the current user
+workspace.create_task(task_settings)
+```
+
+### [Projects][]
+
+> A project represents a prioritized list of tasks in Asana. It exists in a
+> single workspace and is accessible to a subset of users in that workspace
+> depending on its permissions.
+
+**Note:** It is not possible to create a project from the API.
+
+```ruby
+# Get all projects
+projects = Asana::Project.all
+
+# Get a specific project
+project = Asana::Project.find(:id)
+
+# Get all projects in a given workspace
+workspace = Asana::Workspace.find(:workspace_id)
+projects = workspace.projects
+```
+
+### [Tasks][]
+
+> The task is the basic object around which many operations in Asana are
+> centered. In the Asana application, multiple tasks populate the middle
+> pane according to some view parameters, and the set of selected tasks
+> determine the more detailed information presented in the details pane.
+
+```ruby
+# Get all tasks in a given project
+project = Asana::Project(:project_id)
+tasks = project.tasks
+
+# Get all tasks in a given workspace
+workspace = Asana::Workspace(:workspace_id)
+tasks = workspace.tasks
+
+# Get all stories for a given task
+task = tasks.first
+stories = task.stories
+
+# Create a new task in a given workspace and assign it to the current user
+workspace.create_task(task_settings)
+
+# Create a new story for the given task
+task.create_story(story_settings)
+```
+
+### [Stories][]
+
+> A story represents an activity associated with an object in the Asana
+> system. Stories are generated by the system whenever users take actions
+> such as creating or assigning tasks, or moving tasks between projects.
+> Comments are also a form of user-generated story.
+
+**Note:** It is not possible to update a story from the API.
+
+```ruby
+# Get all stories for a given task
+project = Asana::Project(:project_id)
+task = project.tasks.first
+stories = task.stories
+
+# Create a new story for the given task
+task.create_story(story_settings)
+```
 
 ## Contributing
 
@@ -27,3 +164,12 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+[API key]: http://app.asana.com/-/account_api
+[ActiveResource]: http://api.rubyonrails.org/classes/ActiveResource/Base.html
+[Asana API Documentation]: http://developer.asana.com/documentation/
+[Users]: http://developer.asana.com/documentation/#users
+[Workspaces]: http://developer.asana.com/documentation/#workspaces
+[Projects]: http://developer.asana.com/documentation/#projects
+[Tasks]: http://developer.asana.com/documentation/#tasks
+[Stories]: http://developer.asana.com/documentation/#stories

data/asana.gemspec

@@ -10,6 +10,12 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'activeresource', '~> 3.2.3'
 
+  gem.add_development_dependency 'growl', '~> 1.0.3'
+  gem.add_development_dependency 'guard-minitest', '~> 0.5.0'
+  gem.add_development_dependency 'minitest', '~> 2.12.1'
+  gem.add_development_dependency 'vcr', '~> 2.1.0'
+  gem.add_development_dependency 'webmock', '~> 1.8.6'
+
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/lib/asana/resource.rb

@@ -5,6 +5,15 @@ module Asana
       def check_prefix_options(options)
       end
 
+      def custom_method_collection_url(method_name, options = {})
+        prefix_options, query_options = split_options(options)
+        if method_name
+          "#{prefix(prefix_options)}#{collection_name}/#{method_name}.#{format.extension}#{query_string(query_options)}"
+        else
+          "#{prefix(prefix_options)}#{collection_name}.#{format.extension}#{query_string(query_options)}"
+        end
+      end
+
       def parent_resources(*resources)
         @parent_resources = resources
       end

data/lib/asana/resources/project.rb

@@ -6,5 +6,9 @@ module Asana
       parent_resources :workspace
       all(*args)
     end
+
+    def tasks
+      Task.all_by_project(:params => { :project_id => self.id })
+    end
   end
 end

data/lib/asana/resources/task.rb

@@ -13,5 +13,11 @@ module Asana
     def stories
       Story.all_by_task(:params => { :task_id => self.id })
     end
+
+    def create_story(*args)
+      story = Story.new
+      query_options = { :task => self.id }
+      Task.post("#{self.id}/stories", query_options.merge(args.first), story.to_json)
+    end
   end
 end

data/lib/asana/resources/user.rb

@@ -3,13 +3,13 @@ module Asana
     alias :save :method_not_allowed
     alias :destroy :method_not_allowed
 
-    def self.me
-      get(:me)
-    end
-
     def self.all_by_workspace(*args)
       parent_resources :workspace
       all(*args)
     end
+
+    def self.me
+      User.new(get(:me))
+    end
   end
 end

data/lib/asana/resources/workspace.rb

@@ -7,8 +7,15 @@ module Asana
       Project.all_by_workspace(:params => { :workspace_id => self.id })
     end
 
-    def tasks
-      Task.all_by_workspace(:params => { :workspace_id => self.id })
+    def tasks(assignee)
+      query_options = { :workspace => self.id, :assignee => assignee }
+      Task.all_by_workspace(:params => query_options)
+    end
+
+    def create_task(*args)
+      task = Task.new
+      query_options = { :workspace => self.id, :assignee => 'me' }
+      Task.post(nil, query_options.merge(args.first), task.to_json)
     end
 
     def users

data/lib/asana/version.rb

@@ -1,3 +1,3 @@
 module Asana
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/asana/resources/project_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+module Asana
+  describe Project do
+
+    before do
+      VCR.insert_cassette('projects', :record => :new_episodes)
+      Asana.configure do |c|
+        c.api_key = ENV['ASANA_API_KEY']
+      end
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe '.all' do
+      it 'should return all of the user\'s projects' do
+        projects = Project.all
+        projects.must_be_instance_of Array
+        projects.first.must_be_instance_of Project
+      end
+    end
+
+    describe '.all_by_workspace' do
+      it 'should return all projects for the given workspace' do
+        workspace = Workspace.all.first
+        projects = workspace.projects
+        projects.must_be_instance_of Array
+        projects.first.must_be_instance_of Project
+      end
+    end
+
+    describe '.create' do
+      it 'should raise an ActiveResource::MethodNotAllowed exception' do
+        project = Project.new
+        lambda { project.save }.must_raise ActiveResource::MethodNotAllowed
+      end
+    end
+
+    describe '#tasks' do
+      it 'should return all tasks for the given project' do
+        projects = Project.all.first
+        tasks = projects.tasks
+        tasks.must_be_instance_of Array
+        tasks.first.must_be_instance_of Task
+      end
+    end
+
+  end
+end

data/spec/asana/resources/story_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module Asana
+  describe Story do
+
+    before do
+      VCR.insert_cassette('stories', :record => :new_episodes)
+      Asana.configure do |c|
+        c.api_key = ENV['ASANA_API_KEY']
+      end
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe '#create_story' do
+      it 'should create a new story for the given task' do
+        task = Project.all.first.tasks.first
+        story = task.create_story(:text => 'foo')
+        story.must_be_instance_of Net::HTTPCreated
+      end
+    end
+
+    describe '#update' do
+      it 'should raise an ActiveResource::MethodNotAllowed exception' do
+        story = Project.all.first.tasks.first.stories.first
+        lambda { story.save }.must_raise ActiveResource::MethodNotAllowed
+      end
+    end
+
+  end
+end

data/spec/asana/resources/task_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module Asana
+  describe Task do
+
+    before do
+      VCR.insert_cassette('tasks', :record => :new_episodes)
+      Asana.configure do |c|
+        c.api_key = ENV['ASANA_API_KEY']
+      end
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe '#stories' do
+      it 'should return all stories for the given task' do
+        task = Project.all.first.tasks.first
+        stories = task.stories
+        stories.must_be_instance_of Array
+        stories.first.must_be_instance_of Story
+      end
+    end
+
+  end
+end

data/spec/asana/resources/user_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+module Asana
+  describe User do
+
+    before do
+      VCR.insert_cassette('users', :record => :new_episodes)
+      Asana.configure do |c|
+        c.api_key = ENV['ASANA_API_KEY']
+      end
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe '.all' do
+      it 'should return all users for all of the user\'s workspaces' do
+        users = User.all
+        users.must_be_instance_of Array
+        users.first.must_be_instance_of User
+      end
+    end
+
+    describe '.all_by_workspace' do
+      it 'should return all users for the given workspace' do
+        user = User.me
+        workspace = user.workspaces.first
+        users = workspace.users
+        users.must_be_instance_of Array
+        users.first.must_be_instance_of User
+      end
+    end
+
+    describe '.find' do
+      it 'should return the user with the given ID' do
+        user = User.me
+        user = User.find(user.id)
+        user.wont_be_nil
+        user.must_be_instance_of User
+      end
+    end
+
+    describe '.me' do
+      it 'should return the user associated with the given API key' do
+        user = User.me
+        user.wont_be_nil
+        user.must_be_instance_of User
+      end
+    end
+
+    describe '#save' do
+      it 'should raise an ActiveResource::MethodNotAllowed exception' do
+        user = User.me
+        lambda { user.save }.must_raise ActiveResource::MethodNotAllowed
+      end
+    end
+
+    describe '#update' do
+      it 'should raise an ActiveResource::MethodNotAllowed exception' do
+        user = User.me
+        lambda { user.update_attribute(:name, 'foo') }.must_raise ActiveResource::MethodNotAllowed
+      end
+    end
+
+    describe '#destroy' do
+      it 'should raise an ActiveResource::MethodNotAllowed exception' do
+        user = User.me
+        lambda { user.destroy }.must_raise ActiveResource::MethodNotAllowed
+      end
+    end
+
+  end
+end

data/spec/asana/resources/workspace_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+module Asana
+  describe Workspace do
+
+    before do
+      VCR.insert_cassette('workspaces', :record => :new_episodes)
+      Asana.configure do |c|
+        c.api_key = ENV['ASANA_API_KEY']
+      end
+    end
+
+    after do
+      VCR.eject_cassette
+    end
+
+    describe '.all' do
+      it 'should return all of the user\'s workspaces' do
+        workspaces = Workspace.all
+        workspaces.must_be_instance_of Array
+        workspaces.first.must_be_instance_of Workspace
+      end
+    end
+
+    describe '#create_task' do
+      it 'should create a new task for the given workspace' do
+        workspace = Workspace.all.first
+        task = workspace.create_task(:name => 'foo')
+        task.must_be_instance_of Net::HTTPCreated
+      end
+    end
+
+    describe '#projects' do
+      it 'should return all projects for the given workspace' do
+        workspace = Workspace.all.first
+        projects = workspace.projects
+        projects.must_be_instance_of Array
+        projects.first.must_be_instance_of Project
+      end
+    end
+
+    describe '#tasks' do
+      it 'should return all tasks for the given workspace' do
+        workspace = Workspace.all.first
+        user = User.all.first
+        tasks = workspace.tasks(user.id)
+        tasks.must_be_instance_of Array
+        tasks.first.must_be_instance_of Task
+      end
+    end
+
+    describe '#users' do
+      it 'should return all users for the given workspace' do
+        workspace = Workspace.all.first
+        users = workspace.users
+        users.must_be_instance_of Array
+        users.first.must_be_instance_of User
+      end
+    end
+
+    describe '#create' do
+      it 'should raise an ActiveResource::MethodNotAllowed exception' do
+        workspace = Workspace.new
+        lambda { workspace.save }.must_raise ActiveResource::MethodNotAllowed
+      end
+    end
+
+    describe '#destroy' do
+      it 'should raise an ActiveResource::MethodNotAllowed exception' do
+        workspace = Workspace.all.first
+        lambda { workspace.destroy }.must_raise ActiveResource::MethodNotAllowed
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'vcr'
+require 'asana'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/cassettes'
+  c.hook_into :webmock
+  c.filter_sensitive_data('<API_KEY>') { ENV['ASANA_API_KEY'] }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asana
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-19 00:00:00.000000000 Z
+date: 2012-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -27,6 +27,86 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.6
 description: Ruby wrapper for the Asana REST API
 email:
 - ryan@rbright.net
@@ -36,6 +116,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -49,6 +130,12 @@ files:
 - lib/asana/resources/user.rb
 - lib/asana/resources/workspace.rb
 - lib/asana/version.rb
+- spec/asana/resources/project_spec.rb
+- spec/asana/resources/story_spec.rb
+- spec/asana/resources/task_spec.rb
+- spec/asana/resources/user_spec.rb
+- spec/asana/resources/workspace_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/rbright/asana
 licenses: []
 post_install_message: 
@@ -73,5 +160,11 @@ rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Asana REST API
-test_files: []
+test_files:
+- spec/asana/resources/project_spec.rb
+- spec/asana/resources/story_spec.rb
+- spec/asana/resources/task_spec.rb
+- spec/asana/resources/user_spec.rb
+- spec/asana/resources/workspace_spec.rb
+- spec/spec_helper.rb
 has_rdoc: