Initial Commit

.gitignore

@@ -0,0 +1,3 @@
+tests/boot.php
+vendor/*
+composer\.lock

ComodoCACert.cer

@@ -0,0 +1,34 @@
+-----BEGIN CERTIFICATE-----
+MIIF2DCCA8CgAwIBAgIQTKr5yttjb+Af907YWwOGnTANBgkqhkiG9w0BAQwFADCB
+hTELMAkGA1UEBhMCR0IxGzAZBgNVBAgTEkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4G
+A1UEBxMHU2FsZm9yZDEaMBgGA1UEChMRQ09NT0RPIENBIExpbWl0ZWQxKzApBgNV
+BAMTIkNPTU9ETyBSU0EgQ2VydGlmaWNhdGlvbiBBdXRob3JpdHkwHhcNMTAwMTE5
+MDAwMDAwWhcNMzgwMTE4MjM1OTU5WjCBhTELMAkGA1UEBhMCR0IxGzAZBgNVBAgT
+EkdyZWF0ZXIgTWFuY2hlc3RlcjEQMA4GA1UEBxMHU2FsZm9yZDEaMBgGA1UEChMR
+Q09NT0RPIENBIExpbWl0ZWQxKzApBgNVBAMTIkNPTU9ETyBSU0EgQ2VydGlmaWNh
+dGlvbiBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCR
+6FSS0gpWsawNJN3Fz0RndJkrN6N9I3AAcbxT38T6KhKPS38QVr2fcHK3YX/JSw8X
+pz3jsARh7v8Rl8f0hj4K+j5c+ZPmNHrZFGvnnLOFoIJ6dq9xkNfs/Q36nGz637CC
+9BR++b7Epi9Pf5l/tfxnQ3K9DADWietrLNPtj5gcFKt+5eNu/Nio5JIk2kNrYrhV
+/erBvGy2i/MOjZrkm2xpmfh4SDBF1a3hDTxFYPwyllEnvGfDyi62a+pGx8cgoLEf
+Zd5ICLqkTqnyg0Y3hOvozIFIQ2dOciqbXL1MGyiKXCJ7tKuY2e7gUYPDCUZObT6Z
++pUX2nwzV0E8jVHtC7ZcryxjGt9XyD+86V3Em69FmeKjWiS0uqlWPc9vqv9JWL7w
+qP/0uK3pN/u6uPQLOvnoQ0IeidiEyxPx2bvhiWC4jChWrBQdnArncevPDt09qZah
+SL0896+1DSJMwBGB7FY79tOi4lu3sgQiUpWAk2nojkxl8ZEDLXB0AuqLZxUpaVIC
+u9ffUGpVRr+goyhhf3DQw6KqLCGqR84onAZFdr+CGCe01a60y1Dma/RMhnEw6abf
+Fobg2P9A3fvQQoh/ozM6LlweQRGBY84YcWsr7KaKtzFcOmpH4MN5WdYgGq/yapiq
+crxXStJLnbsQ/LBMQeXtHT1eKJ2czL+zUdqnR+WEUwIDAQABo0IwQDAdBgNVHQ4E
+FgQUu69+Aj36pvE8hI6t7jiY7NkyMtQwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB
+/wQFMAMBAf8wDQYJKoZIhvcNAQEMBQADggIBAArx1UaEt65Ru2yyTUEUAJNMnMvl
+wFTPoCWOAvn9sKIN9SCYPBMtrFaisNZ+EZLpLrqeLppysb0ZRGxhNaKatBYSaVqM
+4dc+pBroLwP0rmEdEBsqpIt6xf4FpuHA1sj+nq6PK7o9mfjYcwlYRm6mnPTXJ9OV
+2jeDchzTc+CiR5kDOF3VSXkAKRzH7JsgHAckaVd4sjn8OoSgtZx8jb8uk2Intzna
+FxiuvTwJaP+EmzzV1gsD41eeFPfR60/IvYcjt7ZJQ3mFXLrrkguhxuhoqEwWsRqZ
+CuhTLJK7oQkYdQxlqHvLI7cawiiFwxv/0Cti76R7CZGYZ4wUAc1oBmpjIXUDgIiK
+boHGhfKppC3n9KUkEEeDys30jXlYsQab5xoq2Z0B15R97QNKyvDb6KkBPvVWmcke
+jkk9u+UJueBPSZI9FoJAzMxZxuY67RIuaTxslbH9qh17f4a+Hg4yRvv7E491f0yL
+S0Zj/gA0QHDBw7mh3aZw4gSzQbzpgJHqZJx64SIDqZxubw5lT2yHh17zbqD5daWb
+QOhTsiedSrnAdyGN/4fy3ryM7xfft0kL0fJuMAsaDk527RH89elWsn2/x20Kk4yl
+0MC2Hb46TpSi125sC8KKfPog88Tk5c0NqMuRkrF8hey1FGlmDoLnzc7ILaZRfyHB
+NVOFBkpdn627G190
+-----END CERTIFICATE-----

composer.json

@@ -0,0 +1,27 @@
+{
+	"name": "adamcmoore/insurance-hub",
+    "description": "API wrapper for Insurance Hub, based on https://github.com/Insure-Tech/InsuranceHub.Client.Php",
+    "homepage": "https://smccoachhire.com",
+    "authors": [
+        {
+            "name": "Adam Moore",
+            "email": "[email protected]"
+        }
+    ],
+	"require": {
+		"php": ">=5.3.0"
+	},
+    "require-dev": {
+        "phpunit/phpunit": "^5"
+    },
+	"autoload": {
+		"psr-4": {
+			"InsuranceHub\\": "src"
+		}
+	},
+    "autoload-dev": {
+        "psr-4": {
+            "Tests\\": "tests/"
+        }
+    }
+}

phpunit.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+         backupStaticAttributes="false"
+         bootstrap="tests/boot.php"
+         colors="true"
+         convertErrorsToExceptions="true"
+         convertNoticesToExceptions="true"
+         convertWarningsToExceptions="true"
+         processIsolation="false"
+         stopOnFailure="false">
+    <testsuites>
+        <testsuite name="Offering">
+            <directory suffix="Test.php">./tests</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

src/ApiClient.php

@@ -0,0 +1,58 @@
+<?php 
+namespace InsuranceHub;
+
+use InsuranceHub\Exception\ApiException;
+use InsuranceHub\Exception\ApiAuthenticationException;
+use InsuranceHub\Exception\ApiValidationException;
+
+class ApiClient
+{
+    public $url;
+    public $certificatePath;
+
+    public function __construct($serviceURL, $caCertificatePath) {
+        $this->url = $serviceURL;
+        $this->certificatePath = $caCertificatePath;
+    }
+
+	public function execute($request)
+    {
+        $authToken = new AuthToken($request->vendorId, $request->apiKey);
+
+        $ch = curl_init($this->url);
+
+        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
+        curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($request));
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
+        curl_setopt($ch, CURLOPT_CAINFO, $this->certificatePath);
+        curl_setopt($ch, CURLOPT_HTTPHEADER, [
+            'Content-Type: application/json',
+            'X-InsuranceHub-VendorId: '.$request->vendorId,
+            'X-InsuranceHub-AuthToken: '.$authToken->getToken()]);
+
+        $response = curl_exec($ch);
+
+        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
+
+        switch ($httpCode) {
+            case 401:
+                throw new ApiAuthenticationException();
+            case 403:
+                throw new ApiAuthorisationException();
+            case 400:
+                $validationError = json_decode($response);
+
+                $validationMessages = implode(",", $validationError->validationMessages);
+
+                throw new ApiValidationException($validationMessages);
+            case 500:
+                $apiError = json_decode($response);
+                throw new ApiException($apiError->message);
+        }
+
+        curl_close($ch);
+
+        return array($httpCode, json_decode($response));
+    }
+}

src/AuthToken.php

@@ -0,0 +1,21 @@
+<?php 
+namespace InsuranceHub;
+
+class AuthToken
+{
+    protected $formattedVendorId;
+    protected $formattedApiKey;
+
+	public function __construct($vendorId, $apiKey)
+    {
+        $this->formattedVendorId = str_replace('-', '', strtolower($vendorId));
+        $this->formattedApiKey = str_replace('-', '', strtolower($apiKey));
+    }
+
+    public function getToken()
+    {
+        $date = gmdate('dmY');
+
+        return base64_encode(hash_hmac('sha1', $this->formattedVendorId.$date, $this->formattedApiKey, true));
+    }
+}

src/Exception/ApiAuthenticationException.php

@@ -0,0 +1,10 @@
+<?php 
+namespace InsuranceHub\Exception;
+
+class ApiAuthenticationException extends Exception 
+{
+    public function errorMessage() 
+    {
+        return "Unauthorised request.  Check your Vendor ID and Api Key";
+    }
+}

src/Exception/ApiAuthorisationException.php

@@ -0,0 +1,10 @@
+<?php 
+namespace InsuranceHub\Exception;
+
+class ApiAuthorisationException extends Exception 
+{
+    public function errorMessage() 
+    {
+        return "You do not have access to this service.  Please contact support if you think this is in error.";
+    }
+}

src/Exception/ApiException.php

@@ -0,0 +1,11 @@
+<?php 
+namespace InsuranceHub\Exception;
+
+class ApiException extends Exception 
+{
+	public function errorMessage() 
+	{
+		$error = "InsureHub API Exception : ".$this->getMessage();
+		return $error;
+	}
+}

src/Exception/ApiValidationException.php

@@ -0,0 +1,9 @@
+<?php 
+namespace InsuranceHub\Exception;
+
+class ValidationException extends Exception 
+{
+    public function errorMessage() {
+        return "Invalid Request : ".$this->getMessage();
+    }
+}

src/Exception/Exception.php

@@ -0,0 +1,7 @@
+<?php 
+namespace InsuranceHub\Exception;
+
+abstract class Exception extends \Exception 
+{
+    abstract protected function errorMessage();
+}

src/InsuranceHub.php

@@ -0,0 +1,86 @@
+<?php 
+namespace InsuranceHub;
+
+use InsuranceHub\Exception\ApiException;
+use InsuranceHub\Resource\Request;
+use InsuranceHub\Resource\Result;
+use InsuranceHub\Resource\Product;
+use InsuranceHub\Resource\Sale;
+
+class InsuranceHub
+{
+	protected $vendorId;
+	protected $apiKey;
+	protected $offeringRequestURL;
+	protected $offeringResultURL;
+
+
+	public function __construct($vendorId, $apiKey, $offeringRequestURL, $offeringResultURL)
+	{
+		$this->vendorId            = $vendorId;
+		$this->apiKey              = $apiKey;
+		$this->offeringRequestURL = $offeringRequestURL;
+		$this->offeringResultURL  = $offeringResultURL;
+		$this->certPath            = getcwd()."/ComodoCACert.cer";;
+	}
+
+
+	public function getOffering($products, $reference = null)
+	{
+		$client            = new ApiClient($this->offeringRequestURL, $this->certPath);		
+		$request           = new Request();
+		$request->vendorId = $this->vendorId;
+		$request->apiKey   = $this->apiKey;		
+		$request->products = $products;
+
+		if ($reference) {
+			$request->vendorRequestReference = $reference;
+		}		
+
+		$offering = $client->execute($request)[1];
+
+		return $offering;
+	}
+
+
+	public function sendSaleResult($offering, $reference, $customerFirstName, $customerLastName)
+	{
+		return $this->sendResult($offering, $reference, $customerFirstName, $customerLastName, true);
+	}
+
+
+	public function sendNoSaleResult($offering, $reference, $customerFirstName, $customerLastName)
+	{
+		return $this->sendResult($offering, $reference, $customerFirstName, $customerLastName, false);
+	}
+
+
+	private function sendResult($offering, $reference, $customerFirstName, $customerLastName, $isSale)
+	{
+		$client                      = new ApiClient($this->offeringResultURL, $this->certPath);		
+		$result                      = new Result();
+		$result->vendorId            = $this->vendorId;
+		$result->apiKey              = $this->apiKey;
+		$result->offeringId          = $offering->id;
+		$result->vendorSaleReference = $reference;
+		$result->customerForename    = $customerFirstName;
+		$result->customerSurname     = $customerLastName;
+
+		foreach ($offering->productOfferings as $i => $product) {
+			$sale = new Sale();
+	        $sale->productOfferingId = $product->id;
+	        $sale->sold = $isSale;
+
+	        $result->sales[$i] = $sale;
+	    }
+
+		$responseCode = $client->execute($result)[0];
+
+		// check success reponse code recieved (2xx)
+		if ($responseCode >= 200 && $responseCode < 300) {
+			return true;
+		} else {
+			throw new ApiException('Sending offering Result returned HTTP status code '.$responseCode);
+		}
+	}
+}

src/Resource/Product.php

@@ -0,0 +1,17 @@
+<?php 
+namespace InsuranceHub\Resource;
+
+class Product implements \JsonSerializable
+{
+    public $categoryCode;
+    public $price;
+    public $completionDate;
+
+    public function jsonSerialize() {
+        return [
+            'categoryCode'   => $this->categoryCode,
+            'price'          => $this->price,
+            'completionDate' => $this->completionDate->format(\DateTime::ISO8601),
+        ];
+    }
+}

src/Resource/Request.php

@@ -0,0 +1,20 @@
+<?php 
+namespace InsuranceHub\Resource;
+
+class Request implements \JsonSerializable
+{
+    public $vendorId;
+    public $apiKey;
+    public $vendorRequestReference;
+    public $products;
+    public $premiumAsSummary;
+
+    public function jsonSerialize() {
+        return [
+            'vendorId'               => $this->vendorId,
+            'vendorRequestReference' => $this->vendorRequestReference,
+            'products'               => $this->products,
+            'premiumAsSummary'       => $this->premiumAsSummary,
+        ];
+    }
+}

src/Resource/Result.php

@@ -0,0 +1,24 @@
+<?php 
+namespace InsuranceHub\Resource;
+
+class Result implements \JsonSerializable
+{
+    public $vendorId;
+    public $apiKey;
+    public $offeringId;
+    public $vendorSaleReference;
+    public $customerForename;
+    public $customerSurname;
+    public $sales = [];
+
+    public function jsonSerialize() {
+        return [
+            'vendorId'            => $this->vendorId,
+            'offeringId'          => $this->offeringId,
+            'vendorSaleReference' => $this->vendorSaleReference,
+            'customerForename'    => $this->customerForename,
+            'customerSurname'     => $this->customerSurname,
+            'sales'               => $this->sales,
+        ];
+    }
+}

src/Resource/Sale.php

@@ -0,0 +1,15 @@
+<?php 
+namespace InsuranceHub\Resource;
+
+class Sale implements \JsonSerializable
+{
+    public $productOfferingId;
+    public $sold;
+
+    public function jsonSerialize() {
+        return [
+			'productOfferingId' => $this->productOfferingId,
+			'sold'              => $this->sold,
+        ];
+    }
+}