Class: BitBucket::Client::Repos::Keys

Inherits:
API
  • Object
show all
Defined in:
lib/bitbucket_rest_api/client/repos/keys.rb

Constant Summary collapse

VALID_KEY_PARAM_NAMES = 
%w[ label key ].freeze

Constants included from Validations

Validations::VALID_API_KEYS

Constants included from Validations::Token

Validations::Token::TOKEN_REQUIRED, Validations::Token::TOKEN_REQUIRED_REGEXP

Constants included from BitBucket::Constants

BitBucket::Constants::ACCEPT, BitBucket::Constants::ACCEPT_CHARSET, BitBucket::Constants::CACHE_CONTROL, BitBucket::Constants::CONTENT_LENGTH, BitBucket::Constants::CONTENT_TYPE, BitBucket::Constants::DATE, BitBucket::Constants::ETAG, BitBucket::Constants::LOCATION, BitBucket::Constants::META_FIRST, BitBucket::Constants::META_LAST, BitBucket::Constants::META_NEXT, BitBucket::Constants::META_PREV, BitBucket::Constants::META_REL, BitBucket::Constants::PARAM_PAGE, BitBucket::Constants::PARAM_START_PAGE, BitBucket::Constants::QUERY_STR_SEP, BitBucket::Constants::RATELIMIT_LIMIT, BitBucket::Constants::RATELIMIT_REMAINING, BitBucket::Constants::SERVER, BitBucket::Constants::USER_AGENT

Instance Attribute Summary

Attributes inherited from API

#current_options

Instance Method Summary collapse

Methods inherited from API

#_merge_user_into_params!, #_merge_user_repo_into_params!, #_update_user_repo_params, #api_methods_in, #append_arguments, #arguments, extract_class_name, inherited, #initialize, #method_missing, namespace, #process_basic_auth, #set, #set_api_client, #setup, #with, #yield_or_eval

Methods included from BitBucket::ClassMethods

#configuration, #configure, #require_all

Methods included from Normalizer

#normalize!

Methods included from ParameterFilter

#filter!

Methods included from Validations::Required

#assert_required_keys

Methods included from Validations::Token

#validates_token_for

Methods included from Validations::Format

#assert_valid_values

Methods included from Validations::Presence

#assert_presence_of

Methods included from Request::Verbs

#delete_request, #get_request, #options_request, #patch_request, #post_request, #put_request

Methods included from Authorization

#authenticated?, #authentication, #basic_authed?

Constructor Details

This class inherits a constructor from BitBucket::API

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class BitBucket::API

Instance Method Details

#create(user_name, repo_name, params = {}) ⇒ Object

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..."



39
40
41
42
43
44
45
46
47
 
# File 'lib/bitbucket_rest_api/client/repos/keys.rb', line 39

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)

  post_request("/repositories/#{user}/#{repo.downcase}/deploy-keys/", params)
end

#delete(user_name, repo_name, key_id, params = {}) ⇒ Object

Delete key

Examples

@bitbucket = BitBucket.new
@bitbucket.repos.keys.delete 'user-name', 'repo-name', 'key-id'



78
79
80
81
82
83
84
85
 
# File 'lib/bitbucket_rest_api/client/repos/keys.rb', line 78

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("/repositories/#{user}/#{repo.downcase}/deploy-keys/#{key_id}", params)
end

#edit(user_name, repo_name, key_id, params = {}) ⇒ Object

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..."



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/bitbucket_rest_api/client/repos/keys.rb', line 61

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("/repositories/#{user}/#{repo.downcase}/deploy-keys/#{key_id}", params)
end

#list(user_name, repo_name, params = {}) ⇒ Object Also known as: all

List deploy keys

Examples

bitbucket = BitBucket.new
bitbucket.repos.keys.list 'user-name', 'repo-name'
bitbucket.repos.keys.list 'user-name', 'repo-name' { |key| ... }



16
17
18
19
20
21
22
23
24
 
# File 'lib/bitbucket_rest_api/client/repos/keys.rb', line 16

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("/repositories/#{user}/#{repo.downcase}/deploy-keys/", params)
  return response unless block_given?
  response.each { |el| yield el }
end