github_api2 1.0.0

data/lib/github_api2/client/pull_requests.rb

@@ -0,0 +1,195 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::PullRequests < API
+
+    require_all 'github_api2/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

data/lib/github_api2/client/repos/branches/protections.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+require_relative '../../../api'
+
+module Github
+  # The Branch Protections API
+  class Client::Repos::Branches::Protections < API
+    VALID_PROTECTION_PARAM_NAMES = %w[
+      required_status_checks
+      required_pull_request_reviews
+      enforce_admins
+      restrictions
+      accept
+    ].freeze
+
+    # Get a single branch's protection
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.get 'user', 'repo', 'branch'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :branch])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
+    end
+    alias :find :get
+
+    # Edit a branch protection
+    #
+    # Users with push access to the repository can edit a branch protection.
+    #
+    # @param [Hash] params
+    # @input params [String] :required_status_checks
+    #   Required.
+    # @input params [String] :enforce_admins
+    #   Required.
+    # @input params [String] :restrictions
+    #   Required.
+    # @input params [String] :required_pull_request_reviews
+    #   Required.
+    # Look to the branch protection API to see how to use these
+    # https://developer.github.com/v3/repos/branches/#update-branch-protection
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.edit 'user', 'repo', 'branch',
+    #     required_pull_request_reviews: {dismiss_stale_reviews: false}
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :branch]) do
+        permit VALID_PROTECTION_PARAM_NAMES
+      end
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
+    end
+    alias :update :edit
+
+    # Delete a branch protection
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.protections.delete 'user', 'repo', 'branch'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :branch])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}/protection", arguments.params)
+    end
+    alias :remove :delete
+  end # Client::Repos::Branches::Protections
+end # Github

data/lib/github_api2/client/repos/branches.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Branches < API
+    require_all 'github_api2/client/repos/branches', 'protections'
+
+    # Access to Repos::Branches::Protections API
+    namespace :protections
+
+    # List branches
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.list 'user-name', 'repo-name'
+    #   github.repos(user: 'user-name', repo: 'repo-name').branches.list
+    #
+    # @example
+    #   repos = Github::Repos.new
+    #   repos.branches.list 'user-name', 'repo-name'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/branches", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get branch
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.branches.get 'user-name', 'repo-name', 'branch-name'
+    #   github.repos.branches.get user: 'user-name', repo: 'repo-name', branch: 'branch-name'
+    #   github.repos(user: 'user-name', repo: 'repo-name', branch: 'branch-name').branches.get
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :branch])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/branches/#{arguments.branch}", arguments.params)
+    end
+    alias :find :get
+  end # Client::Repos::Branches
+end # Github

data/lib/github_api2/client/repos/collaborators.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Collaborators < API
+    # List collaborators
+    #
+    # When authenticating as an organization owner of an
+    # organization-owned repository, all organization owners are included
+    # in the list of collaborators. Otherwise, only users with access to the
+    # repository are returned in the collaborators list.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.collaborators.list 'user-name', 'repo-name'
+    #
+    # @example
+    #  github.repos.collaborators.list 'user-name', 'repo-name' { |cbr| .. }
+    #
+    # @return [Array]
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/collaborators", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Add collaborator
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.collaborators.add 'user', 'repo', 'username'
+    #
+    # @example
+    #  collaborators = Github::Repos::Collaborators.new
+    #  collaborators.add 'user', 'repo', 'username'
+    #
+    # @api public
+    def add(*args)
+      arguments(args, required: [:user, :repo, :username])
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/collaborators/#{arguments.username}", arguments.params)
+    end
+    alias :<< :add
+
+    # Checks if user is a collaborator for a given repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.collaborators.collaborator?('user', 'repo', 'username')
+    #
+    # @example
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.collaborators.collaborator? username: 'collaborator'
+    #
+    # @api public
+    def collaborator?(*args)
+      arguments(args, required: [:user, :repo, :username])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/collaborators/#{arguments.username}", arguments.params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+
+    # Removes collaborator
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.collaborators.remove 'user', 'repo', 'username'
+    #
+    # @api public
+    def remove(*args)
+      arguments(args, required: [:user, :repo, :username])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/collaborators/#{arguments.username}", arguments.params)
+    end
+  end # Client::Repos::Collaborators
+end # Github

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

@@ -0,0 +1,125 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Comments < API
+
+    REQUIRED_COMMENT_OPTIONS = %w[ body ].freeze
+
+    VALID_COMMENT_OPTIONS = %w[
+      body
+      line
+      path
+      position
+    ].freeze
+
+    # List commit comments for a repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.comments.list 'user-name', 'repo-name'
+    #
+    # @example
+    #  github.repos.comments.list 'user-name', 'repo-name' { |com| ... }
+    #
+    # List comments for a single commit
+    #
+    # @example
+    #  github.repos.comments.list 'user-name', 'repo-name',
+    #   sha: '6dcb09b5b57875f334f61aebed695e2e4193db5e'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+      user   = arguments.user
+      repo   = arguments.repo
+
+      response = if (sha = params.delete('sha'))
+        get_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
+      else
+        get_request("/repos/#{user}/#{repo}/comments", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single commit comment
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.comments.get 'user-name', 'repo-name', 'id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/comments/#{arguments.id}", arguments.params)
+    end
+    alias :find :get
+
+    # Creates a commit comment
+    #
+    # @param [Hash] params
+    # @option params [String] :body
+    #   Required. The contents of the comment.
+    # @option params [String] :path
+    #   Required. Relative path of the file to comment on.
+    # @option params [Number] :position
+    #   Required number - Line index in the diff to comment on.
+    # @option params [Number] :line
+    #   Required number - Line number in the file to comment on.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.comments.create 'user-name', 'repo-name', 'sha-key',
+    #    body: "Nice change",
+    #    position: 4,
+    #    line: 1,
+    #    path: "file1.txt"
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :sha]) do
+        assert_required REQUIRED_COMMENT_OPTIONS
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/commits/#{arguments.sha}/comments", arguments.params)
+    end
+
+    # Update a commit comment
+    #
+    # @param [Hash] params
+    # @option params [String] :body
+    #   Required. The contents of the comment.
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.comments.update 'user-name', 'repo-name', 'id',
+    #     body: "Nice change"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :id]) do
+        assert_required REQUIRED_COMMENT_OPTIONS
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/comments/#{arguments.id}", arguments.params)
+    end
+
+    # Deletes a commit comment
+    #
+    # @example
+    #   github = Github.new
+    #   github.repos.comments.delete 'user-name', 'repo-name', 'id'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/comments/#{arguments.id}", arguments.params)
+    end
+  end # Client::Repos::Comments
+end # Github

data/lib/github_api2/client/repos/commits.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Repos::Commits < API
+
+    VALID_COMMITS_OPTIONS = %w[
+      sha
+      path
+      author
+      since
+      until
+    ].freeze
+
+    # List commits on a repository
+    #
+    # @param [Hash] params
+    # @option params [String] :sha
+    #   Sha or branch to start listing commits from.
+    # @option params [String] :path
+    #   Only commits containing this file path will be returned.
+    # @option params [String] :author
+    #   GitHub login, name or email by which to filter by commit author.
+    # @option params [String] :since
+    #   Only commits after this date will be returned. This is a timestamp
+    #   in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+    # @option params [String] :until
+    #   Only commits before this date will be returned. This is a timestamp
+    #   in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.commits.list 'user-name', 'repo-name', sha: '...'
+    #  github.repos.commits.list 'user-name', 'repo-name', sha: '...' { |commit| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_COMMITS_OPTIONS
+      end
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/commits", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single commit
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.commits.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :sha])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/commits/#{arguments.sha}", arguments.params)
+    end
+    alias :find :get
+
+    # Compares two commits
+    #
+    # @note Both :base and :head can be either branch names in :repo or
+    # branch names in other repositories in the same network as :repo.
+    # For the latter case, use the format user:branch:
+    #
+    # @example
+    #  github = Github.new
+    #  github.repos.commits.compare 'user-name', 'repo-name', 'v0.4.8', 'master'
+    #
+    # @api public
+    def compare(*args)
+      arguments(args, required: [:user, :repo, :base, :head])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/compare/#{arguments.base}...#{arguments.head}", arguments.params)
+    end
+  end # Client::Repos::Commits
+end # Github