redmine_api_helper 0.3.35

data/lib/redmine_api_helper/api_helper.rb

@@ -0,0 +1,333 @@
+##
+# 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 'net/http'
+
+module RedmineAPIHelper
+  module APIHelper
+  
+  ########################################################################################
+  # api functions
+  ########################################################################################
+  class TooManyRedirects < StandardError; end
+  LIMIT_REDIRECTS = 10
+  USER_AGENT      = ["Redmine API Helper", RedmineAPIHelper::VERSION].join(" ")
+  
+  ########################################################################################
+  # returns error
+  ########################################################################################
+  def error(err)
+    OpenStruct.new(:error => err.message, :backtrace => err.backtrace)
+  end #def
+  
+  ########################################################################################
+  # assembles url from fragments
+  ########################################################################################
+  def url_path(*fragments, **options)
+    [fragments.map do |fragment|
+       fragment.to_s.gsub(/\/\z/,"")
+     end.join("/"),
+     options.to_query.presence
+    ].compact.join("?")
+  end #def
+  
+  ########################################################################################
+  # lists objects, corresponds to controller#index
+  ########################################################################################
+  def list_objects(objects, params={})
+    jget(:url => send("#{objects}_url"), :params => params ).send(objects) 
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  def list_project_objects(project_id, objects, params={})
+    jget(:url => send("project_#{objects}_url", project_id), :params => params ).send(objects)
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  ########################################################################################
+  # reads object having id, corresponds to controller#show
+  ########################################################################################
+  def read_object(object, id, params={})
+    jget(:url => send("#{object}_url", id), :params => params ).send(object)
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  def read_project_object(project_id, object, id, params={})
+    jget(:url => send("project_#{object}_url", project_id, id), :params => params ).send(object)
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  ########################################################################################
+  # creates a new object with params, corresponds to controller#create
+  ########################################################################################
+  def create_object(object, params={})
+    jpost( {object => params}, :url => send("#{object.to_s.pluralize}_url") ).send(object)
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  def create_project_object(project_id, object, params={})
+    jpost( {object => params}, :url => send("project_#{object.to_s.pluralize}_url", project_id) ).send(object)
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  ########################################################################################
+  # updates an existing object with params, corresponds to controller#update
+  ########################################################################################
+  def update_object(object, id, params={})
+    jput( {object  => params}, :url => send("#{object}_url", id) )
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  def update_project_object(project_id, object, id, params={})
+    jput( {object  => params}, :url => send("project_#{object}_url", project_id, id) )
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  ########################################################################################
+  # deletes an existing object with params, corresponds to controller#destroy
+  ########################################################################################
+  def destroy_object(object, id, params={})
+    jdel(:url => send("#{object}_url", id), :params => params )
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  def destroy_project_object(project_id, object, id, params={})
+    jdel(:url => send("project_#{object}_url", project_id, id), :params => params )
+  rescue Exception => err
+    error(err)
+  end #def
+  
+  ########################################################################################
+  # fetch(options), get request
+  ########################################################################################
+  def fetch(options={})
+    
+    # create query parameters
+    params                   = options[:params].to_h.to_query
+    url                      = options[:url]
+    
+    # create GET request
+    uri                      = URI.parse([url, params.presence].compact.join("?"))
+    req                      = Net::HTTP::Get.new(uri.request_uri)
+    
+    # create HTTP handler
+    http                     = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl             = uri.scheme.downcase == "https"
+    
+    # get request
+    @http_response           = http.request(req)
+    
+    case @http_response
+    
+    when Net::HTTPSuccess 
+      @http_response.body.present? ? @http_response.body : serialize(:response => "OK")
+      
+    when Net::HTTPRedirection 
+      options[:redirects] = options[:redirects].to_i + 1
+      raise TooManyRedirects if options[:redirects] > LIMIT_REDIRECTS
+      fetch( options.merge(:url => response['location']) )
+      
+    else
+      serialize(:response => @http_response.code)
+      
+    end
+    
+  end #def
+  
+  ########################################################################################
+  # jget(options), get request
+  ########################################################################################
+  def jget(options={})
+    
+    index                    = options[:index].to_i
+    json                     = options[:json].nil? || !!options[:json]
+    params                   = json ? options[:params].to_h.merge(:format => "json").to_query : options[:params].to_h.to_query
+    content_type             = json ? "application/json" : options[:content_type]
+    api                      = options[:api_key].nil? ? true : !!options[:api_key]
+    url                      = options[:url].presence || args.objects[index].object_url
+    
+    # create GET request
+    uri                      = URI.parse( [url, params.presence].compact.join("?"))
+    req                      = Net::HTTP::Get.new(uri.request_uri)
+    req["Content-Type"]      = content_type
+    req['X-Redmine-API-Key'] = args.api_key if api
+    req["Referer"]           = args.deep_try(:eparams, :url) || args.deep_try(:urls, :back)
+    req["User-Agent"]        = USER_AGENT
+    req["Accept"]            = "*/*"
+    req.basic_auth(args.site_user, args.site_password) if args.site_user.present? || args.site_password.present?
+    
+    # create HTTP handler
+    http                     = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl             = uri.scheme.downcase == "https"
+    
+    # get request
+    @http_response           = http.request(req)
+    
+    # follow redirection or get result code
+    handle_response(options)
+    
+  end #def
+  
+  ########################################################################################
+  # jput(body, options), put request
+  ########################################################################################
+  def jput(body, options={})
+    
+    index                    = options[:index].to_i
+    json                     = options[:json].nil? || !!options[:json]
+    params                   = json ? options[:params].to_h.merge(:format => "json").to_query : options[:params].to_h.to_query
+    content_type             = json ? "application/json" : options[:content_type]
+    api                      = options[:api_key].nil? ? true : !!options[:api_key]
+    url                      = options[:url].presence || args.objects[index].object_url
+    
+    # create PUT request
+    uri                      = URI.parse( [url, params.presence].compact.join("?"))
+    req                      = Net::HTTP::Put.new(uri.request_uri)
+    req["Content-Type"]      = content_type 
+    req['X-Redmine-API-Key'] = args.api_key if api
+    req["Referer"]           = args.deep_try(:eparams, :url) || args.deep_try(:urls, :back)
+    req["User-Agent"]        = USER_AGENT
+    req["Accept"]            = "*/*"
+    req.basic_auth(args.site_user, args.site_password) if args.site_user.present? || args.site_password.present?
+    
+    # create body
+    req.body                 = deserialize(body).to_json
+    
+    # create HTTP handler
+    http                     = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl             = uri.scheme.downcase == "https"
+    
+    # get request
+    @http_response           = http.request(req)
+    
+    # follow redirection or get result code
+    handle_response(options)
+    
+  end #def
+  
+  ########################################################################################
+  # jpost(body, options), post request
+  ########################################################################################
+  def jpost(body, options={})
+    
+    index                    = options[:index].to_i
+    json                     = options[:json].nil? || !!options[:json]
+    params                   = json ? options[:params].to_h.merge(:format => "json").to_query : options[:params].to_h.to_query
+    content_type             = json ? "application/json" : options[:content_type]
+    api                      = options[:api_key].nil? ? true : !!options[:api_key]
+    url                      = options[:url].presence || args.objects[index].object_url
+    
+    # create POST request
+    uri                      = URI.parse( [url, params.presence].compact.join("?"))
+    req                      = Net::HTTP::Post.new(uri.request_uri)
+    req["Content-Type"]      = content_type 
+    req['X-Redmine-API-Key'] = args.api_key if api
+    req["Referer"]           = args.deep_try(:eparams, :url) || args.deep_try(:urls, :back)
+    req["User-Agent"]        = USER_AGENT
+    req["Accept"]            = "*/*"
+    req.basic_auth(args.site_user, args.site_password) if args.site_user.present? || args.site_password.present?
+    
+    # create body
+    req.body                 = deserialize(body).to_json
+    
+    # create HTTP handler
+    http                     = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl             = uri.scheme.downcase == "https"
+    
+    # get request
+    @http_response           = http.request(req)
+    
+    # follow redirection or get result code
+    handle_response(options)
+    
+  end #def
+  
+  ########################################################################################
+  # jdel(options), delete request
+  ########################################################################################
+  def jdel(options={})
+    
+    index                    = options[:index].to_i
+    json                     = options[:json].nil? || !!options[:json]
+    params                   = json ? options[:params].to_h.merge(:format => "json").to_query : options[:params].to_h.to_query
+    content_type             = json ? "application/json" : options[:content_type]
+    api                      = options[:api_key].nil? ? true : !!options[:api_key]
+    url                      = options[:url].presence || args.objects[index].object_url
+    
+    # create DELETE request
+    uri                      = URI.parse( [url, params.presence].compact.join("?"))
+    req                      = Net::HTTP::Delete.new(uri.request_uri)
+    req["Content-Type"]      = content_type
+    req['X-Redmine-API-Key'] = args.api_key if api
+    req["Referer"]           = args.deep_try(:eparams, :url) || args.deep_try(:urls, :back)
+    req["User-Agent"]        = USER_AGENT
+    req["Accept"]            = "*/*"
+    req.basic_auth(args.site_user, args.site_password) if args.site_user.present? || args.site_password.present?
+    
+    # create HTTP handler
+    http                     = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl             = uri.scheme.downcase == "https"
+    
+    # get request
+    @http_response           = http.request(req)
+    
+    # follow redirection or get result code
+    handle_response(options)
+    
+  end #def
+  
+  ########################################################################################
+  # private
+  ########################################################################################
+  private
+  
+  ########################################################################################
+  # handle_response
+  ########################################################################################
+  def handle_response(options)
+  
+    case @http_response
+    
+    when Net::HTTPSuccess
+      @http_response.body.present? ? serialize(JSON.parse(@http_response.body)) : serialize(:result => @http_response.code)
+      
+    when Net::HTTPRedirection
+      options[:redirects] = options[:redirects].to_i + 1
+      raise TooManyRedirects if options[:redirects] > LIMIT_REDIRECTS
+      function = caller_locations(1,1)[0].label.to_sym
+      send(function, options)
+      
+    else
+      @http_response.body.present? ? serialize(JSON.parse(@http_response.body)) : serialize(:result => @http_response.code)
+      
+    end
+  end #def
+  
+  end #module
+end #module

data/lib/redmine_api_helper/args_helper.rb

@@ -0,0 +1,106 @@
+##
+# aids creating fiddles for redmine_scripting_engine
+#
+# Copyright x 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 ArgsHelper
+  
+  ########################################################################################
+  # iterates over current object, set index for functions accessing current object
+  ########################################################################################
+  def iterate(&block)
+    args.objects.map do |object|
+      obj = yield object
+      @index += 1 unless @index + 1 >= args.objects.length
+      obj
+    end
+  end #def
+  
+  ########################################################################################
+  # gets value of field in current object
+  ########################################################################################
+  def value( *fields )
+    args.objects[index].deep_try(*fields)
+  end #def
+  
+  ########################################################################################
+  # serializes object to OpenStruct
+  ########################################################################################
+  def serialize(object, **options)
+    if object.is_a?(Hash)
+       OpenStruct.new(object.map{ |key, val| [ key, serialize(val, options) ] }.to_h)
+    elsif object.is_a?(Array)
+       object.map{ |obj| serialize(obj, options) }
+    else # assumed to be a primitive value
+      if options[:parse]
+        JSON.parse(object, object_class:OpenStruct) rescue object 
+      else
+        object
+      end
+    end
+  end #def
+  
+  ########################################################################################
+  # serializes JSON string to OpenStruct
+  ########################################################################################
+  def jparse(object)
+    serialize(object, :parse => true)
+  end #def
+  
+  ########################################################################################
+  # deserializes object from OpenStruct
+  ########################################################################################
+  def deserialize(object)
+    if object.is_a?(OpenStruct)
+      return deserialize( object.to_h )
+    elsif object.is_a?(Hash)
+      return object.map{|key, obj| [key, deserialize(obj)]}.to_h
+    elsif object.is_a?(Array)
+      return object.map{|obj| deserialize(obj)}
+    else # assumed to be a primitive value
+      return object
+    end
+  end #def
+    
+  ########################################################################################
+  # print pretty arguments passed to ruby script by plugin
+  ########################################################################################
+  def pretty(a=args)
+    JSON.pretty_generate(deserialize(a))
+  end #def
+  
+  ########################################################################################
+  # print pretty response returned from http request
+  ########################################################################################
+  def pretty_response(hr=@http_response)
+    JSON.pretty_generate({
+      :code => hr.try(:code),
+      :body => JSON.parse(hr.try(:body).to_s)
+    })
+  end #def
+  
+  ########################################################################################
+  # create html link
+  ########################################################################################
+  def link_to(body, url)
+    "<a href='#{url}'>#{body}</a>"
+  end #def
+  
+  end #module
+end #module

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, object, 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