Contents

# encoding: utf-8

require_relative '../../api'

module Github
  class Client::Repos::Forks < API
    # List repository forks
    #
    # @param [Hash] params
    # @input params [String] :sort
    #   The sort order. Can be either newest, oldest, or stargazers.
    #   Default: newest
    #
    # @example
    #   github = Github.new
    #   github.repos.forks.list('user-name', 'repo-name')
    #   github.repos.forks.list('user-name', 'repo-name') { |fork|
    #     #...
    #   }
    #
    # @api public
    def list(*args)
      arguments(args, required: [:user, :repo])

      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/forks", arguments.params)
      return response unless block_given?
      response.each { |el| yield el }
    end
    alias :all :list

    # Create a fork for the authenticated user
    #
    # @param [Hash] params
    # @input params [String] :organization
    #   The organization login. The repository will be forked into
    #   this organization.
    #
    # @example
    #   github = Github.new
    #   github.repos.forks.create 'user-name', 'repo-name',
    #     organization: "github"
    #
    # @api public
    def create(*args)
      arguments(args, required: [:user, :repo])

      post_request("/repos/#{arguments.user}/#{arguments.repo}/forks", arguments.params)
    end
  end # Client::Repos::Forks
end # Github

Version data entries

3 entries across 3 versions & 2 rubygems

Version	Path
github_api2-1.0.1	lib/github_api2/client/repos/forks.rb
github_api2-1.0.0	lib/github_api2/client/repos/forks.rb
github_api-0.19.0	lib/github_api/client/repos/forks.rb