basecamp3 0.1.3

data/lib/basecamp3/models/document.rb

@@ -0,0 +1,71 @@
+# A model for Basecamp's Document
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/documents.md#documents For more information, see the official Basecamp3 API documentation for Documents}
+class Basecamp3::Document < 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,
+                :title,
+                :content
+
+  REQUIRED_FIELDS = %w(title content)
+
+  # Returns a paginated list of active documents.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the parent
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::Document>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/vaults/#{parent_id}/documents", params, Basecamp3::Document)
+  end
+
+  # Returns the document.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the document
+  #
+  # @return [Basecamp3::Document]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/documents/#{id}", {}, Basecamp3::Document)
+  end
+
+  # Creates a document.
+  #
+  # @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 Document with
+  # @option params [Integer] :title (required) the title of the document
+  # @option params [String] :content (required) the body of the document
+  # @option params [String] :status (optional) set to active to publish immediately
+  #
+  # @return [Basecamp3::Document]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/vaults/#{parent_id}/documents", data, Basecamp3::Document)
+  end
+
+  # Updates the document.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the document
+  # @param [Hash] data the data to update the document with
+  # @option params [Integer] :title (required) the title of the document
+  # @option params [String] :content (required) the body of the document
+  # @option params [String] :status (optional) set to active to publish immediately
+  #
+  # @return [Basecamp3::Document]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/documents/#{id}", data, Basecamp3::Document)
+  end
+end

data/lib/basecamp3/models/forward.rb

@@ -0,0 +1,40 @@
+# A model for Basecamp's Forward
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/forwards.md#forwards For more information, see the official Basecamp3 API documentation for Forwards}
+class Basecamp3::Forward < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+  include Basecamp3::Concerns::Recordingable
+
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :subject,
+                :content,
+                :from,
+                :replies_count
+
+  # Returns a paginated list of active forwards.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the inbox
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::Forward>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/inboxes/#{parent_id}/forwards", params, Basecamp3::Forward)
+  end
+
+  # Returns the forward.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the forward
+  #
+  # @return [Basecamp3::Forward]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/inbox_forwards/#{id}", {}, Basecamp3::Forward)
+  end
+end

data/lib/basecamp3/models/inbox.rb

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

data/lib/basecamp3/models/message.rb

@@ -0,0 +1,73 @@
+# A model for Basecamp's Message
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/messages.md#messages For more information, see the official Basecamp3 API documentation for Messages}
+class Basecamp3::Message < 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,
+                :subject,
+                :content
+
+  REQUIRED_FIELDS = %w(subject)
+
+  # Returns a paginated list of active messages.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the message board
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::Message>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/message_boards/#{parent_id}/messages", params, Basecamp3::Message)
+  end
+
+  # Returns the message.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the message
+  #
+  # @return [Basecamp3::Message]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/messages/#{id}", {}, Basecamp3::Message)
+  end
+
+  # Creates a message.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the message board
+  # @param [Hash] data the data to create a message with
+  # @option params [Integer] :subject (required) the title of the message
+  # @option params [String] :status (required) set to active to publish immediately
+  # @option params [String] :content (optional) the body of the message
+  # @option params [Integer] :category_id (optional) to set a type for the message
+  #
+  # @return [Basecamp3::Message]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/message_boards/#{parent_id}/messages", data, Basecamp3::Message)
+  end
+
+  # Updates the message.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the message
+  # @param [Hash] data the data to update the message with
+  # @option params [Integer] :subject (required) the title of the message
+  # @option params [String] :status (required) set to active to publish immediately
+  # @option params [String] :content (optional) the body of the message
+  # @option params [Integer] :category_id (optional) to set a type for the message
+  #
+  # @return [Basecamp3::Message]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/messages/#{id}", data, Basecamp3::Message)
+  end
+end

data/lib/basecamp3/models/message_board.rb

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

data/lib/basecamp3/models/message_type.rb

@@ -0,0 +1,68 @@
+# A model for Basecamp's Message Board
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/message_types.md#get-message-types For more information, see the official Basecamp3 API documentation for Message types}
+class Basecamp3::MessageType < Basecamp3::Model
+  attr_accessor :id,
+                :created_at,
+                :updated_at,
+                :name,
+                :icon
+
+  REQUIRED_FIELDS = %w(name icon)
+
+  # Returns a list of all the message types.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  #
+  # @return [Array<Basecamp3::MessageType>]
+  def self.all(bucket_id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/categories", {}, Basecamp3::MessageType)
+  end
+
+  # Returns the message type.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the message type
+  #
+  # @return [Basecamp3::MessageType]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/categories/#{id}", {}, Basecamp3::MessageType)
+  end
+
+  # Creates a message type.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Hash] data the data to create a message type with
+  # @option params [String] :name (required) the name of the message type
+  # @option params [String] :icon (required) the icon of the message type
+  #
+  # @return [Basecamp3::MessageType]
+  def self.create(bucket_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/categories", data, Basecamp3::MessageType)
+  end
+
+  # Updates a message type.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the message type
+  # @param [Hash] data the data to update the message type with
+  # @option params [String] :name (required) the name of the message type
+  # @option params [String] :icon (required) the icon of the message type
+  #
+  # @return [Basecamp3::MessageType]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/categories/#{id}", data, Basecamp3::MessageType)
+  end
+
+  # Deletes the message type.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the message type
+  #
+  # @return [Boolean]
+  def self.delete(bucket_id, id)
+    Basecamp3.request.delete("/buckets/#{bucket_id}/categories/#{id}")
+  end
+end

data/lib/basecamp3/models/person.rb

@@ -0,0 +1,46 @@
+# A model for Basecamp's Message Person
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/people.md#people For more information, see the official Basecamp3 API documentation for People}
+class Basecamp3::Person < Basecamp3::Model
+  attr_accessor :id,
+                :name,
+                :title,
+                :email_address,
+                :bio,
+                :avatar_url,
+                :admin,
+                :owner,
+                :time_zone,
+                :created_at,
+                :updated_at
+
+  # Returns a list of all people visible to the current user.
+  #
+  # @return [Array<Basecamp3::Person>]
+  def self.all
+    Basecamp3.request.get("/people", {}, Basecamp3::Person)
+  end
+
+  # Returns a list of all people who can be pinged.
+  #
+  # @return [Array<Basecamp3::Person>]
+  def self.pingable
+    Basecamp3.request.get("/circles/people", {}, Basecamp3::Person)
+  end
+
+  # Returns the person.
+  #
+  # @param [Integer] id the id of the person
+  #
+  # @return [Basecamp3::Person]
+  def self.find(id)
+    Basecamp3.request.get("/people/#{id}", {}, Basecamp3::Person)
+  end
+
+  # Returns the current user's personal info..
+  #
+  # @return [Basecamp3::Person]
+  def self.me
+    Basecamp3.request.get("/my/profile", {}, Basecamp3::Person)
+  end
+end

data/lib/basecamp3/models/project.rb

@@ -0,0 +1,70 @@
+# A model for Basecamp's Project (Basecamp)
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/basecamps.md#basecamps For more information, see the official Basecamp3 API documentation for Basecamps}
+class Basecamp3::Project < Basecamp3::Model
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :name,
+                :description,
+                :bookmarked
+
+  REQUIRED_FIELDS = %w(name)
+
+  # Returns a paginated list of active projects (basecamps) visible to the current user sorted by most recently
+  # created project (basecamp) first.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  # @option params [String] :status (optional) when set to archived or trashed,
+  # will return archived or trashed projects (basecamps) visible to the current user
+  #
+  # @return [Array<Basecamp3::Project>]
+  def self.all(params = {})
+    Basecamp3.request.get("/projects", params, Basecamp3::Project)
+  end
+
+  # Returns the project (basecamp).
+  #
+  # @param [Integer] id the id of the project
+  #
+  # @return [Basecamp3::Project]
+  def self.find(id)
+    Basecamp3.request.get("/projects/#{id}", {}, Basecamp3::Project)
+  end
+
+  # Creates a project.
+  #
+  # @param [Hash] data the data to create a project with
+  # @option params [String] :name (required) the name of the project
+  # @option params [String] :description (optional) the description of the project
+  #
+  # @return [Basecamp3::Project]
+  def self.create(data)
+    self.validate_required(data)
+    Basecamp3.request.post("/projects", data, Basecamp3::Project)
+  end
+
+  # Updates the project.
+  #
+  # @param [Integer] id the id of the project
+  # @param [Hash] data the data to update the project with
+  # @option params [String] :name (required) the name of the project
+  # @option params [String] :description (optional) the description of the project
+  #
+  # @return [Basecamp3::Project]
+  def self.update(id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/projects/#{id}", data, Basecamp3::Project)
+  end
+
+  # Deletes the project.
+  #
+  # @param [Integer] id the id of the project
+  #
+  # @return [Boolean]
+  def self.delete(id)
+    Basecamp3.request.delete("/projects/#{id}")
+  end
+end

data/lib/basecamp3/models/question.rb

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