Feature/cups (rawilk#2)

Author: rawilk

.github/workflows/php-cs-fixer.yml

@@ -8,7 +8,7 @@ jobs:
 
         steps:
             -   name: Checkout code
-                uses: actions/checkout@v1
+                uses: actions/checkout@v2
 
             -   name: Fix style
                 uses: docker://oskarstark/php-cs-fixer-ga

.github/workflows/psalm.yml

@@ -11,7 +11,7 @@ jobs:
         name: psalm
         runs-on: ubuntu-latest
         steps:
-            - uses: actions/checkout@v1
+            - uses: actions/checkout@v2
 
             - name: Setup PHP
               uses: shivammathur/setup-php@v2

.github/workflows/run-tests.yml

@@ -16,17 +16,19 @@ jobs:
       matrix:
         os: [ubuntu-latest, windows-latest]
         php: [7.4]
-        laravel: [7.*]
+        laravel: [6.*, 7.*]
         dependency-version: [prefer-lowest, prefer-stable]
         include:
           - laravel: 7.*
             testbench: 5.*
+          - laravel: 6.*
+            testbench: 4.*
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }} - ${{ matrix.os }}
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v1
+        uses: actions/checkout@v2
 
       - name: Cache dependencies
         uses: actions/cache@v1
@@ -35,7 +37,7 @@ jobs:
           key: dependencies-laravel-${{ matrix.laravel }}-php-${{ matrix.php }}-composer-${{ hashFiles('composer.json') }}
 
       - name: Setup PHP
-        uses: shivammathur/setup-php@v1
+        uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-printing` will be documented in this file.
 
+## 1.2.0 - 202X-XX-XX
+### Added
+- Add support for CUPS driver.
+
 ## 1.1.6 - 2020-07-23
 ### Changed
 - Remove `int` parameter type hint on `PrintNodePrintJob` `id` setter.

README.md

@@ -20,6 +20,7 @@ $printJob->id(); // the id number returned from the print server
 Supported Print Drivers:
 
 - PrintNode: https://printnode.com
+- CUPS: https://cups.org
 
 ## Documentation:
 
@@ -47,7 +48,7 @@ return [
     | Driver
     |--------------------------------------------------------------------------
     |
-    | Supported: `printnode`
+    | Supported: `printnode`, `cups`
     |
     */
     'driver' => env('PRINTING_DRIVER', 'printnode'),
@@ -64,6 +65,12 @@ return [
         'printnode' => [
             'key' => env('PRINT_NODE_API_KEY'),
         ],
+        'cups' => [
+            'ip' => env('CUPS_SERVER_IP'),
+            'username' => env('CUPS_SERVER_USERNAME'),
+            'password' => env('CUPS_SERVER_PASSWORD'),
+            'port' => env('CUPS_SERVER_PORT', 631),
+        ],
     ],
 
     /*
@@ -108,6 +115,8 @@ return [
 ];
 ```
 
+- When using CUPS, you can either use a local CUPS server that runs on the **same server as your Laravel installation** (useful for local development), or you can specify an IP address, username, and password for a remote CUPS server. The remote CUPS server **must be on the same network** as any printers you are going to print to.
+
 ## Usage
 
 ### Listing printers
@@ -150,7 +159,10 @@ Printing::newPrintTask()
     ->send();
 ```
 
-More PrintNode options can be found here: https://www.printnode.com/en/docs/api/curl#printjob-options
+- More PrintNode options can be found here: https://www.printnode.com/en/docs/api/curl#printjob-options
+- More info on using CUPS options can be found here: https://github.com/smalot/cups-ipp
+
+> **Note:** If using CUPS, you can pass in a `$contentType` as a second parameter to the `file()`, `url()`, and `content()` methods. The default is `application/octet-stream` (PDF). More types can be found in `Rawilk\Printing\Drivers\Cups\ContentType.php`. 
 
 ## Receipt Printing
 Receipt printing can be done if you have a receipt printer by using the `Rawilk\Printing\Receipts\ReceiptPrinter` class.

composer.json

@@ -24,7 +24,9 @@
         "ext-json": "*",
         "illuminate/support": "^6.0|^7.0",
         "mike42/escpos-php": "^3.0",
-        "printnode/printnode-php": "^2.0@RC"
+        "php-http/socket-client": "2.*",
+        "printnode/printnode-php": "^2.0@RC",
+        "smalot/cups-ipp": "^0.5.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.16",

config/printing.php

@@ -6,7 +6,7 @@
     | Driver
     |--------------------------------------------------------------------------
     |
-    | Supported: `printnode`
+    | Supported: `printnode`, `cups`
     |
     */
     'driver' => env('PRINTING_DRIVER', 'printnode'),
@@ -23,6 +23,12 @@
         'printnode' => [
             'key' => env('PRINT_NODE_API_KEY'),
         ],
+        'cups' => [
+            'ip' => env('CUPS_SERVER_IP'),
+            'username' => env('CUPS_SERVER_USERNAME'),
+            'password' => env('CUPS_SERVER_PASSWORD'),
+            'port' => env('CUPS_SERVER_PORT', 631),
+        ],
     ],
 
     /*

phpunit.xml.dist

@@ -1,28 +1,18 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
+<phpunit backupGlobals="false"
          backupStaticAttributes="false"
+         bootstrap="vendor/autoload.php"
          colors="true"
-         verbose="true"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="false">
+         stopOnFailure="false"
+         verbose="true"
+>
     <testsuites>
         <testsuite name="Rawilk Test Suite">
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">src/</directory>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage"/>
-        <log type="coverage-text" target="build/coverage.txt"/>
-        <log type="coverage-clover" target="build/logs/clover.xml"/>
-    </logging>
 </phpunit>

psalm.xml

@@ -16,6 +16,7 @@
     </projectFiles>
 
     <issueHandlers>
+        <TypeDoesNotContainType errorLevel="suppress"/>
     </issueHandlers>
 
     <plugins>

src/Drivers/Cups/ContentType.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rawilk\Printing\Drivers\Cups;
+
+class ContentType
+{
+    /** @var string */
+    public const HTML = 'text/html';
+
+    /** @var string */
+    public const PDF = 'application/octet-stream';
+
+    /** @var string */
+    public const TEXT = 'text/plain';
+}