octokit 4.21.0 → 4.25.0

data/lib/octokit/client/organizations.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Organizations API
     #
     # @see https://developer.github.com/v3/orgs/
     module Organizations
-
       # Get an organization
       #
       # @param org [String, Integer] Organization GitHub login or id.
@@ -18,7 +18,7 @@ module Octokit
       def organization(org, options = {})
         get Organization.path(org), options
       end
-      alias :org :organization
+      alias org organization
 
       # Update an organization.
       #
@@ -48,7 +48,7 @@ module Octokit
       def update_organization(org, values, options = {})
         patch Organization.path(org), options.merge(values)
       end
-      alias :update_org :update_organization
+      alias update_org update_organization
 
       # Get organizations for a user.
       #
@@ -78,12 +78,12 @@ module Octokit
       #   Octokit.list_orgs('pengwynn')
       # @example
       #   @client.organizations
-      def organizations(user=nil, options = {})
+      def organizations(user = nil, options = {})
         paginate "#{User.path user}/orgs", options
       end
-      alias :list_organizations :organizations
-      alias :list_orgs :organizations
-      alias :orgs :organizations
+      alias list_organizations organizations
+      alias list_orgs organizations
+      alias orgs organizations
 
       # List all GitHub organizations
       #
@@ -98,9 +98,9 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] List of GitHub organizations.
       def all_organizations(options = {})
-        paginate "organizations", options
+        paginate 'organizations', options
       end
-      alias :all_orgs :all_organizations
+      alias all_orgs all_organizations
 
       # List organization repositories
       #
@@ -125,8 +125,8 @@ module Octokit
       def organization_repositories(org, options = {})
         paginate "#{Organization.path org}/repos", options
       end
-      alias :org_repositories :organization_repositories
-      alias :org_repos :organization_repositories
+      alias org_repositories organization_repositories
+      alias org_repos organization_repositories
 
       # Get organization members
       #
@@ -143,10 +143,10 @@ module Octokit
       #   Octokit.org_members('github')
       def organization_members(org, options = {})
         options = options.dup
-        path = "public_" if options.delete(:public)
+        path = 'public_' if options.delete(:public)
         paginate "#{Organization.path org}/#{path}members", options
       end
-      alias :org_members :organization_members
+      alias org_members organization_members
 
       # Get organization public members
       #
@@ -160,9 +160,9 @@ module Octokit
       # @example
       #   Octokit.org_public_members('github')
       def organization_public_members(org, options = {})
-        organization_members org, options.merge(:public => true)
+        organization_members org, options.merge(public: true)
       end
-      alias :org_public_members :organization_public_members
+      alias org_public_members organization_public_members
 
       # Check if a user is a member of an organization.
       #
@@ -188,7 +188,7 @@ module Octokit
           result
         end
       end
-      alias :org_member? :organization_member?
+      alias org_member? organization_member?
 
       # Check if a user is a public member of an organization.
       #
@@ -208,7 +208,7 @@ module Octokit
       def organization_public_member?(org, user, options = {})
         boolean_from_response :get, "#{Organization.path org}/public_members/#{user}", options
       end
-      alias :org_public_member? :organization_public_member?
+      alias org_public_member? organization_public_member?
 
       # List pending organization invitations
       #
@@ -223,7 +223,7 @@ module Octokit
       def organization_invitations(org, options = {})
         get "#{Organization.path org}/invitations", options
       end
-      alias :org_invitations :organization_invitations
+      alias org_invitations organization_invitations
 
       # List outside collaborators for an organization
       #
@@ -235,7 +235,7 @@ module Octokit
       #
       # @example
       #   @client.outside_collaborators('github')
-      def outside_collaborators(org, options={})
+      def outside_collaborators(org, options = {})
         paginate "#{Organization.path org}/outside_collaborators", options
       end
 
@@ -250,7 +250,7 @@ module Octokit
       #
       # @example
       #   @client.remove_outside_collaborator('github', 'lizzhale')
-      def remove_outside_collaborator(org, user, options={})
+      def remove_outside_collaborator(org, user, options = {})
         boolean_from_response :delete, "#{Organization.path org}/outside_collaborators/#{user}", options
       end
 
@@ -265,7 +265,7 @@ module Octokit
       #
       # @example
       #   @client.convert_to_outside_collaborator('github', 'lizzhale')
-      def convert_to_outside_collaborator(org, user, options={})
+      def convert_to_outside_collaborator(org, user, options = {})
         boolean_from_response :put, "#{Organization.path org}/outside_collaborators/#{user}", options
       end
 
@@ -283,7 +283,7 @@ module Octokit
       def organization_teams(org, options = {})
         paginate "#{Organization.path org}/teams", options
       end
-      alias :org_teams :organization_teams
+      alias org_teams organization_teams
 
       # Create team
       #
@@ -303,7 +303,7 @@ module Octokit
       #   })
       def create_team(org, options = {})
         if options.key?(:permission)
-          octokit_warn "Deprecated: Passing :permission option to #create_team. Assign team repository permission by passing :permission to #add_team_repository instead."
+          octokit_warn 'Deprecated: Passing :permission option to #create_team. Assign team repository permission by passing :permission to #add_team_repository instead.'
         end
         if options.key?(:parent_team_id)
           options = ensure_api_media_type(:nested_teams, options)
@@ -429,7 +429,7 @@ module Octokit
         # There's a bug in this API call. The docs say to leave the body blank,
         # but it fails if the body is both blank and the content-length header
         # is not 0.
-        boolean_from_response :put, "teams/#{team_id}/members/#{user}", options.merge({:name => user})
+        boolean_from_response :put, "teams/#{team_id}/members/#{user}", options.merge({ name: user })
       end
 
       # Remove team member
@@ -494,7 +494,7 @@ module Octokit
       def team_repositories(team_id, options = {})
         paginate "teams/#{team_id}/repos", options
       end
-      alias :team_repos :team_repositories
+      alias team_repos team_repositories
 
       # Check if a repo is managed by a specific team
       #
@@ -508,10 +508,10 @@ module Octokit
       #   @client.team_repository?(8675309, 'octokit/octokit.rb')
       # @example
       #   @client.team_repo?(8675309, 'octokit/octokit.rb')
-      def team_repository?(team_id, repo, options = {})
+      def team_repository?(team_id, repo, _options = {})
         boolean_from_response :get, "teams/#{team_id}/repos/#{Repository.new(repo)}"
       end
-      alias :team_repo? :team_repository?
+      alias team_repo? team_repository?
 
       # Add team repository
       #
@@ -540,7 +540,7 @@ module Octokit
       def add_team_repository(team_id, repo, options = {})
         boolean_from_response :put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options
       end
-      alias :add_team_repo :add_team_repository
+      alias add_team_repo add_team_repository
 
       # Remove team repository
       #
@@ -557,10 +557,10 @@ module Octokit
       #   @client.remove_team_repository(100000, 'github/developer.github.com')
       # @example
       #   @client.remove_team_repo(100000, 'github/developer.github.com')
-      def remove_team_repository(team_id, repo, options = {})
+      def remove_team_repository(team_id, repo, _options = {})
         boolean_from_response :delete, "teams/#{team_id}/repos/#{Repository.new(repo)}"
       end
-      alias :remove_team_repo :remove_team_repository
+      alias remove_team_repo remove_team_repository
 
       # Remove organization member
       #
@@ -579,7 +579,7 @@ module Octokit
         # provided in the GH API v3
         boolean_from_response :delete, "#{Organization.path org}/members/#{user}", options
       end
-      alias :remove_org_member :remove_organization_member
+      alias remove_org_member remove_organization_member
 
       # Publicize a user's membership of an organization
       #
@@ -610,14 +610,14 @@ module Octokit
       def unpublicize_membership(org, user, options = {})
         boolean_from_response :delete, "#{Organization.path org}/public_members/#{user}", options
       end
-      alias :conceal_membership :unpublicize_membership
+      alias conceal_membership unpublicize_membership
 
       # List all teams for the authenticated user across all their orgs
       #
       # @return [Array<Sawyer::Resource>] Array of team resources.
       # @see https://developer.github.com/v3/orgs/teams/#list-user-teams
       def user_teams(options = {})
-        paginate "user/teams", options
+        paginate 'user/teams', options
       end
 
       # Check if a user has a team membership.
@@ -667,9 +667,9 @@ module Octokit
       # @return [Array<Sawyer::Resource>] Array of organizations memberships.
       # @see https://developer.github.com/v3/orgs/members/#list-your-organization-memberships
       def organization_memberships(options = {})
-        paginate "user/memberships/orgs", options
+        paginate 'user/memberships/orgs', options
       end
-      alias :org_memberships :organization_memberships
+      alias org_memberships organization_memberships
 
       # Get an organization membership
       #
@@ -686,7 +686,7 @@ module Octokit
           get "user/memberships/orgs/#{org}", options
         end
       end
-      alias :org_membership :organization_membership
+      alias org_membership organization_membership
 
       # Edit an organization membership
       #
@@ -707,7 +707,7 @@ module Octokit
           patch "user/memberships/orgs/#{org}", options
         end
       end
-      alias :update_org_membership :update_organization_membership
+      alias update_org_membership update_organization_membership
 
       # Remove an organization membership
       #
@@ -719,7 +719,7 @@ module Octokit
         user = options.delete(:user)
         user && boolean_from_response(:delete, "#{Organization.path(org)}/memberships/#{user}", options)
       end
-      alias :remove_org_membership :remove_organization_membership
+      alias remove_org_membership remove_organization_membership
 
       # Initiates the generation of a migration archive.
       #
@@ -731,7 +731,7 @@ module Octokit
       # @return [Sawyer::Resource] Hash representing the new migration.
       # @example
       #   @client.start_migration('github', ['github/dotfiles'])
-      # @see https://developer.github.com/v3/orgs/migrations/#start-a-migration
+      # @see https://docs.github.com/en/rest/reference/migrations#start-an-organization-migration
       def start_migration(org, repositories, options = {})
         options = ensure_api_media_type(:migrations, options)
         options[:repositories] = repositories
@@ -744,7 +744,7 @@ module Octokit
       #
       # @param org [String, Integer] Organization GitHub login or id.
       # @return [Array<Sawyer::Resource>] Array of migration resources.
-      # @see https://developer.github.com/v3/orgs/migrations/#get-a-list-of-migrations
+      # @see https://docs.github.com/en/rest/reference/migrations#list-organization-migrations
       def migrations(org, options = {})
         options = ensure_api_media_type(:migrations, options)
         paginate "#{Organization.path(org)}/migrations", options
@@ -756,7 +756,7 @@ module Octokit
       #
       # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] ID number of the migration.
-      # @see https://developer.github.com/v3/orgs/migrations/#get-the-status-of-a-migration
+      # @see https://docs.github.com/en/rest/reference/migrations#get-an-organization-migration-status
       def migration_status(org, id, options = {})
         options = ensure_api_media_type(:migrations, options)
         get "#{Organization.path(org)}/migrations/#{id}", options
@@ -768,7 +768,7 @@ module Octokit
       #
       # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] ID number of the migration.
-      # @see https://developer.github.com/v3/orgs/migrations/#download-a-migration-archive
+      # @see https://docs.github.com/en/rest/reference/migrations#download-an-organization-migration-archive
       def migration_archive_url(org, id, options = {})
         options = ensure_api_media_type(:migrations, options)
         url = "#{Organization.path(org)}/migrations/#{id}/archive"
@@ -783,7 +783,7 @@ module Octokit
       #
       # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] ID number of the migration.
-      # @see https://developer.github.com/v3/orgs/migrations/#delete-a-migration-archive
+      # @see https://docs.github.com/en/rest/reference/migrations#delete-an-organization-migration-archive
       def delete_migration_archive(org, id, options = {})
         options = ensure_api_media_type(:migrations, options)
         delete "#{Organization.path(org)}/migrations/#{id}/archive", options
@@ -796,20 +796,20 @@ module Octokit
       # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] ID number of the migration.
       # @param repo [String] Name of the repository.
-      # @see https://developer.github.com/v3/orgs/migrations/#unlock-a-repository
+      # @see https://docs.github.com/en/rest/reference/migrations#unlock-an-organization-repository
       def unlock_repository(org, id, repo, options = {})
         options = ensure_api_media_type(:migrations, options)
         delete "#{Organization.path(org)}/migrations/#{id}/repos/#{repo}/lock", options
       end
 
       # Get GitHub Actions billing for an organization
-      # 
+      #
       # Requires authenticated organization owner.
-      # 
+      #
       # @param org [String, Integer] Organization GitHub login or id.
       # @return [Sawyer::Resource] Hash representing GitHub Actions billing for an organization.
       # @see https://docs.github.com/en/rest/reference/billing#get-github-actions-billing-for-an-organization
-      # 
+      #
       # @example
       #   @client.billing_actions('github')
       def billing_actions(org)

data/lib/octokit/client/pages.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Pages API
     #
     # @see https://developer.github.com/v3/repos/pages/
     module Pages
-
       # List Pages information for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -36,7 +36,7 @@ module Octokit
       def pages_builds(repo, options = {})
         get "#{Repository.path repo}/pages/builds", options
       end
-      alias :list_pages_builds :pages_builds
+      alias list_pages_builds pages_builds
 
       # List the latest Pages build information for a repository
       #

data/lib/octokit/client/projects.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for Projects API
     #
     # @see https://developer.github.com/v3/repos/projects
     module Projects
-
       # List projects for a repository
       #
       # Requires authenticated client
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] Repository projects
-      # @see https://developer.github.com/v3/projects/#list-repository-projects 
+      # @see https://developer.github.com/v3/projects/#list-repository-projects
       # @example
       #   @client.projects('octokit/octokit.rb')
       def projects(repo, options = {})
@@ -28,7 +28,7 @@ module Octokit
       # @param name [String] Project name
       # @option options [String] :body Body of the project
       # @return [Sawyer::Resource] Fresh new project
-      # @see https://developer.github.com/v3/projects/#create-a-repository-project 
+      # @see https://developer.github.com/v3/projects/#create-a-repository-project
       # @example Create project with only a name
       #   @client.create_project('octokit/octokit.rb', 'implement new APIs')
       #
@@ -53,7 +53,7 @@ module Octokit
         opts = ensure_api_media_type(:projects, options)
         paginate "orgs/#{org}/projects", opts
       end
-      alias :organization_projects :org_projects
+      alias organization_projects org_projects
 
       # Create organization project
       #
@@ -73,13 +73,13 @@ module Octokit
         opts[:name] = name
         post "orgs/#{org}/projects", opts
       end
-      alias :create_organization_project :create_org_project
+      alias create_organization_project create_org_project
 
-      # Get a project by id 
+      # Get a project by id
       #
       # @param id [Integer] Project id
       # @return [Sawyer::Resource] Project
-      # @see https://developer.github.com/v3/projects/#get-a-project 
+      # @see https://developer.github.com/v3/projects/#get-a-project
       # @example
       #   Octokit.project(123942)
       def project(id, options = {})
@@ -95,7 +95,7 @@ module Octokit
       # @option options [String] :name Project name
       # @option options [String] :body Project body
       # @return [Sawyer::Resource] Project
-      # @see https://developer.github.com/v3/projects/#update-a-project 
+      # @see https://developer.github.com/v3/projects/#update-a-project
       # @example Update project name
       #   @client.update_project(123942, name: 'New name')
       def update_project(id, options = {})
@@ -109,7 +109,7 @@ module Octokit
       #
       # @param id [Integer] Project id
       # @return [Boolean] Result of deletion
-      # @see https://developer.github.com/v3/projects/#delete-a-project 
+      # @see https://developer.github.com/v3/projects/#delete-a-project
       # @example
       #   @client.delete_project(123942)
       def delete_project(id, options = {})
@@ -119,9 +119,9 @@ module Octokit
 
       # List project columns
       #
-      # @param id [Integer] Project id 
+      # @param id [Integer] Project id
       # @return [Array<Sawyer::Resource>] List of project columns
-      # @see https://developer.github.com/v3/projects/columns/#list-project-columns 
+      # @see https://developer.github.com/v3/projects/columns/#list-project-columns
       # @example
       #   @client.project_columns(123942)
       def project_columns(id, options = {})
@@ -136,7 +136,7 @@ module Octokit
       # @param id [Integer] Project column id
       # @param name [String] New column name
       # @return [Sawyer::Resource] Newly created column
-      # @see https://developer.github.com/v3/projects/columns/#create-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#create-a-project-column
       # @example
       #   @client.create_project_column(123942, "To Dones")
       def create_project_column(id, name, options = {})
@@ -149,7 +149,7 @@ module Octokit
       #
       # @param id [Integer] Project column id
       # @return [Sawyer::Resource] Project column
-      # @see https://developer.github.com/v3/projects/columns/#get-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#get-a-project-column
       # @example
       #   Octokit.project_column(30294)
       def project_column(id, options = {})
@@ -164,7 +164,7 @@ module Octokit
       # @param id [Integer] Project column id
       # @param name [String] New column name
       # @return [Sawyer::Resource] Updated column
-      # @see https://developer.github.com/v3/projects/columns/#update-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#update-a-project-column
       # @example
       #   @client.update_project_column(30294, "new column name")
       def update_project_column(id, name, options = {})
@@ -179,7 +179,7 @@ module Octokit
       #
       # @param id [Integer] Project column id
       # @return [Boolean] Result of deletion request, true when deleted
-      # @see https://developer.github.com/v3/projects/columns/#delete-a-project-column 
+      # @see https://developer.github.com/v3/projects/columns/#delete-a-project-column
       # @example
       #   @client.delete_project_column(30294)
       def delete_project_column(id, options = {})
@@ -192,7 +192,7 @@ module Octokit
       # Requires authenticated client
       #
       # @param id [Integer] Project column id
-      # @param position [String] New position for the column. Can be one of 
+      # @param position [String] New position for the column. Can be one of
       #   <tt>first</tt>, <tt>last</tt>, or <tt>after:<column-id></tt>, where
       #   <tt><column-id></tt> is the id value of a column in the same project.
       # @return [Sawyer::Resource] Result
@@ -296,7 +296,7 @@ module Octokit
       end
 
       # Delete a project card
-      # 
+      #
       # Requires authenticated client
       #
       # @param id [Integer] Project card id
@@ -308,7 +308,6 @@ module Octokit
         opts = ensure_api_media_type(:projects, options)
         boolean_from_response :delete, "projects/columns/cards/#{id}", opts
       end
-
     end # Projects
   end
 end

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the PubSubHubbub API
     #
     # @see https://developer.github.com/v3/repos/hooks/#pubsubhubbub
     module PubSubHubbub
-
       # Subscribe to a pubsub topic
       #
       # @param topic [String] A recoginized and supported pubsub topic
@@ -18,11 +18,11 @@ module Octokit
       #   client.subscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
       def subscribe(topic, callback, secret = nil)
         options = {
-          :"hub.callback" => callback,
-          :"hub.mode" => "subscribe",
-          :"hub.topic" => topic
+          "hub.callback": callback,
+          "hub.mode": 'subscribe',
+          "hub.topic": topic
         }
-        options.merge!(:"hub.secret" => secret) unless secret.nil?
+        options.merge!("hub.secret": secret) unless secret.nil?
 
         response = pub_sub_hubbub_request(options)
 
@@ -40,9 +40,9 @@ module Octokit
       #   client.unsubscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
       def unsubscribe(topic, callback)
         options = {
-          :"hub.callback" => callback,
-          :"hub.mode" => "unsubscribe",
-          :"hub.topic" => topic
+          "hub.callback": callback,
+          "hub.mode": 'unsubscribe',
+          "hub.topic": topic
         }
         response = pub_sub_hubbub_request(options)
 
@@ -64,7 +64,7 @@ module Octokit
       #    client.subscribe_service_hook('joshk/device_imapable', 'Travis', { :token => "test", :domain => "domain", :user => "user" })
       def subscribe_service_hook(repo, service_name, service_arguments = {}, secret = nil)
         topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
-        callback = "github://#{service_name}?#{service_arguments.collect{ |k,v| [ k,v ].map{ |p| URI.encode_www_form_component(p) }.join("=") }.join("&") }"
+        callback = "github://#{service_name}?#{service_arguments.collect { |k, v| [k, v].map { |p| URI.encode_www_form_component(p) }.join('=') }.join('&')}"
         subscribe(topic, callback, secret)
       end
 
@@ -88,20 +88,20 @@ module Octokit
       def pub_sub_hubbub_request(options = {})
         # This method is janky, bypass normal stack so we don't
         # serialize request as JSON
-        conn = Faraday.new(:url => @api_endpoint) do |http|
+        conn = Faraday.new(url: @api_endpoint) do |http|
           http.headers[:user_agent] = user_agent
           if basic_authenticated?
-            http.basic_auth(@login, @password)
+            http.request *FARADAY_BASIC_AUTH_KEYS, @login, @password
           elsif token_authenticated?
-            http.authorization 'token', @access_token
+            http.request :authorization, 'token', @access_token
           end
-          http.request  :url_encoded
+          http.request :url_encoded
           http.use Octokit::Response::RaiseError
-          http.adapter  Faraday.default_adapter
+          http.adapter Faraday.default_adapter
         end
 
         conn.post do |req|
-          req.url "hub"
+          req.url 'hub'
           req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
           req.body = options
         end