Add Noteable interface

Author: Matt Humphrey

lib/Gitlab/Api/AbstractApi.php

@@ -105,6 +105,7 @@ protected function delete($path, array $parameters = array(), $requestHeaders =
 
     /**
      * @param int $id
+     * @param string $path
      * @return string
      */
     protected function getProjectPath($id, $path)

lib/Gitlab/HttpClient/HttpClient.php

@@ -50,7 +50,8 @@ class HttpClient implements HttpClientInterface
     private $lastRequest;
 
     /**
-     * @param array           $options
+     * @param string $baseUrl
+     * @param array $options
      * @param ClientInterface $client
      */
     public function __construct($baseUrl, array $options, ClientInterface $client)

lib/Gitlab/Model/Branch.php

@@ -112,7 +112,7 @@ public function createFile($file_path, $content, $commit_message)
     {
         $data = $this->api('repositories')->createFile($this->project->id, $file_path, $content, $this->name, $commit_message);
 
-        return File::fromArray($this->getClient(), $this, $data);
+        return File::fromArray($this->getClient(), $this->project, $data);
     }
 
     /**
@@ -125,7 +125,7 @@ public function updateFile($file_path, $content, $commit_message)
     {
         $data = $this->api('repositories')->updateFile($this->project->id, $file_path, $content, $this->name, $commit_message);
 
-        return File::fromArray($this->getClient(), $this, $data);
+        return File::fromArray($this->getClient(), $this->project, $data);
     }
 
     /**

lib/Gitlab/Model/Issue.php

@@ -20,7 +20,7 @@
  * @property-read Milestone $milestone
  * @property-read Project $project
  */
-class Issue extends AbstractModel
+class Issue extends AbstractModel implements Noteable
 {
     /**
      * @var array
@@ -122,13 +122,21 @@ public function open()
     }
 
     /**
-     * @param string $body
+     * @return Issue
+     */
+    public function reopen()
+    {
+        return $this->open();
+    }
+
+    /**
+     * @param string $comment
      * @return Note
      */
-    public function addComment($body)
+    public function addComment($comment)
     {
         $data = $this->api('issues')->addComment($this->project->id, $this->id, array(
-            'body' => $body
+            'body' => $comment
         ));
 
         return Note::fromArray($this->getClient(), $this, $data);
@@ -148,4 +156,16 @@ public function showComments()
 
         return $notes;
     }
+
+    /**
+     * @return bool
+     */
+    public function isClosed()
+    {
+        if ($this->state == 'closed') {
+            return true;
+        }
+
+        return false;
+    }
 }

lib/Gitlab/Model/MergeRequest.php

@@ -23,7 +23,7 @@
  * @property-read User $assignee
  * @property-read Project $project
  */
-class MergeRequest extends AbstractModel
+class MergeRequest extends AbstractModel implements Noteable
 {
     /**
      * @var array
@@ -127,13 +127,23 @@ public function reopen()
         ));
     }
 
+    /**
+     * @return MergeRequest
+     */
+    public function open()
+    {
+        return $this->reopen();
+    }
+
     /**
      * @param string $message
      * @return MergeRequest
      */
     public function merge($message = null)
     {
-        $data = $this->api('mr')->merge($this->project->id, $this->id, array('merge_commit_message' => $message));
+        $data = $this->api('mr')->merge($this->project->id, $this->id, array(
+            'merge_commit_message' => $message
+        ));
 
         return static::fromArray($this->getClient(), $this->project, $data);
     }
@@ -149,12 +159,12 @@ public function merged()
     }
 
     /**
-     * @param string $note
+     * @param string $comment
      * @return Note
      */
-    public function addComment($note)
+    public function addComment($comment)
     {
-        $data = $this->api('mr')->addComment($this->project->id, $this->id, $note);
+        $data = $this->api('mr')->addComment($this->project->id, $this->id, $comment);
 
         return Note::fromArray($this->getClient(), $this, $data);
     }

lib/Gitlab/Model/Note.php

@@ -32,11 +32,11 @@ class Note extends AbstractModel
 
     /**
      * @param Client $client
-     * @param string $type
+     * @param Noteable $type
      * @param array $data
      * @return mixed
      */
-    public static function fromArray(Client $client, $type, array $data)
+    public static function fromArray(Client $client, Noteable $type, array $data)
     {
         $comment = new static($type, $data['id'], $client);
 
@@ -48,11 +48,11 @@ public static function fromArray(Client $client, $type, array $data)
     }
 
     /**
-     * @param string $type
+     * @param Noteable $type
      * @param int $id
      * @param Client $client
      */
-    public function __construct($type, $id = null, Client $client = null)
+    public function __construct(Noteable $type, $id = null, Client $client = null)
     {
         $this->setClient($client);
         $this->setData('parent_type', get_class($type));

lib/Gitlab/Model/Noteable.php

@@ -0,0 +1,36 @@
+<?php namespace Gitlab\Model;
+
+interface Noteable
+{
+    /**
+     * @param string $comment
+     * @return Note
+     */
+    public function addComment($comment);
+
+    /**
+     * @return Note[]
+     */
+    public function showComments();
+
+    /**
+     * @param string $comment
+     * @return static
+     */
+    public function close($comment = null);
+
+    /**
+     * @return static
+     */
+    public function open();
+
+    /**
+     * @return static
+     */
+    public function reopen();
+
+    /**
+     * @return bool
+     */
+    public function isClosed();
+}