basecamp3 0.1.3

data/lib/basecamp3/models/question_answer.rb

@@ -0,0 +1,35 @@
+# A model for Basecamp's Question Answer
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/question_answers.md#question-answers For more information, see the official Basecamp3 API documentation for Question Answers}
+class Basecamp3::QuestionAnswer < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :content,
+                :group_on
+
+  # Returns a paginated list of answers.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::QuestionAnswer>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/questions/#{parent_id}/answers", params, Basecamp3::QuestionAnswer)
+  end
+
+  # Returns the answer.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the question
+  #
+  # @return [Basecamp3::QuestionAnswer]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/question_answers/#{id}", {}, Basecamp3::QuestionAnswer)
+  end
+end

data/lib/basecamp3/models/questionnaire.rb

@@ -0,0 +1,31 @@
+# A model for Basecamp's Questionnaire
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/questionnaires.md#questionnaires For more information, see the official Basecamp3 API documentation for Questionnaires}
+class Basecamp3::Questionnaire < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :name,
+                :questions_count
+
+  # Returns a list of related questions.
+  #
+  # @return [Array<Basecamp3::Question>]
+  def questions
+    @mapped_questions ||= Basecamp3::Question.all(bucket.id, id)
+  end
+
+  # Returns the questionnaire.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the questionnaire
+  #
+  # @return [Basecamp3::Questionnaire]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/questionnaires/#{id}", {}, Basecamp3::Questionnaire)
+  end
+end

data/lib/basecamp3/models/schedule.rb

@@ -0,0 +1,31 @@
+# A model for Basecamp's Schedule
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/schedules.md#schedules For more information, see the official Basecamp3 API documentation for Schedules}
+class Basecamp3::Schedule < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :title,
+                :entries_count
+
+  # Returns a list of related entries.
+  #
+  # @return [Array<Basecamp3::ScheduleEntry>]
+  def entries
+    @mapped_entries ||= Basecamp3::ScheduleEntry.all(bucket.id, id)
+  end
+
+  # Returns the schedule.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the schedule
+  #
+  # @return [Basecamp3::Schedule]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/schedules/#{id}", {}, Basecamp3::Schedule)
+  end
+end

data/lib/basecamp3/models/schedule_entry.rb

@@ -0,0 +1,93 @@
+# A model for Basecamp's Schedule Entry
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/schedule_entries.md#schedule-entries For more information, see the official Basecamp3 API documentation for Schedule entries}
+class Basecamp3::ScheduleEntry < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+  include Basecamp3::Concerns::Recordingable
+  include Basecamp3::Concerns::Commentable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :summary,
+                :description,
+                :starts_at,
+                :ends_at,
+                :all_day
+
+  REQUIRED_FIELDS = %w(summary starts_at ends_at)
+
+  # Returns a list of related participants.
+  #
+  # @return [Array<Basecamp3::Person>]
+  def participants
+    return [] if @participants.nil?
+
+    @mapped_participants ||= @participants.map{ |p| Basecamp3::Person.new(p) }
+  end
+
+  # Returns a paginated list of active schedule entries.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  # @option params [Integer] :status (optional) when set to archived or trashed, will return archived or trashed schedule entries that are in this schedule
+  #
+  # @return [Array<Basecamp3::ScheduleEntry>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/schedules/#{parent_id}/entries", params, Basecamp3::ScheduleEntry)
+  end
+
+  # Returns the schedule entry.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the schedule entry
+  #
+  # @return [Basecamp3::ScheduleEntry]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/schedule_entries/#{id}", {}, Basecamp3::ScheduleEntry)
+  end
+
+
+  # Creates a schedule entry.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the schedule
+  # @param [Hash] data the data to create a schedule entry with
+  # @option params [Integer] :summary (required) what this schedule entry is about
+  # @option params [Integer] :starts_at (required) timestamp for when this schedule entry begins
+  # @option params [Integer] :ends_at (required) timestamp for when this schedule entry ends
+  # @option params [String] :description (optional) containing more information about the schedule entry
+  # @option params [Array<Integer>] :participant_ids (optional) an array of people IDs that will participate in this entry
+  # @option params [Boolean] :all_day (optional) when set to true, the schedule entry will not have a specific start or end time,
+  # and instead will be held for the entire day or days denoted in starts_at and ends_at
+  # @option params [Boolean] :notify (optional) when set to true, will notify the participants about the entry
+  #
+  # @return [Basecamp3::ScheduleEntry]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/schedules/#{parent_id}/entries", data, Basecamp3::ScheduleEntry)
+  end
+
+  # Updates the schedule entry.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the schedule entry
+  # @param [Hash] data the data to update the schedule entry with
+  # @option params [Integer] :summary (required) what this schedule entry is about
+  # @option params [Integer] :starts_at (required) timestamp for when this schedule entry begins
+  # @option params [Integer] :ends_at (required) timestamp for when this schedule entry ends
+  # @option params [String] :description (optional) containing more information about the schedule entry
+  # @option params [Array<Integer>] :participant_ids (optional) an array of people IDs that will participate in this entry
+  # @option params [Boolean] :all_day (optional) when set to true, the schedule entry will not have a specific start or end time,
+  # and instead will be held for the entire day or days denoted in starts_at and ends_at
+  # @option params [Boolean] :notify (optional) when set to true, will notify the participants about the entry
+  #
+  # @return [Basecamp3::ScheduleEntry]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/schedule_entries/#{id}", data, Basecamp3::ScheduleEntry)
+  end
+end

data/lib/basecamp3/models/todo.rb

@@ -0,0 +1,108 @@
+# A model for Basecamp's TODO
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/todos.md#to-dos For more information, see the official Basecamp3 API documentation for TODOs}
+class Basecamp3::Todo < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+  include Basecamp3::Concerns::Recordingable
+  include Basecamp3::Concerns::Commentable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :content,
+                :description,
+                :starts_on,
+                :due_on
+
+  REQUIRED_FIELDS = %w(content)
+
+  # Returns a list of related assignees.
+  #
+  # @return [Array<Basecamp3::Person>]
+  def assignees
+    @mapped_assignees ||= @assignees.map{ |a| Basecamp3::Person.new(a) }
+  end
+
+  # Returns a paginated list of active TODOs.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [String] :status (optional) when set to archived or trashed, will return archived or trashed to-dos that are in this list
+  # @option params [Boolean] :completed (optional) when set to true, will only return to-dos that are completed
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::Todo>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/todolists/#{parent_id}/todos", params, Basecamp3::Todo)
+  end
+
+  # Returns the TODO.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the TODO
+  #
+  # @return [Basecamp3::Todo]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/todos/#{id}", {}, Basecamp3::Todo)
+  end
+
+  # Creates a TODO.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the TODO list
+  # @param [Hash] data the data to create a TODO with
+  # @option params [String] :content (required) for what the to-do is for
+  # @option params [String] :description (optional) containing information about the to-do
+  # @option params [Array<Integer>] :assignee_ids (optional) an array of people that will be assigned to this to-do
+  # @option params [Boolean] :notify (optional) when set to true, will notify the assignees about being assigned
+  # @option params [Date] :due_on (optional) a date when the to-do should be completed
+  # @option params [Date] :starts_on (optional) allows the to-do to run from this date to the due_on date
+  #
+  # @return [Basecamp3::Todo]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/todolists/#{parent_id}/todos", data, Basecamp3::Todo)
+  end
+
+  # Updates the TODO.
+  #
+  # REMEMBER: Pass all existing parameters in addition to those being updated!
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the TODO
+  # @param [Hash] data the data to update the TODO with
+  # @option params [String] :content (required) for what the to-do is for
+  # @option params [String] :description (optional) containing information about the to-do
+  # @option params [Array<Integer>] :assignee_ids (optional) an array of people that will be assigned to this to-do
+  # @option params [Boolean] :notify (optional) when set to true, will notify the assignees about being assigned
+  # @option params [Date] :due_on (optional) a date when the to-do should be completed
+  # @option params [Date] :starts_on (optional) allows the to-do to run from this date to the due_on date
+  #
+  # @return [Basecamp3::Todo]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/todos/#{id}", data, Basecamp3::Todo)
+  end
+
+  # Completes the TODO.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the TODO
+  #
+  # @return [Boolean]
+  def self.complete(bucket_id, id)
+    Basecamp3.request.post("/buckets/#{bucket_id}/todos/#{id}/completion")
+  end
+
+  # Incompletes the TODO.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the TODO
+  #
+  # @return [Boolean]
+  def self.incomplete(bucket_id, id)
+    Basecamp3.request.delete("/buckets/#{bucket_id}/todos/#{id}/completion")
+  end
+end

data/lib/basecamp3/models/todo_list.rb

@@ -0,0 +1,77 @@
+# A model for Basecamp's TODO List
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/todolists.md#to-do-lists For more information, see the official Basecamp3 API documentation for TODO lists}
+class Basecamp3::TodoList < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+  include Basecamp3::Concerns::Recordingable
+  include Basecamp3::Concerns::Commentable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :name,
+                :description,
+                :completed,
+                :completed_ratio
+
+  REQUIRED_FIELDS = %w(name)
+
+  # Returns a list of related todos.
+  #
+  # @return [Array<Basecamp3::Todo>]
+  def todos
+    @mapped_todos ||= Basecamp3::Todo.all(bucket.id, id)
+  end
+
+  # Returns a paginated list of active TODO lists.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [String] :status (optional) when set to archived or trashed, will return archived or trashed to-do lists that are in this to-do list
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::TodoList>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/todosets/#{parent_id}/todolists", params, Basecamp3::TodoList)
+  end
+
+  # Returns the TODO list.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the TODO list
+  #
+  # @return [Basecamp3::TodoList]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/todolists/#{id}", {}, Basecamp3::TodoList)
+  end
+
+  # Creates a TODO list.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the TODO set
+  # @param [Hash] data the data to create a TODO list with
+  # @option params [String] :name (required) the name of the to-do list
+  # @option params [String] :description (optional) containing information about the to-do list
+  #
+  # @return [Basecamp3::TodoList]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/todosets/#{parent_id}/todolists", data, Basecamp3::TodoList)
+  end
+
+  # Updates the TODO list.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the TODO list
+  # @param [Hash] data the data to create the TODO list with
+  # @option params [String] :name (required) the name of the to-do list
+  # @option params [String] :description (optional) containing information about the to-do list
+  #
+  # @return [Basecamp3::TodoList]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/todolists/#{id}", data, Basecamp3::TodoList)
+  end
+end

data/lib/basecamp3/models/todo_set.rb

@@ -0,0 +1,33 @@
+# A model for Basecamp's TODO Set
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/todosets.md#to-do-sets For more information, see the official Basecamp3 API documentation for TODO sets}
+class Basecamp3::TodoSet < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :name,
+                :todolists_count,
+                :completed,
+                :completed_ratio
+
+  # Returns a list of related todo lists.
+  #
+  # @return [Array<Basecamp3::TodoList>]
+  def todo_lists
+    @mapped_todo_lists ||= Basecamp3::TodoList.all(bucket.id, id)
+  end
+
+  # Returns the TODO set.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the TODO set
+  #
+  # @return [Basecamp3::TodoSet]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/todosets/#{id}", {}, Basecamp3::TodoSet)
+  end
+end

data/lib/basecamp3/models/vault.rb

@@ -0,0 +1,79 @@
+# A model for Basecamp's Vault
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/vaults.md#vaults For more information, see the official Basecamp3 API documentation for Vaults}
+class Basecamp3::Vault < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :title,
+                :documents_count,
+                :uploads_count,
+                :vaults_count
+
+  REQUIRED_FIELDS = %w(title)
+
+  # Returns a list of related documents.
+  #
+  # @return [Array<Basecamp3::Document>]
+  def documents
+    @mapped_documents ||= Basecamp3::Document.all(bucket.id, id)
+  end
+
+  # Returns a list of related vaults.
+  #
+  # @return [Array<Basecamp3::Vault>]
+  def vaults
+    @mapped_vaults ||= Basecamp3::Vault.all(bucket.id, id)
+  end
+
+  # Returns a paginated list of active vaults.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::Vault>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/vaults/#{parent_id}/vaults", params, Basecamp3::Vault)
+  end
+
+  # Returns the vault.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the vault
+  #
+  # @return [Basecamp3::Vault]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/vaults/#{id}", {}, Basecamp3::Vault)
+  end
+
+  # Creates a vault
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the parent
+  # @param [Hash] data the data to create a vault with
+  # @option params [String] :title (required) the name of the vault
+  #
+  # @return [Basecamp3::Vault]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/vaults/#{parent_id}/vaults", data, Basecamp3::Vault)
+  end
+
+  # Updates the vault
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the vault
+  # @param [Hash] data the data to update the vault with
+  # @option params [String] :title (required) the name of the vault
+  #
+  # @return [Basecamp3::Vault]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/vaults/#{id}", data, Basecamp3::Vault)
+  end
+end