lingfennan-github_api 0.18.2

data/lib/github_api/client/issues/comments.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Issues::Comments < API
+
+    VALID_ISSUE_COMMENT_PARAM_NAME = %w[
+      body
+      resource
+      mime_type
+    ].freeze
+
+    # List comments on an issue
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.all 'owner-name', 'repo-name', number: 'id'
+    #  github.issues.comments.all 'owner-name', 'repo-name', number: 'id' {|com| .. }
+    # @example
+    #  github.issues.comments.all owner: 'username', repo: 'repo-name', number: 'id'
+    #
+    # List comments in a repository
+    #
+    # @param [Hash] params
+    # @option params [String] :sort
+    #   Optional string, created or updated
+    # @option params [String] :direction
+    #   Optional string, asc or desc. Ignored with sort parameter.
+    # @option params [String] :since
+    #   Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.comments.all 'user-name', 'repo-name'
+    #   github.issues.comments.all 'user-name', 'repo-name' {|com| .. }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+
+      response = if (number = params.delete('number'))
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{number}/comments", params)
+      else
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single comment
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.find 'user-name', 'repo-name', 'id'
+    #
+    # @example
+    #  github.issues.comments.find owner: 'user-name', repo: 'repo-name', id: 'id'
+    #
+    def get(*args)
+      arguments(args, required: [:user, :repo, :id])
+      params = arguments.params
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments/#{arguments.id}", params)
+    end
+    alias :find :get
+
+    # Create a comment
+    #
+    # @param [Hash] params
+    # @option [String] :body
+    #   Required string
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.create 'user-name', 'repo-name', 'number',
+    #     body: 'a new comment'
+    #
+    # @example
+    #   github.issues.comments.create
+    #     user: 'owner-name',
+    #     repo: 'repo-name',
+    #     number: 'issue-number',
+    #     body: 'a new comment body'
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :number]) do
+        permit VALID_ISSUE_COMMENT_PARAM_NAME
+        assert_required %w[ body ]
+      end
+      params = arguments.params
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/comments", params)
+    end
+
+    # Edit a comment
+    #
+    # @param [Hash] params
+    # @option params [String] :body
+    #   Required string
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.edit 'owner-name', 'repo-name', 'id',
+    #     body: 'a new comment'
+    #
+    # @example
+    #   github.issues.comments.edit
+    #     user: 'owner-name',
+    #     repo: 'repo-name',
+    #     id: 'comment-id',
+    #     body: 'a new comment body'
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :id]) do
+        permit VALID_ISSUE_COMMENT_PARAM_NAME
+        assert_required %w[ body ]
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments/#{arguments.id}", arguments.params)
+    end
+
+    # Delete a comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.comments.delete 'owner-name', 'repo-name', 'comment-id'
+    #
+    # @example
+    #   github.issues.comments.delete
+    #     user: 'owner-name',
+    #     repo: 'repo-name',
+    #     id: 'comment-id',
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments/#{arguments.id}", arguments.params)
+    end
+  end # Issues::Comments
+end # Github

data/lib/github_api/client/issues/events.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Issues::Events < API
+    # List events for an issue
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.events.list 'user-name', 'repo-name',
+    #    issue_number: 'issue-number'
+    #
+    # List events for a repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.events.list 'user-name', 'repo-name'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+
+      response = if (issue_number = params.delete('issue_number'))
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{issue_number}/events", params)
+      else
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/events", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single event
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.events.get 'user-name', 'repo-name', 'event-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :id])
+      params = arguments.params
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/events/#{arguments.id}", params)
+    end
+    alias :find :get
+  end # Issues::Events
+end # Github

data/lib/github_api/client/issues/labels.rb

@@ -0,0 +1,189 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Issues::Labels < API
+
+    VALID_LABEL_INPUTS = %w[ name color ].freeze
+
+    # List all labels for a repository
+    #
+    # @example
+    #   github = Github.new user: 'user-name', repo: 'repo-name'
+    #   github.issues.labels.list
+    #   github.issues.labels.list { |label| ... }
+    #
+    # Get labels for every issue in a milestone
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.list 'user-name', 'repo-name', milestone_id: 'milestone-id'
+    #
+    # List labels on an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.list 'user-name', 'repo-name', issue_id: 'issue-id'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+      user = arguments.user
+      repo = arguments.repo
+
+      response = if (milestone_id = params.delete('milestone_id'))
+        get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
+      elsif (issue_id = params.delete('issue_id'))
+        get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+      else
+        get_request("/repos/#{user}/#{repo}/labels", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single label
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.find 'user-name', 'repo-name', 'label-name'
+    #
+    # @example
+    #   github = Github.new user: 'user-name', repo: 'repo-name'
+    #   github.issues.labels.get label_name: 'bug'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :label_name])
+      params = arguments.params
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/labels/#{arguments.label_name}", params)
+    end
+    alias :find :get
+
+    # Create a label
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string
+    # @option params [String] :color
+    #   Required string - 6 character hex code, without leading #
+    #
+    # @example
+    #   github = Github.new user: 'user-name', repo: 'repo-name'
+    #   github.issues.labels.create name: 'API', color: 'FFFFFF'
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_LABEL_INPUTS
+        assert_required VALID_LABEL_INPUTS
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/labels", arguments.params)
+    end
+
+    # Update a label
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string
+    # @option params [String] :color
+    #   Required string - 6 character hex code, without leading #
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.update 'user-name', 'repo-name', 'label-name',
+    #     name: 'API', color: "FFFFFF"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :label_name]) do
+        permit VALID_LABEL_INPUTS
+        assert_required VALID_LABEL_INPUTS
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/labels/#{arguments.label_name}", arguments.params)
+    end
+    alias :edit :update
+
+    # Delete a label
+    #
+    # @examples
+    #   github = Github.new
+    #   github.issues.labels.delete 'user-name', 'repo-name', 'label-name'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :label_name])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/labels/#{arguments.label_name}", arguments.params)
+    end
+
+    # Add labels to an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.add 'user-name', 'repo-name', 'issue-number',
+    #     'label1', 'label2', ...
+    #
+    # @api public
+    def add(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/labels", params)
+    end
+    alias :<< :add
+
+    # Remove a label from an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.remove 'user-name', 'repo-name', 'issue-number',
+    #     label_name: 'label-name'
+    #
+    # Remove all labels from an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.remove 'user-name', 'repo-name', 'issue-number'
+    #
+    # @api public
+    def remove(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      user   = arguments.user
+      repo   = arguments.repo
+      number = arguments.number
+
+      if (label_name = params.delete('label_name'))
+        delete_request("/repos/#{user}/#{repo}/issues/#{number}/labels/#{label_name}", params)
+      else
+        delete_request("/repos/#{user}/#{repo}/issues/#{number}/labels", params)
+      end
+    end
+
+    # Replace all labels for an issue
+    #
+    # Sending an empty array ([]) will remove all Labels from the Issue.
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.replace 'user-name', 'repo-name', 'issue-number',
+    #     'label1', 'label2', ...
+    #
+    # @api public
+    def replace(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/labels", params)
+    end
+  end # Issues::Labels
+end # Github

data/lib/github_api/client/issues/milestones.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Issues::Milestones < API
+
+    VALID_MILESTONE_OPTIONS = {
+     'state' => %w[ open closed all ],
+     'sort'  => %w[ due_date completeness ],
+     'direction' => %w[ desc asc ]
+    }.freeze # :nodoc:
+
+    VALID_MILESTONE_INPUTS = %w[
+      title
+      state
+      description
+      due_on
+    ].freeze # :nodoc:
+
+    # List milestones for a repository
+    #
+    # @param [Hash] params
+    # @option params [String] :state
+    #   The state of the milestone. Either open, closed, or all. Default: open
+    # @option params [String] :sort
+    #   What to sort results by. Either due_date or completeness.
+    #   Default: due_date
+    # @option params [String] :direction
+    #   The directoin of the sort. Either asc or desc. Default: desc
+    #
+    # @example
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.issues.milestones.list
+    #
+    # @example
+    #  github.issues.milestones.list state: 'open', sort: 'due_date',
+    #    direction: 'asc'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_MILESTONE_OPTIONS.keys
+        assert_values VALID_MILESTONE_OPTIONS
+      end
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/milestones", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single milestone
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.milestones.get 'user-name', 'repo-name', 'milestone-number'
+    #
+    # @example
+    #   github.issues.milestones.get
+    #     user: 'user-name',
+    #     repo: 'repo-name',
+    #     number: 'milestone-number'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/milestones/#{arguments.number}", arguments.params)
+    end
+    alias :find :get
+
+    # Create a milestone
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Required string. The title of the milestone
+    # @option params [String] :state
+    #   The state of the milestone. Either open or closed. Default: open.
+    # @option params [String] :description
+    #   A description of the milestone
+    # @option params [String] :due_on
+    #   The milestone due date. This is a timestamp in ISO 8601 format:
+    #   YYYY-MM-DDTHH:MM:SSZ.
+    #
+    # @example
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.issues.milestones.create title: 'hello-world',
+    #    state: "open or closed",
+    #    description: "String",
+    #    due_on: "Time"
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_MILESTONE_INPUTS
+        assert_required %w[ title ]
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/milestones", arguments.params)
+    end
+
+    # Update a milestone
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Required string. The title of the milestone
+    # @option params [String] :state
+    #   The state of the milestone. Either open or closed. Default: open.
+    # @option params [String] :description
+    #   A description of the milestone
+    # @option params [String] :due_on
+    #   The milestone due date. This is a timestamp in ISO 8601 format:
+    #   YYYY-MM-DDTHH:MM:SSZ.
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.milestones.update 'user-name', 'repo-name', 'number',
+    #     :title => 'hello-world',
+    #     :state => "open or closed",
+    #     :description => "String",
+    #     :due_on => "Time"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :number]) do
+        permit VALID_MILESTONE_INPUTS
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/milestones/#{arguments.number}", arguments.params)
+    end
+
+    # Delete a milestone
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.milestones.delete 'user-name', 'repo-name', 'number'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/milestones/#{arguments.number}", arguments.params)
+    end
+  end # Issues::Milestones
+end # Github