Add composer support, update readme and minor tweaks - tag 1.0.0

Author: chrisbarr

.gitignore

@@ -1,2 +1,4 @@
 .tmp*
 .DS_Store*
+.idea/
+vendor/

README.md

@@ -1,38 +1,51 @@
-# Amazon SNS PHP API v0.5.1 Documentation #
+# Amazon SNS PHP API v1.0.0 Documentation
+
 This API wrapper is a lightweight alternative to the official [Amazon aws-sdk-for-php](http://aws.amazon.com/sdkforphp) for access to Amazon SNS (Simple Notification Service) using PHP
 
 Find out more about Amazon SNS here - http://aws.amazon.com/sns
 
 To use this wrapper you must be using PHP5 with cURL, and have an [Amazon AWS account](http://aws.amazon.com)
 
-## Basic Use ##
-Download the latest version: https://github.com/chrisbarr/AmazonSNS-PHP-API/tarball/master
-
-Include the class on your page:
-
-	include('lib/amazonsns.class.php');
-
-Create a connection to the API:
+## Basic Use
+Install using [Composer](https://getcomposer.org/) on the command line:
+```
+$ composer require chrisbarr/amazon-sns-php-api
+```
 
-	$AmazonSNS = new AmazonSNS(AMAZON_ACCESS_KEY_ID, AMAZON_SECRET_ACCESS_KEY);
+Or add it to your composer.json file:
 
-Create a Topic:
+```
+{
+	...
+	"require": {
+		"chrisbarr/amazon-sns-php-api": "~1.0"
+	}
+}
+```
 
-	$topicArn = $AmazonSNS->createTopic('My New SNS Topic');
+Example usage:
 
-Set the Topic's Display Name (required):
+```php
+<?php
+require 'vendor/autoload.php';
 
-	$result = $AmazonSNS->setTopicAttributes($topicArn, 'DisplayName', 'My SNS Topic Display Name');
+// Create an instance
+$AmazonSNS = new AmazonSNS(AMAZON_ACCESS_KEY_ID, AMAZON_SECRET_ACCESS_KEY);
 
-Subscribe to this topic:
+// Create a Topic
+$topicArn = $AmazonSNS->createTopic('My New SNS Topic');
 
-	$AmazonSNS->subscribe($topicArn, 'email', 'example@github.com');
+// Set the Topic's Display Name (required)
+$AmazonSNS->setTopicAttributes($topicArn, 'DisplayName', 'My SNS Topic Display Name');
 
-And send a message to subscribers of this topic:
+// Subscribe to this topic
+$AmazonSNS->subscribe($topicArn, 'email', 'example@github.com');
 
-	$AmazonSNS->publish($topicArn, 'Hello, world!');
+// And send a message to subscribers of this topic
+$AmazonSNS->publish($topicArn, 'Hello, world!');
+```
 
-## API Methods ##
+## API Methods
 Available methods:
 
 * `addPermission($topicArn, $label, $permissions)`
@@ -55,25 +68,25 @@ To set the API region (US-EAST-1, US-WEST-1, EU-WEST-1, AP-SE-1, AP-NE-1 or SA-E
 
 *The default API region is US-EAST-1*
 
-## Advanced Use ##
-A more complex example demonstrating catching Exceptions:
-
-	<?php
-	include('lib/amazonsns.class.php');
-	$AmazonSNS = new AmazonSNS(AMAZON_ACCESS_KEY_ID, AMAZON_SECRET_ACCESS_KEY);
-	$AmazonSNS->setRegion('EU-WEST-1');
-	
-	try
-	{
-		$topics = $AmazonSNS->listTopics();
-	}
-	catch(SNSException $e)
-	{
-		// Amazon SNS returned an error
-		echo 'SNS returned the error "' . $e->getMessage() . '" and code ' . $e->getCode();
-	}
-	catch(APIException $e)
-	{
-		// Problem with the API
-		echo 'There was an unknown problem with the API, returned code ' . $e->getCode();
-	}
+## Further Example
+Make sure to catch Exceptions where necessary:
+
+```php
+<?php
+require 'vendor/autoload.php';
+
+$AmazonSNS = new AmazonSNS(AMAZON_ACCESS_KEY_ID, AMAZON_SECRET_ACCESS_KEY);
+$AmazonSNS->setRegion('EU-WEST-1');
+
+try {
+	$topics = $AmazonSNS->listTopics();
+}
+catch(SNSException $e) {
+	// Amazon SNS returned an error
+	echo 'SNS returned the error "' . $e->getMessage() . '" and code ' . $e->getCode();
+}
+catch(APIException $e) {
+	// Problem with the API
+	echo 'There was an unknown problem with the API, returned code ' . $e->getCode();
+}
+```

composer.json

@@ -0,0 +1,21 @@
+{
+  "name": "chrisbarr/amazon-sns-php-api",
+  "type": "library",
+  "description": "Amazon SNS PHP API",
+  "homepage": "https://github.com/chrisbarr/AmazonSNS-PHP-API",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Chris Barr",
+      "email": "chris.barr@ntlworld.com"
+    }
+  ],
+  "require": {
+    "php": ">=5.2"
+  },
+  "autoload": {
+    "psr-0": {
+      "AmazonSNS": "lib/"
+    }
+  }
+}

lib/amazonsns.class.php lib/AmazonSNS.phplib/amazonsns.class.php renamed to lib/AmazonSNS.php

@@ -3,16 +3,15 @@
 /**
  * Lightweight API interface with the Amazon Simple Notification Service
  *
- * @author Chris Barr
+ * @author Chris Barr <chris.barr@ntlworld.com>
  * @link http://aws.amazon.com/sns/
  * @link http://docs.amazonwebservices.com/sns/latest/api/
- * @version 0.5.1
  */
 class AmazonSNS {
 	/** @var string $access_key */
-	private $access_key = '';
+	private $access_key;
 	/** @var string $secret_key */
-	private $secret_key = '';
+	private $secret_key;
 
 	/** @var string $protocol */
 	private $protocol = 'https://'; // http is allowed
@@ -33,23 +32,20 @@ class AmazonSNS {
 	/**
 	 * Instantiate the object - set access_key and secret_key and set default region
 	 *
-	 * @param string|null $access_key [optional]
-	 * @param string|null $secret_key [optional]
+	 * @param string $access_key
+	 * @param string $secret_key
+	 * @param string $region [optional]
 	 * @throws InvalidArgumentException
 	 */
-	public function __construct($access_key = null, $secret_key = null) {
-		if(!is_null($access_key)) {
-			$this->access_key = $access_key;
-		}
-		if(!is_null($secret_key)) {
-			$this->secret_key = $secret_key;
-		}
+	public function __construct($access_key, $secret_key, $region = 'US-EAST-1') {
+		$this->access_key = $access_key;
+		$this->secret_key = $secret_key;
 
 		if(empty($this->access_key) || empty($this->secret_key)) {
 			throw new InvalidArgumentException('Must define Amazon access key and secret key');
 		}
 
-		$this->setRegion('US-EAST-1');
+		$this->setRegion($region);
 	}
 
 	/**