ePages 7.17.0 - DE_EPAGES/Installer/API/FishEyeHandler.pm

Package DE_EPAGES::Installer::API::FishEyeHandler

API for interaction with FishEye

Functions

getBranch
getBranchArray
getFilenames
getInformation
getRevisions
getUserArray
new

getBranch

returns brach related to EPG number and/or fisheye file

Syntax
$FishEyeHandler->getBranch($Revision, $JiraCase, $Path );
Input
$Revision (string)
revision number
$Path (string)
fisheye path to file (optional)
$JiraCase (string)
EPG number, can be "EPG-123", "EPG 123" or "123" (optional)
Return
$Info->{'branch'} (string)
branch of passed revision number and EPG number and or fisheye file

getBranchArray

returns array of Branch related to EPG number and/or fisheye file

Syntax
$FishEyeHandler->getBranchArray( $JiraCase, $Path );
Input
$Path (string)
fisheye path to file (optional)
$JiraCase (string)
EPG number, can be "EPG-123", "EPG 123" or "123" (optional)
Return
$aResult (ref array)
array of Branch of passed EPG number and or fisheye file

getFilenames

returns all files associated with passed issue

Syntax
$FishEyeHandler->getFilenames( $JiraCase );
Input
$EPG (string)
EPG number, can be "EPG-123", "EPG 123" or "123"
$Branch (string)
Branch version (optional)
Return
$aResutl (ref array)
Array of file path

getInformation

returns revision, date, path, user and brach related to EPG number and/or fisheye file

Syntax
$FishEyeHandler->getInformation( $JiraCase, $Path );
Input
$Path (string)
fisheye path to file (optional)
$JiraCase (string)
EPG number, can be "EPG-123", "EPG 123" or "123" (optional)
Return
$aResult (ref array of ref hash)
array of fisheye information hash
  • revision
  • date
  • path
  • user
  • branch

getRevisions

returns all revisions associated with passed file

Syntax
$FishEyeHandler->getRevisions( $Path, $JiraCase, $Branch );
Input
$Path (string)
fisheye path to file
$JiraCase (string)
EPG number, can be "EPG-123", "EPG 123" or "123" (optional)
$Branch (string)
Branch version (optional)
Return
$aResutl (ref array)
Array of revision

getUserArray

returns array of user related to EPG number and/or fisheye file

Syntax
$FishEyeHandler->getUserArray( $JiraCase, $Path );
Input
$Path (string)
fisheye path to file (optional)
$JiraCase (string)
EPG number, can be "EPG-123", "EPG 123" or "123" (optional)
Return
$aResult (ref array)
array of user of passed EPG number and or fisheye file

new

initializes rest client as class variable

Syntax
$FishEyeHandler->new( $Host );
Input
$Username (string)
fisheye username for login
$Password (string)
fisheye password for login
$Host (string)
url of fisheye installation (optional)
standard value = https://fisheye.epages.com:443/