redmine_api_helper 0.3.35

data/lib/redmine_api_helper/scripts_api_helper.rb

@@ -0,0 +1,87 @@
+##
+# 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 ScriptsAPIHelper
+  
+  ########################################################################################
+  # reads scripts_url from args
+  ########################################################################################
+  def scripts_url(**params)
+    url_path(args.urls.Home, 'scripts', params)
+  end #def
+  
+  ########################################################################################
+  # reads project_scripts_url from args
+  ########################################################################################
+  def project_scripts_url(project_id, **params)
+    url_path(project_url(project_id), 'scripts', params)
+  end #def
+  
+  ########################################################################################
+  # reads run_script_url from args
+  ########################################################################################
+  def run_script_url(id, **params)
+    url_path(scripts_url, id, 'run', params)
+  end #def
+  
+  ########################################################################################
+  # reads run_project_script_url from args
+  ########################################################################################
+  def run_project_script_url(project_id, id, **params)
+    url_path(project_scripts_url(project_id), id, 'run', params)
+  end #def
+  
+  ########################################################################################
+  # lists scripts, corresponds to controller#index
+  ########################################################################################
+  def list_scripts(project_id, **params)
+    list_objects(:scripts, params)
+  end #def
+  
+  ########################################################################################
+  # lists scripts, corresponds to controller#index
+  ########################################################################################
+  def list_project_scripts(project_id, **params)
+    list_project_objects(project_id, :scripts, params)
+  end #def
+  
+  ########################################################################################
+  # reads script having id, corresponds to controller#show
+  ########################################################################################
+  def read_script(id, **params)
+    read_object(:script, id, params)
+  end #def
+  
+  ########################################################################################
+  # runs script having id, corresponds to controller#run
+  ########################################################################################
+  def run_script(id, **params)
+    jget(:url => run_script_url(id), :params => params ).script
+  end #def
+  
+  ########################################################################################
+  # runs script having id, corresponds to controller#run
+  ########################################################################################
+  def run_project_script(project_id, id, **params)
+    jget(:url => run_project_script_url(project_id, id), :params => params ).script
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/search_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 SearchAPIHelper
+  
+  ########################################################################################
+  # reads my_account_url from args
+  ########################################################################################
+  def search_url(**params)
+    url_path(args.urls.Home, "search", params)
+  end #def
+  
+  ########################################################################################
+  # list_search result, corresponds to controller#index
+  ########################################################################################
+  def list_search(**params)
+    jget(:url => search_url, :params => params).results
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/time_entries_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 TimeEntriesAPIHelper
+  
+  ########################################################################################
+  # reads time_entries_url from args
+  ########################################################################################
+  def time_entries_url(**params)
+    url_path(args.urls.Home, "time_entries", params)
+  end #def
+  
+  ########################################################################################
+  # creates a time_entry_url
+  ########################################################################################
+  def time_entry_url(id, **params)
+    url_path(time_entries_url, id, params)
+  end #def
+  
+  ########################################################################################
+  # lists time_entries, corresponds to controller#index
+  ########################################################################################
+  def list_time_entries(**params)
+    list_objects(:time_entries, params)
+  end #def
+  
+  ########################################################################################
+  # reads time_entry having id, corresponds to controller#show
+  ########################################################################################
+  def read_time_entry(id, **params)
+    read_object(:time_entry, id, params)
+  end #def
+  
+  ########################################################################################
+  # creates a new time_entry with params, corresponds to controller#create
+  ########################################################################################
+  def create_time_entry(**params)
+    create_object(:time_entry, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing time_entry with params, corresponds to controller#update
+  ########################################################################################
+  def update_time_entry(id, **params)
+    update_object(:time_entry, id, params)
+  end #def
+  
+  ########################################################################################
+  # deletes an existing time_entry with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_time_entry(id, **params)
+    destroy_object(:time_entry, id, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/time_entry_activities_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 TimeEntryActivitiesAPIHelper
+  
+  ########################################################################################
+  # reads time_entry_activities_url from args
+  ########################################################################################
+  def time_entry_activities_url(**params)
+    url_path(args.urls.Home, "enumerations", "time_entry_activities", params)
+  end #def
+  
+  ########################################################################################
+  # lists time_entries, corresponds to controller#index
+  ########################################################################################
+  def list_time_entry_activities(**params)
+    list_objects(:time_entry_activities, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/trackers_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 TrackersAPIHelper
+  
+  ########################################################################################
+  # reads trackers_url from args
+  ########################################################################################
+  def trackers_url(**params)
+    url_path(args.urls.Home, "trackers", params)
+  end #def
+  
+  ########################################################################################
+  # lists trackers, corresponds to controller#index
+  ########################################################################################
+  def list_trackers(**params)
+    list_objects(:tracker, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/users_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 UsersAPIHelper
+  
+  ########################################################################################
+  # reads users_url from args
+  ########################################################################################
+  def users_url(**params)
+    url_path(args.urls.Home, "users", params)
+  end #def
+  
+  ########################################################################################
+  # crerate user_url
+  ########################################################################################
+  def user_url(id, **params)
+    url_path(users_url, id, **params)
+  end #def
+  
+  ########################################################################################
+  # lists users, corresponds to controller#index
+  ########################################################################################
+  def list_users(**params)
+    list_objects(:users, params)
+  end #def
+  
+  ########################################################################################
+  # reads user having id, corresponds to controller#show
+  ########################################################################################
+  def read_user(id, **params)
+    read_object(:user, id, params)
+  end #def
+  
+  ########################################################################################
+  # creates a new user with params, corresponds to controller#create
+  ########################################################################################
+  def create_user(**params)
+    create_object(:user, params)
+  end #def
+  
+  ########################################################################################
+  # updates an existing user with params, corresponds to controller#update
+  ########################################################################################
+  def update_user(id, **params)
+    update_object(:user, id, params)
+  end #def
+  
+  ########################################################################################
+  # deletes an existing user with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_user(id, **params)
+    destroy_object(:user, id, params)
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/version.rb

@@ -0,0 +1,24 @@
+# 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
+  VERSION = "0.3.35"
+end

data/lib/redmine_api_helper/wiki_pages_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 WikiPagesAPIHelper
+  
+  ########################################################################################
+  # reads wiki_pages_url from args
+  ########################################################################################
+  def project_wiki_pages_url(project_id, **params)
+    url_path(project_url(project_id), "wiki", params)
+  end #def
+  
+  ########################################################################################
+  # creates wiki_page_url 
+  ########################################################################################
+  def project_wiki_page_url(project_id, id, **params)
+    url_path(project_wiki_pages_url(project_id), id, params)
+  end #def
+
+  ########################################################################################
+  # lists wiki_pages, corresponds to controller#index
+  ########################################################################################
+  def list_project_wiki_pages(project_id, **params)
+    jget(:url => url_path(project_wiki_pages_url(project_id), "index"), :params => params )
+  end #def
+  
+  ########################################################################################
+  # reads wiki_page having id, corresponds to controller#show
+  ########################################################################################
+  def read_project_wiki_page(project_id, title, **params)
+    jget(:url => url_path(project_wiki_pages_url(project_id), title), :params => params ).wiki_page
+  end #def
+  
+  ########################################################################################
+  # updates or creates an existing wiki_page with params, corresponds to controller#update
+  ########################################################################################
+  def create_or_update_project_wiki_page(project_id, title, **params)
+    jput({:wiki_page => params}, :url => url_path(project_wiki_pages_url(project_id), title))
+  end #def
+  
+  ########################################################################################
+  # deletes an existing wiki_page with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_project_wiki_page(project_id, id, **params)
+    jdel(:url => url_path(project_wiki_pages_url(project_id), id), :params => params )
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper.rb

@@ -0,0 +1,88 @@
+# 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.
+#
+
+require "deep_try"
+require 'net/http'
+require "active_support/json"
+require 'active_support/core_ext/object/to_query'
+
+require "redmine_api_helper/version"
+require "redmine_api_helper/api_helper"
+require "redmine_api_helper/args_helper"
+require "redmine_api_helper/define_api_helpers"
+
+require "redmine_api_helper/attachments_api_helper"
+require "redmine_api_helper/document_categories_api_helper"
+require "redmine_api_helper/groups_api_helper"
+require "redmine_api_helper/issue_priorities_api_helper"
+require "redmine_api_helper/issue_relations_api_helper"
+require "redmine_api_helper/issue_statuses_api_helper"
+require "redmine_api_helper/issues_api_helper"
+require "redmine_api_helper/my_account_api_helper"
+require "redmine_api_helper/news_api_helper"
+require "redmine_api_helper/project_memberships_api_helper"
+require "redmine_api_helper/projects_api_helper"
+require "redmine_api_helper/roles_api_helper"
+require "redmine_api_helper/scripts_api_helper"
+require "redmine_api_helper/search_api_helper"
+require "redmine_api_helper/time_entries_api_helper"
+require "redmine_api_helper/time_entry_activities_api_helper"
+require "redmine_api_helper/trackers_api_helper"
+require "redmine_api_helper/users_api_helper"
+require "redmine_api_helper/wiki_pages_api_helper"
+
+require "redmine_api_helper/helpers"
+
+# goodie: odf_writer
+
+require "zip"
+require "nokogiri"
+require 'digest'
+
+require "odf_writer/parser/default"
+require "odf_writer/path_finder"
+
+require "odf_writer/nested"
+require "odf_writer/field"
+require "odf_writer/field_reader"
+require "odf_writer/text"
+require "odf_writer/text_reader"
+require "odf_writer/bookmark"
+require "odf_writer/bookmark_reader"
+require "odf_writer/image"
+require "odf_writer/image_reader"
+require "odf_writer/table"
+require "odf_writer/table_reader"
+require "odf_writer/section"
+require "odf_writer/section_reader"
+require "odf_writer/images"
+require "odf_writer/template"
+require "odf_writer/document"
+require "odf_writer/style"
+require "odf_writer/list_style"
+
+require "odf_writer/odf_helper"
+
+# goodie: date forward
+
+require "date_helper/date"
+
+

data/redmine_api_helper.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/redmine_api_helper/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name                          = "redmine_api_helper"
+  spec.version                       = RedmineAPIHelper::VERSION
+  spec.authors                       = ["Stephan Wenzel"]
+  spec.email                         = ["stephan.wenzel@drwpatent.de"]
+  spec.license                       = 'GPL-2.0'
+  
+  spec.summary                       = %q{redmine_api_helper aids creating fiddles for redmine_scripting_engine}
+  spec.description                   = %q{redmine_api_helper contains methods to ease handling Redmine API calls}
+  spec.homepage                      = "https://github.com/HugoHasenbein/redmine_api_helper"
+  spec.required_ruby_version         = Gem::Requirement.new(">= 2.3.0")
+  
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  
+  spec.metadata["homepage_uri"]      = spec.homepage
+  spec.metadata["source_code_uri"]   = "https://github.com/HugoHasenbein/redmine_api_helper"
+  spec.metadata["changelog_uri"]     = "https://github.com/HugoHasenbein/redmine_api_helper/Changelog.md"
+  
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }.reject{ |f| f.match(%r{\.gem\z})}
+  end
+  
+  spec.bindir                        = "exe"
+  spec.executables                   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths                 = ["lib"]
+  
+  spec.add_runtime_dependency 'deep_try'
+  spec.add_runtime_dependency 'rubyzip', "~> 2"
+  spec.add_runtime_dependency 'nokogiri'
+  spec.add_runtime_dependency 'rack'
+end