Merge branch 'release/1.0.1'

danskernesdigitalebibliotek · Feb 15, 2023 · 414ddc6 · 414ddc6
2 parents b5da365 + 18e33d2
commit 414ddc6
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 3,049 deletions.
diff --git a/.env b/.env
@@ -0,0 +1,3 @@
+# Use by development docker setup.
+COMPOSE_PROJECT_NAME=ddb-cover-service-php-client
+COMPOSE_DOMAIN=ddb-cover-service-php-client.local.itkdev.dk
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 /vendor/
 .php_cs.cache
+composer.lock
diff --git a/README.md b/README.md
@@ -1,6 +1,12 @@
-# 
-This service provides covers for library materials indexed by isbn, issn, faust, pid. The service is provided by [Danskernes Digitale Bibliotek](https://www.danskernesdigitalebibliotek.dk/) ### Authentication notes Authentication is done via OAuth2 against auth.dbc.dk. To obtain a valid token follow instructions in [1.2. Password Grant](https://github.com/DBCDK/hejmdal/blob/master/docs/oauth2.md#12-password-grant). To use the \"Authorize\" option in this tool use your 'client_id' and 'client_secret' and fill in '@' for both username and password. ### Implementation notes Currently the API is not fully implemented. The following features are missing: * Generic Covers: parameter is currently ignored. Service doesn't yet provide generic covers.
+# Api Client for DDF Cover Service 
 
+This is a PHP Api Client for DDF Cover Service. This service provides covers for library materials indexed by isbn, issn, faust, pid. 
+The service is provided by [Danskernes Digitale Bibliotek](https://www.danskernesdigitalebibliotek.dk/) 
+
+### Authentication notes 
+Authentication is done via OAuth2 against auth.dbc.dk. To obtain a valid token follow instructions in [1.2. Password Grant](https://github.com/DBCDK/hejmdal/blob/master/docs/oauth2.md#12-password-grant). To use the \"Authorize\" option in this tool use your 'client_id' and 'client_secret' and fill in '@' for both username and password. 
+
+### Implementation notes 
 This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0
@@ -14,24 +20,12 @@ PHP 5.5 and later
 ## Installation & Usage
 ### Composer
 
-To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
+To install the bindings via [Composer](http://getcomposer.org/), do:
 
 ```
-{
-  "repositories": [
-    {
-      "type": "git",
-      "url": "https://github.com/danskernesdigitalebibliotek/ddb-cover-service-php-client.git"
-    }
-  ],
-  "require": {
-    "danskernesdigitalebibliotek/ddb-cover-service-php-client": "*@dev"
-  }
-}
+composer require danskernesdigitalebibliotek/ddb-cover-service-php-client
 ```
 
-Then run `composer install`
-
 ### Manual Installation
 
 Download the files and include `autoload.php`:
@@ -40,15 +34,6 @@ Download the files and include `autoload.php`:
     require_once('/path/to//vendor/autoload.php');
 ```
 
-## Tests
-
-To run the unit tests:
-
-```
-composer install
-./vendor/bin/phpunit
-```
-
 ## Getting Started
 
 Please follow the [installation procedure](#installation--usage) and then run the following:

diff --git a/composer.json b/composer.json
@@ -1,21 +1,9 @@
 {
     "name": "danskernesdigitalebibliotek/ddb-cover-service-php-client",
-    "version": "2.0.0",
-    "description": "",
-    "keywords": [
-        "swagger",
-        "php",
-        "sdk",
-        "api"
-    ],
-    "homepage": "http://swagger.io",
+    "version": "1.0.1",
+    "description": "Api Client for DDF Cover Service",
+    "homepage": "https://github.com/danskernesdigitalebibliotek/ddb-cover-service-php-client",
     "license": "AGPL-3.0-only",
-    "authors": [
-        {
-            "name": "Swagger and contributors",
-            "homepage": "https://github.com/swagger-api/swagger-codegen"
-        }
-    ],
     "require": {
         "php": ">=7",
         "ext-curl": "*",
@@ -24,41 +12,20 @@
         "guzzlehttp/guzzle": "^6.2"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.16",
-        "squizlabs/php_codesniffer": "^3.5"
+        "friendsofphp/php-cs-fixer": "^2.16"
     },
     "autoload": {
         "psr-4": { "CoverService\\" : "lib/" }
     },
-    "scripts":{
-        "check": [
-            "@check-coding-standards"
+    "scripts": {
+        "coding-standards-apply": [
+            "php-cs-fixer fix"
         ],
-        "check-coding-standards/php-cs-fixer": [
-            "php-cs-fixer --config=.php_cs.dist fix --dry-run --format=checkstyle"
-        ],
-        "check-coding-standards/phpcs": [
-            "phpcs --standard=phpcs.xml.dist"
-        ],
-        "check-coding-standards": [
-            "@check-coding-standards/php-cs-fixer",
-            "@check-coding-standards/phpcs"
-        ],
-        "apply-coding-standards/php-cs-fixer": [
-            "php-cs-fixer --config=.php_cs.dist fix"
-        ],
-        "apply-coding-standards/phpcs": [
-            "phpcbf --standard=phpcs.xml.dist"
-        ],
-        "apply-coding-standards": [
-            "@apply-coding-standards/php-cs-fixer",
-            "@apply-coding-standards/phpcs"
-        ],
-        "actions/phpcs": [
-            "phpcs --standard=phpcs.xml.dist --report=checkstyle"
+        "coding-standards-check": [
+            "php-cs-fixer fix --dry-run --format=checkstyle"
         ],
         "actions/phpcsfixer": [
-            "php-cs-fixer --config=.php_cs.dist fix --dry-run --diff --diff-format=udiff"
+            "php-cs-fixer fix --dry-run --format=checkstyle"
         ]
     }
 }