nwjsmith/thumbtack

# frozen_string_literal: true

module Thumbtack
  # Represents a note
  #
  # @api public
  class Note
    # The attributes for a Note
    #
    # @api private
    ATTRIBUTES = %i[
      id
      title
      created_at
      updated_at
      digest
      text
      length
    ].freeze

    # The identifier for the note
    #
    # @example
    #   note.id  # => '8e5d6964bb810e0050b0'
    #
    # @return [String]
    #
    # @api public
    attr_reader :id

    # The title of the note
    #
    # @example
    #   note.title  # => 'StarCraft beta coming this week!'
    #
    # @return [String]
    #
    # @api public
    attr_reader :title

    # The time at which the note was created
    #
    # @example
    #   note.created_at  # => 2014-08-13 19:53:16 +0000
    #
    # @return [Time]
    #
    # @api public
    def created_at
      Types::Time.deserialize_from_note(@created_at)
    end

    # The time at which the note was last updated
    #
    # @example
    #   note.updated_at  # => 2014-08-13 19:53:16 +0000
    #
    # @return [Time]
    #
    # @api public
    def updated_at
      Types::Time.deserialize_from_note(@updated_at)
    end

    # 20 character hexadecimal SHA1 hash of the note text
    #
    # @example
    #   note.digest  # => '0c9c30f60cadabd31415'
    #
    # @return [String]
    #
    # @api public
    attr_reader :digest

    # The text of the note
    #
    # @example
    #   note.text  # => 'It was clear that readers showing up...
    #
    # @return [String]
    #
    # @api public
    attr_reader :text

    # The length of the note text
    #
    # @example
    #   note.length  # => 153
    #
    # @return [Integer]
    #
    # @api public
    attr_reader :length

    # Creates a new Note from a Hash
    #
    # @param [Hash{#to_sym => Object}] hash
    #   Note attributes
    #
    # @return [Note]
    #
    # @api private
    # @see Client#get
    def self.from_hash(hash)
      new(HashToDigest.rename(hash).transform_keys(&:to_sym))
    end

    # Initialize a Note
    #
    # @param [Hash] attrs
    #   Note attributes
    #
    # @api private
    def initialize(attrs = EMPTY_HASH)
      ATTRIBUTES.each do |attribute|
        instance_variable_set "@#{attribute}", attrs.fetch(attribute)
      end
    end
  end
end