piotrmurach/github

# encoding: utf-8

require_relative '../../api'

module Github
  class Client::Gists::Comments < API
    # List comments on a gist
    #
    # @see https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
    #
    # @example
    #   github = Github.new
    #   github.gists.comments.list 'gist-id'
    #
    # @return [Hash]
    #
    # @api public
    def list(*args)
      arguments(args, required: [:gist_id])

      response = get_request("/gists/#{arguments.gist_id}/comments",
                             arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end
    alias_method :all, :list

    # Get a single comment
    #
    # @see https://developer.github.com/v3/gists/comments/#get-a-single-comment
    #
    # @example
    #   github = Github.new
    #   github.gists.comments.get 'gist-id', 'comment-id'
    #
    # @api public
    def get(*args)
      arguments(args, required: [:gist_id, :id])

      get_request("/gists/#{arguments.gist_id}/comments/#{arguments.id}",
                  arguments.params)
    end
    alias_method :find, :get

    # Create a comment
    #
    # @see https://developer.github.com/v3/gists/comments/#create-a-comment
    #
    # @param [Hash] params
    # @option params [String] :body
    #   Required. The comment text.
    #
    # @example
    #   github = Github.new
    #   github.gists.comments.create 'gist-id'
    #
    # @api public
    def create(*args)
      arguments(args, required: [:gist_id])

      post_request("/gists/#{arguments.gist_id}/comments", arguments.params)
    end

    # Edit a comment
    #
    # @see https://developer.github.com/v3/gists/comments/#edit-a-comment
    #
    # @param [Hash] params
    # @option params [String] :body
    #   Required. The comment text.
    #
    # @example
    #   github = Github.new
    #   github.gists.comments.edit 'gist-id', 'comment-id'
    #
    # @api public
    def edit(*args)
      arguments(args, required: [:gist_id, :id])

      patch_request("/gists/#{arguments.gist_id}/comments/#{arguments.id}",
                    arguments.params)
    end

    # Delete a comment
    #
    # @see https://developer.github.com/v3/gists/comments/#delete-a-comment
    #
    # @example
    #   github = Github.new
    #   github.gists.comments.delete 'gist-id', 'comment-id'
    #
    # @api public
    def delete(*args)
      arguments(args, required: [:gist_id, :id])

      delete_request("/gists/#{arguments.gist_id}/comments/#{arguments.id}",
                     arguments.params)
    end
  end # Gists::Comments
end # Github