class BitBucket::Repos::Keys

Constants

VALID_KEY_PARAM_NAMES

Public Instance Methods

all(user_name, repo_name, params = {})
Alias for: list
create(user_name, 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 37
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
  filter! VALID_KEY_PARAM_NAMES, params
  assert_required_keys(VALID_KEY_PARAM_NAMES, params)

  options = { headers: { 'Content-Type' => 'application/json' } }
  post_request("/1.0/repositories/#{user}/#{repo}/deploy-keys/", params, options)
end
delete(user_name, 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 77
def delete(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

  delete_request("/1.0/repositories/#{user}/#{repo}/deploy-keys/#{key_id}", 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 60
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}/#{repo}/deploy-keys/#{key_id}", params)
end
list(user_name, 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 13
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("/1.0/repositories/#{user}/#{repo}/deploy-keys/", params)
  return response unless block_given?

  response.each { |el| yield el }
end
Also aliased as: all