Merge pull request #58 from ConvertKit/1.0-beta

1.0

Author: n7studios

.env.dist.testing

@@ -0,0 +1,10 @@
+CONVERTKIT_API_BROADCAST_ID="8697158"
+CONVERTKIT_API_FORM_ID="2765139"
+CONVERTKIT_API_LEGACY_FORM_URL="https://app.convertkit.com/landing_pages/470099"
+CONVERTKIT_API_LANDING_PAGE_URL="https://cheerful-architect-3237.ck.page/cc5eb21744"
+CONVERTKIT_API_LEGACY_LANDING_PAGE_URL="https://app.convertkit.com/landing_pages/470103"
+CONVERTKIT_API_SEQUENCE_ID="1030824"
+CONVERTKIT_API_TAG_NAME="wordpress"
+CONVERTKIT_API_TAG_ID="2744672"
+CONVERTKIT_API_SUBSCRIBER_EMAIL="[email protected]"
+CONVERTKIT_API_SUBSCRIBER_ID="1579118532"

.env.example

@@ -0,0 +1,14 @@
+CONVERTKIT_API_KEY_NO_DATA=
+CONVERTKIT_API_SECRET_NO_DATA=
+CONVERTKIT_API_KEY=
+CONVERTKIT_API_SECRET=
+CONVERTKIT_API_BROADCAST_ID="8697158"
+CONVERTKIT_API_FORM_ID="2765139"
+CONVERTKIT_API_LEGACY_FORM_URL="https://app.convertkit.com/landing_pages/470099"
+CONVERTKIT_API_LANDING_PAGE_URL="https://cheerful-architect-3237.ck.page/cc5eb21744"
+CONVERTKIT_API_LEGACY_LANDING_PAGE_URL="https://app.convertkit.com/landing_pages/470103"
+CONVERTKIT_API_SEQUENCE_ID="1030824"
+CONVERTKIT_API_TAG_NAME="wordpress"
+CONVERTKIT_API_TAG_ID="2744672"
+CONVERTKIT_API_SUBSCRIBER_EMAIL="[email protected]"
+CONVERTKIT_API_SUBSCRIBER_ID="1579118532"

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,70 @@
+name: Bug report
+description: Create a report to help us improve
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior
+      placeholder: |
+        1. Fetch a '...'
+        2. Update the '....'
+        3. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: code-snippets
+    attributes:
+      label: Code snippets
+      description: If applicable, add code snippets to help explain your problem.
+      render: PHP
+    validations:
+      required: false
+  - type: input
+    id: os
+    attributes:
+      label: OS
+      placeholder: macOS
+    validations:
+      required: true
+  - type: input
+    id: language-version
+    attributes:
+      label: PHP version
+      placeholder: PHP 8.1
+    validations:
+      required: true
+  - type: input
+    id: lib-version
+    attributes:
+      label: Library version
+      placeholder: v1.0.0
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context about the problem here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: ConvertKit support
+    url: https://convertkit.com/support/
+    about: |
+      Please only file issues here that you believe represent actual bugs or feature requests for the ConvertKit PHP SDK.
+
+      If you're having general trouble with your ConvertKit integration, please reach out to support.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,28 @@
+name: Feature request
+description: Suggest an idea for this PHP SDK
+labels: ["feature-request"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem? Please describe.
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional context
+      description: Add any other context about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,20 @@
+## Summary
+
+A brief description of what this PR adds, changes or fixes.
+
+If it is adding functionality, a use case of why this is needed helps determine its suitability.
+
+## Testing
+
+Not sure how to perform testing, or perhaps didn't include a test in this PR? Walk through the following in order for a beginner-friendly guide:
+- [Setup](SETUP.md) - setting up your local environment for development and testing
+- [Development](DEVELOPMENT.md) - best practices for development
+- [Testing](TESTING.md) - how to write and run tests
+
+## Checklist
+
+* [ ] I have [written a test](TESTING.md#writing-a-test) and included it in this PR
+* [ ] I have [run all tests](TESTING.md#run-tests) and they pass
+* [ ] The code passes when [running the PHP CodeSniffer](TESTING.md#run-php-codesniffer)
+* [ ] The code passes when [running PHPStan](TESTING.md#run-phpstan)
+* [ ] I have assigned a reviewer or two to review this PR (if you're not sure who to assign, we can do this step for you)

.github/docs/coding-standards.png

@@ -0,0 +1,71 @@
+{% block content %}
+# {{ node.name }}
+
+{% if node.summary %}{{ node.summary|raw }}{% endif %}
+{% if node.description %}{{ node.description|raw }}{% endif %}
+
+* Full name: `{{ node.FullyQualifiedStructuralElementName }}`
+{% if node.parent and node.parent is not empty %}* Parent class: {{ macros.mdClassLink(node.parent, macros.mdClassPath(node), node.parent.FullyQualifiedStructuralElementName) }}
+{% endif %}
+{% if node.final %}* This class is marked as **final** and can't be subclassed
+{% endif %}
+{% if node.deprecated %}* **Warning:** this class is **deprecated**. This means that this class will likely be removed in a future version.
+{% endif %}
+{% if node.interfaces is not empty %}
+* This class implements:
+{% for interface in node.interfaces %}
+{% if loop.index0 > 0 %}{{ ', ' }}{% endif %}{{ macros.mdClassLink(interface, macros.mdClassPath(node), interface) }}{% endfor %}
+
+{% endif %}
+{% if node.abstract %}* This class is an **Abstract class**
+{% endif %}
+{% if node.final %}* This class is a **Final class**
+{% endif %}
+
+{% if node.tags.see is not empty or node.tags.link is not empty %}
+**See Also:**
+
+{% for see in node.tags.see %}
+* {{ see.reference }} {% if see.description %}- {{ see.description|raw }}{% endif %}
+
+{% endfor %}
+{% for link in node.tags.link %}
+* {{ link.link }} {% if link.description and link.description != link.link %}- {{ link.description|raw }}{% endif %}
+
+{% endfor %}
+
+{% endif %}{# node.tags.see || node.tags.link #}
+{% if node.constants | length > 0 %}
+## Constants
+
+| Constant | Visibility | Type | Value |
+|:---------|:-----------|:-----|:------|
+{% for constant in node.constants %}
+|`{{constant.name}}`|{{ constant.visibility | default('*default*') }}|{{constant.type | default(' ')}}|{{constant.value}}|
+{% endfor %}
+{% endif %}
+{% if node.properties | length > 0 %}
+## Properties
+
+{% for property in node.properties %}
+{% include 'property.md.twig' %}
+{% endfor %}
+{% endif %}
+{% if node.methods|length > 0 %}
+## Methods
+
+{% for method in node.methods %}
+{% include 'method.md.twig' %}
+{% endfor %}
+{% endif %}{# if methods #}
+
+{% if node.InheritedMethods|length > 0 %}
+## Inherited methods
+
+{% for method in node.InheritedMethods %}
+{% include 'method.md.twig' %}
+{% endfor %}
+
+{% endif %}{# if InheritedMethods #}
+
+{% endblock %}

.github/docs/new-release.png

@@ -0,0 +1,50 @@
+### {{ method.name }}
+
+{{ method.summary | raw }}
+
+{# Method signature #}
+```php
+{% if method.final %}{{ 'final' ~ ' ' }}{% endif %}{{ method.visibility ~ ' ' }}{%if method.static%}{{ 'static' ~ ' ' }}{% endif %}{{ method.name }}({% for argument in method.arguments %}
+{{- argument.type | raw }} 
+{{- argument.byReference ? '&' }} $
+{{- argument.name | raw }}{% if argument.default %} = {{ argument.default | raw }}{% endif %}
+{%- if not loop.last %}, {% endif %}
+{%- endfor %}): {{ method.response.type | raw }}
+```
+{% if method.description %}{{ method.description | raw }}{% endif %}
+{% if method.static %}* This method is **static**.{% endif %}
+{% if method.abstract %}* This method is **abstract**.{% endif %}
+{% if method.final %}* This method is **final**.{% endif %}
+{% if method.deprecated %}* **Warning:** this method is **deprecated**. This means that this method will likely be removed in a future version.
+{% endif %}
+
+{% if method.arguments is not empty %}
+
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+{% for argument in method.arguments %}
+| `{{ '$' ~ argument.name }}` | **{{ argument.type ? argument.type | default(' ') | replace({'|': '\\|'}) | raw }}** | {{ argument.description | replace({'|': '\\|'}) | nl2br | replace({"\n": "", "\r": "", "\t": ""}) | raw }} |
+{% endfor %}
+{% endif %}{# method.arguments is not empty #}
+{% if method.response.description and method.response.description is not empty %}
+
+**Return Value:**
+
+{{ method.response.description | raw }}
+{% endif %}
+
+{% if method.tags.see is not empty or method.tags.link is not empty %}
+**See Also:**
+
+{% for see in method.tags.see %}
+* {{ see.reference }} {% if see.description is not empty %}- {{ see.description | raw }}{% endif %}
+{% endfor %}
+{% for link in method.tags.link %}
+* {{ link.link }} {% if link.description and link.description != link.link %}- {{ link.description | raw }}{% endif %}
+{% endfor %}
+
+{% endif %}{# method.tags.see || method.tags.link #}
+
+---

.github/docs/phpstan.png

@@ -0,0 +1,19 @@
+### {{ property.name }}
+
+{{ property.summary | raw }}
+
+```php
+{{ property.visibility ~ ' ' }}{% if property.static %}{{ 'static' ~ ' ' }}{% endif %}{% if property.type and property.type is not empty %}{{ property.type ~ ' ' }}{% endif %}{{ '$' ~ property.name }}
+```
+
+{% if property.description %}{{ property.description | raw }}{% endif %}
+{% if property.static %}* This property is **static**.{% endif %}
+{% if property.deprecated %}* **Warning:** this property is **deprecated**. This means that this property will likely be removed in a future version.{% endif %}
+{% if property.tags.see is not empty or property.tags.link is not empty %}
+{% for see in property.tags.see %}
+* {{ see.reference }} {% if see.description %}- {{ see.description | raw }}{% endif %}
+{% endfor %}
+{% for link in property.tags.link %}
+* {{ link.link }} {% if link.description and link.description != link.link %}- {{ link.description | raw }}{% endif %}
+{% endfor %}
+{% endif %}

.github/phpdoc-template/class.md.twig

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<template>
+    <name>markdown</name>
+    <author>Sakri Koskimies</author>
+    <email>[email protected]</email>
+    <version>0.0.2</version>
+    <transformations>
+        <transformation writer="twig" query="indexes.classes" source="class.md.twig"
+                        artifact="classes/{{FullyQualifiedStructuralElementName}}.md"/>
+    </transformations>
+    <parameters>
+        <parameter key="twig-debug">true</parameter>
+    </parameters>
+</template>

.github/phpdoc-template/method.md.twig

@@ -0,0 +1,77 @@
+name: Run Tests
+
+# When to run tests.
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+  push:
+    branches:
+      - main
+
+jobs:
+  tests:
+    # Name.
+    name: PHP ${{ matrix.php-versions }}
+
+    # Virtual Environment to use.
+    # @see: https://github.com/actions/virtual-environments
+    runs-on: ubuntu-latest
+
+    # Defines PHP Versions matrix to run tests on
+    strategy:
+      matrix:
+        php-versions: [ '7.4', '8.0', '8.1', '8.2' ]
+
+    # Steps to install, configure and run tests
+    steps:
+      # Checkout (copy) this repository's Plugin to this VM.
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      # Install PHP version
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          coverage: none
+
+      # Write any secrets, such as API keys, to the .env.dist.testing file now.
+      # Make sure your committed .env.dist.testing file ends with a newline.
+      # The formatting of the contents to include a blank newline is deliberate.
+      - name: Define GitHub Secrets in .env.dist.testing
+        uses: DamianReeves/[email protected]
+        with:
+          path: .env.dist.testing
+          contents: |
+
+            CONVERTKIT_API_KEY=${{ secrets.CONVERTKIT_API_KEY }}
+            CONVERTKIT_API_SECRET=${{ secrets.CONVERTKIT_API_SECRET }}
+            CONVERTKIT_API_KEY_NO_DATA=${{ secrets.CONVERTKIT_API_KEY_NO_DATA }}
+            CONVERTKIT_API_SECRET_NO_DATA=${{ secrets.CONVERTKIT_API_SECRET_NO_DATA }}
+          write-mode: append
+
+      # Rename .env.dist.testing to .env, so PHPUnit reads it for tests.
+      - name: Rename .env.dist.testing to .env 
+        run: mv .env.dist.testing .env
+
+      # Installs PHPUnit, PHP CodeSniffer and anything else needed to run tests.
+      - name: Run Composer
+        run: composer update
+
+      # Generate autoloader
+      - name: Build PHP Autoloader
+        run: composer dump-autoload
+
+      # Run Coding Standards.
+      - name: Run Coding Standards
+        run: php vendor/bin/phpcs --standard=phpcs.xml
+
+      # Run Coding Standards on Tests.
+      - name: Run Coding Standards on Tests
+        run: php vendor/bin/phpcs --standard=phpcs.tests.xml
+
+      # Run PHPUnit Tests.
+      - name: Run PHPUnit Tests
+        run: vendor/bin/phpunit --verbose --stop-on-failure