Contents

# frozen_string_literal: true
module BitBucket
  class Repos::Forks < API
    REQUIRED_KEY_PARAM_NAMES = %w[name].freeze
    DEFAULT_REPO_OPTIONS = {
      'website' => '',
      'is_private' => false,
      'has_issues' => false,
      'has_wiki' => false,
      'scm' => 'git',
      'no_public_forks' => false
    }.freeze

    VALID_REPO_OPTIONS = %w[
      owner
      name
      description
      website
      is_private
      has_issues
      has_wiki
      no_public_forks
      language
      scm
    ].freeze

    # List forks of a repo
    #
    # = Examples
    #  bitbucket = BitBucket.new
    #  bitbucket.repos.forks.list 'user-name', 'repo-name'
    #  bitbucket.repos.forks.list 'user-name', 'repo-name' { |fork| ... }
    #
    def list(user_name, repo_name, params = {})
      _update_user_repo_params(user_name, repo_name)
      _validate_user_repo_params(user, repo) unless user? && repo?
      normalize! params

      response = get_request("/2.0/repositories/#{user}/#{repo.downcase}/forks/", params)
      return response unless block_given?

      response.each { |el| yield el }
    end
    alias all list

    # Create a fork
    #
    # = Inputs
    # * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.
    #
    # = Examples
    #  bitbucket = BitBucket.new
    #  bitbucket.repos.forks.create 'user-name', 'repo-name',
    #    "name"           => "Basecamp",
    #
    def create(user_name, repo_name, params = {})
      _update_user_repo_params(user_name, repo_name)
      _validate_user_repo_params(user, repo) unless user? && repo?
      normalize! params
      assert_required_keys(REQUIRED_KEY_PARAM_NAMES, params)
      filter! VALID_REPO_OPTIONS, params

      post_request("/1.0/repositories/#{user}/#{repo.downcase}/fork", params)
    end
  end # Repos::Keys
end # BitBucket

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
bitbuckets-0.2.0	lib/bitbucket_rest_api/repos/forks.rb