Add lint commands + fix lint errors (#554)

- Add build + clean commands to makefile
- Refine ci gha check
- Bump squizlabs/php_codesniffer to 3.11.2

.github/workflows/ci.yaml

@@ -18,7 +18,10 @@ jobs:
       run: docker build . --file Dockerfile --tag zendesk_api_client_php-app
 
     - name: Run Composer install
-      run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app composer install
+      run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app make build
+
+    - name: Run lint
+      run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app make lint
 
     - name: Run tests
-      run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app vendor/bin/phpunit --testsuite "Zendesk API Unit Test Suites"
+      run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app make test

Dockerfile

@@ -3,6 +3,9 @@ FROM php:8.2-cli
 # OS requirements for PHP
 RUN apt-get update && apt-get install -y git unzip
 
+# Safe requirements to allow Makefile tasks to run
+RUN git config --global --add safe.directory /app
+
 # PHP requirements
 RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
 WORKDIR /app

Makefile

@@ -1,6 +1,10 @@
-.PHONY: test all
+.PHONY: build test lint
+
+build:
+	composer install
 
 test:
 	composer test:unit
 
-all: test
+lint:
+	composer lint

composer.json

@@ -11,19 +11,22 @@
   },
   "require-dev": {
     "phpunit/phpunit": "11.5.0",
-    "squizlabs/php_codesniffer": "2.*",
+    "squizlabs/php_codesniffer": "3.*",
     "phpmd/phpmd": "@stable",
     "fakerphp/faker": "^1.24.1",
     "psy/psysh": "@stable"
   },
   "autoload": {
     "psr-0": {
       "Zendesk\\API\\": "src/",
-      "Zendesk\\Console\\": "src/"
+      "Zendesk\\Console\\": "src/",
+      "Zendesk\\Fixtures\\": "src/"
     }
-  },
+},
   "scripts": {
     "test:unit": "vendor/bin/phpunit --testsuite 'Zendesk API Unit Test Suites'",
-    "test:live": "vendor/bin/phpunit --testsuite 'Zendesk API Live Test Suites'"
+    "test:live": "vendor/bin/phpunit --testsuite 'Zendesk API Live Test Suites'",
+    "lint": "vendor/bin/phpcs --runtime-set ignore_warnings_on_exit 1 --standard=PSR12 --extensions=php --ignore=vendor/ .",
+    "lint:fix": "vendor/bin/phpcbf --runtime-set ignore_warnings_on_exit 1 --standard=PSR12 --extensions=php --ignore=vendor/ ."
   }
 }

samples/attachments/uploadFileAttachment.php

@@ -28,5 +28,5 @@
     print_r($attachment);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/attachments/uploadStreamAttachment.php

@@ -29,5 +29,5 @@
     print_r($attachment);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/groups/createGroup.php

@@ -1,4 +1,5 @@
 <?php
+
 include("../../vendor/autoload.php");
 
 use Zendesk\API\HttpClient as ZendeskAPI;

samples/groups/getGroups.php

@@ -1,4 +1,5 @@
 <?php
+
 include("../../vendor/autoload.php");
 
 use Zendesk\API\HttpClient as ZendeskAPI;

samples/helpcenter/createArticles.php

@@ -26,6 +26,5 @@
     print_r($article);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }
-

samples/helpcenter/createSections.php

@@ -28,5 +28,5 @@
     print_r($section);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/helpcenter/findArticles.php

@@ -24,5 +24,5 @@
     print_r($articles);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/helpcenter/findArticlesBySectionId.php

@@ -25,5 +25,5 @@
     print_r($articles);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/helpcenter/findCategories.php

@@ -23,5 +23,5 @@
     print_r($categories);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/helpcenter/findSections.php

@@ -41,5 +41,5 @@
     print_r($sections);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/organizations/createOrganization.php

@@ -1,4 +1,5 @@
 <?php
+
 include("../../vendor/autoload.php");
 use Zendesk\API\HttpClient as ZendeskAPI;
 

samples/sell/getContacts.php

@@ -23,5 +23,5 @@
     print_r($contacts);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/ticket_fields/createDropdownOption.php

@@ -1,4 +1,5 @@
 <?php
+
 include("../../vendor/autoload.php");
 use Zendesk\API\HttpClient as ZendeskAPI;
 

samples/ticket_fields/editDropdownOption.php

@@ -1,4 +1,5 @@
 <?php
+
 include("../../vendor/autoload.php");
 use Zendesk\API\HttpClient as ZendeskAPI;
 

samples/ticket_fields/replaceDropdownOptions.php

@@ -1,4 +1,5 @@
 <?php
+
 include("../../vendor/autoload.php");
 use Zendesk\API\HttpClient as ZendeskAPI;
 
@@ -11,14 +12,14 @@
 $client = new ZendeskAPI($subdomain);
 $client->setAuth('basic', ['username' => $username, 'token' => $token]);
 try {
-    $result = $client->ticketFields()->update(51931448, ["custom_field_options"=> [
+    $result = $client->ticketFields()->update(51931448, ["custom_field_options" => [
         [
-          "name"=> "Apple Pie",
-          "value"=> "apple_pie"
+          "name" => "Apple Pie",
+          "value" => "apple_pie"
         ],
         [
-          "name"=> "Pecan Pie",
-          "value"=> "pecan_pie"
+          "name" => "Pecan Pie",
+          "value" => "pecan_pie"
         ]
       ]
     ]);

samples/tickets/createTicket.php

@@ -36,5 +36,5 @@
     print_r($newTicket);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/createTicketWithAttachment.php

@@ -11,7 +11,7 @@
 $subdomain  = "subdomain";
 $username   = "[email protected]";
 $token      = "6wiIBWbGkBMo1mRDMuVwkw1EPsNkeUj95PIz2akv";
-$attachment = getcwd().'/sample.jpg';
+$attachment = getcwd() . '/sample.jpg';
 
 $client = new ZendeskAPI($subdomain);
 $client->setAuth('basic', ['username' => $username, 'token' => $token]);
@@ -46,5 +46,5 @@
     print_r($newTicket);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/deleteTicket.php

@@ -21,5 +21,5 @@
     $deleteTicket = $client->tickets()->delete($id);
     echo "Ticket ($id) has been removed";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/getTicketComments.php

@@ -25,5 +25,5 @@
     print_r($tickets);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/getTicketMetrics.php

@@ -24,5 +24,5 @@
     print_r($metrics);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/getTickets.php

@@ -24,5 +24,5 @@
     print_r($tickets);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/searchTickets.php

@@ -17,7 +17,7 @@
 
 try {
     // Search the current customer
-    $params = ['query' =>'[email protected]'];
+    $params = ['query' => '[email protected]'];
     $search = $client->users()->search($params);
 
     if (empty($search->users)) {
@@ -34,5 +34,5 @@
         }
     }
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/updateTicket.php

@@ -29,5 +29,5 @@
     print_r($updateTicket);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/tickets/viewTicket.php

@@ -26,5 +26,5 @@
     print_r($tickets->ticket);
     echo "</pre>";
 } catch (\Zendesk\API\Exceptions\ApiResponseException $e) {
-    echo $e->getMessage().'</br>';
+    echo $e->getMessage() . '</br>';
 }

samples/users/createUser.php

@@ -1,4 +1,5 @@
 <?php
+
 include("../../vendor/autoload.php");
 
 use Zendesk\API\HttpClient as ZendeskAPI;