Merge pull request #1 from PortoSpire/ghmaster

-- push of initial version to github

README.md

@@ -0,0 +1,37 @@
+<img src="https://img.shields.io/github/v/release/PortoSpire/suiteCRMClient" /> <img src="https://img.shields.io/github/languages/code-size/PortoSpire/suiteCRMClient" /> <img src="https://img.shields.io/github/license/PortoSpire/suiteCRMClient" />
+# Client library for use with SuiteCRM
+A free (LGPL3) client library for use with SuiteCRM to abstract various API usage to enable easier integrations.
+<a href="https://suitecrm.com/"><img src="https://assets.portospire.com/psf/img/suite_icon.png" alt="SuiteCRM" width="182" /></a>
+
+<a href="https://www.portospire.com/">Provided by PortoSpire 
+    <img src="https://assets.portospire.com/psf/img/portospire%20header.svg" alt="PortoSpire - be seen" width="182" /></a>
+
+[Introduction](#introduction)
+[Setup](#setup)
+[Usage](#usage)
+* [Mezzio](#mezzio)
+* [Laminas MVC](#laminasmvc)
+* [Standalone](#standalone)
+
+
+## <a name="introduction" href="#introduction">Introduction</a>
+This package provides a SuiteCRM client to abstract API calls and form submissions to provide and receive 
+data from SuiteCRM instances. It makes use of Person Form campaigns and both the V8 and rest APIs as needed.
+
+## <a name="setup" href="#setup">Setup</a>
+Install libraries
+> composer install
+
+## <a name="usage" href="#usage">Usage</a>
+This package is built to support zend-expressive and zend-framework 2/3 as well 
+as be available as a stand alone library. 
+
+### <a name="mezzio" href="#mezzio">Mezzio</a>
+Add the ConfigProvider class to the config aggregator (typically found in config.php)
+> \PortoSpire\SuiteCRM\ConfigProvider::class,
+
+### <a name="laminasmvc" href="#laminasmvc">Laminas MVC</a>
+Add the module to the module config (typically found in APP_DIR/config/modules.config.php)
+> SuiteCRM
+
+### <a name="standalone" href="#standalone">Standalone</a>

_config.yaml

@@ -0,0 +1 @@
+theme: jekyll-theme-slate

composer.json

@@ -0,0 +1,37 @@
+{
+    "name": "portospire/suitecrmclient",
+    "description": "A free client library for use with SuiteCRM to abstract the various API usage to enable easier integrations provided by PortoSpire",
+    "license": "GNU LGPLv3",
+    "keywords": [
+        "portospire",
+        "SuiteCRM",
+        "SuiteCRM api v8",
+        "SuiteCRM rest api",
+        "SuiteCRM person form",
+        "SuiteCRM web to lead form"
+    ],
+    "homepage": "https://www.portospire.com/",
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "require": {
+        "php": "^7.0",
+        "guzzlehttp/guzzle": "^6.3"
+    },
+    "autoload": {
+        "psr-4": {
+            "PortoSpire\\SuiteCRMClient\\": "src/"
+        }
+    },
+
+    "scripts": {
+    },
+    "config": {
+        "preferred-install": "dist"
+    },
+    "suggest": {
+        "laminas/laminas-log": "A psr-3 log-implementation provider"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.4"
+    }
+}

config/module.config.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Description of module.config
+ * 
+ * PHP version 7
+ * 
+ * * * License * * * 
+ * Copyright (C) 2019 PortoSpire, LLC.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301  USA
+ * * * End License * * * 
+ * 
+ * @category  CategoryName
+ * @package   PackageName
+ * @author    Andrew Wallace <andrew.wallace@portospire.com>
+ * @copyright 2019 PORTOSPIRE
+ * @license   LGPL 3
+ * @version   GIT: $ID$
+ * @link      https://portospire.com 
+ */
+
+/*
+ * Returns module configuration for Zend Expressive and Zend Framework 2/3
+ */
+return [
+    'service_manager' => [
+        'factories' => [
+            PortoSpire\SuiteCRMClient\Service\SuiteCrm::class => PortoSpireSuiteCRMClient\Service\SuiteCrmFactory::class,
+        ]
+    ]
+];

doc/index.html

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<!--
+Copyright (C) 2021 andrewwallace.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 3 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+MA 02110-1301  USA
+-->
+<html>
+    <head>
+        <title>SuiteCRMClient</title>
+        <meta charset="UTF-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    </head>
+    <body>
+        <div>TODO write content</div>
+    </body>
+</html>