asana 0.0.6 → 0.1.1

data/lib/asana/resources/response_helper.rb

@@ -0,0 +1,14 @@
+module Asana
+  module Resources
+    # Internal: A helper to make response body parsing easier.
+    module ResponseHelper
+      def parse(response)
+        data = response.body.fetch('data') do
+          fail("Unexpected response body: #{response.body}")
+        end
+        extra = response.body.reject { |k, _| k == 'data' }
+        [data, extra]
+      end
+    end
+  end
+end

data/lib/asana/resources/story.rb

@@ -1,13 +1,64 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
 module Asana
-  class Story < Asana::Resource
+  module Resources
+    # 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.
+    #
+    # Stories are a form of history in the system, and as such they are read-only.
+    # Once generated, it is not possible to modify a story.
+    class Story < Resource
 
-    alias :destroy :method_not_allowed
-    alias :update :method_not_allowed
 
-    def self.all_by_task(*args)
-      parent_resources :task
-      all(*args)
-    end
+      attr_reader :id
+
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'stories'
+        end
+
+        # Returns the full record for a single story.
+        #
+        # id - [Id] Globally unique identifier for the team.
+        #
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
 
+          self.new(parse(client.get("/stories/#{id}", options: options)).first, client: client)
+        end
+
+        # Returns the compact records for all stories on the task.
+        #
+        # task - [Id] Globally unique identifier for the task.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_task(client, task: required("task"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/tasks/#{task}/stories", params: params, options: options)), type: self, client: client)
+        end
+
+        # Adds a comment to a task. The comment will be authored by the
+        # currently authenticated user, and timestamped when the server receives
+        # the request.
+        #
+        # Returns the full record for the new story added to the task.
+        #
+        # task - [Id] Globally unique identifier for the task.
+        #
+        # text - [String] The plain text of the comment to add.
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create_on_task(client, task: required("task"), text: required("text"), options: {}, **data)
+          with_params = data.merge(text: text).reject { |_,v| v.nil? || Array(v).empty? }
+          self.new(parse(client.post("/tasks/#{task}/stories", body: with_params, options: options)).first, client: client)
+        end
+      end
+
+    end
   end
 end

data/lib/asana/resources/tag.rb

@@ -1,28 +1,120 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
 module Asana
-  class Tag < Asana::Resource
+  module Resources
+    # A _tag_ is a label that can be attached to any task in Asana. It exists in a
+    # single workspace or organization.
+    #
+    # Tags have some metadata associated with them, but it is possible that we will
+    # simplify them in the future so it is not encouraged to rely too heavily on it.
+    # Unlike projects, tags do not provide any ordering on the tasks they
+    # are associated with.
+    class Tag < Resource
 
-    alias :create :method_not_allowed
-    alias :destroy :method_not_allowed
 
-    def self.all_by_task(*args)
-      parent_resources :task
-      all(*args)
-    end
+      attr_reader :id
 
-    def self.all_by_workspace(*args)
-      parent_resources :workspace
-      all(*args)
-    end
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'tags'
+        end
 
-    def tasks
-      Task.all_by_tag(:params => { :tag_id => self.id })
-    end
+        # Creates a new tag in a workspace or organization.
+        #
+        # Every tag is required to be created in a specific workspace or
+        # organization, and this cannot be changed once set. Note that you can use
+        # the `workspace` parameter regardless of whether or not it is an
+        # organization.
+        #
+        # Returns the full record of the newly created tag.
+        #
+        # workspace - [Id] The workspace or organization to create the tag in.
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create(client, workspace: required("workspace"), options: {}, **data)
+          with_params = data.merge(workspace: workspace).reject { |_,v| v.nil? || Array(v).empty? }
+          self.new(parse(client.post("/tags", body: with_params, options: options)).first, client: client)
+        end
 
-    def modify(modified_fields)
-      resource = Resource.new(modified_fields)
-      response = Tag.put(self.id, nil, resource.to_json)
-      Tag.new(connection.format.decode(response.body))
-    end
+        # Creates a new tag in a workspace or organization.
+        #
+        # Every tag is required to be created in a specific workspace or
+        # organization, and this cannot be changed once set. Note that you can use
+        # the `workspace` parameter regardless of whether or not it is an
+        # organization.
+        #
+        # Returns the full record of the newly created tag.
+        #
+        # workspace - [Id] The workspace or organization to create the tag in.
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create_in_workspace(client, workspace: required("workspace"), options: {}, **data)
+
+          self.new(parse(client.post("/workspaces/#{workspace}/tags", body: data, options: options)).first, client: client)
+        end
+
+        # Returns the complete tag record for a single tag.
+        #
+        # id - [Id] The tag to get.
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
+
+          self.new(parse(client.get("/tags/#{id}", options: options)).first, client: client)
+        end
 
+        # Returns the compact tag records for some filtered set of tags.
+        # Use one or more of the parameters provided to filter the tags returned.
+        #
+        # workspace - [Id] The workspace or organization to filter tags on.
+        # team - [Id] The team to filter tags on.
+        # archived - [Boolean] Only return tags whose `archived` field takes on the value of
+        # this parameter.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_all(client, workspace: nil, team: nil, archived: nil, per_page: 20, options: {})
+          params = { workspace: workspace, team: team, archived: archived, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/tags", params: params, options: options)), type: self, client: client)
+        end
+
+        # Returns the compact tag records for all tags in the workspace.
+        #
+        # workspace - [Id] The workspace or organization to find tags in.
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_workspace(client, workspace: required("workspace"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/workspaces/#{workspace}/tags", params: params, options: options)), type: self, client: client)
+        end
+      end
+
+      # Updates the properties of a tag. Only the fields provided in the `data`
+      # block will be updated; any unspecified fields will remain unchanged.
+      #
+      # When using this method, it is best to specify only those fields you wish
+      # to change, or else you may overwrite changes made by another user since
+      # you last retrieved the task.
+      #
+      # Returns the complete updated tag record.
+      #
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def update(options: {}, **data)
+
+        refresh_with(parse(client.put("/tags/#{id}", body: data, options: options)).first)
+      end
+
+      # A specific, existing tag can be deleted by making a DELETE request
+      # on the URL for that tag.
+      #
+      # Returns an empty data record.
+      def delete()
+
+        client.delete("/tags/#{id}") && true
+      end
+
+    end
   end
 end

data/lib/asana/resources/task.rb

@@ -1,73 +1,300 @@
+### WARNING: This file is auto-generated by the asana-api-meta repo. Do not
+### edit it manually.
+
 module Asana
-  class Task < Asana::Resource
+  module Resources
+    # 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 determines
+    # the more detailed information presented in the details pane.
+    class Task < Resource
 
-    def self.all_by_project(*args)
-      parent_resources :project
-      all(*args)
-    end
+      include AttachmentUploading
 
-    def self.all_by_tag(*args)
-      parent_resources :tag
-      all(*args)
-    end
+      include EventSubscription
 
-    def self.all_by_workspace(*args)
-      parent_resources :workspace
-      all(*args)
-    end
 
-    def modify(modified_fields)
-      resource = Resource.new(modified_fields)
-      response = Task.put(self.id, nil, resource.to_json)
-      Task.new(connection.format.decode(response.body))
-    end
+      attr_reader :assignee
 
-    def projects
-      Project.all_by_task(:params => { :task_id => self.id })
-    end
+      attr_reader :assignee_status
 
-    def tags
-      Tag.all_by_task(:params => { :task_id => self.id })
-    end
+      class << self
+        # Returns the plural name of the resource.
+        def plural_name
+          'tasks'
+        end
 
-    def add_project(project_id)
-      path = "#{self.id}/addProject"
-      resource = Resource.new({:project => project_id})
-      Task.post(path, nil, resource.to_json)
-      self
-    end
+        # Creating a new task is as easy as POSTing to the `/tasks` endpoint
+        # with a data block containing the fields you'd like to set on the task.
+        # Any unspecified fields will take on default values.
+        #
+        # Every task is required to be created in a specific workspace, and this
+        # workspace cannot be changed once set. The workspace need not be set
+        # explicitly if you specify a `project` or a `parent` task instead.
+        #
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create(client, options: {}, **data)
 
-    def add_tag(tag_id)
-      path = "#{self.id}/addTag"
-      resource = Resource.new({:tag => tag_id})
-      Task.post(path, nil, resource.to_json)
-      self
-    end
+          self.new(parse(client.post("/tasks", body: data, options: options)).first, client: client)
+        end
 
-    def create_story(*args)
-      path = "#{self.id}/stories"
-      options = { :task => self.id }
-      story = Story.new(options.merge(args.first))
-      response = Task.post(path, nil, story.to_json)
-      Story.new(connection.format.decode(response.body))
-    end
+        # Creating a new task is as easy as POSTing to the `/tasks` endpoint
+        # with a data block containing the fields you'd like to set on the task.
+        # Any unspecified fields will take on default values.
+        #
+        # Every task is required to be created in a specific workspace, and this
+        # workspace cannot be changed once set. The workspace need not be set
+        # explicitly if you specify a project or a parent task instead.
+        #
+        # workspace - [Id] The workspace to create a task in.
+        # options - [Hash] the request I/O options.
+        # data - [Hash] the attributes to post.
+        def create_in_workspace(client, workspace: required("workspace"), options: {}, **data)
 
-    def stories
-      Story.all_by_task(:params => { :task_id => self.id })
-    end
+          self.new(parse(client.post("/workspaces/#{workspace}/tasks", body: data, options: options)).first, client: client)
+        end
 
-    def create_subtask(*args)
-      path = "#{self.id}/subtasks"
-      options = { :task => self.id }
-      task = Task.new(options.merge(args.first))
-      response = Task.post(path, nil, task.to_json)
-      Task.new(connection.format.decode(response.body).merge parent: self)
-    end
+        # Returns the complete task record for a single task.
+        #
+        # id - [Id] The task to get.
+        # options - [Hash] the request I/O options.
+        def find_by_id(client, id, options: {})
 
-    def subtasks
-      path = "#{self.id}/subtasks"
-      Task.get(path, nil).map { |subtask| Task.new(subtask.merge(parent: self)) }
-    end
+          self.new(parse(client.get("/tasks/#{id}", options: options)).first, client: client)
+        end
+
+        # Returns the compact task records for all tasks within the given project,
+        # ordered by their priority within the project.
+        #
+        # projectId - [Id] The project in which to search for tasks.
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_project(client, projectId: required("projectId"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/projects/#{projectId}/tasks", params: params, options: options)), type: self, client: client)
+        end
+
+        # Returns the compact task records for all tasks with the given tag.
+        #
+        # tag - [Id] The tag in which to search for tasks.
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        def find_by_tag(client, tag: required("tag"), per_page: 20, options: {})
+          params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/tags/#{tag}/tasks", params: params, options: options)), type: self, client: client)
+        end
+
+        # Returns the compact task records for some filtered set of tasks. Use one
+        # or more of the parameters provided to filter the tasks returned.
+        #
+        # assignee - [Id] The assignee to filter tasks on.
+        # workspace - [Id] The workspace or organization to filter tasks on.
+        # completed_since - [String] Only return tasks that are either incomplete or that have been
+        # completed since this time.
+        #
+        # modified_since - [String] Only return tasks that have been modified since the given time.
+        #
+        # per_page - [Integer] the number of records to fetch per page.
+        # options - [Hash] the request I/O options.
+        # Notes:
+        #
+        # If you specify `assignee`, you must also specify the `workspace` to filter on.
+        #
+        # If you specify `workspace`, you must also specify the `assignee` to filter on.
+        #
+        # A task is considered "modified" if any of its properties change,
+        # or associations between it and other objects are modified (e.g.
+        # a task being added to a project). A task is not considered modified
+        # just because another object it is associated with (e.g. a subtask)
+        # is modified. Actions that count as modifying the task include
+        # assigning, renaming, completing, and adding stories.
+        def find_all(client, assignee: nil, workspace: nil, completed_since: nil, modified_since: nil, per_page: 20, options: {})
+          params = { assignee: assignee, workspace: workspace, completed_since: completed_since, modified_since: modified_since, limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+          Collection.new(parse(client.get("/tasks", params: params, options: options)), type: self, client: client)
+        end
+      end
+
+      # A specific, existing task can be updated by making a PUT request on the
+      # URL for that task. Only the fields provided in the `data` block will be
+      # updated; any unspecified fields will remain unchanged.
+      #
+      # When using this method, it is best to specify only those fields you wish
+      # to change, or else you may overwrite changes made by another user since
+      # you last retrieved the task.
+      #
+      # Returns the complete updated task record.
+      #
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def update(options: {}, **data)
 
+        refresh_with(parse(client.put("/tasks/#{id}", body: data, options: options)).first)
+      end
+
+      # A specific, existing task can be deleted by making a DELETE request on the
+      # URL for that task. Deleted tasks go into the "trash" of the user making
+      # the delete request. Tasks can be recovered from the trash within a period
+      # of 30 days; afterward they are completely removed from the system.
+      #
+      # Returns an empty data record.
+      def delete()
+
+        client.delete("/tasks/#{id}") && true
+      end
+
+      # Adds each of the specified followers to the task, if they are not already
+      # following. Returns the complete, updated record for the affected task.
+      #
+      # followers - [Array] An array of followers to add to the task.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def add_followers(followers: required("followers"), options: {}, **data)
+        with_params = data.merge(followers: followers).reject { |_,v| v.nil? || Array(v).empty? }
+        refresh_with(parse(client.post("/tasks/#{id}/addFollowers", body: with_params, options: options)).first)
+      end
+
+      # Removes each of the specified followers from the task if they are
+      # following. Returns the complete, updated record for the affected task.
+      #
+      # followers - [Array] An array of followers to remove from the task.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def remove_followers(followers: required("followers"), options: {}, **data)
+        with_params = data.merge(followers: followers).reject { |_,v| v.nil? || Array(v).empty? }
+        refresh_with(parse(client.post("/tasks/#{id}/removeFollowers", body: with_params, options: options)).first)
+      end
+
+      # Returns a compact representation of all of the projects the task is in.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def projects(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/tasks/#{id}/projects", params: params, options: options)), type: Project, client: client)
+      end
+
+      # Adds the task to the specified project, in the optional location
+      # specified. If no location arguments are given, the task will be added to
+      # the beginning of the project.
+      #
+      # `addProject` can also be used to reorder a task within a project that
+      # already contains it.
+      #
+      # Returns an empty data block.
+      #
+      # project - [Id] The project to add the task to.
+      # insertAfter - [Id] A task in the project to insert the task after, or `null` to
+      # insert at the beginning of the list.
+      #
+      # insertBefore - [Id] A task in the project to insert the task before, or `null` to
+      # insert at the end of the list.
+      #
+      # section - [Id] A section in the project to insert the task into. The task will be
+      # inserted at the top of the section.
+      #
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def add_project(project: required("project"), insertAfter: nil, insertBefore: nil, section: nil, options: {}, **data)
+        with_params = data.merge(project: project, insertAfter: insertAfter, insertBefore: insertBefore, section: section).reject { |_,v| v.nil? || Array(v).empty? }
+        client.post("/tasks/#{id}/addProject", body: with_params, options: options) && true
+      end
+
+      # Removes the task from the specified project. The task will still exist
+      # in the system, but it will not be in the project anymore.
+      #
+      # Returns an empty data block.
+      #
+      # project - [Id] The project to remove the task from.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def remove_project(project: required("project"), options: {}, **data)
+        with_params = data.merge(project: project).reject { |_,v| v.nil? || Array(v).empty? }
+        client.post("/tasks/#{id}/removeProject", body: with_params, options: options) && true
+      end
+
+      # Returns a compact representation of all of the tags the task has.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def tags(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/tasks/#{id}/tags", params: params, options: options)), type: Tag, client: client)
+      end
+
+      # Adds a tag to a task. Returns an empty data block.
+      #
+      # tag - [Id] The tag to add to the task.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def add_tag(tag: required("tag"), options: {}, **data)
+        with_params = data.merge(tag: tag).reject { |_,v| v.nil? || Array(v).empty? }
+        client.post("/tasks/#{id}/addTag", body: with_params, options: options) && true
+      end
+
+      # Removes a tag from the task. Returns an empty data block.
+      #
+      # tag - [Id] The tag to remove from the task.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def remove_tag(tag: required("tag"), options: {}, **data)
+        with_params = data.merge(tag: tag).reject { |_,v| v.nil? || Array(v).empty? }
+        client.post("/tasks/#{id}/removeTag", body: with_params, options: options) && true
+      end
+
+      # Returns a compact representation of all of the subtasks of a task.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def subtasks(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/tasks/#{id}/subtasks", params: params, options: options)), type: self.class, client: client)
+      end
+
+      # Makes an existing task a subtask of another. Returns an empty data block.
+      #
+      # subtask - [Id] The subtask to add to the task.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def add_subtask(subtask: required("subtask"), options: {}, **data)
+        with_params = data.merge(subtask: subtask).reject { |_,v| v.nil? || Array(v).empty? }
+        client.post("/tasks/#{id}/subtasks", body: with_params, options: options) && true
+      end
+
+      # Changes the parent of a task. Each task may only be a subtask of a single
+      # parent, or no parent task at all. Returns an empty data block.
+      #
+      # parent - [Id] The new parent of the task, or `null` for no parent.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def set_parent(parent: required("parent"), options: {}, **data)
+        with_params = data.merge(parent: parent).reject { |_,v| v.nil? || Array(v).empty? }
+        client.post("/tasks/#{id}/setParent", body: with_params, options: options) && true
+      end
+
+      # Returns a compact representation of all of the stories on the task.
+      #
+      # per_page - [Integer] the number of records to fetch per page.
+      # options - [Hash] the request I/O options.
+      def stories(per_page: 20, options: {})
+        params = { limit: per_page }.reject { |_,v| v.nil? || Array(v).empty? }
+        Collection.new(parse(client.get("/tasks/#{id}/stories", params: params, options: options)), type: Story, client: client)
+      end
+
+      # Adds a comment to a task. The comment will be authored by the
+      # currently authenticated user, and timestamped when the server receives
+      # the request.
+      #
+      # Returns the full record for the new story added to the task.
+      #
+      # text - [String] The plain text of the comment to add.
+      # options - [Hash] the request I/O options.
+      # data - [Hash] the attributes to post.
+      def add_comment(text: required("text"), options: {}, **data)
+        with_params = data.merge(text: text).reject { |_,v| v.nil? || Array(v).empty? }
+        Story.new(parse(client.post("/tasks/#{id}/stories", body: with_params, options: options)).first, client: client)
+      end
+
+    end
   end
 end