octokit 5.3.0 → 5.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 141fb4f7d19bc08a88ee10f57ef90a92693d9809fd48a456c84d27a420d808ce
-  data.tar.gz: a1e56cee779f2b90a0241dbc4a36a150e836a77c7f5001d12ded8b4f6c8bc01d
+  metadata.gz: bbf0b3ef2f8550628d4bde2fa55f7bcb97261364e94aac9f5a149ce6e86fa019
+  data.tar.gz: d336c02e28efb73618c1c24827b2b7703dc5341ce95087467089cf36f11d96fb
 SHA512:
-  metadata.gz: 539ba245d6a0e5768b0e5771e2060070c8fbb9e57f22029adbbf5cf9e27e36367194545319842cd6a999b92e7f05746cb910acef767e4f4db4a2c957181cb3e0
-  data.tar.gz: 95c82a4c3cc174b17a0566cea12dc261dfae703e20a9a1c8478a5704d4d011ec72840883b7d0c2552861e2127d305329f62210401dbbc57672b123b9a11868ae
+  metadata.gz: 960aacdc0e1a37794e6bed1a0c5f2686c1dca5160c0802cb449590f92ecab4cf243a0201b65e419fe3ffa38c194f106eceed0d46c90f63ceeb8a4aa14b22d716
+  data.tar.gz: 22a81c032d49f11c2f3875bfbc1c577449787d0899f20d0108dc7de868a2b5f1c86163ccebf46eb4a4b2567277c46fd83aca619c071a238746229664894008bf

data/README.md

@@ -79,7 +79,7 @@ Install via Rubygems
 
 ... or add to your Gemfile
 
-    gem "octokit", "~> 4.0"
+    gem "octokit", "~> 5.0"
 
 Access the library in Ruby:
 
@@ -664,7 +664,7 @@ Once configured, the middleware will store responses in cache based on ETag
 fingerprint and serve those back up for future `304` responses for the same
 resource. See the [project README][cache] for advanced usage.
 
-[cache]: https://github.com/plataformatec/faraday-http-cache
+[cache]: https://github.com/sourcelevel/faraday-http-cache
 [faraday]: https://github.com/lostisland/faraday
 
 ## Hacking on Octokit.rb

data/lib/octokit/client/actions_artifacts.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Actions Artifacts API
+    #
+    # @see https://developer.github.com/v3/actions/artifacts
+    module ActionsArtifacts
+      # List all artifacts for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Sawyer::Resource] the total count and an array of artifacts
+      # @see https://developer.github.com/v3/actions/artifacts#list-artifacts-for-a-repository
+      def repository_artifacts(repo, options = {})
+        paginate "#{Repository.path repo}/actions/artifacts", options
+      end
+
+      # List all artifacts for a workflow run
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param workflow_run_id [Integer] Id of a workflow run
+      #
+      # @return [Sawyer::Resource] the total count and an array of artifacts
+      # @see https://docs.github.com/en/rest/actions/artifacts#list-workflow-run-artifacts
+      def workflow_run_artifacts(repo, workflow_run_id, options = {})
+        paginate "#{Repository.path repo}/actions/runs/#{workflow_run_id}/artifacts", options
+      end
+
+      # Get an artifact
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of an artifact
+      #
+      # @return [Sawyer::Resource] Artifact information
+      # @see https://docs.github.com/en/rest/actions/artifacts#get-an-artifact
+      def artifact(repo, id, options = {})
+        get "#{Repository.path repo}/actions/artifacts/#{id}", options
+      end
+
+      # Get a download URL for an artifact
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of an artifact
+      #
+      # @return [String] URL to the .zip archive of the artifact
+      # @see https://docs.github.com/en/rest/actions/artifacts#download-an-artifact
+      def artifact_download_url(repo, id, options = {})
+        url = "#{Repository.path repo}/actions/artifacts/#{id}/zip"
+
+        response = client_without_redirects.head(url, options)
+        response.headers['Location']
+      end
+
+      # Delete an artifact
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] Id of an artifact
+      #
+      # @return [Boolean] Return true if the artifact was successfully deleted
+      # @see https://docs.github.com/en/rest/actions/artifacts#delete-an-artifact
+      def delete_artifact(repo, id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/actions/artifacts/#{id}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/organizations.rb

@@ -335,6 +335,27 @@ module Octokit
         get "#{Organization.path(org)}/teams/#{team_slug}", options
       end
 
+      # Check team permissions for a repository
+      #
+      # Requires authenticated organization member.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param team_slug_or_id [String, Integer] Team slug or Team ID.
+      # @param owner [String] Owner name for the repository.
+      # @param repo [String] Name of the repo to check permissions against.
+      # @return [String, Sawyer::Resource] Depending on options it may be an empty string or a resource.
+      # @example
+      #   # Check whether the team has any permissions with the repository
+      #   @client.team_permissions_for_repo("github", "justice-league", "octocat", "hello-world")
+      #
+      # @example
+      #   # Get the full repository object including the permissions level and role for the team
+      #   @client.team_permissions_for_repo("github", "justice-league", "octocat", "hello-world", :accept => 'application/vnd.github.v3.repository+json')
+      # @see https://docs.github.com/en/rest/teams/teams#check-team-permissions-for-a-repository
+      def team_permissions_for_repo(org, team_slug_or_id, owner, repo, options = {})
+        get "#{Organization.path(org)}/teams/#{team_slug_or_id}/repos/#{owner}/#{repo}", options
+      end
+
       # List child teams
       #
       # Requires authenticated organization member.
@@ -802,6 +823,26 @@ module Octokit
       def billing_actions(org)
         get "#{Organization.path(org)}/settings/billing/actions"
       end
+
+      # Get organization audit log.
+      #
+      # Gets the audit log for an organization.
+      #
+      # @param org [String, Integer] Organization GitHub login or id for which
+      #   to retrieve the audit log.
+      # @option options [String] :include ('all') Filter by event type.
+      #   `all`, `git` or `web`.
+      # @option options [String] :phrase A search phrase.
+      # @option options [String] :order ('desc') The order of audit log events. To list newest events first, specify desc.
+      # To list oldest events first, specify asc.
+      #
+      # @return [Array<Sawyer::Resource>] List of events
+      # @see https://docs.github.com/en/enterprise-cloud@latest/rest/orgs/orgs#get-the-audit-log-for-an-organization
+      # @example
+      #   Octokit.organization_audit_log('github', {include: 'all', phrase: 'action:org.add_member created:>2022-08-29 user:octocat'})
+      def organization_audit_log(org, options = {})
+        paginate "#{Organization.path org}/audit-log", options
+      end
     end
   end
 end

data/lib/octokit/client/projects.rb

@@ -4,7 +4,7 @@ module Octokit
   class Client
     # Methods for Projects API
     #
-    # @see https://developer.github.com/v3/repos/projects
+    # @see https://docs.github.com/en/rest/projects
     module Projects
       # List projects for a repository
       #

data/lib/octokit/client.rb

@@ -11,6 +11,7 @@ require 'octokit/rate_limit'
 require 'octokit/repository'
 require 'octokit/user'
 require 'octokit/organization'
+require 'octokit/client/actions_artifacts'
 require 'octokit/client/actions_secrets'
 require 'octokit/client/actions_workflows'
 require 'octokit/client/actions_workflow_jobs'
@@ -74,6 +75,7 @@ module Octokit
     include Octokit::Configurable
     include Octokit::Connection
     include Octokit::Warnable
+    include Octokit::Client::ActionsArtifacts
     include Octokit::Client::ActionsSecrets
     include Octokit::Client::Authorizations
     include Octokit::Client::Checks

data/lib/octokit/error.rb

@@ -77,7 +77,7 @@ module Octokit
         Octokit::TooManyRequests
       when /login attempts exceeded/i
         Octokit::TooManyLoginAttempts
-      when /returns blobs up to [0-9]+ MB/i
+      when /(returns|for) blobs (up to|between) [0-9\-]+ MB/i
         Octokit::TooLargeContent
       when /abuse/i
         Octokit::AbuseDetected

data/lib/octokit/version.rb

@@ -7,11 +7,11 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 3
+  MINOR = 6
 
   # Current patch level.
   # @return [Integer]
-  PATCH = 0
+  PATCH = 1
 
   # Full release version.
   # @return [String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.6.1
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,6 +85,7 @@ files:
 - lib/octokit/arguments.rb
 - lib/octokit/authentication.rb
 - lib/octokit/client.rb
+- lib/octokit/client/actions_artifacts.rb
 - lib/octokit/client/actions_secrets.rb
 - lib/octokit/client/actions_workflow_jobs.rb
 - lib/octokit/client/actions_workflow_runs.rb