octokit 4.22.0 → 9.2.0

data/lib/octokit/client/authorizations.rb

@@ -1,182 +0,0 @@
-module Octokit
-  class Client
-
-    # Methods for the Authorizations API
-    #
-    # @see https://developer.github.com/v3/oauth_authorizations/#oauth-authorizations-api
-    module Authorizations
-
-      # List the authenticated user's authorizations
-      #
-      # API for users to manage their own tokens.
-      # You can only access your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @return [Array<Sawyer::Resource>] A list of authorizations for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations
-      # @example List authorizations for user ctshryock
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.authorizations
-      def authorizations(options = {})
-        paginate 'authorizations', options
-      end
-
-      # Get a single authorization for the authenticated user.
-      #
-      # You can only access your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization
-      # @example Show authorization for user ctshryock's Travis auth
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.authorization(999999)
-      def authorization(number, options = {})
-        get "authorizations/#{number}", options
-      end
-
-      # Create an authorization for the authenticated user.
-      #
-      # You can create your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @param options [Hash] A customizable set of options.
-      # @option options [Array] :scopes A list of scopes that this authorization is in.
-      # @option options [String] :note A note to remind you what the OAuth token is for.
-      # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
-      # @option options [Boolean] :idempotent If true, will return an existing authorization if one has already been created.
-      # @option options [String] :client_id  Client Id we received when our application was registered with GitHub.
-      # @option options [String] :client_secret  Client Secret we received when our application was registered with GitHub.
-      #
-      # @return [Sawyer::Resource] A single authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth/#scopes Available scopes
-      # @see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization
-      # @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
-      # @example Create a new authorization for user ctshryock's project Zoidberg
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.create_authorization({:scopes => ["public_repo", "gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})
-      # @example Create a new OR return an existing authorization to be used by a specific client for user ctshryock's project Zoidberg
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.create_authorization({:idempotent => true, :client_id => 'xxxx', :client_secret => 'yyyy', :scopes => ["user"]})
-      def create_authorization(options = {})
-        # Technically we can omit scopes as GitHub has a default, however the
-        # API will reject us if we send a POST request with an empty body.
-        options = options.dup
-        if options.delete :idempotent
-          client_id, client_secret = fetch_client_id_and_secret(options)
-          raise ArgumentError.new("Client ID and Secret required for idempotent authorizations") unless client_id && client_secret
-
-          # Remove the client_id from the body otherwise
-          # this will result in a 422.
-          options.delete(:client_id)
-
-          if (fingerprint = options.delete(:fingerprint))
-            put "authorizations/clients/#{client_id}/#{fingerprint}", options.merge(:client_secret => client_secret)
-          else
-            put "authorizations/clients/#{client_id}", options.merge(:client_secret => client_secret)
-          end
-
-        else
-          post 'authorizations', options
-        end
-      end
-
-      # Update an authorization for the authenticated user.
-      #
-      # You can update your own tokens, but only through
-      # Basic Authentication.
-      #
-      # @param options [Hash] A customizable set of options.
-      # @option options [Array] :scopes Replace the authorization scopes with these.
-      # @option options [Array] :add_scopes A list of scopes to add to this authorization.
-      # @option options [Array] :remove_scopes A list of scopes to remove from this authorization.
-      # @option options [String] :note A note to remind you what the OAuth token is for.
-      # @option options [String] :note_url A URL to remind you what app the OAuth token is for.
-      #
-      # @return [Sawyer::Resource] A single (updated) authorization for the authenticated user
-      # @see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization
-      # @see https://developer.github.com/v3/oauth/#scopes for available scopes
-      # @example Update the authorization for user ctshryock's project Zoidberg
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.update_authorization(999999, {:add_scopes => ["gist", "repo"], :note => "Why not Zoidberg possibly?"})
-      def update_authorization(number, options = {})
-        patch "authorizations/#{number}", options
-      end
-
-      # Delete an authorization for the authenticated user.
-      #
-      # You can delete your own tokens, and only through
-      # Basic Authentication.
-      #
-      # @param number [Number] An existing Authorization ID
-      #
-      # @return [Boolean] Success
-      # @see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization
-      # @example Delete an authorization
-      #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.delete_authorization(999999)
-      def delete_authorization(number, options = {})
-        boolean_from_response :delete, "authorizations/#{number}", options
-      end
-
-      # Check scopes for a token
-      #
-      # @param token [String] GitHub OAuth token
-      # @param options [Hash] Header params for request
-      # @return [Array<String>] OAuth scopes
-      # @see https://developer.github.com/v3/oauth/#scopes
-      def scopes(token = @access_token, options = {})
-        options= options.dup
-        raise ArgumentError.new("Access token required") if token.nil?
-
-        auth = { "Authorization" => "token #{token}" }
-        headers = (options.delete(:headers) || {}).merge(auth)
-
-        agent.call(:get, "user", :headers => headers).
-          headers['X-OAuth-Scopes'].
-          to_s.
-          split(',').
-          map(&:strip).
-          sort
-      end
-
-      # Revoke all tokens for an app
-      #
-      # Applications can revoke all of their tokens in a single request
-      #
-      # @deprecated As of January 25th, 2016: https://developer.github.com/changes/2014-04-08-reset-api-tokens/
-      # @return [Boolean] false
-      def revoke_all_application_authorizations(options = {})
-        octokit_warn("Deprecated: If you need to revoke all tokens for your application, you can do so via the settings page for your application.")
-        false
-      end
-
-      # Get the URL to authorize a user for an application via the web flow
-      #
-      # @param app_id [String] Client Id we received when our application was registered with GitHub.
-      # @option options [String] :redirect_uri The url to redirect to after authorizing.
-      # @option options [String] :scope The scopes to request from the user.
-      # @option options [String] :state A random string to protect against CSRF.
-      # @return [String] The url to redirect the user to authorize.
-      # @see Octokit::Client
-      # @see https://developer.github.com/v3/oauth/#web-application-flow
-      # @example
-      #   @client.authorize_url('xxxx')
-      def authorize_url(app_id = client_id, options = {})
-        opts = options.dup
-        if app_id.to_s.empty?
-          raise Octokit::ApplicationCredentialsRequired, "client_id required"
-        end
-        authorize_url = opts.delete(:endpoint) || Octokit.web_endpoint
-        authorize_url << "login/oauth/authorize?client_id=#{app_id}"
-
-        require 'cgi'
-        opts.each do |key, value|
-          authorize_url << "&#{key}=#{CGI.escape value}"
-        end
-
-        authorize_url
-      end
-    end
-  end
-end

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -1,111 +0,0 @@
-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
-      # @param callback [String] A callback url to be posted to when the topic event is fired
-      # @param secret [String] An optional shared secret used to generate a SHA1 HMAC of the outgoing body content
-      # @return [Boolean] true if the subscribe was successful, otherwise an error is raised
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Subscribe to push events from one of your repositories, having an email sent when fired
-      #   client = Octokit::Client.new(:oauth_token = "token")
-      #   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
-        }
-        options.merge!(:"hub.secret" => secret) unless secret.nil?
-
-        response = pub_sub_hubbub_request(options)
-
-        response.status == 204
-      end
-
-      # Unsubscribe from a pubsub topic
-      #
-      # @param topic [String] A recoginized pubsub topic
-      # @param callback [String] A callback url to be unsubscribed from
-      # @return [Boolean] true if the unsubscribe was successful, otherwise an error is raised
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Unsubscribe to push events from one of your repositories, no longer having an email sent when fired
-      #   client = Octokit::Client.new(:oauth_token = "token")
-      #   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
-        }
-        response = pub_sub_hubbub_request(options)
-
-        response.status == 204
-      end
-
-      # Subscribe to a repository through pubsub
-      #
-      # @param repo [String, Repository, Hash] A GitHub repository
-      # @param service_name [String] service name owner
-      # @param service_arguments [Hash] params that will be passed by subscribed hook.
-      #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
-      #    Please refer Data node for complete list of arguments.
-      # @param secret [String] An optional shared secret used to generate a SHA1 HMAC of the outgoing body content
-      # @return [Boolean] True if subscription successful, false otherwise
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Subscribe to push events to one of your repositories to Travis-CI
-      #    client = Octokit::Client.new(:oauth_token = "token")
-      #    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("&") }"
-        subscribe(topic, callback, secret)
-      end
-
-      # Unsubscribe repository through pubsub
-      #
-      # @param repo [String, Repository, Hash] A GitHub repository
-      # @param service_name [String] service name owner
-      #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
-      # @see https://developer.github.com/v3/repos/hooks/#subscribing
-      # @example Subscribe to push events to one of your repositories to Travis-CI
-      #    client = Octokit::Client.new(:oauth_token = "token")
-      #    client.unsubscribe_service_hook('joshk/device_imapable', 'Travis')
-      def unsubscribe_service_hook(repo, service_name)
-        topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
-        callback = "github://#{service_name}"
-        unsubscribe(topic, callback)
-      end
-
-      private
-
-      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|
-          http.headers[:user_agent] = user_agent
-          if basic_authenticated?
-            http.request :basic_auth, @login, @password
-          elsif token_authenticated?
-            http.request :authorization, 'token', @access_token
-          end
-          http.request  :url_encoded
-          http.use Octokit::Response::RaiseError
-          http.adapter  Faraday.default_adapter
-        end
-
-        conn.post do |req|
-          req.url "hub"
-          req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-          req.body = options
-        end
-      end
-    end
-  end
-end

data/lib/octokit/preview.rb

@@ -1,46 +0,0 @@
-module Octokit
-
-  # Default setup options for preview features
-  module Preview
-
-    PREVIEW_TYPES = {
-      :applications_api       => 'application/vnd.github.doctor-strange-preview+json'.freeze,
-      :branch_protection      => 'application/vnd.github.luke-cage-preview+json'.freeze,
-      :commit_search          => 'application/vnd.github.cloak-preview+json'.freeze,
-      :commit_pulls           => 'application/vnd.github.groot-preview+json'.freeze,
-      :commit_branches        => 'application/vnd.github.groot-preview+json'.freeze,
-      :migrations             => 'application/vnd.github.wyandotte-preview+json'.freeze,
-      :licenses               => 'application/vnd.github.drax-preview+json'.freeze,
-      :source_imports         => 'application/vnd.github.barred-rock-preview'.freeze,
-      :reactions              => 'application/vnd.github.squirrel-girl-preview'.freeze,
-      :transfer_repository    => 'application/vnd.github.nightshade-preview+json'.freeze,
-      :issue_timelines        => 'application/vnd.github.mockingbird-preview+json'.freeze,
-      :nested_teams           => 'application/vnd.github.hellcat-preview+json'.freeze,
-      :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze,
-      :projects               => 'application/vnd.github.inertia-preview+json'.freeze,
-      :traffic                => 'application/vnd.github.spiderman-preview'.freeze,
-      :topics                 => 'application/vnd.github.mercy-preview+json'.freeze,
-      :community_profile      => 'application/vnd.github.black-panther-preview+json'.freeze,
-      :strict_validation      => 'application/vnd.github.speedy-preview+json'.freeze,
-      :template_repositories  => 'application/vnd.github.baptiste-preview+json'.freeze,
-      :project_card_events    => 'application/vnd.github.starfox-preview+json'.freeze,
-      :vulnerability_alerts   => 'application/vnd.github.dorian-preview+json'.freeze,
-    }
-
-    def ensure_api_media_type(type, options)
-      if options[:accept].nil?
-        options[:accept] = PREVIEW_TYPES[type]
-        warn_preview(type)
-      end
-      options
-    end
-
-    def warn_preview(type)
-      octokit_warn <<-EOS
-WARNING: The preview version of the #{type.to_s.capitalize} API is not yet suitable for production use.
-You can avoid this message by supplying an appropriate media type in the 'Accept' request
-header.
-EOS
-    end
-  end
-end