Merge pull request #4 from 123inkt/init-repo-no-skeleton

Setup the initial repo for publication v2

Author: RubenKluft

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
         runs-on: ubuntu-latest
         strategy:
             matrix:
-                php-versions: [ '8.1', '8.2', '8.3', '8.4' ]
+                php-versions: [ '8.3', '8.4' ]
                 composer-flags: [ '', '--prefer-lowest' ]
         steps:
             -   uses: actions/checkout@v4
@@ -46,17 +46,17 @@ jobs:
             -   name: Setup PHP
                 uses: shivammathur/setup-php@v2
                 with:
-                    php-version: 8.2
+                    php-version: 8.3
                     coverage: pcov
 
             -   name: Install dependencies
                 run: composer update --prefer-dist --no-progress --no-suggest --prefer-stable
 
             -   name: Run test suite
-                run: php -dpcov.enabled=1 -dpcov.exclude="~vendor~" vendor/bin/phpunit --testsuite unit --coverage-clover ./.coverage/coverage.xml
+                run: php -dpcov.enabled=1 -dpcov.exclude="~vendor~" vendor/bin/phpunit --testsuite unit --coverage-clover ./coverage.xml
 
             -   name: Check coverage
-                run: test ! -f ./.coverage/coverage.xml || php vendor/bin/phpfci inspect ./.coverage/coverage.xml ./.coverage/phpfci.xml --exit-code-on-failure
+                run: test ! -f ./.coverage/coverage.xml || php vendor/bin/phpfci inspect ./coverage.xml ./phpfci.xml --exit-code-on-failure
 
     quality:
         name: Quality checks
@@ -67,7 +67,7 @@ jobs:
             -   name: Setup PHP
                 uses: shivammathur/setup-php@v2
                 with:
-                    php-version: 8.1
+                    php-version: 8.3
                     coverage: none
 
             -   name: Install dependencies

.gitignore

@@ -1,5 +1,6 @@
 /.idea
 /vendor
-/composer.lock
-/phpunit.xml
 /.phpunit.result.cache
+/.phpunit.cache
+/composer.lock
+/coverage.xml

README.md

@@ -1,4 +1,93 @@
-[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.1-8892BF)](https://php.net/)
+[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.3-8892BF)](https://php.net/)  
+
+# Digitalrevolution IPP library
+
+## Installation
+
+```bash
+composer require digitalrevolution/ipp
+```
+
+## Usage
+
+### Initialize the library
+
+```php
+    $server = new IppServer();
+    $server->setUri('https://cups.local');
+    $server->setUsername('admin'); // optional
+    $server->setPassword('admin'); // optional
+
+    $ipp = new Ipp($server, new Psr18Client());
+```
+
+### Print a file
+
+```php
+    // define a printer        
+    $printer = new IppPrinter();
+    $printer->setHostname('my.printer');
+    
+    // print a file on the selected printer
+    $ippFile = new IppPrintFile(file_get_contents('/dir/file.ps'), FileTypeEnum::PS);
+    $ipp->print($printer, $ippFile);
+```
+
+### Fetch job attributes
+
+```php
+    $printJob = $ipp->print($printer, $ippFile);
+    $updatedPrintJob = $ipp->getJobAttributes($printJob->getJobUri());
+```
+
+### Register a printer with cups
+
+```php
+    $printer = new IppPrinter();
+    $printer->setHostname('my.printer');
+    $printer->setDeviceUri('my.uri');
+    $printer->setLocation('location');
+
+    $ipp->createPrinter($printer);
+```
+
+### Delete a printer
+
+```php
+    $printer = new IppPrinter();
+    $printer->setHostname('my.printer');
+
+    $ipp->deletePrinter($printer);
+```
+
+### Contributing
+
+See [contributing.md](./CONTRIBUTING.md)  
+Pull requests welcome for adding standard IPP Operations
+
+### Creating a custom IPP operation
+
+This project is created to be easily extensible, adding a new IPP operation is as simple as making sure it has an identifier in IppOperationEnum  
+Then adding any Job, Printer or Operation Attributes as required by your standard.    
+Finally sending the request and parsing the response using the standard parser.
+
+```php
+public function myOperation(): IppResponseInterface
+    $operation = new IppOperation(IppOperationEnum::OperationType);
+    $operation->addOperationAttribute(new IppAttribute(IppTypeEnum::Charset, 'attributes-charset', 'utf-8'));
+    
+    $response = $this->client->sendRequest(
+        new Request(
+            'POST',
+            $this->server->getUri(),
+            ['Content-Type' => 'application/ipp'],
+            (string)$operation
+        )
+    );
+
+    return $this->parser->getResponse($response->getBody()->getContents());
+}
+```
 
 ## About us
 

composer.json

@@ -1,26 +1,35 @@
 {
-    "name": "digitalrevolution/skeleton",
-    "description": "Digital Revolution skeleton package",
+    "name": "digitalrevolution/ipp",
+    "description": "Digital Revolution IPP library",
     "type": "library",
     "license": "MIT",
     "minimum-stability": "stable",
     "config": {
         "sort-packages": true,
+        "process-timeout": 0,
         "allow-plugins": {
-            "phpstan/extension-installer": true
-        }
+            "phpstan/extension-installer": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "digitalrevolution/php-codesniffer-baseline": true
+        },
+        "lock": false
     },
     "require": {
-        "php": ">=8.1"
+        "php": "^8.3",
+        "nyholm/psr7": "^1.8",
+        "psr/http-client": "^1.0",
+        "psr/log": "^3.0",
+        "digitalrevolution/utils": "^1.0"
     },
     "require-dev": {
-        "digitalrevolution/phpunit-file-coverage-inspection": "^v2.0.0",
-        "phpmd/phpmd": "^2.14",
-        "phpstan/extension-installer": "^1.3",
-        "phpstan/phpstan": "^2.0",
-        "phpstan/phpstan-phpunit": "^2.0",
-        "phpstan/phpstan-strict-rules": "^2.0",
-        "phpunit/phpunit": "^11.5 || ^12.0",
+        "digitalrevolution/accessorpair-constraint": "^v2.4.1",
+        "digitalrevolution/phpunit-file-coverage-inspection": "^3.0",
+        "digitalrevolution/php-codesniffer-baseline": "^1.1",
+        "phpmd/phpmd": "^2.12",
+        "phpstan/extension-installer": "^1.2",
+        "phpstan/phpstan": "^1.9.1",
+        "phpstan/phpstan-phpunit": "^1.2.2",
+        "phpunit/phpunit": "^11.5",
         "roave/security-advisories": "dev-latest",
         "squizlabs/php_codesniffer": "^3.7",
         "slevomat/coding-standard": "^8.16"
@@ -31,19 +40,33 @@
             "@baseline:phpmd"
         ],
         "baseline:phpstan": "phpstan --generate-baseline",
-        "baseline:phpmd": "phpmd src,tests xml phpmd.xml.dist --generate-baseline",
+        "baseline:phpmd": "phpmd src,tests xml phpmd.xml --generate-baseline",
         "check": [
             "@check:phpstan",
             "@check:phpmd",
             "@check:phpcs"
         ],
         "check:phpstan": "phpstan analyse",
-        "check:phpmd": "phpmd src,tests text phpmd.xml.dist --suffixes php",
+        "check:phpmd": "phpmd src,tests text phpmd.xml --suffixes php",
         "check:phpcs": "phpcs src tests",
         "fix": "@fix:phpcbf",
         "fix:phpcbf": "phpcbf src tests",
-        "test": "phpunit",
-        "test:integration": "phpunit --testsuite integration",
-        "test:unit": "phpunit --testsuite unit"
+        "test": "phpunit --testsuite unit",
+        "test:coverage": [
+            "phpunit --testsuite unit --coverage-clover coverage.xml",
+            "phpfci inspect coverage.xml --exit-code-on-failure"
+        ],
+        "test:phpfci": "phpfci inspect coverage.xml --exit-code-on-failure"
+    },
+    "autoload": {
+        "psr-4": {
+            "DR\\Ipp\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "DR\\Ipp\\Tests\\Unit\\": "tests/Unit/",
+            "DR\\Ipp\\Tests\\": "tests/"
+        }
     }
 }

phpcs.xml.dist phpcs.xmlphpcs.xml.dist renamed to phpcs.xml

@@ -20,8 +20,8 @@
     </rule>
     <rule ref="SlevomatCodingStandard.Complexity.Cognitive">
         <properties>
-            <property name="warningThreshold" value="16"/>
-            <property name="errorThreshold" value="16"/>
+            <property name="warningThreshold" value="6"/>
+            <property name="errorThreshold" value="6"/>
         </properties>
     </rule>
     <rule ref="SlevomatCodingStandard.Arrays.DisallowImplicitArrayCreation"/>

phpfci.xml

@@ -1,4 +1,3 @@
-<?xml version="1.0" encoding="UTF-8"?>
 <phpfci xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/digitalrevolution/phpunit-file-coverage-inspection/resources/phpfci.xsd"
         min-coverage="100">

phpmd.xml.dist phpmd.xmlphpmd.xml.dist renamed to phpmd.xml

@@ -3,4 +3,4 @@ parameters:
   treatPhpDocTypesAsCertain: false
   paths:
     - src
-    - test
+    - tests