octokit 5.4.0 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb3c4ab224890bb19194fb2c7af88c0e89be709e12b9a7df13df4d3aa7cac1dc
-  data.tar.gz: 79a40c2fea62d7898e7906a3119bf5049c51baeb128dfa88722301682b691204
+  metadata.gz: 142651c8cb905616f9b98ef7d87db6e56a729a6ee87cf423f347c6be549d356a
+  data.tar.gz: d647f6470d7c7c21d9dc589018a181225a51fe45913cb323704d9ddb01cecd1f
 SHA512:
-  metadata.gz: 6b6a080f40b9c52cb1450d13f5d64d0dbc8f8e27e699b585d0e9e1a3e29eb1a0b19eec29ca6ef25726b1c113f0c088a530762eabc297eb2a47ca77dedc71444c
-  data.tar.gz: ea44cdd3350cf3206dee44ca90f3fa3f3776d1be078fdaa77b64c99b3e3d1e9d7d7d6800f95cd4cfa076a0e171f8e7e7d689066ff551d2d8d5a63cb1efaff56c
+  metadata.gz: a674820129345b669b42d31934f195caeb453344907a4c95a5b11819466c3aba01dc37889e0371703dd0211747ab919b8a60858be0fa4cac7b39df261de42bd7
+  data.tar.gz: 7f2b1d6165badfe0094c0fffc3b2c176656a0fa11063dafef707595e749d99350cd692910e4f6d4829227bdd0e505452f8713b8e8bab524dcc94a9989af1f89b

data/README.md

@@ -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/workflow-runs#download-workflow-run-logs
+      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

@@ -823,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/version.rb

@@ -7,7 +7,7 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 4
+  MINOR = 6
 
   # Current patch level.
   # @return [Integer]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 5.6.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-30 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