octokit 3.0.0 → 3.1.0

data/lib/octokit/client/contents.rb

@@ -5,7 +5,7 @@ module Octokit
 
     # Methods for the Repo Contents API
     #
-    # @see http://developer.github.com/v3/repos/contents/
+    # @see https://developer.github.com/v3/repos/contents/
     module Contents
 
       # Receive the default Readme for a repository
@@ -13,7 +13,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
       # @return [Sawyer::Resource] The detail of the readme
-      # @see http://developer.github.com/v3/repos/contents/#get-the-readme
+      # @see https://developer.github.com/v3/repos/contents/#get-the-readme
       # @example Get the readme file for a repo
       #   Octokit.readme("octokit/octokit.rb")
       def readme(repo, options={})
@@ -26,7 +26,7 @@ module Octokit
       # @option options [String] :path A folder or file path
       # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
       # @return [Sawyer::Resource] The contents of a file or list of the files in the folder
-      # @see http://developer.github.com/v3/repos/contents/#get-contents
+      # @see https://developer.github.com/v3/repos/contents/#get-contents
       # @example List the contents of lib/octokit.rb
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
       def contents(repo, options={})
@@ -46,7 +46,7 @@ module Octokit
       #   @option options [String] :branch The branch on which to add the content
       #   @option options [String] :file Path or Ruby File object for content
       # @return [Sawyer::Resource] The contents and commit info for the addition
-      # @see http://developer.github.com/v3/repos/contents/#create-a-file
+      # @see https://developer.github.com/v3/repos/contents/#create-a-file
       # @example Add content at lib/octokit.rb
       #   Octokit.create_contents("octokit/octokit.rb",
       #                    "lib/octokit.rb",
@@ -95,7 +95,7 @@ module Octokit
       #   @option options [String] :branch The branch on which to update the content
       #   @option options [String] :file Path or Ruby File object for content
       # @return [Sawyer::Resource] The contents and commit info for the update
-      # @see http://developer.github.com/v3/repos/contents/#update-a-file
+      # @see https://developer.github.com/v3/repos/contents/#update-a-file
       # @example Update content at lib/octokit.rb
       #   Octokit.update_contents("octokit/octokit.rb",
       #                    "lib/octokit.rb",
@@ -123,7 +123,7 @@ module Octokit
       # @param sha [String] The _blob sha_ of the content to delete
       # @option options [String] :branch The branch on which to delete the content
       # @return [Sawyer::Resource] The commit info for the delete
-      # @see http://developer.github.com/v3/repos/contents/#delete-a-file
+      # @see https://developer.github.com/v3/repos/contents/#delete-a-file
       # @example Delete content at lib/octokit.rb
       #   Octokit.delete_contents("octokit/octokit.rb",
       #                    "lib/octokit.rb",
@@ -146,7 +146,7 @@ module Octokit
       # @option options format [String] Either tarball (default) or zipball.
       # @option options [String] :ref Optional valid Git reference, defaults to master.
       # @return [String] Location of the download
-      # @see http://developer.github.com/v3/repos/contents/#get-archive-link
+      # @see https://developer.github.com/v3/repos/contents/#get-archive-link
       # @example Get archive link for octokit/octokit.rb
       #   Octokit.archive_link("octokit/octokit.rb")
       def archive_link(repo, options={})

data/lib/octokit/client/deployments.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Deployments API
     #
-    # @see http://developer.github.com/v3/repos/commits/deployments/
+    # @see https://developer.github.com/v3/repos/commits/deployments/
     module Deployments
 
       DEPLOYMENTS_PREVIEW_MEDIA_TYPE = "application/vnd.github.cannonball-preview+json".freeze
@@ -12,7 +12,7 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] A list of deployments
-      # @see http://developer.github.com/v3/repos/deployments/#list-deployments
+      # @see https://developer.github.com/v3/repos/deployments/#list-deployments
       def deployments(repo, options = {})
         options = ensure_deployments_api_media_type(options)
         get("repos/#{Repository.new(repo)}/deployments", options)
@@ -28,7 +28,7 @@ module Octokit
       # @option options [String] :auto_merge Optional parameter to merge the default branch into the requested deployment branch if necessary. Default: false
       # @option options [String] :description Optional short description.
       # @return [Sawyer::Resource] A deployment
-      # @see http://developer.github.com/v3/repos/deployments/#create-a-deployment
+      # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment
       def create_deployment(repo, ref, options = {})
         options = ensure_deployments_api_media_type(options)
         options[:ref] = ref
@@ -39,7 +39,7 @@ module Octokit
       #
       # @param deployment_url [String] A URL for a deployment resource
       # @return [Array<Sawyer::Resource>] A list of deployment statuses
-      # @see http://developer.github.com/v3/repos/deployments/#list-deployment-statuses
+      # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
       def deployment_statuses(deployment_url, options = {})
         options = ensure_deployments_api_media_type(options)
         deployment = get(deployment_url, :accept => options[:accept])
@@ -52,7 +52,7 @@ module Octokit
       # @param deployment_url [String] A URL for a deployment resource
       # @param state [String] The state: pending, success, failure, error
       # @return [Sawyer::Resource] A deployment status
-      # @see http://developer.github.com/v3/repos/deployments/#create-a-deployment-status
+      # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
       def create_deployment_status(deployment_url, state, options = {})
         options = ensure_deployments_api_media_type(options)
         deployment = get(deployment_url, :accept => options[:accept])

data/lib/octokit/client/downloads.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Repo Downloads API
     #
-    # @see http://developer.github.com/v3/repos/downloads/
+    # @see https://developer.github.com/v3/repos/downloads/
     module Downloads
 
       # List available downloads for a repository
@@ -11,11 +11,11 @@ module Octokit
       # @param repo [String, Repository, Hash] A Github Repository
       # @return [Array] A list of available downloads
       # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
-      # @see http://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository
+      # @see https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository
       # @example List all downloads for Github/Hubot
       #   Octokit.downloads("github/hubot")
       def downloads(repo, options={})
-        get "repos/#{Repository.new(repo)}/downloads", options
+        paginate "repos/#{Repository.new(repo)}/downloads", options
       end
       alias :list_downloads :downloads
 
@@ -25,7 +25,7 @@ module Octokit
       # @param id [Integer] ID of the download
       # @return [Sawyer::Resource] A single download from the repository
       # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
-      # @see http://developer.github.com/v3/repos/downloads/#get-a-single-download
+      # @see https://developer.github.com/v3/repos/downloads/#get-a-single-download
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.download("github/hubot")
       def download(repo, id, options={})
@@ -37,7 +37,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param id [Integer] ID of the download
       # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
-      # @see http://developer.github.com/v3/repos/downloads/#delete-a-download
+      # @see https://developer.github.com/v3/repos/downloads/#delete-a-download
       # @return [Boolean] Status
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.delete_download("github/hubot", 1234)

data/lib/octokit/client/emojis.rb

@@ -7,7 +7,7 @@ module Octokit
       # List all emojis used on GitHub
       #
       # @return [Sawyer::Resource] A list of all emojis on GitHub
-      # @see http://developer.github.com/v3/emojis/#emojis
+      # @see https://developer.github.com/v3/emojis/#emojis
       # @example List all emojis
       #   Octokit.emojis
       def emojis(options = {})

data/lib/octokit/client/events.rb

@@ -3,14 +3,14 @@ module Octokit
 
     # Method for the Events API
     #
-    # @see http://developer.github.com/v3/activity/events/
-    # @see http://developer.github.com/v3/issues/events/
+    # @see https://developer.github.com/v3/activity/events/
+    # @see https://developer.github.com/v3/issues/events/
     module Events
 
       # List all public events for GitHub
       #
       # @return [Array<Sawyer::Resource>] A list of all public events from GitHub
-      # @see http://developer.github.com/v3/activity/events/#list-public-events
+      # @see https://developer.github.com/v3/activity/events/#list-public-events
       # @example List all pubilc events
       #   Octokit.public_events
       def public_events(options = {})
@@ -20,7 +20,7 @@ module Octokit
       # List all user events
       #
       # @return [Array<Sawyer::Resource>] A list of all user events
-      # @see http://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
+      # @see https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
       # @example List all user events
       #   Octokit.user_events("sferik")
       def user_events(user, options = {})
@@ -31,7 +31,7 @@ module Octokit
       #
       # @param user [String] GitHub username
       # @return [Array<Sawyer::Resource>] A list of public user events
-      # @see http://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user
       # @example List public user events
       #   Octokit.user_events("sferik")
       def user_public_events(user, options = {})
@@ -41,7 +41,7 @@ module Octokit
       # List events that a user has received
       #
       # @return [Array<Sawyer::Resource>] A list of all user received events
-      # @see http://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received
+      # @see https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received
       # @example List all user received events
       #   Octokit.received_events("sferik")
       def received_events(user, options = {})
@@ -51,7 +51,7 @@ module Octokit
       # List public events a user has received
       #
       # @return [Array<Sawyer::Resource>] A list of public user received events
-      # @see http://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received
       # @example List public user received events
       #   Octokit.received_public_events("sferik")
       def received_public_events(user, options = {})
@@ -62,7 +62,7 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] A list of events for a repository
-      # @see http://developer.github.com/v3/activity/events/#list-repository-events
+      # @see https://developer.github.com/v3/activity/events/#list-repository-events
       # @example List events for a repository
       #   Octokit.repository_events("sferik/rails_admin")
       def repository_events(repo, options = {})
@@ -73,7 +73,7 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] A list of events for a repository's network
-      # @see http://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories
       # @example List events for a repository's network
       #   Octokit.repository_network_events("sferik/rails_admin")
       def repository_network_events(repo, options = {})
@@ -86,7 +86,7 @@ module Octokit
       #
       # @param org [String] Organization GitHub handle
       # @return [Array<Sawyer::Resource>] List of all events from a GitHub organization
-      # @see http://developer.github.com/v3/activity/events/#list-events-for-an-organization
+      # @see https://developer.github.com/v3/activity/events/#list-events-for-an-organization
       # @example List events for the lostisland organization
       #   @client.organization_events("lostisland")
       def organization_events(org, options = {})
@@ -97,7 +97,7 @@ module Octokit
       #
       # @param org [String] Organization GitHub username
       # @return [Array<Sawyer::Resource>] List of public events from a GitHub organization
-      # @see http://developer.github.com/v3/activity/events/#list-public-events-for-an-organization
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization
       # @example List public events for GitHub
       #   Octokit.organization_public_events("GitHub")
       def organization_public_events(org, options = {})
@@ -109,8 +109,8 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       #
       # @return [Array<Sawyer::Resource>] Array of all Issue Events for this Repository
-      # @see http://developer.github.com/v3/issues/events/#list-events-for-a-repository
-      # @see http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
+      # @see https://developer.github.com/v3/issues/events/#list-events-for-a-repository
+      # @see https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
       # @example Get all Issue Events for Octokit
       #   Octokit.repository_issue_events("octokit/octokit.rb")
       def repository_issue_events(repo, options = {})
@@ -124,7 +124,7 @@ module Octokit
       # @param number [Integer] Issue number
       #
       # @return [Array<Sawyer::Resource>] Array of events for that issue
-      # @see http://developer.github.com/v3/issues/events/#list-events-for-an-issue
+      # @see https://developer.github.com/v3/issues/events/#list-events-for-an-issue
       # @example List all issues events for issue #38 on octokit/octokit.rb
       #   Octokit.issue_events("octokit/octokit.rb", 38)
       def issue_events(repo, number, options = {})
@@ -137,7 +137,7 @@ module Octokit
       # @param number [Integer] Event number
       #
       # @return [Sawyer::Resource] A single Event for an Issue
-      # @see http://developer.github.com/v3/issues/events/#get-a-single-event
+      # @see https://developer.github.com/v3/issues/events/#get-a-single-event
       # @example Get Event information for ID 3094334 (a pull request was closed)
       #   Octokit.issue_event("octokit/octokit.rb", 3094334)
       def issue_event(repo, number, options = {})

data/lib/octokit/client/feeds.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Feeds API
     #
-    # @see http://developer.github.com/v3/activity/feeds/
+    # @see https://developer.github.com/v3/activity/feeds/
     module Feeds
 
       # List Feeds
@@ -12,7 +12,7 @@ module Octokit
       # for more information.
       #
       # @return [Array<Sawyer::Resource>] list of feeds
-      # @see http://developer.github.com/v3/activity/feeds/#list-feeds
+      # @see https://developer.github.com/v3/activity/feeds/#list-feeds
       def feeds
         get "feeds"
       end

data/lib/octokit/client/gists.rb

@@ -3,7 +3,7 @@ module Octokit
 
     # Methods for the Gists API
     #
-    # @see http://developer.github.com/v3/gists/
+    # @see https://developer.github.com/v3/gists/
     module Gists
 
       # List gists for a user or all public gists
@@ -14,7 +14,7 @@ module Octokit
       #   Octokit.gists('defunkt')
       # @example Fetch all public gists
       #   Octokit.gists
-      # @see http://developer.github.com/v3/gists/#list-gists
+      # @see https://developer.github.com/v3/gists/#list-gists
       def gists(username=nil, options = {})
         if username.nil?
           paginate 'gists', options
@@ -29,7 +29,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of gists
       # @example Fetch all public gists
       #   Octokit.public_gists
-      # @see http://developer.github.com/v3/gists/#list-gists
+      # @see https://developer.github.com/v3/gists/#list-gists
       def public_gists(options = {})
         paginate 'gists/public', options
       end
@@ -37,7 +37,7 @@ module Octokit
       # List the authenticated user’s starred gists
       #
       # @return [Array<Sawyer::Resource>] A list of gists
-      # @see http://developer.github.com/v3/gists/#list-gists
+      # @see https://developer.github.com/v3/gists/#list-gists
       def starred_gists(options = {})
         paginate 'gists/starred', options
       end
@@ -46,7 +46,7 @@ module Octokit
       #
       # @param gist [String] ID of gist to fetch
       # @return [Sawyer::Resource] Gist information
-      # @see http://developer.github.com/v3/gists/#get-a-single-gist
+      # @see https://developer.github.com/v3/gists/#get-a-single-gist
       def gist(gist, options = {})
         get "gists/#{Gist.new(gist)}", options
       end
@@ -60,7 +60,7 @@ module Octokit
       #   should be the filename, the value a Hash with a :content key with text
       #   content of the Gist.
       # @return [Sawyer::Resource] Newly created gist info
-      # @see http://developer.github.com/v3/gists/#create-a-gist
+      # @see https://developer.github.com/v3/gists/#create-a-gist
       def create_gist(options = {})
         post 'gists', options
       end
@@ -79,7 +79,7 @@ module Octokit
       #   can be performed by including the filename with a null hash.
       # @return
       #   [Sawyer::Resource] Newly created gist info
-      # @see http://developer.github.com/v3/gists/#edit-a-gist
+      # @see https://developer.github.com/v3/gists/#edit-a-gist
       # @example Update a gist
       #   @client.edit_gist('some_id', {
       #     :files => {"boo.md" => {"content" => "updated stuff"}}
@@ -93,7 +93,7 @@ module Octokit
       #
       # @param gist [String] Gist ID
       # @return [Boolean] Indicates if gist is starred successfully
-      # @see http://developer.github.com/v3/gists/#star-a-gist
+      # @see https://developer.github.com/v3/gists/#star-a-gist
       def star_gist(gist, options = {})
         boolean_from_response :put, "gists/#{Gist.new(gist)}/star", options
       end
@@ -102,7 +102,7 @@ module Octokit
       #
       # @param gist [String] Gist ID
       # @return [Boolean] Indicates if gist is unstarred successfully
-      # @see http://developer.github.com/v3/gists/#unstar-a-gist
+      # @see https://developer.github.com/v3/gists/#unstar-a-gist
       def unstar_gist(gist, options = {})
         boolean_from_response :delete, "gists/#{Gist.new(gist)}/star", options
       end
@@ -111,7 +111,7 @@ module Octokit
       #
       # @param gist [String] Gist ID
       # @return [Boolean] Indicates if gist is starred
-      # @see http://developer.github.com/v3/gists/#check-if-a-gist-is-starred
+      # @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
       def gist_starred?(gist, options = {})
         boolean_from_response :get, "gists/#{Gist.new(gist)}/star", options
       end
@@ -120,7 +120,7 @@ module Octokit
       #
       # @param gist [String] Gist ID
       # @return [Sawyer::Resource] Data for the new gist
-      # @see http://developer.github.com/v3/gists/#fork-a-gist
+      # @see https://developer.github.com/v3/gists/#fork-a-gist
       def fork_gist(gist, options = {})
         post "gists/#{Gist.new(gist)}/forks", options
       end
@@ -129,7 +129,7 @@ module Octokit
       #
       # @param gist [String] Gist ID
       # @return [Boolean] Indicating success of deletion
-      # @see http://developer.github.com/v3/gists/#delete-a-gist
+      # @see https://developer.github.com/v3/gists/#delete-a-gist
       def delete_gist(gist, options = {})
         boolean_from_response :delete, "gists/#{Gist.new(gist)}", options
       end
@@ -138,7 +138,7 @@ module Octokit
       #
       # @param gist_id [String] Gist Id.
       # @return [Array<Sawyer::Resource>] Array of hashes representing comments.
-      # @see http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
+      # @see https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
       # @example
       #   Octokit.gist_comments('3528ae645')
       def gist_comments(gist_id, options = {})
@@ -150,7 +150,7 @@ module Octokit
       # @param gist_id [String] Id of the gist.
       # @param gist_comment_id [Integer] Id of the gist comment.
       # @return [Sawyer::Resource] Hash representing gist comment.
-      # @see http://developer.github.com/v3/gists/comments/#get-a-single-comment
+      # @see https://developer.github.com/v3/gists/comments/#get-a-single-comment
       # @example
       #   Octokit.gist_comment('208sdaz3', 1451398)
       def gist_comment(gist_id, gist_comment_id, options = {})
@@ -164,7 +164,7 @@ module Octokit
       # @param gist_id [String] Id of the gist.
       # @param comment [String] Comment contents.
       # @return [Sawyer::Resource] Hash representing the new comment.
-      # @see http://developer.github.com/v3/gists/comments/#create-a-comment
+      # @see https://developer.github.com/v3/gists/comments/#create-a-comment
       # @example
       #   @client.create_gist_comment('3528645', 'This is very helpful.')
       def create_gist_comment(gist_id, comment, options = {})
@@ -180,7 +180,7 @@ module Octokit
       # @param gist_comment_id [Integer] Id of the gist comment to update.
       # @param comment [String] Updated comment contents.
       # @return [Sawyer::Resource] Hash representing the updated comment.
-      # @see http://developer.github.com/v3/gists/comments/#edit-a-comment
+      # @see https://developer.github.com/v3/gists/comments/#edit-a-comment
       # @example
       #   @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
       def update_gist_comment(gist_id, gist_comment_id, comment, options = {})
@@ -195,7 +195,7 @@ module Octokit
       # @param gist_id [String] Id of the gist.
       # @param gist_comment_id [Integer] Id of the gist comment to delete.
       # @return [Boolean] True if comment deleted, false otherwise.
-      # @see http://developer.github.com/v3/gists/comments/#delete-a-comment
+      # @see https://developer.github.com/v3/gists/comments/#delete-a-comment
       # @example
       #   @client.delete_gist_comment('208sdaz3', '586399')
       def delete_gist_comment(gist_id, gist_comment_id, options = {})

data/lib/octokit/client/gitignore.rb

@@ -3,14 +3,14 @@ module Octokit
 
     # Methods for the Gitignore API
     #
-    # @see http://developer.github.com/v3/gitignore/
+    # @see https://developer.github.com/v3/gitignore/
     module Gitignore
 
       # Listing available gitignore templates.
       #
       # These templates can be passed option when creating a repository.
       #
-      # @see http://developer.github.com/v3/gitignore/#listing-available-templates
+      # @see https://developer.github.com/v3/gitignore/#listing-available-templates
       #
       # @return [Array<String>] List of templates.
       #
@@ -29,7 +29,7 @@ module Octokit
       #   case sensitive, make sure to use a valid name from the
       #   .gitignore_templates list.
       #
-      # @see http://developer.github.com/v3/gitignore/#get-a-single-template
+      # @see https://developer.github.com/v3/gitignore/#get-a-single-template
       #
       # @return [Sawyer::Resource] Gitignore template
       #