Update Context, Clean ups and tests

.editorconfig

@@ -10,3 +10,6 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.gitattributes

@@ -2,10 +2,14 @@
 # https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
 
 # Ignore all test and documentation with "export-ignore".
-/.gitattributes export-ignore
-/.github export-ignore
-/.gitignore export-ignore
-/phpunit.xml.dist export-ignore
-/tests export-ignore
-/.editorconfig export-ignore
-/.php_cs export-ignore
+/.github export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/phpunit.xml.dist export-ignore
+/psalm.xml.dist export-ignore
+/tests export-ignore
+/.editorconfig export-ignore
+/.php-cs-fixer.dist.php export-ignore
+/art export-ignore
+/docs export-ignore
+/UPGRADING.md export-ignore

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,14 @@
+blank_issues_enabled: false
+contact_links:
+ - name: Ask a question
+ url: https:/:vendor_name/:package_name/discussions/new?category=q-a
+ about: Ask the community for help
+ - name: Request a feature
+ url: https:/:vendor_name/:package_name/discussions/new?category=ideas
+ about: Share ideas for new features
+ - name: Report a security issue
+ url: https:/:vendor_name/:package_name/security/policy
+ about: Learn how to notify us for sensitive bugs
+ - name: Report a bug
+ url: https:/:vendor_name/:package_name/issues/new
+ about: Report a reproducable bug

.github/dependabot.yml

@@ -3,7 +3,6 @@
 
 version: 2
 updates:
-
  - package-ecosystem: "github-actions"
  directory: "/"
  schedule:

.github/workflows/dependabot-auto-merge.yml

@@ -2,31 +2,30 @@ name: dependabot-auto-merge
 on: pull_request_target
 
 permissions:
- pull-requests: write
- contents: write
+  pull-requests: write
+  contents: write
 
 jobs:
- dependabot:
- runs-on: ubuntu-latest
- if: ${{ github.actor == 'dependabot[bot]' }}
- steps:
-
- - name: Dependabot metadata
- id: metadata
- uses: dependabot/[email protected]
- with:
- github-token: "${{ secrets.GITHUB_TOKEN }}"
-
- - name: Auto-merge Dependabot PRs for semver-minor updates
- if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
- run: gh pr merge --auto --merge "$PR_URL"
- env:
- PR_URL: ${{github.event.pull_request.html_url}}
- GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
-
- - name: Auto-merge Dependabot PRs for semver-patch updates
- if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
- run: gh pr merge --auto --merge "$PR_URL"
- env:
- PR_URL: ${{github.event.pull_request.html_url}}
- GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+ dependabot:
+ runs-on: ubuntu-latest
+ if: ${{ github.actor == 'dependabot[bot]' }}
+ steps:
+ - name: Dependabot metadata
+ id: metadata
+ uses: dependabot/[email protected]
+ with:
+ github-token: "${{ secrets.GITHUB_TOKEN }}"
+
+ - name: Auto-merge Dependabot PRs for semver-minor updates
+ if: ${{steps.metadata.outputs.update-type == 'version-update:semver-minor'}}
+ run: gh pr merge --auto --merge "$PR_URL"
+ env:
+ PR_URL: ${{github.event.pull_request.html_url}}
+ GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+ - name: Auto-merge Dependabot PRs for semver-patch updates
+ if: ${{steps.metadata.outputs.update-type == 'version-update:semver-patch'}}
+ run: gh pr merge --auto --merge "$PR_URL"
+ env:
+ PR_URL: ${{github.event.pull_request.html_url}}
+ GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 .idea
 .php_cs
 .php_cs.cache
@@ -10,5 +11,3 @@ phpunit.xml
 psalm.xml
 vendor
 .php-cs-fixer.cache
-.DS-Store
-.DS_Store

.php-cs-fixer.dist.php

@@ -36,4 +36,4 @@
  ],
  'single_trait_insert_per_statement' => true,
  ])
- ->setFinder($finder);
+ ->setFinder($finder);

CHANGELOG.md

@@ -4,4 +4,6 @@ All notable changes to `conlect\image-iiif` will be documented in this file
 
 ## 0.2.0 - 2018-11-18
 
-- stable pre-release allows passing config as array
+- stable pre-release allows passing config as array
+
+## 1.0.0 -

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Conlectio LLC
+Copyright (c) jeremytubbs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,20 +2,19 @@
 [![Tests](https:/conlect/image-iiif/actions/workflows/run-tests.yml/badge.svg?branch=main)](https:/conlect/image-iiif/actions/workflows/run-tests.yml)
 [![Total Downloads](https://img.shields.io/packagist/dt/conlect/image-iiif.svg?style=flat-square)](https://packagist.org/packages/conlect/image-iiif)
 
-
 # Image IIIF
 
 This package implements the [IIIF Image API 3.0](https://iiif.io/api/image/3.0/), it is unopinionated about implementation and many of the `MUST` features are not included because it does not include an actual implementation only the means to create one. I consider it a bring your own framework solution for implementing Image API 3.0 with PHP. The package utilizes the [Intervention Image](http://image.intervention.io/) package for manipulations. I have provided Intervention filters for each of the 5 IIIF parameters that can be used independently of the `$factory()->load()->withParameters()` pipeline methods.
 
 **Supports all Image Request Parameters:**
-- Region (full || square || x,y,w,h || pct:x,y,w,h)
-- Size (full || max || w, || ,h || pct:n || w,h || !w,h)
-- Rotation (n || !n)
-- Quality (color || gray || bitonal || default)
-- Format (jpg || tif || png || gif || webp)
 
-Supports the `info.json` response for an identifier.
+- Region (full || square || x,y,w,h || pct:x,y,w,h)
+- Size (full || max || w, || ,h || pct:n || w,h || !w,h)
+- Rotation (n || !n)
+- Quality (color || gray || default)
+- Format (jpg || tif || png || gif || webp)
 
+Supports the `info.json` response for an identifier.
 
 #### Laravel image route example:
 

composer.json

@@ -11,20 +11,20 @@
  "authors": [
  {
  "name": "Jeremy Tubbs",
- "email": "[email protected]",
- "homepage": "https://conlect.io",
+ "email": "[email protected]",
+ "homepage": "https://jeremytubbs.com",
  "role": "Developer"
  }
  ],
  "require": {
- "php": ">=5.5.9",
- "hassankhan/config": "^2.1",
- "intervention/image": "^2.5"
+ "php": "^8.0.2",
+ "hassankhan/config": "^3.0.1",
+ "intervention/image": "^2.7.2"
  },
  "require-dev": {
  "friendsofphp/php-cs-fixer": "^3.0",
  "larapack/dd": "^1.1",
- "phpunit/phpunit": "^9.3"
+ "phpunit/phpunit": "^9.5"
  },
  "suggest": {
  "ext-gd": "to use GD library based image processing.",
@@ -48,7 +48,6 @@
  "vendor/bin/phpunit --coverage-html coverage"
  ],
  "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes"
-
  },
  "config": {
  "sort-packages": true

config/iiif.php

@@ -2,8 +2,12 @@
 
 return [
 
+ 'base_url' => 'https://example.test',
+
  'driver' => 'gd', // or imagick
 
+ 'allow_upscaling' => true,
+
  'tile_width' => 1024,
 
  'quality' => 90,
@@ -13,8 +17,8 @@
  'tif' => 'image/tiff',
  'png' => 'image/png',
  'gif' => 'image/gif',
- 'jp2' => 'image/jp2',
- 'pdf' => 'application/pdf',
+ // 'jp2' => 'image/jp2',
+ // 'pdf' => 'application/pdf',
  'webp' => 'image/webp',
  ],
 
@@ -25,13 +29,12 @@
  'qualities' => [
  'color',
  'gray',
- 'bitonal',
+ // 'bitonal',
  'default',
  ],
 
  'supports' => [
- 'baseUriRedirect', // The base URI of the service will redirect to the image information document.
- 'canonicalLinkHeader', //
- 'cors',
+ 'baseUriRedirect',
+ "jsonldMediaType",
  ],
 ];

src/ImageIIIF.php

@@ -84,8 +84,11 @@ public function hasValidParameters(array $parameters)
 
  public function info($prefix = 'iiif', $identifier)
  {
+ // Optional - maxWidth, maxHeight, maxArea
+ // sizes - prefered w,h pairs
+ // rights - CC license
  return [
- '@context' => 'http://iiif.io/api/image/2/context.json',
+ '@context' => 'http://iiif.io/api/image/3/context.json',
  'id' => $this->config['base_url'] . '/' . $prefix . '/' . $identifier,
  'type' => 'ImageService3',
  'protocol' => 'http://iiif.io/api/image',

src/Validators/RegionValidator.php

@@ -2,21 +2,24 @@
 
 namespace Conlect\ImageIIIF\Validators;
 
+use function array_filter;
+
 use Conlect\ImageIIIF\Exceptions\BadRequestException;
 use Conlect\ImageIIIF\Validators\Contracts\ValidatorInterface;
 
+use function count;
+use function explode;
+use function in_array;
+use function str_starts_with;
+
 class RegionValidator extends ValidatorAbstract implements ValidatorInterface
 {
  public function valid($value)
  {
  $options = explode(',', $value);
 
- if (in_array($options[0], ['full', 'square'])) {
- return true;
- }
-
- if (str_contains($options[0], ':') && ! str_starts_with($options[0], 'pct:')) {
- return $this->valueException($value);
+ if (count($options) == 1) {
+ return $this->validateFullOrSquare($options[0]);
  }
 
  if (count($options) !== 4) {
@@ -28,10 +31,25 @@ public function valid($value)
  }
 
  if (str_starts_with($options[0], 'pct:')) {
- $options[0] = substr($options[0], 4);
+ $options[0] = \substr($options[0], 4);
  }
 
  if (4 === count(array_filter($options, 'is_numeric'))) {
+ $validator = new ValidatorShared();
+ foreach ($options as $option) {
+ $validator->floatingPointValidator($option);
+ }
+
+ return true;
+ }
+
+
+ return $this->valueException($value);
+ }
+
+ protected function validateFullOrSquare($value)
+ {
+ if (in_array($value, ['full', 'square'])) {
  return true;
  }
 

src/Validators/SizeValidator.php

@@ -3,6 +3,7 @@
 namespace Conlect\ImageIIIF\Validators;
 
 use Conlect\ImageIIIF\Exceptions\BadRequestException;
+use Conlect\ImageIIIF\Exceptions\NotImplementedException;
 use Conlect\ImageIIIF\Validators\Contracts\ValidatorInterface;
 
 class SizeValidator extends ValidatorAbstract implements ValidatorInterface
@@ -21,17 +22,27 @@ public function valid($value)
  {
  $startValue = $value;
 
+ if (str_starts_with($value, '^') && $this->config['allow_upscaling'] === false) {
+ throw new NotImplementedException("Upscaling is not allowed.");
+ }
+
  if (strpos($value, '^pct:') !== false) {
  $value = preg_replace('/^\^pct:/', '', $value);
 
+ if ((int)$value == 0) {
+ throw new BadRequestException("Size $startValue is invalid.");
+ }
  if ((int)$value >= 1) {
  return true;
  }
  }
 
  if (strpos($value, 'pct:') !== false) {
- $value = preg_replace('/^pct:/', '', $value);
+ $value = preg_replace('/pct:/', '', $value);
 
+ if ((int)$value == 0 || (int)$value > 100) {
+ throw new BadRequestException("Size $startValue is invalid.");
+ }
  if ((int)$value >= 1 && (int)$value <= 100) {
  return true;
  }

src/Validators/ValidatorShared.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Conlect\ImageIIIF\Validators;
+
+use Conlect\ImageIIIF\Exceptions\BadRequestException;
+
+class ValidatorShared
+{
+ public function floatingPointValidator($value)
+ {
+ if (is_float($value + 0)) {
+ // if less than zero and doesn't start with a zero
+ if ($value + 0 < 1 && ! str_starts_with($value, '0')) {
+ throw new BadRequestException('Region values less than one require a leading zero.');
+ }
+ // option should not have an extra trailing zero
+ if (str_ends_with($value, '0')) {
+ throw new BadRequestException('Region values should not contain a trailing zero.');
+ }
+ }
+
+ return true;
+ }
+}

tests/FormatValidatorTest.php

@@ -19,8 +19,6 @@ public function it_validates_format()
  $this->assertTrue($formatValidator->valid('tif'));
  $this->assertTrue($formatValidator->valid('png'));
  $this->assertTrue($formatValidator->valid('gif'));
- $this->assertTrue($formatValidator->valid('jp2'));
- $this->assertTrue($formatValidator->valid('pdf'));
  $this->assertTrue($formatValidator->valid('webp'));
  }