lingfennan-github_api 0.18.2

data/lib/github_api/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_api/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_api/client/projects/cards.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Projects::Cards < API
+    REQUIRED_MOVE_CARD_PARAMS = %w(position).freeze
+
+    # List project cards for a column
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.cards.list :column_id
+    #
+    # @see https://developer.github.com/v3/projects/cards/#list-project-cards
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:column_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      response = get_request("/projects/columns/#{arguments.column_id}/cards", params)
+
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias all list
+
+    # Get a project card
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.cards.get :card_id
+    #
+    # @see https://developer.github.com/v3/projects/cards/#get-a-project-card
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:card_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      get_request("/projects/columns/cards/#{arguments.card_id}", params)
+    end
+    alias find get
+
+    # Create a project card for a column
+    #
+    # @param [Hash] params
+    # @option params [String] :note
+    #  The card's note content. Only valid for cards without another type of
+    #  content, so this must be omitted if content_id and content_type are
+    #  specified.
+    # @option params [Integer] :content_id
+    #  The id of the Issue to associate with this card.
+    # @option params [String] :content_type
+    #  The type of content to associate with this card. Can only be "Issue" at
+    #  this time.
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.cards.create :column_id, note: 'Card Note'
+    #
+    # @example
+    # github = Github.new
+    # github.projects.cards.create :column_id, content_id: <content-id>, content_type: 'content-type'
+    #
+    # @see https://developer.github.com/v3/projects/cards/#create-a-project-card
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:column_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      post_request("/projects/columns/#{arguments.column_id}/cards", params)
+    end
+
+    # Update a project card
+    #
+    # @param [Hash] params
+    # @option params [String] :note
+    #   The card's note content. Only valid for cards without another type of
+    #   content, so this cannot be specified if the card already has a
+    #   content_id and content_type.
+    #
+    # @example
+    #   github = Github.new
+    #   github.projects.cards.update :card_id, note: 'New card note'
+    #
+    # @see https://developer.github.com/v3/projects/cards/#update-a-project-card
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:card_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      patch_request("/projects/columns/cards/#{arguments.card_id}", params)
+    end
+    alias edit update
+
+    # Delete a project card
+    #
+    # @example
+    #   github = Github.new
+    #   github.projects.cards.delete :card_id
+    #
+    # @see https://developer.github.com/v3/projects/cards/#delete-a-project-card
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:card_id])
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      delete_request("/projects/columns/cards/#{arguments.card_id}", params)
+    end
+    alias remove delete
+
+    # Move a project card
+    #
+    # @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.cards.move :card_id, position: 'bottom'
+    #
+    # @example
+    #  github = Github.new
+    #  github.projects.cards.move :card_id, position: 'after:<card-id>', column_id: <column-id>
+    #
+    # @see https://developer.github.com/v3/projects/cards/#move-a-project-card
+    #
+    # @api public
+    def move(*args)
+      arguments(args, required: [:card_id]) do
+        assert_required REQUIRED_MOVE_CARD_PARAMS
+      end
+      params = arguments.params
+
+      params["accept"] ||= ::Github::Client::Projects::PREVIEW_MEDIA
+
+      post_request("/projects/columns/cards/#{arguments.card_id}/moves", params)
+    end
+  end
+end

data/lib/github_api/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_api/client/pull_requests.rb

@@ -0,0 +1,195 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::PullRequests < API
+
+    require_all 'github_api/client/pull_requests', 'comments', 'reviews'
+
+    # Access to PullRequests::Comments API
+    namespace :comments
+    # Access to PullRequests::Reviews API
+    namespace :reviews
+
+    # List pull requests
+    #
+    # @example
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.pull_requests.list
+    #  github.pull_requests.list { |req| ... }
+    #
+    # @example
+    #  pulls = Github::PullRequests.new
+    #  pulls.pull_requests.list 'user-name', 'repo-name'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls",
+                             arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get a single pull request
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.get 'user-name', 'repo-name', 'number'
+    #
+    #  pulls = Github::PullRequests.new
+    #  pulls.get 'user-name', 'repo-name', 'number'
+    #
+    def get(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}", arguments.params)
+    end
+    alias_method :find, :get
+
+    # Create a pull request
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Required string
+    # @option params [String] :body
+    #   Optional string
+    # @option params [String] :base
+    #   Required string - The branch you want your changes pulled into.
+    # @option params [String] :head
+    #   Required string - The branch where your changes are implemented.
+    #
+    # @note: head and base can be either a sha or a branch name.
+    # Typically you would namespace head with a user like this: username:branch.
+    #
+    # Alternative Input
+    # You can also create a Pull Request from an existing Issue by passing
+    # an Issue number instead of <tt>title</tt> and <tt>body</tt>.
+    # @option params [Numeric] :issue
+    #   Required number - Issue number in this repository to turn into a Pull Request.
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.pull_requests.create 'user-name', 'repo-name',
+    #    title: "Amazing new feature",
+    #    body: "Please pull this in!",
+    #    head: "octocat:new-feature",
+    #    base: "master"
+    #
+    # @example
+    #  github.pull_requests.create 'user-name', 'repo-name',
+    #    issue: "5",
+    #    head: "octocat:new-feature",
+    #    base: "master"
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo])
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/pulls",
+                   arguments.params)
+    end
+
+    # Update a pull request
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Optional string
+    # @optoin params [String] :body
+    #   Optional string
+    # @option params [String] :state
+    #   Optional string - State of this Pull Request.
+    #   Valid values are open and closed.
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.pull_requests.update 'user-name', 'repo-name', 'number'
+    #    title: "Amazing new title",
+    #    body: "Update body",
+    #    state: "open"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}", arguments.params)
+    end
+
+    # List commits on a pull request
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.commits 'user-name', 'repo-name', 'number'
+    #
+    # @api public
+    def commits(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/commits", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # List pull requests files
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.files 'user-name', 'repo-name', 'number'
+    #
+    # @api public
+    def files(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/files", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Check if pull request has been merged
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.merged? 'user-name', 'repo-name', 'number'
+    #
+    # @api public
+    def merged?(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/merge", arguments.params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    PREVIEW_MEDIA = 'application/vnd.github.polaris-preview+json'.freeze # :nodoc:
+
+    # Merge a pull request(Merge Button)
+    #
+    # @param [Hash] params
+    # @option params [String] :commit_title
+    #   Optional string - The first line of the message that will be used for the merge commit
+    # @option params [String] :commit_message
+    #   Optional string - The message that will be used for the merge commit
+    # @option params [String] :sha
+    #   Optional string - The SHA that pull request head must match to allow merge
+    # @option params [String] :merge_method
+    #   Optional string - Merge method to use.
+    #   Valid values are merge, squash, and rebase. Default is merge.
+    #
+    # @example
+    #  github = Github.new
+    #  github.pull_requests.merge 'user-name', 'repo-name', 'number'
+    #
+    # @api public
+    def merge(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      params['accept'] ||= PREVIEW_MEDIA
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/pulls/#{arguments.number}/merge", params)
+    end
+  end # PullRequests
+end # Github