redmine_api_helper 0.1.3

data/lib/redmine_api_helper/attachments_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 AttachmentsAPIHelper
+  
+  ########################################################################################
+  # creates an attachment_url from args
+  ########################################################################################
+  def attachment_url(id, **params)
+    url_path(args.urls.Home, "attachments", id, params)
+  end #def
+  
+  ########################################################################################
+  # reads attachment having id, corresponds to controller#show
+  ########################################################################################
+  def read_attachment(id, **params)
+    read_object(:attachment, id, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing attachment with params, corresponds to controller#update
+  ########################################################################################
+  def update_attachment(id, **params)
+    update_object(:attachment, id, params)
+  end #def
+  
+  ########################################################################################
+  # deletes an existing attachment with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_attachment(id, **params)
+    destroy_object(:attachment, id, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/define_api_helpers.rb

@@ -0,0 +1,78 @@
+##
+# 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 DefineAPIHelpers
+  
+  ########################################################################################
+  # defines global standard helpers for object
+  ########################################################################################
+  def define_api_helpers(object)
+  
+    object  = object.to_s.singularize.to_sym
+    objects = object.to_s.pluralize.to_sym
+    
+    # objects_url ########################################################################
+    define_singleton_method("#{objects}_url".to_sym) do |**params|
+      url_path(args.urls.Home, objects, params)
+    end
+    
+    # project_objects_url ################################################################
+    define_singleton_method("project_#{objects}_url".to_sym) do |project_id, **params|
+      url_path(project_url(project_id), objects, params)
+    end
+    
+    # object_url #########################################################################
+    define_singleton_method("#{object}_url".to_sym) do |id, **params|
+      url_path(send("#{objects}_url".to_sym), id, params)
+    end
+    
+    # project_object_url #################################################################
+    define_singleton_method("project_#{object}_url".to_sym) do |project_id, id, **params|
+      url_path(send("project_#{objects}_url".to_sym, project_id), id, params)
+    end
+    
+    # list_objects #######################################################################
+    define_singleton_method("list_#{objects}".to_sym) do |**params|
+      list_objects(objects, params)
+    end
+    
+    # list_project_objects ###############################################################
+    define_singleton_method("list_project_#{objects}".to_sym) do |project_id, **params|
+      list_project_objects(project_id, objects, params)
+    end
+    
+    # create_object ######################################################################
+    define_singleton_method("create_#{object}".to_sym) do |**params|
+      create_object(object, params)
+    end
+    
+    # read_object ########################################################################
+    # update_object ######################################################################
+    # destroy_object #####################################################################
+    %w(read update destroy).each do |action|
+      define_singleton_method("#{action}_#{object}".to_sym) do |id, **params|
+        send("#{action}_object".to_sym, id, params)
+      end
+    end
+    
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/document_categories_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 DocumentCategoriesAPIHelper
+  
+  ########################################################################################
+  # reads document_categories_url from args
+  ########################################################################################
+  def document_categories_url(**params)
+    url_path(args.urls.Home, "enumerations", "document_categories", params)
+  end #def
+  
+  ########################################################################################
+  # lists document_categories, corresponds to controller#index
+  ########################################################################################
+  def list_document_categories(**params)
+    list_objects(:document_categories, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/groups_api_helper.rb

@@ -0,0 +1,80 @@
+##
+# 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 GroupsAPIHelper
+  
+  ########################################################################################
+  # reads groups_url from args
+  ########################################################################################
+  def groups_url(**params)
+    url_path(args.urls.Home, "groups", params)
+  end #def
+  
+  ########################################################################################
+  # creates group_url 
+  ########################################################################################
+  def group_url(id, **params)
+    url_path(groups_url, id, params)
+  end #def
+  
+  ########################################################################################
+  # lists groups, corresponds to controller#index
+  ########################################################################################
+  def list_groups(**params)
+    list_objects(:groups, params)
+  end #def
+  
+  ########################################################################################
+  # reads group having id, corresponds to controller#show
+  ########################################################################################
+  def read_group(id, **params)
+    read_object(:group, id, params)
+  end #def
+  
+  ########################################################################################
+  # creates a new group with params, corresponds to controller#create
+  ########################################################################################
+  def create_group(**params)
+    create_object(:group, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing group with params, corresponds to controller#update
+  ########################################################################################
+  def update_group(id, **params)
+    update_object(:group, id, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing group with params, corresponds to controller#update
+  ########################################################################################
+  def group_add_user(id, user_id, **params)
+    jpost(params.merge(:user_id => user_id), :url => url_path(groups_url, id, "users"))
+  end #def
+  
+  ########################################################################################
+  # deletes an existing group with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_group(id, **params)
+    destroy_object(:group, id, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/helpers.rb

@@ -0,0 +1,48 @@
+# 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
+    
+  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