Class: BitBucket::Repos::Services

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

Constant Summary collapse

REQUIRED_KEY_PARAM_NAMES = 
%w[ type ].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::Request

BitBucket::Request::METHODS, BitBucket::Request::METHODS_WITH_BODIES

Constants included from Connection

Connection::ALLOWED_OPTIONS

Constants included from Constants

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

Instance Method Summary collapse

Methods inherited from API

#_merge_mime_type, #_merge_user_into_params!, #_merge_user_repo_into_params!, #_update_user_repo_params, #api_methods_in, inherited, #initialize, #method_missing, #process_basic_auth, #setup, #update_and_validate_user_repo_params

Methods included from Helpers::RepositoryHelper

#sanitize_repository_name

Methods included from Normalizer

#normalize!

Methods included from ParameterFilter

#filter!

Methods included from AutoloadHelper

#autoload_all, #lookup_constant, #register_constant

Methods included from Validations::Required

#assert_required_keys, #assert_required_values_present, #parse_values

Methods included from Validations::Token

#validates_token_for

Methods included from Validations::Format

#assert_valid_values

Methods included from Validations::Presence

#_validate_presence_of, #_validate_user_repo_params

Methods included from BitBucket::Request

#delete_request, #get_request, #patch_request, #post_request, #put_request, #request, #retry_token_refresh_errors

Methods included from Connection

#caching?, #clear_cache, #connection, #default_middleware, #default_options, #stack

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



62
63
64
65
66
67
68
69
 
# File 'lib/bitbucket_rest_api/repos/services.rb', line 62

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 = {}) ⇒ Object

Delete service

Examples

@bitbucket = BitBucket.new
@bitbucket.repos.services.delete 'user-name', 'repo-name', 109172378



100
101
102
103
104
105
106
107
 
# File 'lib/bitbucket_rest_api/repos/services.rb', line 100

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 = {}) ⇒ Object

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



84
85
86
87
88
89
90
91
92
 
# File 'lib/bitbucket_rest_api/repos/services.rb', line 84

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

#get(user_name, repo_name, service_id, params = {}) ⇒ Object Also known as: find

Gets a single service

Examples

@bitbucket = BitBucket.new
@bitbucket.repos.services.get 'user-name', 'repo-name', 109172378)



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

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

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

List services

Examples

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



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/bitbucket_rest_api/repos/services.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.downcase}/settings/hooks"
        else
          "/1.0/repositories/#{user}/#{repo.downcase}/services"
        end

  response = get_request(url, params)

  return response unless block_given?
  response.each { |el| yield el }
end