class BitBucket::Issues::Milestones

Public Class Methods

new(options = {}) click to toggle source

Creates new Issues::Milestones API

Calls superclass method BitBucket::API::new
# File lib/bitbucket_rest_api/issues/milestones.rb, line 11
def initialize(options = {})
  super(options)
end

Public Instance Methods

all(user_name, repo_name, params={})
Alias for: list
create(user_name, repo_name, params={}) click to toggle source

Create a milestone

Inputs

<tt>:name</tt> - Required string

Examples

bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
bitbucket.issues.milestones.create :name => 'hello-world'
# File lib/bitbucket_rest_api/issues/milestones.rb, line 58
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_MILESTONE_INPUTS, params
  assert_required_keys(%w[ name ], params)

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

Delete a milestone

Examples

bitbucket = BitBucket.new
bitbucket.issues.milestones.delete 'user-name', 'repo-name', 'milestone-id'
# File lib/bitbucket_rest_api/issues/milestones.rb, line 97
def delete(user_name, repo_name, milestone_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of milestone_id
  normalize! params

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

Get a single milestone

Examples

bitbucket = BitBucket.new
bitbucket.issues.milestones.get 'user-name', 'repo-name', 'milestone-id'
# File lib/bitbucket_rest_api/issues/milestones.rb, line 39
def get(user_name, repo_name, milestone_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of milestone_id
  normalize! params

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

List milestones for a repository

Examples

bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name'
bitbucket.issues.milestones.list
# File lib/bitbucket_rest_api/issues/milestones.rb, line 21
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/milestones", params)
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all
update(user_name, repo_name, milestone_id, params={}) click to toggle source

Update a milestone

Inputs

<tt>:name</tt> - Required string

Examples

bitbucket = BitBucket.new
bitbucket.issues.milestones.update 'user-name', 'repo-name', 'milestone-id',
  :name => 'hello-world'
# File lib/bitbucket_rest_api/issues/milestones.rb, line 79
def update(user_name, repo_name, milestone_id, params={})
  _update_user_repo_params(user_name, repo_name)
  _validate_user_repo_params(user, repo) unless user? && repo?
  _validate_presence_of milestone_id

  normalize! params
  filter! VALID_MILESTONE_INPUTS, params
  assert_required_keys(%w[ name ], params)

  put_request("/1.0/repositories/#{user}/#{repo.downcase}/issues/milestones/#{milestone_id}", params)
end