JRedmine-client 
2009-09-15

Ce module contient un plugin rails qui permet d'ouvrir l'api de redmine au protocole REST, ainsi q'un client Java pour interroger les services REST.

Plugin rails JRedmine

Le but de ce plugin est de pouvoir accéder aux données d'un serveur Redmine en utilisant le protocole REST, mais aussi d'effectuer des tâches de maintenance sur le serveur.

La page API détaille l'ensemble des services disponibles depuis le serveur Redmine.

Source du plugin

Les sources du plugin rails sont sont dans le répertoire src/main/redmine

src/main/redmine/
`-- jredmine
    |-- README.rdoc
    |-- app
    |   |-- controllers
    |   |   `-- jredmine_controller.rb
    |   |-- helpers
    |   |-- models
    |   `-- views
    |-- assets
    |   |-- images
    |   |-- javascripts
    |   `-- stylesheets
    |-- config
    |   `-- routes.rb
    |-- db
    |   `-- migrate
    |-- init.rb
    |-- lang
    |   `-- en.yml
    |-- lib
    |   `-- tasks
    `-- test
        `-- functional

Récupération d'une version packagée

Il est possible de récupérer une version zippée du plugin (voir la section des téléchargements).

Installation du plugin sur le serveur Redmine

  • récupération du zip du plugin
  • dézippage dans le répertoire vendor/plugins
  • relancer votre instance de redmine (ou apache).

Configuration des permissions du plugin dans le serveur Redmine

Le plugin est activable par projet et par rôle.

Pour rendre accessible le plugin pour un projet donné, il faut donc ajouter le module JRedmine sur le projet dans l'onglet de configuration des modules du projet.

Pour rendre accessible le plugin pour un rôle, il faut lui ajouter la permission allow_jredmine dans la page des permissions du rôle.

Tester le plugin

Une fois la configuration des permissions réalisées, vous pouvez tester le plugin dans un navigateur web.

Pour cela, loggez-vous en web sur redmine, puis lancer (dans un autre onglet) l'url suivante : (remplacer XX par le chemin d'accès à votre redmine et YY par le nom d'un de vos projet).

http://XX/jredmine/get_project/YY

Vous devez obtenir en retour la description xml du projet demandé.

Client java

Le client java qui interroge le plugin rails se base sur l'api du plugin rails et transforme les données retournées en xml en objets java.

La page suivante détaille les services disponibles en java.