class BitBucket::Repos::Keys

Constants

VALID_KEY_PARAM_NAMES

Public Instance Methods

all(user_name_or_project_key, repo_name, params={})
Alias for: list
create(user_name_or_project_key, repo_name, params={}) click to toggle source

Create a key

Inputs

  • :title - Required string.

  • :key - Required string.

Examples

bitbucket = BitBucket.new
bitbucket.repos.keys.create 'user-name', 'repo-name',
  "label" => "octocat@octomac",
  "key" =>  "ssh-rsa AAA..."
# File lib/bitbucket_rest_api/repos/keys.rb, line 45
def create(user_name_or_project_key, repo_name, params={})
  _update_user_repo_params(user_name_or_project_key, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params
  filter! VALID_KEY_PARAM_NAMES, params

  options = { headers: { "Content-Type" => "application/json" } }

  url = if BitBucket.options[:bitbucket_server]
          "/1.0/projects/#{user_name_or_project_key}/repos/#{repo_name.downcase}/ssh"
        else
          "/1.0/repositories/#{user_name_or_project_key}/#{repo.downcase}/deploy-keys/"
        end

  post_request(url, params, options)
end
delete(user_name_or_project_key, repo_name, key_id, params={}) click to toggle source

Delete key

Examples

@bitbucket = BitBucket.new
@bitbucket.repos.keys.delete 'user-name', 'repo-name', 'key-id'
# File lib/bitbucket_rest_api/repos/keys.rb, line 91
def delete(user_name_or_project_key, repo_name, key_id, params={})
  _update_user_repo_params(user_name_or_project_key, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of key_id
  normalize! params

  url = if BitBucket.options[:bitbucket_server]
          "/1.0/projects/#{user_name_or_project_key}/repos/#{repo_name.downcase}/ssh/#{key_id}"
        else
          "/1.0/repositories/#{user_name_or_project_key}/#{repo.downcase}/deploy-keys/#{key_id}"
        end

  delete_request(url, params)
end
edit(user_name, repo_name, key_id, params={}) click to toggle source

Edit a key

Inputs

  • :title - Required string.

  • :key - Required string.

Examples

bitbucket = BitBucket.new
bitbucket.repos.keys.edit 'user-name', 'repo-name',
  "label" => "octocat@octomac",
  "key" =>  "ssh-rsa AAA..."
# File lib/bitbucket_rest_api/repos/keys.rb, line 74
def edit(user_name, repo_name, key_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of key_id

  normalize! params
  filter! VALID_KEY_PARAM_NAMES, params

  put_request("/1.0/repositories/#{user}/#{sanitize_repository_name(repo)}/deploy-keys/#{key_id}", params)
end
list(user_name_or_project_key, repo_name, params={}) { |el| ... } click to toggle source

List deploy keys

Examples

bitbucket = BitBucket.new
bitbucket.repos.keys.list 'user-name', 'repo-name'
bitbucket.repos.keys.list 'user-name', 'repo-name' { |key| ... }
# File lib/bitbucket_rest_api/repos/keys.rb, line 15
def list(user_name_or_project_key, repo_name, params={})
  _update_user_repo_params(user_name_or_project_key, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  normalize! params

  url = if BitBucket.options[:bitbucket_server]
          "/1.0/projects/#{user_name_or_project_key}/repos/#{repo_name.downcase}/ssh"
        else
          "/1.0/repositories/#{user_name_or_project_key}/#{repo.downcase}/deploy-keys/"
        end

  response = get_request(url, params)

  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all