Contents

module Octokit
  class Client

    # Methods for the Pages API
    #
    # @see http://developer.github.com/v3/repos/pages/
    module Pages

      # List Pages information for a repository
      #
      # @param repo [String, Repository, Hash] A GitHub repository
      # @return Sawyer::Resource A GitHub Pages resource
      # @see http://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site
      def pages(repo, options = {})
        get "repos/#{Repository.new(repo)}/pages", options
      end

      # List Pages builds for a repository
      #
      # @param repo [String, Repository, Hash] A GitHub repository
      # @return [Array<Sawyer::Resource>] A list of build history for a repository.
      # @see http://developer.github.com/v3/repos/pages/#list-pages-builds
      def pages_builds(repo, options = {})
        get "repos/#{Repository.new(repo)}/pages/builds", options
      end
      alias :list_pages_builds :pages_builds

      # List the latest Pages build information for a repository
      #
      # @param repo [String, Repository, Hash] A GitHub repository
      # @return Sawyer::Resource A GitHub Pages resource about a build
      # @see http://developer.github.com/v3/repos/pages/#list-latest-pages-build
      def latest_pages_build(repo, options = {})
        get "repos/#{Repository.new(repo)}/pages/builds/latest", options
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
octokit-3.0.0	lib/octokit/client/pages.rb
octokit-3.0.0.pre	lib/octokit/client/pages.rb