github_api2 1.0.0

data/lib/github_api2/client/projects/columns.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Projects::Columns < API
+    REQUIRED_COLUMN_PARAMS = %w(name).freeze
+    REQUIRED_MOVE_COLUMN_PARAMS = %w(position).freeze
+
+    # List a project's columns
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.columns.list :project_id
+    #
+    # @see https://developer.github.com/v3/projects/columns/#list-project-columns
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:project_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      response = get_request("/projects/#{arguments.project_id}/columns", params)
+
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias all list
+
+    # Get a project columns
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.columns.get :column_id
+    #
+    # @see https://developer.github.com/v3/projects/columns/#get-a-project-column
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:column_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      get_request("/projects/columns/#{arguments.column_id}", params)
+    end
+    alias find get
+
+    # Create a project column
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required. The name of the column.
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.columns.create :project_id, name: 'column-name'
+    #
+    # @see https://developer.github.com/v3/projects/columns/#create-a-project-column
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:project_id]) do
+        assert_required REQUIRED_COLUMN_PARAMS
+      end
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      post_request("/projects/#{arguments.project_id}/columns", params)
+    end
+
+    # Update a project column
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required. The name of the column.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.projects.update :column_id, name: 'new-column-name'
+    #
+    # @see https://developer.github.com/v3/projects/columns/#update-a-project-column
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:column_id]) do
+        assert_required REQUIRED_COLUMN_PARAMS
+      end
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      patch_request("/projects/columns/#{arguments.column_id}", params)
+    end
+    alias edit update
+
+    # Delete a project column
+    #
+    # @example
+    #   github = Github.new
+    #   github.projects.columns.delete :column_id
+    #
+    # @see https://developer.github.com/v3/projects/columns/#delete-a-project-column
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:column_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      delete_request("/projects/columns/#{arguments.column_id}", params)
+    end
+    alias remove delete
+
+    # Move a project column
+    #
+    # @param [Hash] params
+    # @option params [String] :position
+    #   Required. Required. Can be one of 'first', 'last', or
+    #   'after:<column-id>', where <column-id> is the id value of a column in
+    #   the same project.
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.columns.move :column_id, position: 'first'
+    #
+    # @see https://developer.github.com/v3/projects/columns/#move-a-project-column
+    #
+    # @api public
+    def move(*args)
+      arguments(args, required: [:column_id]) do
+        assert_required REQUIRED_MOVE_COLUMN_PARAMS
+      end
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      post_request("/projects/columns/#{arguments.column_id}/moves", params)
+    end
+  end
+end

data/lib/github_api2/client/projects.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require_relative '../api'
+
+module Github
+  # Projects API
+  class Client::Projects < API
+    PREVIEW_MEDIA = "application/vnd.github.inertia-preview+json" # :nodoc:
+
+    require_all 'github_api2/client/projects',
+                'columns',
+                'cards'
+
+    # Access to Projects::Columns API
+    namespace :columns
+
+    # Access to Projects::Cards API
+    namespace :cards
+
+    # Get properties for a single project
+    #
+    # @see https://developer.github.com/v3/projects/#get-a-project
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.get 1002604
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      get_request("/projects/#{arguments.id}", params)
+    end
+    alias find get
+
+    # Edit a project
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Optional string
+    # @option params [String] :body
+    #   Optional string
+    # @option params [String] :state
+    #   Optional string
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.edit 1002604,
+    #    name: "Outcomes Tracker",
+    #    body: "The board to track work for the Outcomes application."
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      patch_request("/projects/#{arguments.id}", params)
+    end
+
+    # Delete a project
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.delete 1002604
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      delete_request("/projects/#{arguments.id}", arguments.params)
+    end
+    alias remove delete
+  end # Projects
+end # Github

data/lib/github_api2/client/pull_requests/comments.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::PullRequests::Comments < API
+    # List comments on a pull request
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.comments.list 'user-name', 'repo-name', number: 'id'
+    #
+    # List comments in a repository
+    #
+    # By default, Review Comments are ordered by ascending ID.
+    #
+    # @param [Hash] params
+    # @input params [String] :sort
+    #   Optional string. Can be either created or updated. Default: created
+    # @input params [String] :direction
+    #   Optional string. Can be either asc or desc. Ignored without sort parameter
+    # @input params [String] :since
+    #   Optional string of a timestamp in ISO 8601
+    #                         format: YYYY-MM-DDTHH:MM:SSZ
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.comments.list 'user-name', 'repo-name'
+    #   github.pull_requests.comments.list 'user-name', 'repo-name' { |comm| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+      user = arguments.user
+      repo = arguments.repo
+
+      response = if (number = params.delete('number'))
+        get_request("/repos/#{user}/#{repo}/pulls/#{number}/comments", params)
+      else
+        get_request("/repos/#{user}/#{repo}/pulls/comments", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a single comment for pull requests
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.comments.get 'user-name', 'repo-name', 'number'
+    #
+    # @example
+    #   github.pull_requests.comments.get
+    #     user: 'user-name',
+    #     repo: 'repo-name',
+    #     number: 'comment-number
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/comments", arguments.params)
+    end
+    alias_method :find, :get
+
+    # Create a pull request comment
+    #
+    # @param [Hash] params
+    # @option params [String] :body
+    #   Required string. The text of the comment.
+    # @option params [String] :commit_id
+    #   Required string - The SHA of the commit to comment on.
+    # @option params [String] :path
+    #   Required string. The relative path of the file to comment on.
+    # @option params [Number] :position
+    #   Required number. The line index in the diff to comment on.
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.comments.create 'user-name', 'repo-name', 'number',
+    #    body: "Nice change",
+    #    commit_id: "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    #    path: "file1.txt",
+    #    position: 4
+    #
+    # Alternative Inputs
+    #
+    # Instead of passing commit_id, path, and position you can reply to
+    # an existing Pull Request Comment like this
+    # @option params [String] :body
+    #   Required string. The text of the comment.
+    # @option params [Number] :in_reply_to
+    #   Required number. The comment id to reply to.
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.comments.create 'user-name','repo-name', 'number',
+    #     body: "Nice change",
+    #     in_reply_to: 4
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/comments", arguments.params)
+    end
+
+    # Edit a pull request comment
+    #
+    # @param [Hash] params
+    # @option params [String] :body
+    #   Required string. The text of the comment.
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.comments.edit 'user-name', 'repo-name', 'number',
+    #     body: "Nice change"
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/comments/#{arguments.number}", arguments.params)
+    end
+
+    # Delete a pull request comment
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.comments.delete 'user-name', 'repo-name', 'number'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/comments/#{arguments.number}", arguments.params)
+    end
+  end # PullRequests::Comments
+end # Github

data/lib/github_api2/client/pull_requests/reviews.rb

@@ -0,0 +1,158 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::PullRequests::Reviews < API
+    PREVIEW_MEDIA = "application/vnd.github.black-cat-preview+json".freeze # :nodoc:
+
+    # List reviews on a pull request
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number'
+    #
+    # List pull request reviews in a repository
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number'
+    #   github.pull_requests.reviews.list 'user-name', 'repo-name', number: 'pull-request-number' { |comm| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a single review for pull requests
+    #
+    # @example
+    #   github = Github.new
+    #   github.pull_requests.reviews.get 'user-name', 'repo-name', 'number', 'id'
+    #
+    # @example
+    #   github.pull_requests.reviews.get
+    #     user: 'user-name',
+    #     repo: 'repo-name',
+    #     number: 1,
+    #     id: 80
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+
+      params             = arguments.params
+      params["accept"] ||= PREVIEW_MEDIA
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}", params)
+    end
+    alias_method :find, :get
+
+    # Create a pull request review
+    #
+    # @param [Hash] params
+    # @option params [String] :event
+    #   Required string - The review action (event) to perform; can be one of
+    #   APPROVE, REQUEST_CHANGES, or COMMENT. If left blank, the API returns
+    #   HTTP 422 (Unrecognizable entity) and the review is left PENDING
+    # @option params [String] :body
+    #   Optional string. The text of the review.
+    # @option params [Array] :comments
+    #   Optional array of draft review comment objects. An array of comments
+    #   part of the review.
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.reviews.create 'user-name', 'repo-name', 'number',
+    #    body: "Nice change",
+    #    event: "APPROVE",
+    #    comments: [
+    #      {
+    #        path: 'path/to/file/commented/on',
+    #        position: 10,
+    #        body:     'This looks good.'
+    #      }
+    #    ]
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      params             = arguments.params
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews", params)
+    end
+
+    # Update a pull request review
+    #
+    # @param [Hash] params
+    # @option params [String] :state
+    #   Required string - The review action (event) to perform; can be one of
+    #   APPROVE, REQUEST_CHANGES, or COMMENT. If left blank, the API returns
+    #   HTTP 422 (Unrecognizable entity) and the review is left PENDING
+    # @optoin params [String] :body
+    #   Optional string
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.pull_requests.reviews.update 'user-name', 'repo-name', 'number', 'review-id'
+    #    body: "Update body",
+    #    event: "APPROVE"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/events", params)
+    end
+
+    # @option params [String] :message
+    #   Optional string - Reason for dismissal
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.pull_requests.reviews.dismiss 'user-name', 'repo-name', 'number', 'review-id'
+    #    message: "I can't get to this right now."
+    #
+    # @api public
+    def dismiss(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/dismissals", params)
+    end
+
+    # List comments on a pull request review
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.revieiws.comments 'user-name', 'repo-name', 'number', 'review-id'
+    #
+    # @api public
+    def comments(*args)
+      arguments(args, required: [:user, :repo, :number, :id])
+      params = arguments.params
+
+      params["accept"] ||= PREVIEW_MEDIA
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/reviews/#{arguments.id}/comments", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+  end
+end