redmine_api_helper 0.3.35

data/lib/redmine_api_helper/helpers.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+#
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+
+module RedmineAPIHelper
+  module Helpers
+  
+    include RedmineAPIHelper::APIHelper
+    include RedmineAPIHelper::ArgsHelper
+    include RedmineAPIHelper::DefineAPIHelpers
+    
+    include RedmineAPIHelper::AttachmentsAPIHelper
+    include RedmineAPIHelper::DocumentCategoriesAPIHelper
+    include RedmineAPIHelper::GroupsAPIHelper
+    include RedmineAPIHelper::IssuePrioritiesAPIHelper
+    include RedmineAPIHelper::IssueRelationsAPIHelper
+    include RedmineAPIHelper::IssueStatusesAPIHelper
+    include RedmineAPIHelper::IssuesAPIHelper
+    include RedmineAPIHelper::MyAccountAPIHelper
+    include RedmineAPIHelper::NewsAPIHelper
+    include RedmineAPIHelper::ProjectMembershipsAPIHelper
+    include RedmineAPIHelper::ProjectsAPIHelper
+    include RedmineAPIHelper::RolesAPIHelper
+    include RedmineAPIHelper::SearchAPIHelper
+    include RedmineAPIHelper::TimeEntriesAPIHelper
+    include RedmineAPIHelper::TimeEntryActivitiesAPIHelper
+    include RedmineAPIHelper::TrackersAPIHelper
+    include RedmineAPIHelper::UsersAPIHelper
+    include RedmineAPIHelper::WikiPagesAPIHelper
+    include RedmineAPIHelper::ScriptsAPIHelper
+    
+  end
+end 

data/lib/redmine_api_helper/issue_priorities_api_helper.rb

@@ -0,0 +1,38 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module IssuePrioritiesAPIHelper
+  
+  ########################################################################################
+  # reads issue_priorities_url from args
+  ########################################################################################
+  def issue_priorities_url(**params)
+    url_path(args.urls.Home, "enumerations", "issue_priorities", params)
+  end #def
+  
+  ########################################################################################
+  # lists issue_priorities, corresponds to controller#index
+  ########################################################################################
+  def list_issue_priorities(**params)
+    list_objects(:issue_priorities, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/issue_relations_api_helper.rb

@@ -0,0 +1,66 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module IssueRelationsAPIHelper
+  
+  ########################################################################################
+  # reads issue_relations_url from args
+  ########################################################################################
+  def issue_relations_url(issue_id, **params)
+    url_path(issue_url(issue_id), "relations", params)
+  end #def
+  
+  ########################################################################################
+  # reads relations_url from args
+  ########################################################################################
+  def relation_url(id, **params)
+    url_path(args.urls.Home, "relations", id, params)
+  end #def
+  
+  ########################################################################################
+  # lists issue_relations, corresponds to controller#index
+  ########################################################################################
+  def list_issue_relations(issue_id, **params)
+    jget(:url => issue_relations_url(issue_id), :params => params).relations
+  end #def
+  
+  ########################################################################################
+  # reads issue having id, corresponds to controller#show
+  ########################################################################################
+  def read_relation(id, **params)
+    jget(:url => relation_url(id), :params => params).relation
+  end #def
+  
+  ########################################################################################
+  # creates a new issue with params, corresponds to controller#create
+  ########################################################################################
+  def create_issue_relation(issue_id, **params)
+    jpost(params, :url => issue_relations_url(issue_id)).relation
+  end #def
+  
+  ########################################################################################
+  # deletes an existing issue with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_relation(id, **params)
+    jdel(:url => relation_url(id), :params => params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/issue_statuses_api_helper.rb

@@ -0,0 +1,36 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module IssueStatusesAPIHelper
+  
+  ########################################################################################
+  # reads issue_statuses_url from args
+  ########################################################################################
+  def issue_statuses_url(**params)
+    url_path(args.urls.Home, "issue_statuses", params)
+  end #def
+  
+  ########################################################################################
+  # lists issue_statuses, corresponds to controller#index
+  ########################################################################################
+  def list_issue_statuses(**params)
+    list_objects(:issue_statuses, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/issues_api_helper.rb

@@ -0,0 +1,124 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module IssuesAPIHelper
+  
+  ########################################################################################
+  # reads issues_url from args
+  ########################################################################################
+  def issues_url(**params)
+    url_path(args.urls.Home, "issues", params)
+  end #def
+  
+  ########################################################################################
+  # creates issue_url
+  ########################################################################################
+  def issue_url(id, **params)
+    url_path(issues_url, id, params)
+  end #def
+  
+  ########################################################################################
+  # reads issues_url from args
+  ########################################################################################
+  def project_issues_url(project_id, **params)
+    url_path(project_url(project_id), 'issues', params)
+  end #def
+  
+  ########################################################################################
+  # creates project_issue_url
+  ########################################################################################
+  def project_issue_url(project_id, id, **params)
+    url_path(project_issues_url(project_id), id, params)
+  end #def
+  
+  ########################################################################################
+  # lists issues, corresponds to controller#index
+  ########################################################################################
+  def list_issues(**params)
+    list_objects(:issues, params)
+  end #def
+  
+  ########################################################################################
+  # lists project issues, corresponds to controller#index
+  ########################################################################################
+  def list_project_issues(project_id, **params)
+    list_project_objects(project_id, :issues, params)
+  end #def
+  
+  ########################################################################################
+  # reads issue having id, corresponds to controller#show
+  ########################################################################################
+  def read_issue(id, **params)
+    read_object(:issue, id, params)
+  end #def
+  
+  ########################################################################################
+  # creates a new issue with params, corresponds to controller#create
+  ########################################################################################
+  def create_issue(**params)
+    create_object(:issue, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing issue with params, corresponds to controller#update
+  ########################################################################################
+  def update_issue(id, **params)
+    update_object(:issue, id, params)
+  end #def
+  
+  ########################################################################################
+  # 'bulk_updates' existing issues with params, simulate controller#bulk_update
+  ########################################################################################
+  def update_issues(ids, **params)
+    ids.each do |id|
+      update_object(:issue, id, params)
+    end
+  end #def
+  
+  ########################################################################################
+  # deletes an existing issue with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_issue(id, **params)
+    destroy_object(:issue, id, params)
+  end #def
+  
+  ########################################################################################
+  # reads watchers_url from args
+  ########################################################################################
+  def watchers_url(**params)
+    url_path(args.urls.Watch, params)
+  end #def
+  
+  ########################################################################################
+  # creates a watcher with params, corresponds to watchers#create: params: user_id
+  ########################################################################################
+  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 #def
+  
+  ########################################################################################
+  # deletes a watcher with params, corresponds to watchers#destroy
+  ########################################################################################
+  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 #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/my_account_api_helper.rb

@@ -0,0 +1,45 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module MyAccountAPIHelper
+  
+  ########################################################################################
+  # reads my_account_url from args
+  ########################################################################################
+  def my_account_url(**params)
+    url_path(args.urls.Home, "my", "account", params)
+  end #def
+  
+  ########################################################################################
+  # reads my account, corresponds to controller#show
+  ########################################################################################
+  def read_my_account(**params)
+    jget(params.merge(:url => my_account_url)).user
+  end #def
+  
+  ########################################################################################
+  # updates my account with params, corresponds to controller#update
+  ########################################################################################
+  def update_my_account(**params)
+    jput({:user => params}, :url => my_account_url)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/news_api_helper.rb

@@ -0,0 +1,73 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module NewsAPIHelper
+  
+  ########################################################################################
+  # reads news_url from args
+  ########################################################################################
+  def news_index_url(**params)
+    url_path(args.urls.Home, "news", params)
+  end #def
+  
+  ########################################################################################
+  # creates new_url
+  ########################################################################################
+  def news_url(id, **params)
+    url_path(news_index_url, id, params)
+  end #def
+  
+  ########################################################################################
+  # reads project_news_url from args
+  ########################################################################################
+  def project_news_index_url(project_id, **params)
+    url_path(project_url(project_id), "news", params)
+  end #def
+  
+  ########################################################################################
+  # creates project_new_url 
+  ########################################################################################
+  def project_news_url(project_id, id, **params)
+    url_path(project_news_index_url(project_id), id, params)
+  end #def
+  
+  ########################################################################################
+  # list_news result, corresponds to controller#index
+  ########################################################################################
+  def list_news(**params)
+    jget(:url => news_index_url, :params => params ).news
+  end #def
+  
+  ########################################################################################
+  # list_news result, corresponds to controller#index
+  ########################################################################################
+  def list_project_news(project_id, **params)
+    jget(:url => project_news_index_url(project_id), :params => params ).news
+  end #def
+  
+  ########################################################################################
+  # read_news result, corresponds to controller#show
+  ########################################################################################
+  def read_news(id, **params)
+    read_object(:news, id, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/project_memberships_api_helper.rb

@@ -0,0 +1,77 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module ProjectMembershipsAPIHelper
+  
+  ########################################################################################
+  # reads projects_url from args
+  ########################################################################################
+  def project_memberships_url(project_id, **params)
+    url_path(project_url(project_id), "memberships", params)
+  end #def
+  
+  def memberships_url(**params)
+    url_path(args.urls.Home, "memberships", params)
+  end #def
+  
+  ########################################################################################
+  # creates a membership_url
+  ########################################################################################
+  def membership_url(id, **params)
+    url_path(memberships_url, id, params)
+  end #def
+  
+  ########################################################################################
+  # lists projects, corresponds to controller#index
+  ########################################################################################
+  def list_project_memberships(project_id, **params)
+    list_project_objects(project_id, :memberships, params)
+  end #def
+  
+  ########################################################################################
+  # reads project having id, corresponds to controller#show
+  ########################################################################################
+  def read_membership(id, **params)
+    read_object(:membership, id, params)
+  end #def
+  
+  ########################################################################################
+  # creates a new project with params, corresponds to controller#create
+  ########################################################################################
+  def create_project_membership(project_id, **params)
+    create_project_object(project_id, :membership, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing project with params, corresponds to controller#update
+  ########################################################################################
+  def update_membership(id, **params)
+    update_object(:membership, id, params)
+  end #def
+  
+  ########################################################################################
+  # deletes an existing project with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_membership(id, **params)
+    destroy_object(:membership, id, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/projects_api_helper.rb

@@ -0,0 +1,73 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module ProjectsAPIHelper
+  
+  ########################################################################################
+  # reads projects_url from args
+  ########################################################################################
+  def projects_url(**params)
+    url_path(args.urls.Home, "projects", params)
+  end #def
+  
+  ########################################################################################
+  # creates project_url
+  ########################################################################################
+  def project_url(id, **params)
+    url_path(projects_url, id, params)
+  end #def
+  
+  ########################################################################################
+  # lists projects, corresponds to controller#index
+  ########################################################################################
+  def list_projects(**params)
+    list_objects(:projects, params)
+  end #def
+  
+  ########################################################################################
+  # reads project having id, corresponds to controller#show
+  ########################################################################################
+  def read_project(id, **params)
+    read_object(:project, id, params)
+  end #def
+  
+  ########################################################################################
+  # creates a new project with params, corresponds to controller#create
+  ########################################################################################
+  def create_project(**params)
+    create_object(:project, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing project with params, corresponds to controller#update
+  ########################################################################################
+  def update_project(id, **params)
+    update_object(:project, id, params)
+  end #def
+  
+  ########################################################################################
+  # deletes an existing project with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_project(id, **params)
+    destroy_object(:project, id, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/roles_api_helper.rb

@@ -0,0 +1,52 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright  2021 Stephan Wenzel <stephan.wenzel@drwpatent.de>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+module RedmineAPIHelper
+  module RolesAPIHelper
+  
+  ########################################################################################
+  # reads roles_url from args
+  ########################################################################################
+  def roles_url(**params)
+    url_path(args.urls.Home, "roles", params)
+  end #def
+  
+  ########################################################################################
+  # creates a role_url
+  ########################################################################################
+  def role_url(id, **params)
+    url_path(roles_url, id, params)
+  end #def
+  
+  ########################################################################################
+  # lists roles, corresponds to controller#index
+  ########################################################################################
+  def list_roles(**params)
+    list_objects(:roles, params)
+  end #def
+  
+  ########################################################################################
+  # read role, corresponds to controller#show
+  ########################################################################################
+  def read_role(id, **params)
+    read_object(:role, id, params)
+  end #def
+  
+  end #module
+end #module