octokit 3.8.0 → 4.0.0

data/lib/octokit/default.rb

@@ -1,3 +1,4 @@
+require 'octokit/middleware/follow_redirects'
 require 'octokit/response/raise_error'
 require 'octokit/response/feed_parser'
 require 'octokit/version'
@@ -24,6 +25,7 @@ module Octokit
 
     # Default Faraday middleware stack
     MIDDLEWARE = RACK_BUILDER_CLASS.new do |builder|
+      builder.use Octokit::Middleware::FollowRedirects
       builder.use Octokit::Response::RaiseError
       builder.use Octokit::Response::FeedParser
       builder.adapter Faraday.default_adapter
@@ -67,6 +69,18 @@ module Octokit
         ENV['OCTOKIT_SECRET']
       end
 
+      # Default management console password from ENV
+      # @return [String]
+      def management_console_password
+        ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD']
+      end
+
+      # Default management console endpoint from ENV
+      # @return [String]
+      def management_console_endpoint
+        ENV['OCTOKIT_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT']
+      end
+
       # Default options for Faraday::Connection
       # @return [Hash]
       def connection_options

data/lib/octokit/enterprise_admin_client.rb

@@ -0,0 +1,36 @@
+require 'octokit/connection'
+require 'octokit/configurable'
+require 'octokit/warnable'
+require 'octokit/enterprise_admin_client/admin_stats'
+require 'octokit/enterprise_admin_client/license'
+require 'octokit/enterprise_admin_client/search_indexing'
+require 'octokit/enterprise_admin_client/users'
+
+module Octokit
+
+  # EnterpriseAdminClient is only meant to be used by GitHub Enterprise Admins
+  # and provides access the Admin only API endpoints including Admin Stats,
+  # Management Console, and the Search Indexing API.
+  #
+  # @see Octokit::Client Use Octokit::Client for regular API use for GitHub
+  #   and GitHub Enterprise.
+  # @see https://developer.github.com/v3/enterprise/
+  class EnterpriseAdminClient
+
+    include Octokit::Configurable
+    include Octokit::Connection
+    include Octokit::Warnable
+    include Octokit::EnterpriseAdminClient::AdminStats
+    include Octokit::EnterpriseAdminClient::License
+    include Octokit::EnterpriseAdminClient::SearchIndexing
+    include Octokit::EnterpriseAdminClient::Users
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Octokit::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+  end
+end

data/lib/octokit/enterprise_admin_client/admin_stats.rb

@@ -0,0 +1,120 @@
+module Octokit
+  class EnterpriseAdminClient
+
+    # Methods for the Enterprise Admin Stats API
+    #
+    # @see https://developer.github.com/v3/enterprise/admin_stats/
+    module AdminStats
+
+      # Get all available stats
+      #
+      # @return [Sawyer::Resource] All available stats
+      # @example Get all available stats
+      #   @client.admin_stats
+      def admin_stats
+        get_admin_stats "all"
+      end
+
+      # Get only repository-related stats
+      #
+      # @return [Sawyer::Resource] Only repository-related stats
+      # @example Get only repository-related stats
+      #   @client.admin_repository_stats
+      def admin_repository_stats
+        get_admin_stats "repos"
+      end
+
+      # Get only hooks-related stats
+      #
+      # @return [Sawyer::Resource] Only hooks-related stats
+      # @example Get only hooks-related stats
+      #   @client.admin_hooks_stats
+      def admin_hooks_stats
+        get_admin_stats "hooks"
+      end
+
+      # Get only pages-related stats
+      #
+      # @return [Sawyer::Resource] Only pages-related stats
+      # @example Get only pages-related stats
+      #   @client.admin_pages_stats
+      def admin_pages_stats
+        get_admin_stats "pages"
+      end
+
+      # Get only organization-related stats
+      #
+      # @return [Sawyer::Resource] Only organization-related stats
+      # @example Get only organization-related stats
+      #   @client.admin_organization_stats
+      def admin_organization_stats
+        get_admin_stats "orgs"
+      end
+
+      # Get only user-related stats
+      #
+      # @return [Sawyer::Resource] Only user-related stats
+      # @example Get only user-related stats
+      #   @client.admin_users_stats
+      def admin_users_stats
+        get_admin_stats "users"
+      end
+
+      # Get only pull request-related stats
+      #
+      # @return [Sawyer::Resource] Only pull request-related stats
+      # @example Get only pull request-related stats
+      #   @client.admin_pull_requests_stats
+      def admin_pull_requests_stats
+        get_admin_stats "pulls"
+      end
+
+      # Get only issue-related stats
+      #
+      # @return [Sawyer::Resource] Only issue-related stats
+      # @example Get only issue-related stats
+      #   @client.admin_issues_stats
+      def admin_issues_stats
+        get_admin_stats "issues"
+      end
+
+      # Get only milestone-related stats
+      #
+      # @return [Sawyer::Resource] Only milestone-related stats
+      # @example Get only milestone-related stats
+      #   @client.admin_milestones_stats
+      def admin_milestones_stats
+        get_admin_stats "milestones"
+      end
+
+      # Get only gist-related stats
+      #
+      # @return [Sawyer::Resource] Only only gist-related stats
+      # @example Get only gist-related stats
+      #   @client.admin_gits_stats
+      def admin_gists_stats
+        get_admin_stats "gists"
+      end
+
+      # Get only comment-related stats
+      #
+      # @return [Sawyer::Resource] Only comment-related stats
+      # @example Get only comment-related stats
+      #   @client.admin_comments_stats
+      def admin_comments_stats
+        get_admin_stats "comments"
+      end
+
+      private
+
+      # @private Get enterprise stats
+      #
+      # @param metric [String] The metrics you are looking for
+      # @return [Sawyer::Resource] Magical unicorn stats
+      def get_admin_stats(metric)
+        get "enterprise/stats/#{metric}"
+      end
+    end
+
+  end
+end

data/lib/octokit/enterprise_admin_client/license.rb

@@ -0,0 +1,18 @@
+module Octokit
+  class EnterpriseAdminClient
+
+    # Methods for the Enterprise License API
+    #
+    # @see https://developer.github.com/v3/enterprise/license/
+    module License
+
+      # Get information about the Enterprise license
+      #
+      # @return [Sawyer::Resource] The license information
+      def license_info
+        get "enterprise/settings/license"
+      end
+
+    end
+  end
+end

data/lib/octokit/enterprise_admin_client/search_indexing.rb

@@ -0,0 +1,83 @@
+module Octokit
+  class EnterpriseAdminClient
+
+    # Methods for the Enterprise Search Indexing API
+    #
+    # @see https://developer.github.com/v3/enterprise/search_indexing/
+    module SearchIndexing
+
+      # Queue a User or Organization to be indexed
+      #
+      # @param user [String] A GitHub Enterprise user or organization
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def index_user(user)
+        queue_index user
+      end
+      alias :index_organization :index_user
+
+      # Queue a Repository to be indexed
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def index_repository(repo)
+        queue_index Repository.new repo
+      end
+
+      # Queue a repository's Issues to be indexed
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def index_repository_issues(repo)
+        queue_index "#{Repository.new repo}/issues"
+      end
+
+      # Queue a repository's code to be indexed
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def index_repository_code(repo)
+        queue_index "#{Repository.new repo}/code"
+      end
+
+      # Queue a user's or organization's repositories to be indexed
+      #
+      # @param user [String] A GitHub Enterprise user or organization
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def index_users_repositories(user)
+        queue_index "#{user}/*"
+      end
+      alias :index_organizations_repositories :index_users_repositories
+
+      # Queue an index of all the issues across all of a user's or
+      # organization's repositories
+      #
+      # @param user [String] A GitHub Enterprise user or organization
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def index_users_repositories_issues(user)
+        queue_index "#{user}/*/issues"
+      end
+      alias :index_organizations_repositories_issues :index_users_repositories_issues
+
+      # Queue an index of all the code contained in all of a user's or
+      # organization's repositories
+      #
+      # @param user [String] A GitHub Enterprise user or organization
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def index_users_repositories_code(user)
+        queue_index "#{user}/*/code"
+      end
+      alias :index_organizations_repositories_code :index_users_repositories_code
+
+      private
+
+      # @private Queue a target for indexing
+      #
+      # @param target [String] Target to index
+      # @return [Sawyer:Resource] Result of the queuing containing `:message`
+      def queue_index(target)
+        post "staff/indexing_jobs", :target => target
+      end
+    end
+
+  end
+end

data/lib/octokit/enterprise_admin_client/users.rb

@@ -0,0 +1,53 @@
+module Octokit
+  class EnterpriseAdminClient
+
+    # Methods for the Enterprise User Administration API
+    #
+    # @see https://developer.github.com/v3/users/administration/
+    module Users
+      # Promote an ordinary user to a site administrator
+      #
+      # @param user [String] Username of the user to promote.
+      # @return [Boolean] True if promote was successful, false otherwise.
+      # @see https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator
+      # @example
+      #   @admin_client.promote('holman')
+      def promote(user, options = {})
+        boolean_from_response :put, "users/#{user}/site_admin", options
+      end
+
+      # Demote a site administrator to an ordinary user
+      #
+      # @param user [String] Username of the user to demote.
+      # @return [Boolean] True if demote was successful, false otherwise.
+      # @see https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user
+      # @example
+      #   @admin_client.demote('holman')
+      def demote(user, options = {})
+        boolean_from_response :delete, "users/#{user}/site_admin", options
+      end
+
+      # Suspend a user.
+      #
+      # @param user [String] Username of the user to suspend.
+      # @return [Boolean] True if suspend was successful, false otherwise.
+      # @see https://developer.github.com/v3/users/administration/#suspend-a-user
+      # @example
+      #   @admin_client.suspend('holman')
+      def suspend(user, options = {})
+        boolean_from_response :put, "users/#{user}/suspended", options
+      end
+
+      # Unsuspend a user.
+      #
+      # @param user [String] Username of the user to unsuspend.
+      # @return [Boolean] True if unsuspend was successful, false otherwise.
+      # @see https://developer.github.com/v3/users/administration/#unsuspend-a-user
+      # @example
+      #   @admin_client.unsuspend('holman')
+      def unsuspend(user, options = {})
+        boolean_from_response :delete, "users/#{user}/suspended", options
+      end
+    end
+  end
+end

data/lib/octokit/enterprise_management_console_client.rb

@@ -0,0 +1,50 @@
+require 'octokit/configurable'
+require 'octokit/connection'
+require 'octokit/warnable'
+require 'octokit/enterprise_management_console_client/management_console'
+
+module Octokit
+
+  # EnterpriseManagementConsoleClient is only meant to be used by GitHub Enterprise Admins
+  # and provides access to the management console API endpoints.
+  #
+  # @see Octokit::Client Use Octokit::Client for regular API use for GitHub
+  #   and GitHub Enterprise.
+  # @see https://developer.github.com/v3/enterprise/management_console/
+  class EnterpriseManagementConsoleClient
+
+    include Octokit::Configurable
+    include Octokit::Connection
+    include Octokit::Warnable
+    include Octokit::EnterpriseManagementConsoleClient::ManagementConsole
+
+    def initialize(options = {})
+      # Use options passed in, but fall back to module defaults
+      Octokit::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    protected
+
+    def endpoint
+      management_console_endpoint
+    end
+
+    # Set Enterprise Management Console password
+    #
+    # @param value [String] Management console admin password
+    def management_console_password=(value)
+      reset_agent
+      @management_console_password = value
+    end
+
+    # Set Enterprise Management Console endpoint
+    #
+    # @param value [String] Management console endpoint
+    def management_console_endpoint=(value)
+      reset_agent
+      @management_console_endpoint = value
+    end
+  end
+end

data/lib/octokit/enterprise_management_console_client/management_console.rb

@@ -0,0 +1,176 @@
+module Octokit
+  class EnterpriseManagementConsoleClient
+
+    # Methods for the Enterprise Management Console API
+    #
+    # @see https://developer.github.com/v3/enterprise/management_console
+    module ManagementConsole
+
+      # Uploads a license for the first time
+      #
+      # @param license [String] The path to your .ghl license file.
+      # @param settings [Hash] A hash configuration of the initial settings.
+      #
+      # @see http: //git.io/j5NT
+      # @return nil
+      def upload_license(license, settings = nil)
+        conn = faraday_configuration
+
+        params = { }
+        params[:license] = Faraday::UploadIO.new(license, 'binary')
+        params[:password] = @management_console_password
+        params[:settings] = "#{settings.to_json}" unless settings.nil?
+
+        @last_response = conn.post("/setup/api/start", params)
+      end
+
+      # Start a configuration process.
+      #
+      # @return nil
+      def start_configuration
+        post "/setup/api/configure", password_hash
+      end
+
+      # Upgrade an Enterprise installation
+      #
+      # @param license [String] The path to your .ghl license file.
+      #
+      # @return nil
+      def upgrade(license)
+        conn = faraday_configuration
+
+        params = { }
+        params[:license] = Faraday::UploadIO.new(license, 'binary')
+        params[:api_key] = @management_console_password
+        @last_response = conn.post("/setup/api/upgrade", params)
+      end
+
+      # Get information about the Enterprise installation
+      #
+      # @return [Sawyer::Resource] The installation information
+      def config_status
+        get "/setup/api/configcheck", password_hash
+      end
+      alias :config_check :config_status
+
+      # Get information about the Enterprise installation
+      #
+      # @return [Sawyer::Resource] The settings
+      def settings
+        get "/setup/api/settings", password_hash
+      end
+      alias :get_settings :settings
+
+      # Modify the Enterprise settings
+      #
+      # @param settings [Hash] A hash configuration of the new settings
+      #
+      # @return [nil]
+      def edit_settings(settings)
+        queries = password_hash
+        queries[:query][:settings] = "#{settings.to_json}"
+        put "/setup/api/settings", queries
+      end
+
+      # Get information about the Enterprise maintenance status
+      #
+      # @return [Sawyer::Resource] The maintenance status
+      def maintenance_status
+        get "/setup/api/maintenance", password_hash
+      end
+      alias :get_maintenance_status :maintenance_status
+
+      # Start (or turn off) the Enterprise maintenance mode
+      #
+      # @param maintenance [Hash] A hash configuration of the maintenance settings
+      # @return [nil]
+      def set_maintenance_status(maintenance)
+        queries = password_hash
+        queries[:query][:maintenance] = "#{maintenance.to_json}"
+        post "/setup/api/maintenance", queries
+      end
+      alias :edit_maintenance_status :set_maintenance_status
+
+      # Fetch the authorized SSH keys on the Enterprise install
+      #
+      # @return [Sawyer::Resource] An array of authorized SSH keys
+      def authorized_keys
+        get "/setup/api/settings/authorized-keys", password_hash
+      end
+      alias :get_authorized_keys :authorized_keys
+
+      # Add an authorized SSH keys on the Enterprise install
+      #
+      # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself
+      # @return [Sawyer::Resource] An array of authorized SSH keys
+      def add_authorized_key(key)
+        queries = password_hash
+        case key
+        when String
+          if File.exist?(key)
+            key = File.open(key, "r")
+            content = key.read.strip
+            key.close
+          else
+            content = key
+          end
+        when File
+          content = key.read.strip
+          key.close
+        end
+
+        queries[:query][:authorized_key] = content
+        post "/setup/api/settings/authorized-keys", queries
+      end
+
+      # Removes an authorized SSH keys from the Enterprise install
+      #
+      # @param key Either the file path to a key, a File handler to the key, or the contents of the key itself
+      # @return [Sawyer::Resource] An array of authorized SSH keys
+      def remove_authorized_key(key)
+        queries = password_hash
+        case key
+        when String
+          if File.exist?(key)
+            key = File.open(key, "r")
+            content = key.read.strip
+            key.close
+          else
+            content = key
+          end
+        when File
+          content = key.read.strip
+          key.close
+        end
+
+        queries[:query][:authorized_key] = content
+        delete "/setup/api/settings/authorized-keys", queries
+      end
+      alias :delete_authorized_key :remove_authorized_key
+
+    end
+    private
+
+    def password_hash
+      { :query => { :api_key => @management_console_password } }
+    end
+
+    # We fall back to raw Faraday for handling the licenses because I'm suspicious
+    # that Sawyer isn't handling binary POSTs correctly: http://git.io/jMir
+    def faraday_configuration
+      @faraday_configuration ||= Faraday.new(:url => @management_console_endpoint) do |http|
+        http.headers[:user_agent] = user_agent
+        http.request :multipart
+        http.request :url_encoded
+
+        # Disabling SSL is essential for certain self-hosted Enterprise instances
+        if self.connection_options[:ssl] && !self.connection_options[:ssl][:verify]
+          http.ssl[:verify] = false
+        end
+
+        http.use Octokit::Response::RaiseError
+        http.adapter Faraday.default_adapter
+      end
+    end
+  end
+end