class BitBucket::Issues::Components
Constants
- VALID_COMPONENT_INPUTS
Public Class Methods
new(options = {})
click to toggle source
Creates new Issues::Components
API
Calls superclass method
BitBucket::API::new
# File lib/bitbucket_rest_api/issues/components.rb, line 7 def initialize(options = {}) super(options) end
Public Instance Methods
create(user_name, repo_name, params = {})
click to toggle source
Create a component
Inputs¶ ↑
<tt>:name</tt> - Required string
Examples¶ ↑
bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name' bitbucket.issues.components.create :name => 'API'
# File lib/bitbucket_rest_api/issues/components.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 filter! VALID_COMPONENT_INPUTS, params assert_required_keys(VALID_COMPONENT_INPUTS, params) post_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/components", params) end
delete(user_name, repo_name, component_id, params = {})
click to toggle source
Delete a component
Examples¶ ↑
bitbucket = BitBucket.new bitbucket.issues.components.delete 'user-name', 'repo-name', 'component-id'
# File lib/bitbucket_rest_api/issues/components.rb, line 95 def delete(user_name, repo_name, component_id, params = {}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of component_id normalize! params delete_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/components/#{component_id}", params) end
get(user_name, repo_name, component_id, params = {})
click to toggle source
Get a single component
Examples¶ ↑
bitbucket = BitBucket.new bitbucket.issues.components.find 'user-name', 'repo-name', 'component-id'
# File lib/bitbucket_rest_api/issues/components.rb, line 36 def get(user_name, repo_name, component_id, params = {}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of component_id normalize! params get_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/components/#{component_id}", params) end
Also aliased as: find
list(user_name, repo_name, params = {}) { |el| ... }
click to toggle source
List all components for a repository
Examples¶ ↑
bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name' bitbucket.issues.components.list bitbucket.issues.components.list { |component| ... }
# File lib/bitbucket_rest_api/issues/components.rb, line 18 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}/issues/components", params) return response unless block_given? response.each { |el| yield el } end
Also aliased as: all
update(user_name, repo_name, component_id, params = {})
click to toggle source
Update a component
Inputs¶ ↑
<tt>:name</tt> - Required string
Examples¶ ↑
@bitbucket = BitBucket.new @bitbucket.issues.components.update 'user-name', 'repo-name', 'component-id', :name => 'API'
# File lib/bitbucket_rest_api/issues/components.rb, line 76 def update(user_name, repo_name, component_id, params = {}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of component_id normalize! params filter! VALID_COMPONENT_INPUTS, params assert_required_keys(VALID_COMPONENT_INPUTS, params) put_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/components/#{component_id}", params) end
Also aliased as: edit