Skip to content

Commit 058eb09

Browse files
n7studiosn7studios
authored
Merge pull request #107 from Kit/fix-tests
Fix Failing Tests
2 parents cfd050c + f2adc1b commit 058eb09

File tree

12 files changed

+2467
-642
lines changed

12 files changed

+2467
-642
lines changed

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: ConvertKit support
4-
url: https://convertkit.com/support/
3+
- name: Kit support
4+
url: https://kit.com/support/
55
about: |
6-
Please only file issues here that you believe represent actual bugs or feature requests for the ConvertKit PHP SDK.
6+
Please only file issues here that you believe represent actual bugs or feature requests for the Kit PHP SDK.
77
8-
If you're having general trouble with your ConvertKit integration, please reach out to support.
8+
If you're having general trouble with your Kit integration, please reach out to support.

‎DEPLOYMENT.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Commit the updated files, which should comprise of:
3535

3636
## Create a New Release
3737

38-
[Create a New Release](https://github.com/ConvertKit/convertkitsdk-php/releases/new), completing the following:
38+
[Create a New Release](https://github.com/kit/convertkitsdk-php/releases/new), completing the following:
3939

4040
- Choose a tag: Click this button and enter the new version number (e.g. `1.0`)
4141
- Release title: The version number (e.g. `1.0`)
@@ -91,4 +91,4 @@ When you're happy with the above, click `Publish Release`.
9191

9292
This will then make the release available to developers, who can include it manually or using composer.
9393

94-
The release will also be available to view on the [Releases](https://github.com/ConvertKit/convertkitsdk-php/releases) section of this GitHub repository.
94+
The release will also be available to view on the [Releases](https://github.com/kit/convertkitsdk-php/releases) section of this GitHub repository.

‎SETUP.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Setup Guide
22

3-
This document describes how to setup your development environment, so that it is ready to run, develop and test the ConvertKit PHP SDK.
3+
This document describes how to setup your development environment, so that it is ready to run, develop and test the Kit PHP SDK.
44

55
Suggestions are provided for the LAMP/LEMP stack and Git client are for those who prefer the UI over a command line and/or are less familiar with
66
PHP, MySQL and Git - but you're free to use your preferred software.

‎TESTING.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,19 @@ If you haven't yet set up your local development environment, refer to the [Setu
1414

1515
If you haven't yet created a branch and made any code changes, refer to the [Development Guide](DEVELOPMENT.md)
1616

17+
### Familiar with PHP Coding Standards, PHPStan and PHPUnit?
18+
19+
The following Composer commands can be used:
20+
21+
| Command | Short Command | Description |
22+
|---------|---------------|-------------|
23+
| `composer php-coding-standards` | `composer phpcs` | Runs PHP Coding Standards on the `/src` folder |
24+
| `composer fix-php-coding-standards` | `composer phpcbf` | Fix PHP files to meet PHP Coding Standards on the `/src` folder |
25+
| `composer php-coding-standards-on-tests` | `composer phpcs-tests` | Runs PHP Coding Standards on the `/tests` folder |
26+
| `composer fix-php-coding-standards-on-tests` | `composer phpcbf-tests` | Fix PHP files to meet PHP Coding Standards on the `/tests` folder |
27+
| `composer static-analysis` | `composer phpstan` | Runs PHPStan static analysis with increased memory limit |
28+
| `composer test` | `composer test` | Builds and runs WPUnit tests |
29+
1730
## Write (or modify) a test
1831

1932
If your work creates new functionality, write a test.

‎composer.json‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
11
{
22
"name": "convertkit/convertkitapi",
3-
"description": "ConvertKit PHP SDK for the ConvertKit API",
3+
"description": "Kit PHP SDK for the Kit API",
44
"keywords": [
55
"convertkit",
6+
"kit",
67
"api",
7-
"forms"
8+
"forms",
9+
"tags",
10+
"sequences",
11+
"broadcasts",
12+
"emails",
13+
"subscribers"
814
],
9-
"homepage": "https://convertkit.com/",
15+
"homepage": "https://developers.kit.com/welcome",
1016
"license": "GPLv3",
1117
"authors": [
1218
{
13-
"name": "ConvertKit and contributors",
14-
"homepage": "https://github.com/convertkit/convertkitsdk-php/contributors"
19+
"name": "Kit and contributors",
20+
"homepage": "https://github.com/kit/convertkitsdk-php/contributors"
1521
}
1622
],
1723
"require": {
@@ -23,7 +29,8 @@
2329
"vlucas/phpdotenv": "^5.5",
2430
"phpunit/phpunit": "^5.7 || ^9.0",
2531
"squizlabs/php_codesniffer": "^3.3",
26-
"phpstan/phpstan": "^2.0"
32+
"phpstan/phpstan": "^2.0",
33+
"saggre/phpdocumentor-markdown": "^1.0"
2734
},
2835
"autoload": {
2936
"psr-4": {
@@ -38,6 +45,17 @@
3845
"minimum-stability": "dev",
3946
"prefer-stable": true,
4047
"scripts": {
41-
"create-docs": "phpDocumentor --directory=src --target=docs --template='vendor/saggre/phpdocumentor-markdown/themes/markdown'"
48+
"create-docs": "phpDocumentor --directory=src --target=docs --template='vendor/saggre/phpdocumentor-markdown/themes/markdown'",
49+
"phpcs": "vendor/bin/phpcs ./ -s -v",
50+
"phpcbf": "vendor/bin/phpcbf ./ -s -v",
51+
"phpcs-tests": "vendor/bin/phpcs ./tests --standard=phpcs.tests.xml -s -v",
52+
"phpcbf-tests": "vendor/bin/phpcbf ./tests --standard=phpcs.tests.xml -s -v",
53+
"phpstan": "vendor/bin/phpstan analyse --memory-limit=1250M",
54+
"php-coding-standards": "vendor/bin/phpcs ./ -s -v",
55+
"fix-php-coding-standards": "vendor/bin/phpcbf ./ -s -v",
56+
"php-coding-standards-on-tests": "vendor/bin/phpcs ./tests --standard=phpcs.tests.xml -s -v",
57+
"fix-php-coding-standards-on-tests": "vendor/bin/phpcbf ./tests --standard=phpcs.tests.xml -s -v",
58+
"php-static-analysis": "vendor/bin/phpstan analyse --memory-limit=1250M",
59+
"test": "vendor/bin/phpunit --verbose --stop-on-failure @additional_args"
4260
}
4361
}

‎docs/Home.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
2+
This is an automatically generated documentation for **Documentation**.
3+
4+
## Namespaces
5+
6+
### \ConvertKit_API
7+
8+
#### Classes
9+
10+
| Class | Description |
11+
|-------------------------------------------------------------|----------------------|
12+
| [`ConvertKit_API`](./classes/ConvertKit_API/ConvertKit_API) | ConvertKit API Class |
13+
14+
#### Traits
15+
16+
| Trait | Description |
17+
|---------------------------------------------------------------------------|-----------------------|
18+
| [`ConvertKit_API_Traits`](./classes/ConvertKit_API/ConvertKit_API_Traits) | ConvertKit API Traits |

0 commit comments

Comments
 (0)