Merge pull request #15 from gaalferov/2.0-release

2.0 release

Author: gaalferov

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

@@ -0,0 +1,43 @@
+name: PHP Coding Standards
+
+on: [push]
+
+jobs:
+  phpunit-tests:
+    name: PHP ${{ matrix.php-version }} Latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        php-version: [ '8.0','8.1','8.2' ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        id: setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: mbstring, intl, curl, json, openssl
+
+      - name: Print PHP version
+        run: echo ${{ steps.setup-php.outputs.php-version }}
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer
+
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run phpunit tests
+        run: composer cs-audit

.github/workflows/ci-phpunit.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest ]
-        php-version: [ '5.6','7.0','7.1','7.2','7.3','7.4' ]
+        php-version: [ '8.0','8.1','8.2' ]
 
     steps:
       - name: Checkout

.gitignore

@@ -17,4 +17,5 @@ Dockerfile
 ###> other ###
 .idea/
 .psalm-cache/
+.php-cs-fixer.cache
 ###> other ###

.php-cs-fixer.dist.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of PHP CS Fixer.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *     Dariusz Rumiński <[email protected]>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+$finder = PhpCsFixer\Finder::create()
+    ->ignoreDotFiles(false)
+    ->ignoreVCSIgnored(true)
+    ->exclude(['dev-tools/phpstan', 'tests/Fixtures'])
+    ->in(__DIR__)
+;
+
+$config = new PhpCsFixer\Config();
+$config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PHP74Migration' => true,
+        '@PHP74Migration:risky' => true,
+        '@PHPUnit100Migration:risky' => true,
+        '@PhpCsFixer' => true,
+        '@PhpCsFixer:risky' => true,
+        'general_phpdoc_annotation_remove' => ['annotations' => ['expectedDeprecation']], // one should use PHPUnit built-in method instead
+        'modernize_strpos' => true, // needs PHP 8+ or polyfill
+        'no_useless_concat_operator' => false,
+    ])
+    ->setFinder($finder)
+;
+
+return $config;

.php_cs.dist

@@ -1,3 +1,7 @@
+## [2.0] - 2023-08-23
+
+- Support PHP 8.0 and above
+
 ## [1.4] - 2023-08-14
 
 - Partially updated library and supported PHP versions

CHANGELOG.md

@@ -1,6 +1,7 @@
 PHP extension for Domain Connect
 ===============
 ![GitHub Actions](https://github.com/gaalferov/ext-domain-connect/actions/workflows/ci-phpunit.yml/badge.svg)
+![GitHub Actions](https://github.com/gaalferov/ext-domain-connect/actions/workflows/ci-php-cs-fixer.yml/badge.svg)
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/1df868212d224c8589005c2e8aee7e45)](https://app.codacy.com/gh/gaalferov/ext-domain-connect/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 
 [![PHP version support](https://img.shields.io/packagist/dependency-v/gaalferov/php-ext-domain-connect/php?style=flat)](https://packagist.org/packages/gaalferov/php-ext-domain-connect)
@@ -14,6 +15,9 @@ Library offers Service Provider functionality in Sync mode.
 ## Specification reference
 https://github.com/Domain-Connect/spec/blob/master/Domain%20Connect%20Spec%20Draft.adoc
 
+## DC Templates
+https://github.com/Domain-Connect/Templates/tree/master
+
 ## Install
 ```bash
 composer require gaalferov/php-ext-domain-connect
@@ -34,13 +38,13 @@ use DomainConnect\Services\TemplateService;
 
 try {
     $applyUrl = (new TemplateService())->getTemplateSyncUrl(
-        'foo.connect.domains',
-        'exampleservice.domainconnect.org',
-        'template1',
+        'domainconnect.org', // domain name
+        'exampleservice.domainconnect.org',  // providerId from the template
+        'template1', // serviceId from the template
         [
             'IP' => '132.148.25.185',
             'RANDOMTEXT' => 'shm:1531371203:Hello world sync',
-            'redirect_uri' => 'http://example.com',
+            'redirect_uri' => 'https://your-client-page.com',
             'state' => 'someState'
         ],
     );
@@ -54,7 +58,8 @@ try {
 
 Output:
 ```text
-https://domainconnect.1and1.com/sync/v2/domainTemplates/providers/exampleservice.domainconnect.org/services/template1/apply?domain=connect.domains&host=foo&IP=132.148.25.185&RANDOMTEXT=shm%3A1531371203%3AHello+world+sync&redirect_uri=http%3A%2F%2Fexample.com&state=someState
+https://dcc.godaddy.com/manage/v2/domainTemplates/providers/exampleservice.domainconnect.org/services/template1/apply?domain=domainconnect.org&IP=132.148.25.185&RANDOMTEXT=shm%3A1531371203%3AHello+world+sync&redirect_uri=https%3A%2F%2Fyour-client-page.com&state=someState
+
 ```
 
 ### Sync flow with signed request
@@ -73,13 +78,13 @@ try {
     $keyId = '_dck1';
 
     $applyUrl = $templateService->getTemplateSyncUrl(
-        'foo.connect.domains',
-        'exampleservice.domainconnect.org',
-        'template1',
+        'domainconnect.org', // domain name
+        'exampleservice.domainconnect.org',  // providerId from the template
+        'template1', // serviceId from the template
         [
             'IP' => '132.148.25.185',
             'RANDOMTEXT' => 'shm:1531371203:Hello world sync',
-            'redirect_uri' => 'http://example.com',
+            'redirect_uri' => 'https://your-client-page.com',
             'state' => 'someState'
         ],
         $privateKey,
@@ -117,7 +122,7 @@ try {
     ]);
 
     $applyUrl = $templateService->getTemplateSyncUrl(
-        'foo.connect.domains',
+        'domainconnect.org',
         'exampleservice.domainconnect.org',
         'template1',
         [

README.md

@@ -16,18 +16,18 @@
     }
   },
   "require": {
-    "php": "^5.6 || ^7.0",
+    "php": "^8.0",
     "ext-json": "*",
     "ext-openssl": "*",
-    "guzzlehttp/guzzle": "^6.3",
-    "layershifter/tld-extract": "^2.0"
+    "guzzlehttp/guzzle": "^7.0"
   },
   "require-dev": {
-    "phpunit/phpunit": "^5"
+    "phpunit/phpunit": "^9.0",
+    "friendsofphp/php-cs-fixer": "^3.0"
   },
   "scripts": {
     "tests": "vendor/bin/phpunit",
-    "cs-audit": "php-cs-fixer fix -v --diff --dry-run",
-    "cs-fix": "php-cs-fixer fix -v --diff"
+    "cs-audit": "vendor/bin/php-cs-fixer fix -v --diff --dry-run",
+    "cs-fix": "vendor/bin/php-cs-fixer fix -v --diff"
   }
 }