Module: RedmineAPIHelper::IssuesAPIHelper

Included in:
Helpers
Defined in:
lib/redmine_api_helper/issues_api_helper.rb

Instance Method Summary collapse

Instance Method Details

#create_issue(**params) ⇒ Object

creates a new issue with params, corresponds to controller#create



75
76
77
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 75

def create_issue(**params)
  create_object(:issue, params)
end

#create_issue_watcher(issue_id, user_id, **params) ⇒ Object

creates a watcher with params, corresponds to watchers#create: params: user_id



112
113
114
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 112

def create_issue_watcher(issue_id, user_id, **params)
  jpost(params.merge(:object_type => 'issue', :object_id => issue_id, :user_id => user_id), :url => watchers_url )
end

#destroy_issue(id, **params) ⇒ Object

deletes an existing issue with params, corresponds to controller#destroy



98
99
100
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 98

def destroy_issue(id, **params)
  destroy_object(:issue, id, params)
end

#destroy_issue_watcher(issue_id, user_id, **params) ⇒ Object

deletes a watcher with params, corresponds to watchers#destroy



119
120
121
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 119

def destroy_issue_watcher(issue_id, user_id, **params)
  jdel(:url => watchers_url, :params => params.merge(:object_type => 'issue', :object_id => issue_id, :user_id => user_id))
end

#issue_url(id, **params) ⇒ Object

creates issue_url



33
34
35
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 33

def issue_url(id, **params)
  url_path(issues_url, id, params)
end

#issues_url(**params) ⇒ Object

reads issues_url from args



26
27
28
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 26

def issues_url(**params)
  url_path(args.urls.Home, "issues", params)
end

#list_issues(**params) ⇒ Object

lists issues, corresponds to controller#index



54
55
56
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 54

def list_issues(**params)
  list_objects(:issues, params)
end

#list_project_issues(project_id, **params) ⇒ Object

lists project issues, corresponds to controller#index



61
62
63
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 61

def list_project_issues(project_id, **params)
  list_project_objects(project_id, :issues, params)
end

#project_issue_url(project_id, id, **params) ⇒ Object

creates project_issue_url



47
48
49
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 47

def project_issue_url(project_id, id, **params)
  url_path(project_issues_url(project_id), id, params)
end

#project_issues_url(project_id, **params) ⇒ Object

reads issues_url from args



40
41
42
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 40

def project_issues_url(project_id, **params)
  url_path(project_url(project_id), 'issues', params)
end

#read_issue(id, **params) ⇒ Object

reads issue having id, corresponds to controller#show



68
69
70
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 68

def read_issue(id, **params)
  read_object(:issue, id, params)
end

#update_issue(id, **params) ⇒ Object

updates an existing issue with params, corresponds to controller#update



82
83
84
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 82

def update_issue(id, **params)
  update_object(:issue, id, params)
end

#update_issues(ids, **params) ⇒ Object

‘bulk_updates’ existing issues with params, simulate controller#bulk_update



89
90
91
92
93
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 89

def update_issues(ids, **params)
  ids.each do |id|
    update_object(:issue, id, params)
  end
end

#watchers_url(**params) ⇒ Object

reads watchers_url from args



105
106
107
 
# File 'lib/redmine_api_helper/issues_api_helper.rb', line 105

def watchers_url(**params)
  url_path(args.urls.Watch, params)
end