blob: 3c7580317dcaa8224cccf83d7d09b6720e91534a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
<?php
namespace SparkPost;
use Ivory\HttpAdapter\Configuration;
use Ivory\HttpAdapter\HttpAdapterInterface;
class SparkPost {
public $transmission;
/**
* @dec connection config for making requests.
*/
private $config;
/**
* @desc Ivory\HttpAdapter\HttpAdapterInterface to make requests through.
*/
public $httpAdapter;
/**
* @desc Default config values. Passed in values will override these.
*/
private static $apiDefaults = [
'host'=>'api.sparkpost.com',
'protocol'=>'https',
'port'=>443,
'strictSSL'=>true,
'key'=>'',
'version'=>'v1'
];
/**
* @desc sets up httpAdapter and config
*
* Sets up instances of sub libraries.
*
* @param Ivory\HttpAdapter $httpAdapter - An adapter for making http requests
* @param String | Array $settingsConfig - Hashmap that contains config values
* for the SDK to connect to SparkPost. If its a string we assume that
* its just they API Key.
*/
public function __construct($httpAdapter, $settingsConfig) {
//config needs to be setup before adapter because of default adapter settings
$this->setConfig($settingsConfig);
$this->setHttpAdapter($httpAdapter);
$this->transmission = new Transmission($this);
}
/**
* Creates an unwrapped api interface for endpoints that aren't yet supported.
* The new resource is attached to this object as well as returned
* @return SparkPost\APIResource - the unwrapped resource
*/
public function setupUnwrapped ($endpoint) {
$this->{$endpoint} = new APIResource($this);
$this->{$endpoint}->endpoint = $endpoint;
return $this->{$endpoint};
}
/**
* @desc Merges passed in headers with default headers for http requests
*/
public function getHttpHeaders() {
$defaultOptions = [
'Authorization' => $this->config['key'],
'Content-Type' => 'application/json',
];
return $defaultOptions;
}
/**
* @desc Helper function for getting the configuration for http requests
* @return \Ivory\HttpAdapter\Configuration
*/
private function getHttpConfig($config) {
// get composer.json to extract version number
$composerFile = file_get_contents(dirname(__FILE__) . '/../../composer.json');
$composer = json_decode($composerFile, true);
// create Configuration for http adapter
$httpConfig = new Configuration();
$baseUrl = $config['protocol'] . '://' . $config['host'] . ($config['port'] ? ':' . $config['port'] : '') . '/api/' . $config['version'];
$httpConfig->setBaseUri($baseUrl);
$httpConfig->setUserAgent('php-sparkpost/' . $composer['version']);
return $httpConfig;
}
/**
* @desc Validates and sets up the httpAdapter
* @param $httpAdapter Ivory\HttpAdapter\HttpAdapterInterface to make requests through.
* @throws \Exception
*/
public function setHttpAdapter($httpAdapter) {
if (!$httpAdapter instanceOf HttpAdapterInterface) {
throw new \Exception('$httpAdapter paramter must be a valid Ivory\HttpAdapter');
}
$this->httpAdapter = $httpAdapter;
$this->httpAdapter->setConfiguration($this->getHttpConfig($this->config));
}
/**
* Allows the user to pass in values to override the defaults and set their API key
* @param String | Array $settingsConfig - Hashmap that contains config values
* for the SDK to connect to SparkPost. If its a string we assume that
* its just they API Key.
* @throws \Exception
*/
public function setConfig($settingsConfig) {
// if the config map is a string we should assume that its an api key
if (is_string($settingsConfig)) {
$settingsConfig = ['key'=>$settingsConfig];
}
// Validate API key because its required
if (!isset($settingsConfig['key']) || empty(trim($settingsConfig['key']))){
throw new \Exception('You must provide an API key');
}
$this->config = self::$apiDefaults;
// set config, overriding defaults
foreach ($settingsConfig as $configOption => $configValue) {
if(key_exists($configOption, $this->config)) {
$this->config[$configOption] = $configValue;
}
}
}
}
?>
|
