octokit 4.2.0 → 9.2.0

data/lib/octokit/client/deployments.rb

@@ -1,10 +1,20 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Deployments API
     #
     # @see https://developer.github.com/v3/repos/commits/deployments/
     module Deployments
+      # Fetch a single deployment for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param deployment_id [Integer, String, Repository, Hash] A GitHub repository
+      # @return <Sawyer::Resource> A single deployment
+      # @see https://developer.github.com/v3/repos/deployments/#get-a-single-deployment
+      def deployment(repo, deployment_id, options = {})
+        get("#{Repository.path repo}/deployments/#{deployment_id}", options)
+      end
 
       # List all deployments for a repository
       #
@@ -12,9 +22,9 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of deployments
       # @see https://developer.github.com/v3/repos/deployments/#list-deployments
       def deployments(repo, options = {})
-        get("#{Repository.path repo}/deployments", options)
+        paginate("#{Repository.path repo}/deployments", options)
       end
-      alias :list_deployments :deployments
+      alias list_deployments deployments
 
       # Create a deployment for a ref
       #
@@ -33,25 +43,37 @@ module Octokit
         post("#{Repository.path repo}/deployments", options)
       end
 
+      # Delete a Deployment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param deployment_id [Integer, String, Repository, Hash] A GitHub repository
+      # @return [No Content]
+      # @see https://developer.github.com/v3/repos/deployments/#delete-a-deployment
+      def delete_deployment(repo, deployment_id, options = {})
+        delete("#{Repository.path repo}/deployments/#{deployment_id}", options)
+      end
+
       # List all statuses for a Deployment
       #
       # @param deployment_url [String] A URL for a deployment resource
       # @return [Array<Sawyer::Resource>] A list of deployment statuses
       # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
       def deployment_statuses(deployment_url, options = {})
-        deployment = get(deployment_url, :accept => options[:accept])
-        get(deployment.rels[:statuses].href, options)
+        deployment = get(deployment_url, accept: options[:accept])
+        paginate(deployment.rels[:statuses].href, options)
       end
-      alias :list_deployment_statuses :deployment_statuses
+      alias list_deployment_statuses deployment_statuses
 
       # Create a deployment status for a Deployment
       #
       # @param deployment_url [String] A URL for a deployment resource
       # @param state [String] The state: pending, success, failure, error
+      # @option options [String] :target_url The target URL to associate with this status. Default: ""
+      # @option options [String] :description A short description of the status. Maximum length of 140 characters. Default: ""
       # @return [Sawyer::Resource] A deployment status
       # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
       def create_deployment_status(deployment_url, state, options = {})
-        deployment = get(deployment_url, :accept => options[:accept])
+        deployment = get(deployment_url, accept: options[:accept])
         options[:state] = state.to_s.downcase
         post(deployment.rels[:statuses].href, options)
       end

data/lib/octokit/client/downloads.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Repo Downloads API
     #
     # @see https://developer.github.com/v3/repos/downloads/
     module Downloads
-
       # List available downloads for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A Github Repository
@@ -14,10 +14,10 @@ module Octokit
       # @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={})
+      def downloads(repo, options = {})
         paginate "#{Repository.path repo}/downloads", options
       end
-      alias :list_downloads :downloads
+      alias list_downloads downloads
 
       # Get single download for a repository
       #
@@ -28,7 +28,7 @@ module Octokit
       # @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={})
+      def download(repo, id, options = {})
         get "#{Repository.path repo}/downloads/#{id}", options
       end
 
@@ -44,7 +44,6 @@ module Octokit
       def delete_download(repo, id, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/downloads/#{id}", options
       end
-
     end
   end
 end

data/lib/octokit/client/emojis.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Emojis API
     module Emojis
-
       # List all emojis used on GitHub
       #
       # @return [Sawyer::Resource] A list of all emojis on GitHub
@@ -11,7 +11,7 @@ module Octokit
       # @example List all emojis
       #   Octokit.emojis
       def emojis(options = {})
-        get "emojis", options
+        get 'emojis', options
       end
     end
   end

data/lib/octokit/client/environments.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Environments API
+    #
+    # @see https://docs.github.com/en/rest/deployments/environments
+    module Environments
+      # Fetch a single environment for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return <Sawyer::Resource> A single environment
+      # @see https://docs.github.com/en/rest/deployments/environments#get-an-environment
+      def environment(repo, environment_name, options = {})
+        get("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Lists the environments for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [Integer] :per_page The number of results per page (max 100). Default: 30
+      # @option options [Integer] :page Page number of the results to fetch. Default: 1
+      # @return [Sawyer::Resource] Total count of environments and list of environments
+      # @see https://docs.github.com/en/rest/deployments/environments#list-environments
+      def environments(repo, options = {})
+        paginate("#{Repository.path repo}/environments", options) do |data, last_response|
+          data.environments.concat last_response.data.environments
+          data.total_count += last_response.data.total_count
+        end
+      end
+      alias list_environments environments
+
+      # Create or update an environment with protection rules, such as required reviewers
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @option options [Integer] :wait_timer The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
+      # @option options [Array] :reviewers The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers.
+      # @option options [Object] :deployment_branch_policy The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
+      # @return [Sawyer::Resource] An environment
+      # @see https://docs.github.com/en/rest/deployments/environments#create-or-update-an-environment
+      def create_or_update_environment(repo, environment_name, options = {})
+        put("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Delete an Environment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return [No Content]
+      # @see https://docs.github.com/en/rest/deployments/environments#delete-an-environment
+      def delete_environment(repo, environment_name, options = {})
+        delete("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+    end
+  end
+end

data/lib/octokit/client/events.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Method for the Events API
     #
     # @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
@@ -14,7 +14,7 @@ module Octokit
       # @example List all pubilc events
       #   Octokit.public_events
       def public_events(options = {})
-        paginate "events", options
+        paginate 'events', options
       end
 
       # List all user events
@@ -119,7 +119,7 @@ module Octokit
       def repository_issue_events(repo, options = {})
         paginate "#{Repository.path repo}/issues/events", options
       end
-      alias :repo_issue_events :repository_issue_events
+      alias repo_issue_events repository_issue_events
 
       # List events for an Issue
       #

data/lib/octokit/client/feeds.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Feeds API
     #
     # @see https://developer.github.com/v3/activity/feeds/
     module Feeds
-
       # List Feeds
       #
       # The feeds returned depend on authentication, see the GitHub API docs
@@ -14,7 +14,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] list of feeds
       # @see https://developer.github.com/v3/activity/feeds/#list-feeds
       def feeds
-        get "feeds"
+        get 'feeds'
       end
 
       # Get a Feed by name
@@ -24,10 +24,9 @@ module Octokit
       #   parser.
       def feed(name, options = {})
         if rel = feeds._links[name]
-          get rel.href, :accept => rel.type, :options => options
+          get rel.href, accept: rel.type, options: options
         end
       end
-
     end
   end
 end

data/lib/octokit/client/gists.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Gists API
     #
     # @see https://developer.github.com/v3/gists/
     module Gists
-
       # List gists for a user or all public gists
       #
       # @param user [String] An optional user to filter listing
@@ -15,14 +15,14 @@ module Octokit
       # @example Fetch all public gists
       #   Octokit.gists
       # @see https://developer.github.com/v3/gists/#list-gists
-      def gists(user=nil, options = {})
+      def gists(user = nil, options = {})
         if user.nil?
           paginate 'gists', options
         else
           paginate "#{User.path user}/gists", options
         end
       end
-      alias :list_gists :gists
+      alias list_gists gists
 
       # List public gists
       #
@@ -45,10 +45,17 @@ module Octokit
       # Get a single gist
       #
       # @param gist [String] ID of gist to fetch
+      # @option options [String] :sha Specific gist revision SHA
       # @return [Sawyer::Resource] Gist information
       # @see https://developer.github.com/v3/gists/#get-a-single-gist
+      # @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
       def gist(gist, options = {})
-        get "gists/#{Gist.new(gist)}", options
+        options = options.dup
+        if sha = options.delete(:sha)
+          get "gists/#{Gist.new(gist)}/#{sha}", options
+        else
+          get "gists/#{Gist.new(gist)}", options
+        end
       end
 
       # Create a gist
@@ -69,7 +76,6 @@ module Octokit
       #
       # @param options [Hash] Gist information.
       # @option options [String] :description
-      # @option options [Boolean] :public Sets gist visibility
       # @option options [Hash] :files Files that make up this gist. Keys
       #   should be the filename, the value a Hash with a :content key with text
       #   content of the Gist.
@@ -88,6 +94,17 @@ module Octokit
         patch "gists/#{Gist.new(gist)}", options
       end
 
+      # List gist commits
+      #
+      # @param gist [String] Gist ID
+      # @return [Array] List of commits to the gist
+      # @see https://developer.github.com/v3/gists/#list-gist-commits
+      # @example List commits for a gist
+      #   @client.gist_commits('some_id')
+      def gist_commits(gist, options = {})
+        paginate "gists/#{Gist.new(gist)}/commits", options
+      end
+
       #
       # Star a gist
       #
@@ -125,6 +142,17 @@ module Octokit
         post "gists/#{Gist.new(gist)}/forks", options
       end
 
+      # List gist forks
+      #
+      # @param gist [String] Gist ID
+      # @return [Array] List of gist forks
+      # @see https://developer.github.com/v3/gists/#list-gist-forks
+      # @example List gist forks
+      #   @client.gist_forks('some-id')
+      def gist_forks(gist, options = {})
+        paginate "gists/#{Gist.new(gist)}/forks", options
+      end
+
       # Delete a gist
       #
       # @param gist [String] Gist ID
@@ -168,7 +196,7 @@ module Octokit
       # @example
       #   @client.create_gist_comment('3528645', 'This is very helpful.')
       def create_gist_comment(gist_id, comment, options = {})
-        options.merge!({:body => comment})
+        options = options.merge({ body: comment })
         post "gists/#{gist_id}/comments", options
       end
 
@@ -184,7 +212,7 @@ module Octokit
       # @example
       #   @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
       def update_gist_comment(gist_id, gist_comment_id, comment, options = {})
-        options.merge!({:body => comment})
+        options = options.merge({ body: comment })
         patch "gists/#{gist_id}/comments/#{gist_comment_id}", options
       end
 

data/lib/octokit/client/gitignore.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Gitignore API
     #
     # @see https://developer.github.com/v3/gitignore/
     module Gitignore
-
       # Listing available gitignore templates.
       #
       # These templates can be passed option when creating a repository.
@@ -17,7 +17,7 @@ module Octokit
       # @example Git all the gitignore templates
       #   @client.gitignore_templates
       def gitignore_templates(options = {})
-        get "gitignore/templates", options
+        get 'gitignore/templates', options
       end
 
       # Get a gitignore template.

data/lib/octokit/client/hooks.rb

@@ -1,19 +1,9 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Hooks API
     module Hooks
-
-      # List all Service Hooks supported by GitHub
-      #
-      # @return [Sawyer::Resource] A list of all hooks on GitHub
-      # @see https://developer.github.com/v3/repos/hooks/#services
-      # @example List all hooks
-      #   Octokit.available_hooks
-      def available_hooks(options = {})
-        get "hooks", options
-      end
-
       # List repo hooks
       #
       # Requires authenticated client.
@@ -73,7 +63,7 @@ module Octokit
       #     }
       #   )
       def create_hook(repo, name, config, options = {})
-        options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
+        options = { name: name, config: config, events: ['push'], active: true }.merge(options)
         post "#{Repository.path repo}/hooks", options
       end
 
@@ -116,7 +106,7 @@ module Octokit
       #     }
       #   )
       def edit_hook(repo, id, name, config, options = {})
-        options = {:name => name, :config => config}.merge(options)
+        options = { name: name, config: config }.merge(options)
         patch "#{Repository.path repo}/hooks/#{id}", options
       end
 
@@ -148,39 +138,53 @@ module Octokit
         boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/tests", options
       end
 
+      # Ping hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Id of the hook to send a ping.
+      # @return [Boolean] Ping requested?
+      # @see https://developer.github.com/v3/repos/hooks/#ping-a-hook
+      # @example
+      #   @client.ping_hook('octokit/octokit.rb', 1000000)
+      def ping_hook(repo, id, options = {})
+        boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/pings", options
+      end
+
       # List org hooks
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @return [Array<Sawyer::Resource>] Array of hashes representing hooks.
       # @see https://developer.github.com/v3/orgs/hooks/#list-hooks
       # @example
       #   @client.org_hooks('octokit')
       def org_hooks(org, options = {})
-        paginate "orgs/#{org}/hooks", options
+        paginate "#{Organization.path org}/hooks", options
       end
-      alias :list_org_hooks :org_hooks
+      alias list_org_hooks org_hooks
 
       # Get an org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to get.
       # @return [Sawyer::Resource] Hash representing hook.
       # @see https://developer.github.com/v3/orgs/hooks/#get-single-hook
       # @example
       #   @client.org_hook('octokit', 123)
       def org_hook(org, id, options = {})
-        get "orgs/#{org}/hooks/#{id}", options
+        get "#{Organization.path org}/hooks/#{id}", options
       end
 
       # Create an org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param config [Hash] A Hash containing key/value pairs to provide
       #   settings for this hook.
       # @option options [Array<String>] :events ('["push"]') Determines what
@@ -203,15 +207,15 @@ module Octokit
       #     }
       #   )
       def create_org_hook(org, config, options = {})
-        options = { :name => "web", :config => config }.merge(options)
-        post "orgs/#{org}/hooks", options
+        options = { name: 'web', config: config }.merge(options)
+        post "#{Organization.path org}/hooks", options
       end
 
       # Update an org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to update.
       # @param config [Hash] A Hash containing key/value pairs to provide
       #   settings for this hook.
@@ -236,37 +240,37 @@ module Octokit
       #     }
       #   )
       def edit_org_hook(org, id, config, options = {})
-        options = { :config => config }.merge(options)
-        patch "orgs/#{org}/hooks/#{id}", options
+        options = { config: config }.merge(options)
+        patch "#{Organization.path org}/hooks/#{id}", options
       end
-      alias :update_org_hook :edit_org_hook
+      alias update_org_hook edit_org_hook
 
       # Ping org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to update.
       # @return [Boolean] Success
       # @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook
       # @example
       #   @client.ping_org_hook('octokit', 1000000)
       def ping_org_hook(org, id, options = {})
-        boolean_from_response :post, "orgs/#{org}/hooks/#{id}/pings", options
+        boolean_from_response :post, "#{Organization.path org}/hooks/#{id}/pings", options
       end
 
       # Remove org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to update.
       # @return [Boolean] True if hook removed, false otherwise.
       # @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook
       # @example
       #   @client.remove_org_hook('octokit', 1000000)
       def remove_org_hook(org, id, options = {})
-        boolean_from_response :delete, "orgs/#{org}/hooks/#{id}", options
+        boolean_from_response :delete, "#{Organization.path org}/hooks/#{id}", options
       end
 
       # Parse payload string