Merge pull request #8 from anyarms/master

Added composer.json and adapted readme to reflect

.gitignore

@@ -161,3 +161,9 @@ pip-log.txt
 
 # Mac crap
 .DS_Store
+
+# Composer stuff
+Samples/composer.json
+Samples/vendor/
+Samples/composer.lock
+vendor/

README.md

@@ -5,29 +5,10 @@ This is a PHP sample demonstrating the [AvaTax REST API](http://developer.avalar
  [tax/get POST](http://developer.avalara.com/api-docs/rest/tax/post/), [tax/get GET](http://developer.avalara.com/api-docs/rest/tax/get), [tax/cancel POST](http://developer.avalara.com/api-docs/rest/tax/cancel), and [address/validate GET](http://developer.avalara.com/api-docs/rest/address-validation).
 
  For more information on the use of these methods and the AvaTax product, please visit our [developer site](http://developer.avalara.com/) or [homepage](http://www.avalara.com/)
-
-Contents:
-----------
-
-<table>
-<th colspan="2" align=left>Sample Files</th>
-<tr><td>CancelTaxTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/tax/cancel">CancelTax</a> method used to <a href="http://developer.avalara.com/api-docs/api-reference/canceltax">void a document</a>.</td></tr>
-<tr><td>EstimateTaxTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/tax/get">EstimateTax</a> method used for product- and line- indifferent tax estimates.</td></tr>
-<tr><td>GetTaxTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/tax/post">GetTax</a> method used for product- and line- specific <a href="http://developer.avalara.com/api-docs/api-reference/gettax">calculation</a>.</td></tr>
-<tr><td>PingTest.php</td><td>Uses a hardcoded EstimateTax call to test connectivity and credential information.</td></tr>
-<tr><td>ValidateAddressTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/address-validation">ValidateAddress</a> method to <a href="http://developer.avalara.com/api-docs/api-reference/address-validation">normalize an address</a>.</td></tr>
-<th colspan="2" align=left>Other Files</th>
-<tr><td>AvaTaxClasses/</td><td>Contains the core classes that make the service calls.</td></tr>
-<tr><td>.gitattributes</td><td>-</td></tr>
-<tr><td>.gitignore</td><td>-</td></tr>
-<tr><td>LICENSE.md</td><td>-</td></tr>
-<tr><td>README.md</td><td>-</td></tr>
-</table>
 
 Dependencies:
 -----------
-- PHP 5.3 or later
-- Not tested on versions older than PHP 5.3
+- PHP 5.3 or later (not tested on versions older than PHP 5.3)
 
 Requirements:
 ----------
@@ -44,4 +25,36 @@ for your system, uncomment ONE of the following two options in that file:
 		//    To set the path manually, uncomment the following two lines. If you choose to manually set the path, make sure you have commented out the line above 
 		//    that tells curl to NOT use SSL.
 		//$ca = "C:/curl/curl-ca-bundle.crt";
-		//curl_setopt($curl, CURLOPT_CAINFO, $ca);
+		//curl_setopt($curl, CURLOPT_CAINFO, $ca);
+
+- If you would like to use these core classes as part of a project and manage your depencies through [composer](https://getcomposer.org/), the Avatax classes can be added to your existing project by adding
+```
+    "repositories": [
+        {
+            "type": "vcs",
+            "url": "https://github.com/avadev/AvaTax-Calc-REST-PHP"
+        }
+    ],
+    "require": {
+        "avalara/avatax": "*"
+    }
+```
+to your composer.json file and run `php composer.phar update` from your command line.
+
+Contents:
+----------
+
+<table>
+<th colspan="2" align=left>Sample Files</th>
+<tr><td>CancelTaxTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/tax/cancel">CancelTax</a> method used to <a href="http://developer.avalara.com/api-docs/api-reference/canceltax">void a document</a>.</td></tr>
+<tr><td>EstimateTaxTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/tax/get">EstimateTax</a> method used for product- and line- indifferent tax estimates.</td></tr>
+<tr><td>GetTaxTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/tax/post">GetTax</a> method used for product- and line- specific <a href="http://developer.avalara.com/api-docs/api-reference/gettax">calculation</a>.</td></tr>
+<tr><td>PingTest.php</td><td>Uses a hardcoded EstimateTax call to test connectivity and credential information.</td></tr>
+<tr><td>ValidateAddressTest.php</td><td>Demonstrates the <a href="http://developer.avalara.com/api-docs/rest/address-validation">ValidateAddress</a> method to <a href="http://developer.avalara.com/api-docs/api-reference/address-validation">normalize an address</a>.</td></tr>
+<th colspan="2" align=left>Other Files</th>
+<tr><td>AvaTaxClasses/</td><td>Contains the core classes that make the service calls.</td></tr>
+<tr><td>.gitattributes</td><td>-</td></tr>
+<tr><td>.gitignore</td><td>-</td></tr>
+<tr><td>LICENSE.md</td><td>-</td></tr>
+<tr><td>README.md</td><td>-</td></tr>
+</table>

CancelTaxTest.php → Samples/CancelTaxTest.php

@@ -1,11 +1,12 @@
 <?php
-require('AvaTaxClasses/AvaTax.php');
+require('../AvaTaxClasses/AvaTax.php');
+include 'configuration.php';
 
 // Header Level Elements
 // Required Header Level Elements
-$serviceURL = "https://development.avalara.net";
-$accountNumber = "1234567890";
-$licenseKey = "A1B2C3D4E5F6G7H8";
+$serviceURL = $configuration['serviceURL'];
+$accountNumber = $configuration['accountNumber'];
+$licenseKey = $configuration['licenseKey'];
 
 $taxSvc = new TaxServiceRest($serviceURL, $accountNumber, $licenseKey);
 $cancelTaxRequest = new CancelTaxRequest();

EstimateTaxTest.php → Samples/EstimateTaxTest.php

@@ -1,11 +1,12 @@
 <?php
-require('AvaTaxClasses/AvaTax.php');
+require('../AvaTaxClasses/AvaTax.php');
+include 'configuration.php';
 
 // Header Level Elements
 // Required Header Level Elements
-$serviceURL = "https://development.avalara.net";
-$accountNumber = "1234567890";
-$licenseKey = "A1B2C3D4E5F6G7H8";
+$serviceURL = $configuration['serviceURL'];
+$accountNumber = $configuration['accountNumber'];
+$licenseKey = $configuration['licenseKey'];
 
 $taxSvc = new TaxServiceRest($serviceURL, $accountNumber, $licenseKey);
 

GetTaxTest.php → Samples/GetTaxTest.php

@@ -1,11 +1,12 @@
 <?php
-require('AvaTaxClasses/AvaTax.php');
+require('../AvaTaxClasses/AvaTax.php');
+include 'configuration.php';
 
 // Header Level Elements
 // Required Header Level Elements
-$serviceURL = "https://development.avalara.net";
-$accountNumber = "1234567890";
-$licenseKey = "A1B2C3D4E5F6G7H8";
+$serviceURL = $configuration['serviceURL'];
+$accountNumber = $configuration['accountNumber'];
+$licenseKey = $configuration['licenseKey'];
 
 $taxSvc = new TaxServiceRest($serviceURL, $accountNumber, $licenseKey);
 $getTaxRequest = new GetTaxRequest();

PingTest.php → Samples/PingTest.php

@@ -1,11 +1,12 @@
 <?php
-require('AvaTaxClasses/AvaTax.php');
+require('../AvaTaxClasses/AvaTax.php');
+include 'configuration.php';
 
 // Header Level Elements
 // Required Header Level Elements
-$serviceURL = "https://development.avalara.net";
-$accountNumber = "1234567890";
-$licenseKey = "A1B2C3D4E5F6G7H8";
+$serviceURL = $configuration['serviceURL'];
+$accountNumber = $configuration['accountNumber'];
+$licenseKey = $configuration['licenseKey'];
 
 $taxSvc = new TaxServiceRest($serviceURL, $accountNumber, $licenseKey);
 

ValidateAddressTest.php → Samples/ValidateAddressTest.php

@@ -1,11 +1,12 @@
 <?php
-require('AvaTaxClasses/AvaTax.php');
+require('../AvaTaxClasses/AvaTax.php');
+include 'configuration.php';
 
 // Header Level Elements
 // Required Header Level Elements
-$serviceURL = "https://development.avalara.net";
-$accountNumber = "1234567890";
-$licenseKey = "A1B2C3D4E5F6G7H8";
+$serviceURL = $configuration['serviceURL'];
+$accountNumber = $configuration['accountNumber'];
+$licenseKey = $configuration['licenseKey'];
 
 $addressSvc = new AddressServiceRest($serviceURL, $accountNumber, $licenseKey);
 $address = new Address();

Samples/configuration.php

@@ -0,0 +1,8 @@
+<?php
+
+$configuration = Array();
+$configuration['accountNumber'] = "1234567890";
+$configuration['licenseKey'] = "A1B2C3D4E5F6G7H8";
+$configuration['serviceURL'] = "https://development.avalara.net";    
+
+?>

composer.json

@@ -0,0 +1,9 @@
+{
+    "name": "avalara/avatax",
+    "version": "14.4.2",
+    "description": "A set of classes to assist with integration to the Avalara AvaTax REST API.",
+    "require": {
+        "php": ">=5.3.0"
+    },
+    "minimum-stability": "dev"
+}