class BitBucket::Repos::Services

Constants

REQUIRED_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 service

Inputs

  • :type - One of the supported services. The type is a case-insensitive value.

Examples

bitbucket = BitBucket.new
bitbucket.repos.services.create 'user-name', 'repo-name',
  "type"           => "Basecamp",
  "Password"       => "...",
  "Username"       => "...",
  "Discussion URL" => "..."
# File lib/bitbucket_rest_api/repos/services.rb, line 55
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)

  post_request("/1.0/repositories/#{user}/#{repo.downcase}/services", params)
end
delete(user_name, repo_name, service_id, params={}) click to toggle source

Delete service

Examples

@bitbucket = BitBucket.new
@bitbucket.repos.services.delete 'user-name', 'repo-name', 109172378
# File lib/bitbucket_rest_api/repos/services.rb, line 93
def delete(user_name, repo_name, service_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of(service_id)
  normalize! params

  delete_request("/1.0/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
end
edit(user_name, repo_name, service_id, params={}) click to toggle source

Edit a service

Inputs

  • :type - One of the supported services. The type is a case-insensitive value.

Examples

bitbucket = BitBucket.new
bitbucket.repos.services.edit 'user-name', 'repo-name', 109172378,
  "type"           => "Basecamp",
  "Password"       => "...",
  "Username"       => "...",
  "Discussion URL" => "..."
# File lib/bitbucket_rest_api/repos/services.rb, line 77
def edit(user_name, repo_name, service_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of(service_id)

  normalize! params

  put_request("/1.0/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
end
find(user_name, repo_name, service_id, params={})
Alias for: get
get(user_name, repo_name, service_id, params={}) click to toggle source

Gets a single service

Examples

@bitbucket = BitBucket.new
@bitbucket.repos.services.get 'user-name', 'repo-name', 109172378)
# File lib/bitbucket_rest_api/repos/services.rb, line 32
def get(user_name, repo_name, service_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of(service_id)
  normalize! params

  get_request("/1.0/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
end
Also aliased as: find
list(user_name, repo_name, params={}) { |el| ... } click to toggle source

List services

Examples

bitbucket = BitBucket.new
bitbucket.repos.services.list 'user-name', 'repo-name'
bitbucket.repos.services.list 'user-name', 'repo-name' { |service| ... }
# File lib/bitbucket_rest_api/repos/services.rb, line 15
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.downcase}/services", params)
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all