Merge pull request #548 from zendesk/cgoddard/red-2643/fix-issue-when…

…-iterating-over-help-center-categories

[RED-2643] Fix issue when iterating over help center categories

Makefile

@@ -0,0 +1,6 @@
+.PHONY: test all
+
+test:
+	composer test:unit
+
+all: test

src/Zendesk/API/Resources/HelpCenter/Articles.php

@@ -20,12 +20,15 @@ class Articles extends ResourceAbstract
     use Search;
 
     /**
-     * @{inheritdoc}
+     * {@inheritdoc}
      */
     protected $objectName = 'article';
-
     /**
-     * @{inheritdoc}
+     * {@inheritdoc}
+     */
+    protected $objectNamePlural = 'articles';
+    /**
+     * {@inheritdoc}
      */
     protected function setupRoutes()
     {

src/Zendesk/API/Resources/HelpCenter/Categories.php

@@ -21,6 +21,10 @@ class Categories extends ResourceAbstract
      * {@inheritdoc}
      */
     protected $objectName = 'category';
+    /**
+     * {@inheritdoc}
+     */
+    protected $objectNamePlural = 'categories';
 
     /**
      * {@inheritdoc}

src/Zendesk/API/Resources/HelpCenter/Sections.php

@@ -23,6 +23,10 @@ class Sections extends ResourceAbstract
      * {@inheritdoc}
      */
     protected $objectName = 'section';
+    /**
+     * {@inheritdoc}
+     */
+    protected $objectNamePlural = 'sections';
 
     /**
      * @inheritdoc

tests/Zendesk/API/LiveTests/HelpCenterTest.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Zendesk\API\LiveTests;
+
+class HelpCenterTest extends BasicTest
+{
+    /**
+     * @throws \Zendesk\API\Exceptions\MissingParametersException
+     */
+    public function testIterateOverHelpCenterArticles()
+    {
+        $iterator = $this->client->helpCenter->articles()->iterator();
+
+        $actual = iterator_to_array($iterator);
+
+        // Generally, there should be at least one article in the help center, even if these are just the default articles.
+        $this->assertTrue(is_array($actual) && count($actual) > 0, 'Should return a non-empty array of articles.');
+    }
+
+    public function testIterateOverHelpCenterSections()
+    {
+        $iterator = $this->client->helpCenter->sections()->iterator();
+
+        $actual = iterator_to_array($iterator);
+
+        // Generally, there should be at least one section in the help center, even if these are just the default sections.
+        $this->assertTrue(is_array($actual) && count($actual) > 0, 'Should return a non-empty array of sections.');
+    }
+
+    public function testIterateOverHelpCenterCategories()
+    {
+        $iterator = $this->client->helpCenter->categories()->iterator();
+
+        $actual = iterator_to_array($iterator);
+
+        // Generally, there should be at least one category in the help center, even if these are just the default categories.
+        $this->assertTrue(is_array($actual) && count($actual) > 0, 'Should return a non-empty array of categories.');
+    }
+}