Initial Commit

Author: phpfui

.gitattributes

@@ -0,0 +1,7 @@
+# no binary files in this repo and store all files with LF line endings.
+
+# for windows do the following:
+# git config --global core.eol native
+# git config --global core.autocrlf true
+
+* text=auto

.gitignore

@@ -0,0 +1,14 @@
+vendor/
+.idea/
+bin/
+src/PHPFUI/PHPUnitSyntaxCoverage
+src/PHPFUI/MySQLSlowQuery
+src/PHPFUI/HTMLUnitTester
+src/PHPFUI/InstaDoc
+src/PHPFUI/PayPal/PayPal.md
+src/PHPFUI/README.md
+composer.lock
+.php-cs-fixer.cache
+.phpunit.result.cache
+phpunit.xml
+

.php-cs-fixer.dist.php

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project owner. They will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CODE_OF_CONDUCT.md

@@ -0,0 +1,18 @@
+Copyright 2021 Bruce K. Wells
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions: The
+above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

LICENSE

@@ -0,0 +1,76 @@
+# ConstantContact [![Build Status](https://api.travis-ci.com/phpfui/constantcontact.png?branch=master)](https://api.travis-ci.com/phpfui/constantcontact) [![Latest Packagist release](https://img.shields.io/packagist/v/phpfui/constantcontact.svg)](https://packagist.org/packages/phpfui/phpfui)
+
+PHP Object Oriented wrapper for the Constant Contact V3 API.
+
+**PHPFUI/ConstantContact** is a [modern](#php-versions) PHP library that tracks the latest changes to the Constant Contact API.
+
+**PHPFUI/ConstantContact** reads the [YAML](https://api.cc.email/v3/swagger.yaml) file from the Constant Contact documentation and generates PHP classes directly from the YAML file. The library is auto updated nightly. This means the library is always up to date with the latest changes. See the [versioning](#Versioning) section for further details.
+
+## Namespaces
+This library normalizes the [Constant Contact API](https://v3.developer.constantcontact.com/api_guide/index.html) to modern PHP class standards.  All endpoints are first character capitialized. Underscores are removed and followed by a capital letter. Each end point is a class with methods matching the standard REST methods (ie. put, post, delete, put, etc.).  The methods take required and optional parameters matching the name specified in the Constant Contact YAML API.  In addition, this library supports all definitions of types in the API.  See below.
+
+Due to a mistake in naming conventions by Constant Contact API designers, several end points are duplicated between the end point that returns all objects, and the end point that just works with one object. Normally this is dealt with by using the singular form of the noun for CRUD type operations on a single object, and the plural noun form returns a list of objects. This library follows the correct naming convention (single nouns for CRUD and plural nouns for collections) and not the Constant Contact naming convention.
+
+## Definitions
+This Constant Contact API defines all types of objects to interact with the API. They are defined in the **PHPFUI\ConstantContact\Definition** namespace. Only valid fields are allowed to be accessed. Types are fully validated as to the best ability of PHP.  Min and max lengths are enforced for strings.
+
+## Usage Once Authorized (see below)
+```PHP
+// Create a client
+$client = new \PHPFUI\ConstantContact\Client($apiKey, $secret, $redirectURI);
+// Set access and refresh tokens on client
+$client->accessToken = $accessTokenFromDatabase;
+$client->refreshToken = $refreshTokenFromDatabase;
+// Refresh the tokens.  This should be done on a regular (daily) basis so the token does not expire.
+$client->refreshToken();
+// save $client->accessToken and $client->refreshToken to database.
+
+// $client is now ready to use
+$listEndPoint = new \PHPFUI\ConstantContact\V3\ContactLists($client);
+$lists = $listEndPoint->get();
+print_r($lists);
+```
+
+## Constant Contact Setup
+In order to use this library, you will need to set up Constant Contact correctly. Go to [Constant Contact API](https://app.constantcontact.com) and create an application. Get an *API Key* and *Secret* and save it off for the **\PHPFUI\ConstantContact\Client** constructor.  You will also need to set up and add a *Redirect URI*. You can use https://localhost if you want to authorize manually, but it is recommended to allow your users to authorize directly.  The *Redirect URI* will receive a code that you will need to authorize the app, and then store the generated access token and refresh token.  You should also provide the URL to your site's App logo.  This will be shown to your user when they authenticate the app. They will need to sign into Constant Contact if they have not already done so. Fill out the other information as appropriate, but it is for informational purposes only.
+
+## Authorization Control Flow
+You will need to set up a web page where your user can enter the *API Key* and *Secret*.  You should also provide an **"Authorize"** button if the API returns an error, meaning it was not authorized. This allows the user to control the authorization process. Authorization needs to be done interactively.  The user will have to log in to Constant Contact and then authorize the application. Once this is done, the app can run in the background and refresh the token daily and it should not expire or need to be reauthorized as long as the Secret has not been changed.  Change the secret to require reauthorization.
+
+## The Authorization control flow is as follows:
+
+1. Create a Client with the API Key and Secret and specify a Redirect URI which will receive a code from Constant Contact.
+2. Redirect to $client->getAuthorizationURL(); User will authorize and redirected back to the $redirectURI you provide.
+3. Retrieve the code and save access and refresh tokens for later use.  Redirect back to where ever.
+
+### 1. Create A Client
+```php
+$client = new \PHPFUI\ConstantContact\Client($apiKey, $secret, $tokenURL);
+// set any scopes here, defaults to all scopes. Your user will need to accept what ever scopes you specify.
+```
+### 2. Redirect to Authorization URL
+```php
+\header('location: ' . $client->getAuthorizationURL());
+```
+The above will ask the user to authorize the app for the scopes you specified.  The default is all scopes, but you can specify different scopes after constructing the client and before you authorize.
+
+### 3. Retrieve the Code sent to the $redirectURI
+```php
+$client->acquireAccessToken($_GET['code']);
+// Save $client->accessToken and $client->refreshToken to the database
+// redirect back to where ever
+```
+
+You should now be authorized to use the API.  Make sure you save and restore the access token and refresh tokens every time you access the API.
+
+## Versioning
+Since the [Constant Contact API](https://v3.developer.constantcontact.com/api_guide/index.html) is constantly being updated, this library will track all updates on a calendar based versioning schema. The major version will be the last two digits of the year the update was released. The minor version will be the month it was released. Any bug fixes will be a patch version.  So V21.8.0 would be the first August 2021 version, and V21.8.1 would be a bug fix to V21.8.  All bug fixes will be included in subsequent versions, so V21.9.0 would include all fixes from the V21.8 version. YAML changes are tracked nightly and a new version will be generated automatically. Multiple YAML changes in a month will be tracked as patch versions.
+
+## Documentation
+Via [PHPFUI/InstaDoc](http://www.phpfui.com/?PHPFUI\ConstantContact)
+
+## License
+**PHPFUI/ConstantContact** is distributed under the MIT License.
+
+### PHP Versions
+This library only supports PHP 8.0 and higher versions of PHP. While we would love to support PHP from the late Ming Dynasty, the advantages of modern PHP versions far out weigh quaint notions of backward compatibility. Time to upgrade.

README.md

@@ -0,0 +1,161 @@
+<?php
+
+/**
+ * This file is part of the PHPFUI\ConstantContact package
+ *
+ * (c) Bruce Wells
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source
+ * code
+ */
+class DefinitionTest extends \PHPUnit\Framework\TestCase
+	{
+
+	public function testGetSet() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$integer = 123;
+		$fixture->integer = $integer;
+		$this->assertEquals($integer, $fixture->integer);
+		$this->assertIsInt($fixture->integer);
+
+		$string = 'A long string';
+		$fixture->string = $string;
+		$this->assertEquals($string, $fixture->string);
+		$this->assertIsString($fixture->string);
+
+		$boolean = true;
+		$fixture->boolean = $boolean;
+		$this->assertEquals($boolean, $fixture->boolean);
+		$this->assertIsBool($fixture->boolean);
+
+		$array = [1, 2, 3];
+		$fixture->array = $array;
+		$this->assertEquals($array, $fixture->array);
+		$this->assertIsArray($fixture->array);
+
+		$float = 1.23;
+		$fixture->float = $float;
+		$this->assertEquals($float, $fixture->float);
+		$this->assertIsFloat($fixture->float);
+
+		$string = 'primary_email';
+		$fixture->enum = $string;
+		$this->assertEquals($string, $fixture->enum);
+		$this->assertIsString($fixture->enum);
+
+		$integer = 1;
+		$fixture->intEnum = $integer;
+		$this->assertEquals($integer, $fixture->intEnum);
+		$this->assertIsInt($fixture->intEnum);
+
+		$string = 'REMOVED';
+		$fixture->ucEnum = $string;
+		$this->assertEquals($string, $fixture->ucEnum);
+		$this->assertIsString($fixture->ucEnum);
+
+		$class = new \Tests\Fixtures\ClassTest();
+		$fixture->class = $class;
+		$this->assertEquals($class, $fixture->class);
+		$this->assertIsObject($fixture->class);
+
+		$json = $fixture->getJSON();
+		$expectedJSON ='{
+    "class": {},
+    "integer": 123,
+    "string": "A long string",
+    "boolean": true,
+    "array": [
+        1,
+        2,
+        3
+    ],
+    "float": 1.23,
+    "enum": "primary_email",
+    "intEnum": 1,
+    "ucEnum": "REMOVED"
+}';
+		// normalize line endings
+		$expectedJSON = str_replace("\r\n", "\n", $expectedJSON);
+		$this->assertEquals($expectedJSON, $json);
+		}
+
+	public function testBadField() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidField::class);
+		$fixture->badField = 'test';
+		}
+
+	public function testBadIntType() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidType::class);
+		$fixture->integer = 'test';
+		}
+
+	public function testBadStringType() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidType::class);
+		$fixture->string = 123;
+		}
+
+	public function testBadFloatType() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidType::class);
+		$fixture->float = 'abc';
+		}
+
+	public function testBadBooleanType() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidType::class);
+		$fixture->boolean = 0;
+		}
+
+	public function testBadArrayType() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidType::class);
+		$fixture->array = 0;
+		}
+
+	public function testBadClassType() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidType::class);
+		$fixture->class = new \DateTime();
+		}
+
+	public function testBadEnum() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidValue::class);
+		$fixture->enum = 'fred';
+		}
+
+	public function testMinLength() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidLength::class);
+		$fixture->string = 'fred';
+		}
+
+	public function testMaxLength() : void
+		{
+		$fixture = new \Tests\Fixtures\TypeTest();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidLength::class);
+		$fixture->string = str_pad('', 100);
+		}
+
+	public function testGeneratedClass() : void
+		{
+		$fixture = new \PHPFUI\ConstantContact\Definition\EmailCampaignActivity();
+		$this->expectException(\PHPFUI\ConstantContact\Exception\InvalidType::class);
+		$fixture->physical_address_in_footer = new \DateTime();
+		}
+
+	}

Tests/DefinitionTest.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Tests\Fixtures;
+
+class ClassTest
+	{
+
+	}

Tests/Fixtures/ClassTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Tests\Fixtures;
+
+class TypeTest extends \PHPFUI\ConstantContact\Definition\Base
+	{
+
+	protected static array $fields = [
+		'boolean' => 'bool',
+		'integer' => 'int',
+		'string' => 'string',
+		'enum' => ['primary_email', 'permalink', 'resend'],
+		'array' => 'array',
+		'float' => 'float',
+		'ucEnum' => ['DRAFT', 'SCHEDULED', 'EXECUTING', 'DONE', 'ERROR', 'REMOVED'],
+		'intEnum' => [1, 2, 3, 4, 5],
+		'class' => 'Tests\\Fixtures\\ClassTest',
+	];
+
+	protected static array $minLength = [
+		'string' => 10,
+	];
+
+	protected static array $maxLength = [
+		'string' => 50,
+	];
+
+	}

Tests/Fixtures/TypeTest.php

@@ -0,0 +1,19 @@
+<?php
+
+/**
+ * This file is part of the PHPFUI package
+ *
+ * (c) Bruce Wells
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source
+ * code
+ */
+class SyntaxTest extends \PHPFUI\PHPUnitSyntaxCoverage\Extensions
+	{
+	public function testDirectory() : void
+		{
+		$this->assertValidPHPDirectory(PROJECT_ROOT . '/src', 'src directory has an error');
+		$this->assertValidPHPDirectory(PROJECT_ROOT . '/Tools', 'Tools directory has an error');
+		}
+	}