Initial commit.

Author: John O

.gitignore

@@ -0,0 +1,5 @@
+/vendor
+composer.lock
+/.idea
+/tests/_support/_generated
+.env

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 PICR
+
+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.

README.md

@@ -0,0 +1,198 @@
+# php-autopilothq
+
+A php library for interacting with AutopilotHQ API http://docs.autopilot.apiary.io/#.
+
+## Installation
+
+```sh
+$ composer require picr/php-autopilothq
+```
+
+Create an `.env` file
+```env
+AUTOPILOT_SECRET=your-secret-key
+```
+
+## Usage
+---
+All interaction occurs in the `AutopilotManager` class.
+
+### initialize manager
+```php
+// NOTE: AUTOPILOT_SECRET must be defined in .env file
+// NOTE: if AUTOPILOT_HOST is not defined in .env file, will use 'https://api2.autopilothq.com/v1/'
+$manager = new AutopilotManager();
+```
+
+### getContact
+```php
+$manager->getContact($id|$email);
+```
+
+### saveContact
+```php
+$manager->saveContact(AutopilotContact $contact);
+```
+
+### saveContacts
+```php
+$manager->saveContacts(array $contacts);
+```
+
+### deleteContact
+```php
+$manager->deleteContact($id|$email);
+```
+
+### unsubscribeContact
+```php
+$manager->unsubscribeContact($id|$email);
+```
+
+### subscribeContact
+```php
+$manager->subscribeContact($id|$email);
+```
+
+### updateContactEmail
+```php
+$manager->updateContactEmail($oldEmail, $newEmail);
+```
+
+### getAllLists
+```php
+$manager->getAllLists();
+```
+
+### createList
+```php
+$manager->createList($list);
+```
+
+### getListByName
+```php
+$manager->getListByName($list);
+```
+
+### deleteList
+```php
+//TODO: AutopilotHQ hasn't implemented this yet
+$manager->deleteList($list);
+```
+
+### getAllContactsInList
+```php
+$manager->getAllContactsInList($list);
+```
+
+### addContactToList
+```php
+$manager->addContactToList($list, $id|$email);
+```
+
+### removeContactFromList
+```php
+$manager->removeContactFromList($list, $id|$email);
+```
+
+### checkContactInList
+```php
+$manager->checkContactInList($list, $id|$email);
+```
+
+### allTriggers
+```php
+$manager->allTriggers();
+```
+
+### addContactToJourney
+```php
+$manager->addContactToJourney($journey, $id|$email);
+```
+
+## AutopilotContact
+---
+### get value
+```php
+// magic method
+$value = $contact->$name;
+// getter
+$value = $contact->getFieldValue($name);
+```
+
+### set value
+```php
+// magic method
+$contact->$name = $value;
+// setter
+$contact->setFieldValue($name, $value);
+```
+
+### unset value
+```php
+// magic method
+unset($contact->$name);
+// method
+$contact->unsetFieldValue($name);
+```
+
+### isset value
+```php
+// magic method
+isset($contact->$name);
+// method
+$contact->issetFieldValue($name);
+```
+
+### getAllContactLists
+```php
+//NOTE: this only reads cached "lists" array returned for a "contact info" request
+$contact->getAllContactLists();
+```
+
+### hasList
+```php
+//NOTE: this only reads cached "lists" array returned for a "contact info" request
+$contact->hasList($list);
+```
+
+### fill
+```php
+// read array of values and populate properties
+// NOTE: automatically formats attributes according to AutopilotHQ's "naming convention" (doesn't really exist)
+$contact->fill([
+    'firstName' => 'John',
+    'lastName'  => 'Smith',
+    'age'       => 42,
+]);
+```
+
+### toRequest
+```php
+// return array ready to be pushed to the API
+$user = $contact->toRequest();
+```
+
+### toArray
+```php
+// return array of [ property => value ] no matter if custom or defined field
+$user = $contact->toArray();
+/* [
+ *    'firstName' => 'John',
+ *    'lastName'  => 'Smith',
+ *    'age'       => 42,
+ * ]
+ */
+```
+
+### jsonSerialize
+```php
+// json representation of "toArray()"
+$user = $contact->jsonSerialze();
+$user = json_encode($contact);
+```
+
+License
+---
+
+MIT

codeception.yml

@@ -0,0 +1,10 @@
+actor: Tester
+paths:
+    tests: tests
+    log: tests/_output
+    data: tests/_data
+    support: tests/_support
+settings:
+    bootstrap: _bootstrap.php
+    colors: true
+    memory_limit: 1024M

composer.json

@@ -0,0 +1,30 @@
+{
+    "name": "picr/php-autopilothq",
+    "type": "library",
+    "description": "PHP wrapper for interacting with the AutopilotHQ API.",
+    "homepage": "https://github.com/finicprint/php-autopilothq",
+    "keywords": ["picr", "autopilothq", "autopilot"],
+    "version": "0.0.9",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "John O",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">=5.5.9",
+        "guzzlehttp/guzzle": "~6.0",
+        "vlucas/phpdotenv": "~1.0"
+    },
+    "require-dev": {
+        "codeception/codeception": "~2.1.",
+        "codeception/aspect-mock": "dev-master"
+    },
+    "autoload": {
+        "psr-4": {
+            "Autopilot\\": "src/",
+            "Tests\\": "tests/"
+        }
+    }
+}