octokit 4.22.0 → 9.2.0

data/lib/octokit/client/dependabot_secrets.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the dependabot Secrets API
+    #
+    # @see https://docs.github.com/en/rest/dependabot/
+    module DependabotSecrets
+      # Get public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets#get-a-repository-public-key
+      def get_dependabot_public_key(repo)
+        get "#{Repository.path repo}/dependabot/secrets/public-key"
+      end
+
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key
+      def get_org_dependabot_public_key(org)
+        get "#{Organization.path org}/dependabot/secrets/public-key"
+      end
+
+      # List secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_dependabot_secrets(repo)
+        paginate "#{Repository.path repo}/dependabot/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#list-organization-secrets
+      def list_org_dependabot_secrets(org)
+        paginate "#{Organization.path org}/dependabot/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_dependabot_secret(repo, name)
+        get "#{Repository.path repo}/dependabot/secrets/#{name}"
+      end
+
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret
+      def get_org_dependabot_secret(org, name)
+        get "#{Organization.path org}/dependabot/secrets/#{name}"
+      end
+
+      # Create or update secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_dependabot_secret(repo, name, options)
+        put "#{Repository.path repo}/dependabot/secrets/#{name}", options
+      end
+
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret
+      def create_or_update_org_dependabot_secret(org, name, options)
+        put "#{Organization.path org}/dependabot/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_dependabot_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/dependabot/secrets/#{name}"
+      end
+
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/dependabot/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret
+      def delete_org_dependabot_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/dependabot/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/deployments.rb

@@ -1,11 +1,11 @@
+# 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
@@ -22,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
       #
@@ -59,10 +59,10 @@ module Octokit
       # @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
       #
@@ -73,7 +73,7 @@ module Octokit
       # @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
       #
@@ -131,7 +131,6 @@ module Octokit
       # @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 = {})
-        options = ensure_api_media_type(:project_card_events, options)
         paginate "#{Repository.path repo}/issues/#{number}/events", options
       end
 

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
       #
@@ -196,7 +196,7 @@ module Octokit
       # @example
       #   @client.create_gist_comment('3528645', 'This is very helpful.')
       def create_gist_comment(gist_id, comment, options = {})
-        options = options.merge({:body => comment})
+        options = options.merge({ body: comment })
         post "gists/#{gist_id}/comments", options
       end
 
@@ -212,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 = 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
 
@@ -158,7 +148,7 @@ module Octokit
       # @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={})
+      def ping_hook(repo, id, options = {})
         boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/pings", options
       end
 
@@ -174,7 +164,7 @@ module Octokit
       def org_hooks(org, options = {})
         paginate "#{Organization.path org}/hooks", options
       end
-      alias :list_org_hooks :org_hooks
+      alias list_org_hooks org_hooks
 
       # Get an org hook
       #
@@ -217,7 +207,7 @@ module Octokit
       #     }
       #   )
       def create_org_hook(org, config, options = {})
-        options = { :name => "web", :config => config }.merge(options)
+        options = { name: 'web', config: config }.merge(options)
         post "#{Organization.path org}/hooks", options
       end
 
@@ -250,10 +240,10 @@ module Octokit
       #     }
       #   )
       def edit_org_hook(org, id, config, options = {})
-        options = { :config => config }.merge(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
       #

data/lib/octokit/client/issues.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Issues API
     #
     # @see https://developer.github.com/v3/issues/
     module Issues
-
       # List issues for the authenticated user or repository
       #
       # @param repository [Integer, String, Repository, Hash] A GitHub repository.
@@ -28,10 +28,10 @@ module Octokit
       #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
       #   @client.list_issues
       def list_issues(repository = nil, options = {})
-        path = repository ? "#{Repository.new(repository).path}/issues" : "issues"
+        path = repository ? "#{Repository.new(repository).path}/issues" : 'issues'
         paginate path, options
       end
-      alias :issues :list_issues
+      alias issues list_issues
 
       # List all issues across owned and member repositories for the authenticated user
       #
@@ -91,17 +91,17 @@ module Octokit
       def create_issue(repo, title, body = nil, options = {})
         options[:labels] = case options[:labels]
                            when String
-                             options[:labels].split(",").map(&:strip)
+                             options[:labels].split(',').map(&:strip)
                            when Array
                              options[:labels]
                            else
                              []
                            end
-        parameters = { :title => title }
+        parameters = { title: title }
         parameters[:body] = body unless body.nil?
         post "#{Repository.path repo}/issues", options.merge(parameters)
       end
-      alias :open_issue :create_issue
+      alias open_issue create_issue
 
       # Get a single issue from a repository
       #
@@ -129,7 +129,7 @@ module Octokit
       # @example Close Issue #25 from octokit/octokit.rb
       #   Octokit.close_issue("octokit/octokit.rb", "25")
       def close_issue(repo, number, options = {})
-        patch "#{Repository.path repo}/issues/#{number}", options.merge({:state => "closed"})
+        patch "#{Repository.path repo}/issues/#{number}", options.merge({ state: 'closed' })
       end
 
       # Reopen an issue
@@ -146,7 +146,7 @@ module Octokit
       # @example Reopen Issue #25 from octokit/octokit.rb
       #   Octokit.reopen_issue("octokit/octokit.rb", "25")
       def reopen_issue(repo, number, options = {})
-        patch "#{Repository.path repo}/issues/#{number}", options.merge({:state => "open"})
+        patch "#{Repository.path repo}/issues/#{number}", options.merge({ state: 'open' })
       end
 
       # Lock an issue's conversation, limiting it to collaborators
@@ -210,7 +210,7 @@ module Octokit
         arguments = Arguments.new(args)
         opts = arguments.options
 
-        if arguments.length > 0
+        unless arguments.empty?
           opts[:title] = arguments.shift
           opts[:body] = arguments.shift
         end
@@ -281,7 +281,7 @@ module Octokit
       # @example Add the comment "Almost to v1" to Issue #23 on octokit/octokit.rb
       #   Octokit.add_comment("octokit/octokit.rb", 23, "Almost to v1")
       def add_comment(repo, number, comment, options = {})
-        post "#{Repository.path repo}/issues/#{number}/comments", options.merge({:body => comment})
+        post "#{Repository.path repo}/issues/#{number}/comments", options.merge({ body: comment })
       end
 
       # Update a single comment on an issue
@@ -294,7 +294,7 @@ module Octokit
       # @example Update the comment #1194549 with body "I've started this on my 25-issue-comments-v3 fork" on an issue on octokit/octokit.rb
       #   Octokit.update_comment("octokit/octokit.rb", 1194549, "Almost to v1, added this on my fork")
       def update_comment(repo, number, comment, options = {})
-        patch "#{Repository.path repo}/issues/comments/#{number}", options.merge({:body => comment})
+        patch "#{Repository.path repo}/issues/comments/#{number}", options.merge({ body: comment })
       end
 
       # Delete a single comment
@@ -318,7 +318,6 @@ module Octokit
       # @example Get timeline for issue #1435 on octokit/octokit.rb
       #   Octokit.issue_timeline("octokit/octokit.rb", 1435)
       def issue_timeline(repo, number, options = {})
-        options = ensure_api_media_type(:issue_timelines, options)
         paginate "#{Repository.path repo}/issues/#{number}/timeline", options
       end
 
@@ -343,7 +342,7 @@ module Octokit
       # @example Add assignees "pengwynn" and "joeyw" to Issue #23 on octokit/octokit.rb
       #   Octokit.add_assignees("octokit/octokit.rb", 23, ["pengwynn", "joeyw"])
       def add_assignees(repo, number, assignees, options = {})
-        post "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
+        post "#{Repository.path repo}/issues/#{number}/assignees", options.merge({ assignees: assignees })
       end
 
       # Remove assignees from an issue
@@ -361,7 +360,7 @@ module Octokit
       #   Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn"],
       #     :accept => "application/vnd.github.v3+json")
       def remove_assignees(repo, number, assignees, options = {})
-        delete "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
+        delete "#{Repository.path repo}/issues/#{number}/assignees", options.merge({ assignees: assignees })
       end
     end
   end