# encoding: utf-8 module BitBucket class Issues < API extend AutoloadHelper autoload_all 'bitbucket_rest_api/issues', :Comments => 'comments', :Components => 'Components', :Milestones => 'milestones' VALID_ISSUE_PARAM_NAMES = %w[ filter state labels sort direction since milestone assignee mentioned title body resource mime_type ].freeze VALID_ISSUE_PARAM_VALUES = { 'filter' => %w[ assigned created mentioned subscribed ], 'state' => %w[ open closed ], 'sort' => %w[ created updated comments ], 'direction' => %w[ desc asc ], 'since' => %r{\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z} } # Creates new Issues API def initialize(options = { }) super(options) end # Access to Issues::Comments API def comments @comments ||= ApiFactory.new 'Issues::Comments' end # Access to Issues::Components API def components @components ||= ApiFactory.new 'Issues::Components' end # Access to Issues::Milestones API def milestones @milestones ||= ApiFactory.new 'Issues::Milestones' end # List issues for a repository # # = Parameters # :filter - Optional See https://confluence.atlassian.com/display/BITBUCKET/Issues#Issues-Filtering for building the filter string # # = Examples # bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name' # bitbucket.issues.list_repo :filter => 'kind=bug&kind=enhancement' # def list_repo(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_ISSUE_PARAM_NAMES, params # _merge_mime_type(:issue, params) assert_valid_values(VALID_ISSUE_PARAM_VALUES, params) response = get_request("/repositories/#{user}/#{repo}/issues", params) return response unless block_given? response.each { |el| yield el } end alias :list_repository :list_repo # Get a single issue # # = Examples # bitbucket = BitBucket.new # bitbucket.issues.get 'user-name', 'repo-name', 'issue-id' # def get(user_name, repo_name, issue_id, params={ }) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of issue_id normalize! params # _merge_mime_type(:issue, params) get_request("/repositories/#{user}/#{repo}/issues/#{issue_id}", params) end alias :find :get # Create an issue # # = Inputs # :title - Required string # :content - Optional string # :responsible - Optional string - Login for the user that this issue should be assigned to. # :milestone - Optional number - Milestone to associate this issue with # :version - Optional number - Version to associate this issue with # :component - Optional number - Component to associate this issue with # :priority - Optional string - The priority of this issue # * trivial # * minor # * major # * critical # * blocker # :status - Optional string - The status of this issue # * new # * open # * resolved # * on hold # * invalid # * duplicate # * wontfix # :kind - Optional string - The kind of issue # * bug # * enhancement # * proposal # * task # # = Examples # bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name' # bitbucket.issues.create # "title" => "Found a bug", # "content" => "I'm having a problem with this.", # "responsible" => "octocat", # "milestone" => 1, # "priority" => "blocker" # 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 # _merge_mime_type(:issue, params) filter! VALID_ISSUE_PARAM_NAMES, params assert_required_keys(%w[ title ], params) post_request("/repositories/#{user}/#{repo}/issues", params) end # Edit an issue # # = Inputs # :title - Required string # :content - Optional string # :responsible - Optional string - Login for the user that this issue should be assigned to. # :milestone - Optional number - Milestone to associate this issue with # :version - Optional number - Version to associate this issue with # :component - Optional number - Component to associate this issue with # :priority - Optional string - The priority of this issue # * trivial # * minor # * major # * critical # * blocker # :status - Optional string - The status of this issue # * new # * open # * resolved # * on hold # * invalid # * duplicate # * wontfix # :kind - Optional string - The kind of issue # * bug # * enhancement # * proposal # * task # # = Examples # bitbucket = BitBucket.new :user => 'user-name', :repo => 'repo-name' # bitbucket.issues.create # "title" => "Found a bug", # "content" => "I'm having a problem with this.", # "responsible" => "octocat", # "milestone" => 1, # "priority" => "blocker" # def edit(user_name, repo_name, issue_id, params={ }) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of issue_id normalize! params # _merge_mime_type(:issue, params) filter! VALID_ISSUE_PARAM_NAMES, params put_request("/repositories/#{user}/#{repo}/issues/#{issue_id}/", params) end end # Issues end # BitBucket