jeremytregunna/ruby-trello

View on GitHub
lib/trello/comment.rb

Summary

Maintainability
A
1 hr
Test Coverage
module Trello
  # A Comment is a string with a creation date; it resides inside a Card and belongs to a User.
  #
  # @!attribute [r] id
  #   @return [String]
  # @!attribute [w] text
  #   @return [String]
  # @!attribute [r] date
  #   @return [Datetime]
  # @!attribute [r] creator_id
  #   @return [String]
  # @!attribute [r] data
  #   @return [Hash]
  # @!attribute [r] type
  #   @return [String]
  # @!attribute [r] limits
  #   @return [Hash]
  # @!attribute [r] app_creator
  #   @return [String]
  # @!attribute [r] display
  #   @return [Hash]
  class Comment < BasicData

    schema do
      # Readonly
      attribute :id, readonly: true, primary_key: true
      attribute :creator_id, readonly: true, remote_key: 'idMemberCreator'
      attribute :data, readonly: true
      attribute :type, readonly: true
      attribute :date, readonly: true, serializer: 'Time'
      attribute :limits, readonly: true
      attribute :app_creator, readonly: true, remote_key: 'appCreator'
      attribute :display, readonly: true

      # Writable
      attribute :text, update_only: true
    end

    validates_presence_of :id, :text, :date, :creator_id
    validates_length_of   :text,        in: 1..16384

    class << self
      def find(action_id)
        response = client.get("/actions/#{action_id}")
        self.parse response do |data|
          data.client = client
        end
      end
    end

    # Returns the board this comment is located
    def board(params = {})
      Board.from_response client.get("/actions/#{id}/board", params)
    end

    # Returns the card the comment is located
    def card(params = {})
      Card.from_response client.get("/actions/#{id}/card", params)
    end

    # Returns the list the comment is located
    def list(params = {})
      List.from_response client.get("/actions/#{id}/list", params)
    end

    # Deletes the comment from the card
    def delete
      ruta = "/actions/#{id}"
      client.delete(ruta)
    end

    # Returns the member who created the comment.
    one :member_creator, via: Member, path: :members, using: :creator_id
  end
end