readme

Author: lesstif

README.md

@@ -0,0 +1,126 @@
+
+# Installation
+
+```
+composer require lesstif/php-jira-rest-client dev-master
+```
+
+create config.jira.php file on your project root.
+````php
+<?php
+
+/*
+ * Description get Jira Host Configuration
+ * 
+ * @return array 
+ */
+function getHostConfig() {
+	$jira_config = array ('host' => 'https://jira.example.com',
+			'username' => 'username',
+			'password' => 'secure_passwd');
+
+	return $jira_config;
+}
+
+/**
+ * Description get Client options
+ * 
+ * @return array
+ */
+function getOptions() {
+	$options = array(
+		CURLOPT_SSL_VERIFYHOST => 0,
+		CURLOPT_SSL_VERIFYPEER => 0,	
+		CURLOPT_VERBOSE => false,
+		'LOG_FILE' => 'jira-rest-client.log',
+		'LOG_LEVEL' => \Monolog\Logger::INFO
+		);
+
+	return $options;
+}
+?>
+````
+
+# Usage
+
+## Get Project Info
+
+````php
+try {
+	$proj = new ProjectService();
+
+	$p = $proj->get('TEST');
+	
+	print_r($p);			
+} catch (HTTPException $e) {
+	print("Error Occured! " . $e->getMessage());
+}
+````
+
+## Get All Project list
+````php
+try {
+	$proj = new ProjectService();
+
+	$prjs = $proj->getAllProjects();
+
+	$i = 0;
+	foreach ($prjs as $p) {
+		echo sprintf("Project Key:%s, Id:%s, Name:%s, projectCategory: %s\n",
+			$p->key, $p->id, $p->name, $p->projectCategory['name']
+			);
+			
+	}			
+} catch (HTTPException $e) {
+	print("Error Occured! " . $e->getMessage());
+}
+````
+
+## Get Issue Info
+
+````php
+try {
+	$issueService = new IssueService();
+
+	$issue = $issueService->get('TEST-867');
+	
+	print_r($issue->fields);	
+} catch (HTTPException $e) {
+	print("Error Occured! " . $e->getMessage());
+}
+````
+
+## Create Issue
+
+````php
+try {
+	$issueField = new IssueField();
+	$issueField->setProjectId("12000");
+	$issueField->setSummary("something's wrong");
+	$issueField->setAssigneeName("lesstif");
+	$issueField->setPriorityName("Critical");
+	$issueField->setIssueType("Bug");
+	$issueField->setDescription("Full description for issue");
+
+	$issueField->addVersion(null, "1.0.1");
+	$issueField->addVersion(null, "1.0.3");
+	
+	$issueService = new IssueService();
+
+	$ret = $issueService->create($issueField);
+	
+	//If success, Returns a link to the created issue.
+	print_r($ret);
+} catch (HTTPException $e) {
+	print("Error Occured! " . $e->getMessage());
+}
+````
+
+# License
+
+Apache V2 License
+
+# JIRA Rest API Documents
+* 6.2 - https://docs.atlassian.com/jira/REST/6.2/
+* latest - https://docs.atlassian.com/jira/REST/latest/
+

src/issue/IssueField.php

@@ -14,8 +14,7 @@ public function __construct() {
     }
 
     public function setProjectName($name) {
-    	//$this->project->name = $name;
-    	$this->project->id = '12000';
+    	$this->project->name = $name;
     }
     public function setProjectId($id) {
     	$this->project->id = $id;
@@ -32,7 +31,7 @@ public function setSummary($summary) {
     public function setReporterName($name) {
     	if (is_null($this->reporter))
     	  $this->reporter = new \JiraRestApi\Issue\Reporter();
-    	
+
     	$this->reporter->name = $name;
     }
 

src/issue/IssueService.php

@@ -7,8 +7,8 @@
 class IssueService extends \JiraRestApi\JiraClient {
     private $uri = "/issue";
 
- 	public function __construct($config, $opt_array = null) {
-        parent::__construct($config, $opt_array);        
+ 	public function __construct() {
+        parent::__construct(getHostConfig(), getOptions());        
     }
 
     /**

src/project/ProjectService.php

@@ -7,8 +7,8 @@
 class ProjectService extends \JiraRestApi\JiraClient {	
     private $uri = "/project";
 
- 	public function __construct($config, $opt_array = null) {
-        parent::__construct($config, $opt_array);        
+ 	public function __construct() {
+        parent::__construct(getHostConfig(), getOptions());        
     }
 
     /**

tests/IssueTest.php

@@ -9,7 +9,7 @@ public function testIssue()
     {
     	$this->markTestIncomplete();
 		try {
-			$issueService = new IssueService(getHostConfig(), getOptions());
+			$issueService = new IssueService();
 
 			$issue = $issueService->get('TEST-867');
 
@@ -31,9 +31,8 @@ public function testCreateIssue()
     	//$this->markTestIncomplete();
 		try {
 			$issueField = new IssueField();
-			$issueField->setProjectName("TEST");
+			$issueField->setProjectId("12000");
 			$issueField->setSummary("something's wrong");
-			//$issueField->setReporterName("smithers");
 			$issueField->setAssigneeName("lesstif");
 			$issueField->setPriorityName("Critical");
 			$issueField->setIssueType("Bug");
@@ -42,10 +41,11 @@ public function testCreateIssue()
 			$issueField->addVersion(null, "1.0.1");
 			$issueField->addVersion(null, "1.0.3");
 
-			$issueService = new IssueService(getHostConfig(), getOptions());
+			$issueService = new IssueService();
 
 			$ret = $issueService->create($issueField);
 
+			//If success, Returns a link to the created issue.
 			print_r($ret);
 		} catch (HTTPException $e) {
 			$this->assertTrue(FALSE, "Create Failed : " . $e->getMessage());

tests/ProjectTest.php

@@ -8,7 +8,7 @@ public function testGetProject()
     {
     	//$this->markTestIncomplete();
 		try {
-			$proj = new ProjectService(getHostConfig(), getOptions());
+			$proj = new ProjectService();
 
 			$p = $proj->get('TEST');
 
@@ -25,7 +25,7 @@ public function testGetProjectLists()
     {
     	//$this->markTestIncomplete();
 		try {
-			$proj = new ProjectService(getHostConfig(), getOptions());
+			$proj = new ProjectService();
 
 			$prjs = $proj->getAllProjects();