Merge pull request #508 from zendesk/RED-1950-docker

CI

.github/workflows/ci.yaml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Build Docker image
+      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
+
+    - name: Run tests
+      run: docker run --rm --volume "$(pwd):/app" zendesk_api_client_php-app vendor/bin/phpunit --testsuite "Zendesk API Unit Test Suites"

.gitignore

@@ -1,2 +1,3 @@
 vendor
 phpunit.xml
+tmp/**

CONTRIBUTING.md

@@ -10,6 +10,12 @@
 
 ### Test suite
 
+```sh
+# TODO: Update CONTRIBUTING
+docker-compose up
+docker run -it --rm -v $(pwd):/app zendesk_api_client_php-app bash
+```
+
 The test suite is run via phpunit. Note that these are all live tests that must be run targeted at a real Zendesk instance. Credentials can be provided by setting the environment variables in phpunit.xml; a sample is provided at phpunit.xml.dist.
 
 To run the unit tests: `vendor/bin/phpunit --testsuite "Zendesk API Unit Test Suites"`
@@ -157,4 +163,3 @@ Use `Zendesk\API\Traits\Utility\InstantiatorTrait` when you want a resource to b
 ``` php
 $this->client->tickets()->comments()->findAll();
 ```
-

Dockerfile

@@ -0,0 +1,12 @@
+FROM php:7.4-cli
+
+# OS requirements for PHP
+RUN apt-get update && apt-get install -y git unzip
+
+# PHP requirements
+RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
+WORKDIR /app
+COPY composer.json composer.lock /app/
+RUN composer install
+
+COPY . /app

README.md

@@ -17,6 +17,8 @@ This is the second version of our PHP API client. The previous version of the AP
 This client **only** supports Zendesk's API v2.  Please see our [API documentation](http://developer.zendesk.com) for more information.
 
 ## Requirements
+
+* TODO: Update README
 * PHP 5.5+
 
 ## Installation
@@ -99,13 +101,13 @@ $attachment = $client->attachments()->upload([
 Attaching files to comments
 
 ``` php
-$ticket = $client->tickets()->create([          
-    'subject' => 'The quick brown fox jumps over the lazy dog',      
-    'comment' => [                              
+$ticket = $client->tickets()->create([
+    'subject' => 'The quick brown fox jumps over the lazy dog',
+    'comment' => [
         'body' => 'Lorem ipsum dolor sit amet, consectetur adipisicing elit, ' .
-                  'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.', 
-        'uploads'   => [$attachment->upload->token]                 
-    ]                                           
+                  'sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',
+        'uploads'   => [$attachment->upload->token]
+    ]
 ]);
 ```
 
@@ -135,8 +137,8 @@ The allowed options are
 
 ### Retrying Requests
 
-Add the `RetryHandler` middleware on the `HandlerStack` of your `GuzzleHttp\Client` instance. By default `Zendesk\Api\HttpClient` 
-retries: 
+Add the `RetryHandler` middleware on the `HandlerStack` of your `GuzzleHttp\Client` instance. By default `Zendesk\Api\HttpClient`
+retries:
 * timeout requests
 * those that throw `Psr\Http\Message\RequestInterface\ConnectException:class`
 * and those that throw `Psr\Http\Message\RequestInterface\RequestException:class` that are identified as ssl issue.