FayP · fmancardi · Nov 30, 2013 · Nov 30, 2013 · Nov 30, 2013 · Dec 1, 2013
diff --git a/examples/getCreateIssueMetadata.test.class.php b/examples/getCreateIssueMetadata.test.class.php
@@ -0,0 +1,50 @@
+<?php
+/**
+ * TestLink Open Source Project - http://testlink.sourceforge.net/ 
+ *
+ * @filesource	getCreateIssueMetadata.test.class.php
+ * @author		Francisco Mancardi ([email protected])
+ *
+ * @internal revisions
+ *
+ **/
+require_once('../src/JiraApi/RestRequest.php');
+require_once('../src/JiraApi/Jira.php');
+
+$settings = array('host' => 'https://testlink.atlassian.net/rest/api/latest/',
+                  'username' => 'testlink.forum', 'password' => 'forum');
+
+$api = new JiraApi\Jira($settings);
+
+/*
+$out = $api->getCreateIssueMetadata();
+echo 'Test - Get Create Issue Metadata for all projects' . '<br>'; 
+echo '<pre>';
+var_dump($out);
+echo '</pre>';
+*/
+
+$tg = 'ZOFF';
+$out = $api->getCreateIssueMetadata($tg);
+echo 'Test - Get Create Issue Metadata for project: ' . $tg . '<br>'; 
+echo '<pre>';
+var_dump($out);
+echo '</pre>';
+
+/*
+$tg = 'ZOFF,SCRUM20NOV';
+$out = $api->getCreateIssueMetadata($tg);
+echo 'Test - Get Create Issue Metadata for projects: ' . $tg . '<br>'; 
+echo '<pre>';
+var_dump($out);
+echo '</pre>';
+
+
+$tg = 'ZOFF,SCRUM20NOV';
+$out = $api->getCreateIssueFields($tg);
+echo 'Test - Get Create Issue Fields for project: ' . $tg . '<br>'; 
+echo '<pre>';
+
+var_dump($out);
+echo '</pre>';
+*/
diff --git a/examples/getIssue.test.class.php b/examples/getIssue.test.class.php
@@ -0,0 +1,23 @@
+<?php
+/**
+ * TestLink Open Source Project - http://testlink.sourceforge.net/ 
+ *
+ * @filesource	getIssue.test.class.php
+ * @author		Francisco Mancardi ([email protected])
+ *
+ * @internal revisions
+ *
+ **/
+require_once('../src/JiraApi/RestRequest.php');
+require_once('../src/JiraApi/Jira.php');
+
+$settings = array('host' => 'https://testlink.atlassian.net/rest/api/latest/',
+                  'username' => 'testlink.forum', 'password' => 'forum');
+
+$api = new JiraApi\Jira($settings);
+$issueKey = 'ZOFF-2';
+$out = $api->getIssue($issueKey);
+echo 'Test - Get Issue ' . $issueKey . '<br>'; 
+echo '<pre>';
+var_dump($out);
+echo '</pre>';
diff --git a/examples/getUser.test.class.php b/examples/getUser.test.class.php
@@ -0,0 +1,23 @@
+<?php
+/**
+ * TestLink Open Source Project - http://testlink.sourceforge.net/ 
+ *
+ * @filesource	getUser.test.class.php
+ * @author		Francisco Mancardi ([email protected])
+ *
+ * @internal revisions
+ *
+ **/
+require_once('../src/JiraApi/RestRequest.php');
+require_once('../src/JiraApi/Jira.php');
+
+$settings = array('host' => 'https://testlink.atlassian.net/rest/api/latest/',
+                  'username' => 'testlink.forum', 'password' => 'forum');
+
+$api = new JiraApi\Jira($settings);
+
+$out = $api->getUser($settings['username']);
+echo 'Test - Get Data about connected user' . $settings['username'] . '<br>'; 
+echo '<pre>';
+var_dump($out);
+echo '</pre>';
diff --git a/src/JiraApi/Jira.php b/src/JiraApi/Jira.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * JIRA Rest Client
+ *
+ * @author     Original Author https://github.com/FayP / http://faypickering.com
+ * @author     Francisco Mancardi <[email protected]>
+ */
 
 namespace JiraApi;
 
@@ -9,13 +15,44 @@ class Jira
 
     public function __construct(array $config = array())
     {
+        // Check config before do nothing
         $this->request = new RestRequest();
-        $this->request->username = (isset($config['username'])) ? $config['username'] : null;
-        $this->request->password = (isset($config['password'])) ? $config['password'] : null;
-        $host = (isset($config['host'])) ? $config['host'] : null; 
-        $this->host = 'https://' . $host . '/rest/api/2/';
+        $this->request->username = (isset($config['username'])) ? trim($config['username']) : null;
+        $this->request->password = (isset($config['password'])) ? trim($config['password']) : null;
+        $this->host = (isset($config['host'])) ? trim($config['host']) : null; 
+
+        $this->configCheck();
+        $this->host = trim($this->host,"/") . '/'; 
+
+        if( ($last = $this->host[strlen($this->host)-1]) != '/' )
+        {
+            $this->host .= '/';
+        }
+
     }
 
+    /**
+     *
+     */
+    private function configCheck()
+    {
+        if(is_null($this->host) || $this->host == '')
+        {
+            throw new \Exception('Missing or Empty host (url to API) - unable to continue');      
+        }    
+        if(is_null($this->request->username) || $this->request->username == '' )
+        {
+            throw new \Exception('Missing or Empty username - unable to continue');      
+        }    
+        if(is_null($this->request->password) || $this->request->password == '')
+        {
+            throw new \Exception('Missing or Empty password - unable to continue');      
+        }    
+    }
+
+    /**
+     *
+     */
     public function testLogin()
     {
         $user = $this->getUser($this->request->username);
@@ -26,15 +63,21 @@ public function testLogin()
         return false;
     }
 
+    /**
+     * https://docs.atlassian.com/jira/REST/latest/#api/2/user-getUser
+     */
     public function getUser($username)
     {
-        $this->request->openConnect($this->host . 'user/search/?username=' . $username, 'GET');
+        $this->request->openConnect($this->host . 'user/?username=' . $username, 'GET');
         $this->request->execute();
         $user = json_decode($this->request->getResponseBody());
 
         return $user;
     }
 
+    /**
+     *
+     */
     public function getStatuses()
     {
         $this->request->openConnect($this->host . 'status', 'GET');
@@ -131,14 +174,46 @@ function createPairs($obj) {
         return false;
     }
 
-    public function createIssue($json)
+    /**
+     *
+     * @param array $issueFields using 'fields' member
+     *
+     * Here's an example:
+     *
+     * $issueFields = array('fields' =>
+     *                       array('project' => array('key' => (string)'ZOFF'),
+     *                             'summary' => 'My First JIRA Issue via REST',
+     *                             'description' => '',
+     *                             'issuetype' => array( 'id' => 1)
+     *                            )
+     *                     );
+     *
+     * For more details about fields:
+     * https://developer.atlassian.com/display/JIRADEV/
+     *       JIRA+REST+API+Example+-+Create+Issue#JIRARESTAPIExample-CreateIssue-Examplesofcreatinganissue
+     *
+     * https://developer.atlassian.com/display/JIRADEV/
+     *       JIRA+REST+API+Example+-+Discovering+meta-data+for+creating+issues
+     *
+     *
+     * @return  object reponse body (ATTENTION: can be null if something wrong has happened) 
+     *          properties: id,key,self
+     *          Example:
+     *          {"id":"12505","key":"ZOFF-186","self":"https://testlink.atlassian.net/rest/api/latest/issue/12505"}
+     *
+     */
+    public function createIssue($issueFields)
     {
-        $this->request->openConnect($this->host . 'issue/', 'POST', $json);
+        $this->request->openConnect($this->host . 'issue/', 'POST', $issueFields);
         $this->request->execute();
 
-        return $this->request->lastRequestStatus();
+        return json_decode($this->request->getResponseBody());
     }
 
+    /**
+     *
+     *
+     */
     public function addAttachment($filename, $issueKey)
     {
         $this->request->openConnect($this->host . 'issue/' . $issueKey . '/attachments', 'POST', null, $filename);
@@ -147,9 +222,14 @@ public function addAttachment($filename, $issueKey)
         return $this->request->lastRequestStatus();
     }
 
-    public function updateIssue($json, $issueKey)
+    /**
+     *
+     * @param array $issueFields using 'fields' member
+     *
+     */
+    public function updateIssue($issueFields, $issueKey)
     {
-        $this->request->openConnect($this->host . 'issue/' . $issueKey, 'PUT', $json);
+        $this->request->openConnect($this->host . 'issue/' . $issueKey, 'PUT', $issueFields);
         $this->request->execute();
 
         return $this->request->lastRequestStatus();
@@ -176,5 +256,111 @@ public function addComment($comment, $issueKey)
 
         return $this->request->lastRequestStatus();
     }
-}
-?>
+
+    public function getIssue($issueKey)
+    {
+        $this->request->openConnect($this->host . 'issue/' . $issueKey, 'GET');
+        $this->request->execute();
+        $item = json_decode($this->request->getResponseBody());
+
+        return $item;
+    }
+
+    /**
+     * return a map where main key is projectkey (if call has returned infor
+     * for this key)
+     * Each element is an map with issueTypeID as key, and each element inside
+     * this map has to elements with two keys:
+     * - issueTypeName
+     * - fields => array with field names
+     *
+     * Here a partial example for project with key ZOFF
+     * array(1) {
+     *    ["ZOFF"]=>
+     *         array(7) {
+     *           [1]=>
+     *           array(2) {
+     *             ["issueTypeName"]=> "Bug"
+     *             ["fields"]=> array(21) {
+     *                           ["summary"] => "summary"
+     *                           ["reporter"] => "reporter" 
+     */
+    public function getCreateIssueFields($projectKeys=null)
+    {
+        $opt = 'expand=projects.issuetypes.fields';
+        $items = $this->getCreateIssueMetadata($projectKeys,$opt);
+        $ret = null;
+        if(!is_null($items) && count($items->projects) > 0)
+        {
+            $ro = &$items->projects;
+            foreach($ro as $ele)
+            {
+                $ret[$ele->key] = array();
+                $rx = &$ele->issuetypes;
+                foreach($rx as $it)
+                {
+                    $ret[$ele->key][$it->id]['issueTypeName'] = $it->name;
+                    foreach($it->fields as $field)
+                    {
+                      $ret[$ele->key][$it->id]['fields'][$field->key] = $field->key;
+                    } 
+                }    
+            }    
+            //return $items->projects;
+        }
+        return $ret; 
+    }
+
+
+
+    /**
+     * https://docs.atlassian.com/jira/REST/cloud/#api/2/issue-getCreateIssueMeta
+     *
+     * https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/
+     *       jira-rest-api-tutorials/jira-rest-api-example-discovering-meta-data-for-creating-issues
+     *
+     *
+     * curl -D- -u fred:fred -X GET -H "Content-Type: application/json" \
+     *      http://kelpie9:8081/rest/api/2/issue/createmeta   
+     *
+     * curl -D- -u fred:fred -X GET -H "Content-Type: application/json" \
+     *      http://kelpie9:8081/rest/api/2/issue/createmeta?projectKeys=QA     
+     * 
+     * curl -D- -u fred:fred -X GET -H "Content-Type: application/json" \
+     *      http://kelpie9:8081/rest/api/2/issue/createmeta?projectKeys=QA,XSS     
+     *
+     * From Atlassian documentation
+     * projectKeys  string  
+     *              lists the projects with which to filter the results. 
+     *              If absent, all projects are returned. 
+     *              This parameter can be comma-separated list. 
+     *              Specifiying a project that does not exist 
+     *              (or that you cannot create issues in) is not an error, 
+     *              but it will not be in the results.
+     *
+     * opt can contain issuetypeIds, issuetypeNames, expand=projects.issuetypes.fields.
+     *     Fields will only be returned if expand=projects.issuetypes.fields.
+     */
+    public function getCreateIssueMetadata($projectKeys=null,$opt=null)
+    {
+        $cmd = $this->host . 'issue/createmeta';
+        $ope = '?';
+        if( !is_null($projectKeys) )
+        {
+           $cmd .= $ope . 'projectKeys=' . $projectKeys;
+           $ope = '&';
+        }
+
+        if( !is_null($opt) )
+        {
+           $cmd .= $ope . $opt;
+        }
+
+        $this->request->openConnect($cmd, 'GET');
+        $this->request->execute();
+        $items = json_decode($this->request->getResponseBody());
+
+        return $items;
+    }
+
+}
diff --git a/src/JiraApi/RestRequest.php b/src/JiraApi/RestRequest.php
@@ -29,7 +29,9 @@ public function openConnect($url = null, $verb = 'GET', $requestBody = null, $fi
         $this->contentType       = 'Content-Type: application/json';
 
         if ($this->requestBody !== null || $this->filename !== null)
+        {    
             $this->buildPostBody();
+        }    
     }
 
     public function flush()
@@ -90,10 +92,14 @@ public function buildPostBody($data = null)
                 $this->contentType = 'Content-Type: multipart/form-data; boundary='.$boundary;
             }
             else
+            {    
                 $this->requestBody = json_encode($this->requestBody);
+            }    
         }
         else
+        {    
             $this->requestBody = json_encode($data);
+        }    
     }
 
     public function getResponseBody()
@@ -179,4 +185,3 @@ protected function setAuth(&$ch)
         }
     }
 }
-?>