octodoggy 4.6.2

data/lib/octokit/client/repository_invitations.rb

@@ -0,0 +1,103 @@
+module Octokit
+  class Client
+
+    # Methods for the Repository Invitations API
+    #
+    # @see https://developer.github.com/v3/repos/invitations/
+    module RepositoryInvitations
+
+      # Invite a user to a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param user [String] User GitHub username to add
+      # @return [Sawyer::Resource] The repository invitation
+      # @see https://developer.github.com/v3/repos/invitations/#invite-a-user-to-a-repository
+      def invite_user_to_repository(repo, user, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        put "#{Repository.path repo}/collaborators/#{user}", options
+      end
+      alias invite_user_to_repo invite_user_to_repository
+
+      # List all invitations for a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] A list of invitations
+      # @see https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository
+      def repository_invitations(repo, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        paginate "#{Repository.path repo}/invitations", options
+      end
+      alias repo_invitations repository_invitations
+
+      # Delete an invitation for a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Boolean] True if the invitation was successfully deleted
+      # @see https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation
+      def delete_repository_invitation(repo, invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        boolean_from_response :delete, "#{Repository.path repo}/invitations/#{invitation_id}", options
+      end
+      alias delete_repo_invitation delete_repository_invitation
+
+      # Update an invitation for a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Sawyer::Resource] The updated repository invitation
+      # @see https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation
+      def update_repository_invitation(repo, invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        patch "#{Repository.path repo}/invitations/#{invitation_id}", options
+      end
+      alias update_repo_invitation update_repository_invitation
+
+      # List all repository invitations for the user
+      #
+      # Requires authenticated client
+      #
+      # @return [Array<Sawyer::Resource>] The users repository invitations
+      # @see https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations
+      def user_repository_invitations(options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        paginate "/user/repository_invitations", options
+      end
+      alias user_repo_invitations user_repository_invitations
+
+      # Accept a repository invitation
+      #
+      # Requires authenticated client
+      #
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Boolean] True if the acceptance of the invitation was successful
+      # @see https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation
+      def accept_repository_invitation(invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        patch "/user/repository_invitations/#{invitation_id}", options
+      end
+      alias accept_repo_invitation accept_repository_invitation
+
+      # Decline a repository invitation
+      #
+      # Requires authenticated client
+      #
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Boolean] True if the acceptance of the invitation was successful
+      # @see https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation
+      def decline_repository_invitation(invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        boolean_from_response :delete, "/user/repository_invitations/#{invitation_id}", options
+      end
+      alias decline_invitation decline_repository_invitation
+    end
+  end
+end

data/lib/octokit/client/reviews.rb

@@ -0,0 +1,174 @@
+module Octokit
+  class Client
+
+    # Methods for the Reviews API
+    #
+    # @see https://developer.github.com/v3/reviews/
+    module Reviews
+
+      # List reviews on a pull request
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @see https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request
+      #
+      # @example
+      #   @client.pull_request_reviews('octokit/octokit.rb', 2)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reviews
+      def pull_request_reviews(repo, id, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{id}/reviews", options
+      end
+
+      # Get a single review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @see https://developer.github.com/v3/pulls/reviews/#get-a-single-review
+      #
+      # @example
+      #   @client.pull_request_review('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Sawyer::Resource] Hash representing the review
+      def pull_request_review(repo, number, review, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{number}/reviews/#{review}", options
+      end
+
+      # Delete a pending review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @see https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review
+      #
+      # @example
+      #   @client.delete_pull_request_review('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Sawyer::Resource] Hash representing the deleted review
+      def delete_pull_request_review(repo, number, review, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        delete "#{Repository.path repo}/pulls/#{number}/reviews/#{review}", options
+      end
+
+      # Get comments for a single review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @see https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review
+      #
+      # @example
+      #   @client.pull_request_review_comments('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the review comments
+      def pull_request_review_comments(repo, number, review, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{number}/reviews/#{review}/comments", options
+      end
+
+      # Create a pull request review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @param options [Hash] Method options
+      # @option options [String] :event The review action (event) to perform;
+      #   can be one of APPROVE, REQUEST_CHANGES, or COMMENT.
+      #   If left blank, the review is left PENDING.
+      # @option options [String] :body The body text of the pull request review
+      # @option options [Array<Hash>] :comments Comments part of the review
+      # @option comments [String] :path The path to the file being commented on
+      # @option comments [Integer] :position The position in the file to be commented on
+      # @option comments [String] :body Body of the comment
+      # @see https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review
+      #
+      # @example
+      #   comments = [
+      #     { path: '.travis.yml', position: 10, body: 'ruby-head is under development that is not stable.' },
+      #     { path: '.travis.yml', position: 32, body: 'ruby-head is also required in thervm section.' },
+      #   ]
+      #   options = { event: 'REQUEST_CHANGES', comments: comments }
+      #   @client.create_pull_request_review('octokit/octokit.rb', 844, options)
+      #
+      # @return [Sawyer::Resource>] Hash respresenting the review
+      def create_pull_request_review(repo, id, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        post "#{Repository.path repo}/pulls/#{id}/reviews", options
+      end
+
+      # Submit a pull request review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @param event [String] The review action (event) to perform; can be one of
+      #                       APPROVE, REQUEST_CHANGES, or COMMENT.
+      # @param options [Hash] Method options
+      # @option options [String] :body The body text of the pull request review
+      # @see https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review
+      #
+      # @example
+      #   @client.submit_pull_request_review('octokit/octokit.rb', 825, 6505518,
+      #                                      'APPROVE', body: 'LGTM!')
+      #
+      # @return [Sawyer::Resource] Hash respresenting the review
+      def submit_pull_request_review(repo, number, review, event, options = {})
+        options = options.merge(event: event)
+        options = ensure_api_media_type(:reviews, options)
+        post "#{Repository.path repo}/pulls/#{number}/reviews/#{review}/events", options
+      end
+
+      # Dismiss a pull request review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @param message [String] The message for the pull request review dismissal
+      # @see https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review
+      #
+      # @example
+      #   @client.dismiss_pull_request_review('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Sawyer::Resource] Hash representing the dismissed review
+      def dismiss_pull_request_review(repo, number, review, message, options = {})
+        options = options.merge(message: message)
+        options = ensure_api_media_type(:reviews, options)
+        put "#{Repository.path repo}/pulls/#{number}/reviews/#{review}/dismissals", options
+      end
+
+      # List review requests
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @see https://developer.github.com/v3/pulls/review_requests/#list-review-requests
+      #
+      # @example
+      #   @client.pull_request_review_requests('octokit/octokit.rb', 2)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the review requests
+      def pull_request_review_requests(repo, id, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
+      end
+
+      # Create a review request
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @param reviewers [Array<String>] An array of user logins that will be requested
+      # @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
+      #
+      # @example
+      #   @client.request_pull_request_review('octokit/octokit.rb', 2, ['soudy'])
+      #
+      # @return [Sawyer::Resource>] Hash respresenting the pull request
+      def request_pull_request_review(repo, id, reviewers, options = {})
+        options = options.merge(reviewers: reviewers)
+        options = ensure_api_media_type(:reviews, options)
+        post "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
+      end
+    end
+  end
+end

data/lib/octokit/client/say.rb

@@ -0,0 +1,19 @@
+module Octokit
+  class Client
+
+    # Methods for the unpublished Octocat API
+    module Say
+
+      # Return a nifty ASCII Octocat with GitHub wisdom
+      # or your own
+      #
+      # @return [String]
+      def say(text = nil, options = {})
+        options[:s] = text if text
+        get "octocat", options
+      end
+      alias :octocat :say
+
+    end
+  end
+end

data/lib/octokit/client/search.rb

@@ -0,0 +1,76 @@
+module Octokit
+  class Client
+
+    # Methods for the Search API
+    #
+    # @see https://developer.github.com/v3/search/
+    module Search
+
+      # Search code
+      #
+      # @param query [String] Search term and qualifiers
+      # @param options [Hash] Sort and pagination options
+      # @option options [String] :sort Sort field
+      # @option options [String] :order Sort order (asc or desc)
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
+      # @return [Sawyer::Resource] Search results object
+      # @see https://developer.github.com/v3/search/#search-code
+      def search_code(query, options = {})
+        search "search/code", query, options
+      end
+
+      # Search issues
+      #
+      # @param query [String] Search term and qualifiers
+      # @param options [Hash] Sort and pagination options
+      # @option options [String] :sort Sort field
+      # @option options [String] :order Sort order (asc or desc)
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
+      # @return [Sawyer::Resource] Search results object
+      # @see https://developer.github.com/v3/search/#search-issues
+      def search_issues(query, options = {})
+        search "search/issues", query, options
+      end
+
+      # Search repositories
+      #
+      # @param query [String] Search term and qualifiers
+      # @param options [Hash] Sort and pagination options
+      # @option options [String] :sort Sort field
+      # @option options [String] :order Sort order (asc or desc)
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
+      # @return [Sawyer::Resource] Search results object
+      # @see https://developer.github.com/v3/search/#search-repositories
+      def search_repositories(query, options = {})
+        search "search/repositories", query, options
+      end
+      alias :search_repos :search_repositories
+
+      # Search users
+      #
+      # @param query [String] Search term and qualifiers
+      # @param options [Hash] Sort and pagination options
+      # @option options [String] :sort Sort field
+      # @option options [String] :order Sort order (asc or desc)
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
+      # @return [Sawyer::Resource] Search results object
+      # @see https://developer.github.com/v3/search/#search-users
+      def search_users(query, options = {})
+        search "search/users", query, options
+      end
+
+      private
+
+      def search(path, query, options = {})
+        opts = options.merge(:q => query)
+        paginate(path, opts) do |data, last_response|
+          data.items.concat last_response.data.items
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/service_status.rb

@@ -0,0 +1,38 @@
+module Octokit
+  class Client
+
+    # Methods for the GitHub Status API
+    #
+    # @see https://status.github.com/api
+    module ServiceStatus
+
+      # Root for status API
+      # @private
+      STATUS_ROOT = 'https://status.github.com/api.json'
+
+      # Returns the current system status
+      #
+      # @return [Sawyer::Resource] GitHub status
+      # @see https://status.github.com/api#api-current-status
+      def github_status
+        get(STATUS_ROOT).rels[:status].get.data
+      end
+
+      # Returns the last human communication, status, and timestamp.
+      #
+      # @return [Sawyer::Resource] GitHub status last message
+      # @see https://status.github.com/api#api-last-message
+      def github_status_last_message
+        get(STATUS_ROOT).rels[:last_message].get.data
+      end
+
+      # Returns the most recent human communications with status and timestamp.
+      #
+      # @return [Array<Sawyer::Resource>] GitHub status messages
+      # @see https://status.github.com/api#api-recent-messages
+      def github_status_messages
+        get(STATUS_ROOT).rels[:messages].get.data
+      end
+    end
+  end
+end

data/lib/octokit/client/source_import.rb

@@ -0,0 +1,161 @@
+module Octokit
+  class Client
+
+    # Methods for the Source Import API
+    #
+    # @see https://developer.github.com/v3/migration/source_imports
+    module SourceImport
+
+      # Start a source import to a GitHub repository using GitHub Importer.
+      #
+      # @overload start_source_import(repo, vcs, vcs_url, options = {})
+      #   @deprecated
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      #   @param vcs [String] The originating VCS type. Can be one of "subversion", "git", "mercurial", or "tfvc".
+      #   @param vcs_url [String] The URL of the originating repository.
+      #   @param options [Hash]
+      #   @option options [String] :vcs_username If authentication is required, the username to provide to vcs_url.
+      #   @option options [String] :vcs_password If authentication is required, the password to provide to vcs_url.
+      #   @option options [String] :tfvc_project For a tfvc import, the name of the project that is being imported.
+      # @overload start_source_import(repo, vcs_url, options = {})
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      #   @param vcs_url [String] The URL of the originating repository.
+      #   @param options [Hash]
+      #   @param options [String] :vcs The originating VCS type. Can be one of "subversion", "git", "mercurial", or "tfvc".
+      #   @option options [String] :vcs_username If authentication is required, the username to provide to vcs_url.
+      #   @option options [String] :vcs_password If authentication is required, the password to provide to vcs_url.
+      #   @option options [String] :tfvc_project For a tfvc import, the name of the project that is being imported.
+      # @return [Sawyer::Resource] Hash representing the repository import
+      # @see https://developer.github.com/v3/migration/source_imports/#start-an-import
+      #
+      # @example
+      #   @client.start_source_import("octokit/octokit.rb", "http://svn.mycompany.com/svn/myproject", {
+      #    :vcs           => "subversion",
+      #    :vcs_username" => "octocat",
+      #    :vcs_password  => "secret"
+      #   })
+      def start_source_import(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        vcs_url = arguments.pop
+        vcs = arguments.pop
+        if vcs
+          octokit_warn "Octokit#start_source_import vcs parameter is now an option, please update your call before the next major Octokit version update."
+          arguments.options.merge!(:vcs => vcs)
+        end
+        options = ensure_api_media_type(:source_imports, arguments.options.merge(:vcs_url => vcs_url))
+        put "#{Repository.path arguments.repo}/import", options
+      end
+
+      # View the progress of an import.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Sawyer::Resource] Hash representing the progress of the import
+      # @see https://developer.github.com/v3/migration/source_imports/#get-import-progress
+      #
+      # @example
+      #   @client.source_import_progress("octokit/octokit.rb")
+      def source_import_progress(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        get "#{Repository.path repo}/import", options
+      end
+
+      # Update source import with authentication or project choice
+      # Restart source import if no options are passed
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Sawyer::Resource] Hash representing the repository import
+      # @see https://developer.github.com/v3/migration/source_imports/#update-existing-import
+      # @option options [String] :vcs_username If authentication is required, the username to provide to vcs_url.
+      # @option options [String] :vcs_password If authentication is required, the password to provide to vcs_url.
+      # @option options [String] To update project choice, please refer to the project_choice array from the progress return hash for the exact attributes.
+      # https://developer.github.com/v3/migration/source_imports/#update-existing-import
+      #
+      # @example
+      #   @client.update_source_import("octokit/octokit.rb", {
+      #    :vcs_username" => "octocat",
+      #    :vcs_password  => "secret"
+      #   })
+      def update_source_import(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        patch "#{Repository.path repo}/import", options
+      end
+
+      # List source import commit authors
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      # @option options [String] :since Only authors found after this id are returned.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing commit_authors.
+      # @see https://developer.github.com/v3/migration/source_imports/#get-commit-authors
+      #
+      # @example
+      #   @client.source_import_commit_authors("octokit/octokit.rb")
+      def source_import_commit_authors(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        get "#{Repository.path repo}/import/authors", options
+      end
+
+      # Update an author's identity for the import.
+      #
+      # @param author_url [String] The source import API url for the commit author
+      # @param values [Hash] The updated author attributes
+      # @option values [String] :email The new Git author email.
+      # @option values [String] :name The new Git author name.
+      # @return [Sawyer::Resource] Hash representing the updated commit author
+      # @see https://developer.github.com/v3/migration/source_imports/#map-a-commit-author
+      #
+      # @example
+      #   author_url = "https://api.github.com/repos/octokit/octokit.rb/import/authors/1"
+      #   @client.map_source_import_commit_author(author_url, {
+      #     :email => "hubot@github.com",
+      #     :name => "Hubot the Robot"
+      #   })
+      def map_source_import_commit_author(author_url, values, options = {})
+        options = ensure_api_media_type(:source_imports, options.merge(values))
+        patch author_url, options
+      end
+
+      # Stop an import for a repository.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Boolean] True if the import has been cancelled, false otherwise.
+      # @see https://developer.github.com/v3/migration/source_imports/#cancel-an-import
+      #
+      # @example
+      #   @client.cancel_source_import("octokit/octokit.rb")
+      def cancel_source_import(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        boolean_from_response :delete, "#{Repository.path repo}/import", options
+      end
+
+      # List source import large files
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      # @option options [Integer] :page Page of paginated results
+      # @return [Array<Sawyer::Resource>] Array of hashes representing files over 100MB.
+      # @see https://developer.github.com/v3/migration/source_imports/#get-large-files
+      #
+      # @example
+      #   @client.source_import_large_files("octokit/octokit.rb")
+      def source_import_large_files(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        get "#{Repository.path repo}/import/large_files", options
+      end
+
+      # Set preference for using Git LFS to import files over 100MB
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param use_lfs [String] Preference for using Git LFS to import large files. Can be one of "opt_in" or "opt_out"
+      # @return [Sawyer::Resource] Hash representing the repository import
+      # @see https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference
+      #
+      # @example
+      #   @client.opt_in_source_import_lfs("octokit/octokit.rb", "opt_in")
+      def set_source_import_lfs_preference(repo, use_lfs, options = {})
+        options = ensure_api_media_type(:source_imports, options.merge(:use_lfs => use_lfs))
+        patch "#{Repository.path repo}/import/lfs", options
+      end
+    end
+  end
+end