redmine_api_helper 0.1.3

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "deep_try"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redmine_api_helper.rb

@@ -0,0 +1,44 @@
+# 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 "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/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/version"
+require "redmine_api_helper/wiki_pages_api_helper"
+require "redmine_api_helper/helpers"

data/lib/redmine_api_helper/api_helper.rb

@@ -0,0 +1,310 @@
+##
+# 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 APIHelper
+  
+  ########################################################################################
+  # api functions
+  ########################################################################################
+  class TooManyRedirects < StandardError; end
+  LIMIT_REDIRECTS = 10
+  
+  ########################################################################################
+  # 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 GET request
+    uri                      = URI.parse(options[:url])
+    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]
+    
+    # create GET request
+    uri                      = URI.parse(options[:url] ? [options[:url], params].join("?") : "#{args.objects[index].object_url}#{params}")
+    req                      = Net::HTTP::Get.new(uri.request_uri)
+    req["Content-Type"]      = "content_type" 
+    req['X-Redmine-API-Key'] = args.api_key if api
+    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]
+    
+    # create PUT request
+    uri                      = URI.parse(options[:url] ? [options[:url], params].join("?") : "#{args.objects[index].object_url}#{params}")
+    req                      = Net::HTTP::Put.new(uri.request_uri)
+    req["Content-Type"]      = content_type 
+    req['X-Redmine-API-Key'] = args.api_key if api
+    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]
+    
+    # create POST request
+    uri                      = URI.parse(options[:url] ? [options[:url], params].join("?") : "#{args.objects[index].object_url}#{params}")
+    req                      = Net::HTTP::Post.new(uri.request_uri)
+    req["Content-Type"]      = content_type 
+    req['X-Redmine-API-Key'] = args.api_key if api
+    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]
+    
+    # create DELETE request
+    uri                      = URI.parse(options[:url] ? [options[:url], params].join("?") : "#{args.objects[index].object_url}#{params}")
+    req                      = Net::HTTP::Delete.new(uri.request_uri)
+    req["Content-Type"]      = "content_type" 
+    req['X-Redmine-API-Key'] = args.api_key if api
+    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,96 @@
+##
+# 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'
+
+module RedmineAPIHelper
+  module ArgsHelper
+  
+  ########################################################################################
+  # iterates over current object, set index for functions accessing current object
+  ########################################################################################
+  def objects(&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)
+    if object.is_a?(Hash)
+       return OpenStruct.new(object.map{ |key, val| [ key, serialize(val) ] }.to_h)
+     elsif object.is_a?(Array)
+       return object.map{ |o| serialize(o) }
+     else # assumed to be a primitive value
+       return object
+     end
+  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))
+    })
+  end #def
+  
+  ########################################################################################
+  # create html link
+  ########################################################################################
+  def link_to(text, obj, id)
+    "<a href='#{[args.urls.try(obj.to_sym),id].join("/")}'>#{text}</a>"
+  end #def
+  
+  end #module
+end #module