Merge pull request #12 from cyon/composer-and-namespaces

Using composer and PSR-4 namespaces

Author: pierre

.gitignore

@@ -1 +1,4 @@
 .idea
+
+/vendor/
+composer.lock

.travis.yml

@@ -7,4 +7,6 @@ notifications:
   email:
     - kill-bill-commits@googlegroups.com
 
-script: phpunit --coverage-text test
+install: composer install
+
+script: composer test

README.md

@@ -1,56 +1,70 @@
 killbill-client-php
 ===================
 
-PHP client library for killbill
+PHP client library for [Killbill](http://killbill.io)
 
 Configuration
 -------------
 
-In order to user the library, you need to:
+In order to use the library, you need to:
 
-1. Download the library and unzip it in your application
-2. Require the `lib/killbill.php` script
-3. Point the library to your Killbill instance via the `Killbill_Client::$serverUrl` variable (http://127.0.0.1:8080 by default)
+1. Require the library via [composer](https://getcomposer.org): `composer require killbill\killbill-client`
+2. Point the library to your Killbill instance via the `Client::$serverUrl` variable (http://127.0.0.1:8080 by default)
 
 Example
 -------
 
-We have a Killbill instance running at http://cloudkilling.org:8080 you can play with. The following snippet will create an account:
-
-    // Path to the library
-    require_once(dirname(__FILE__) . '/lib/killbill.php');
-    
-    // Killbill server
-    Killbill_Client::$serverUrl = "http://cloudkilling.org:8080";
-
-    // Set these values for your particular tenant
-    $tenant = new Killbill_Tenant();
-    $tenant->apiKey    = 'bob';
-    $tenant->apiSecret = 'lazar';
-    
-    // Unique id for this account
-    $externalAccountId = uniqid();
-    
-    // Prepare the account data
-    $accountData = new Killbill_Account();
-    $accountData->name = "Killbill php test";
-    $accountData->externalKey = $externalAccountId;
-    $accountData->email = "test-" . $externalAccountId . "@kill-bill.org";
-    $accountData->currency = "USD";
-    $accountData->paymentMethodId = null;
-    $accountData->address1 = "12 rue des ecoles";
-    $accountData->address2 = "Poitier";
-    $accountData->company = "Renault";
-    $accountData->state = "Poitou";
-    $accountData->country = "France";
-    $accountData->phone = "81 53 26 56";
-    $accountData->length = 4;
-    $accountData->billCycleDay = 12;
-    $accountData->timeZone = "UTC";
-    
-    // Create it
-    $createdAccount = $accountData->create("pierre", "PHP_TEST", "Test for " . $externalAccountId, $tenant->getTenantHeaders());
+The following snippet will create an account:
 
+```php
+<?php
+
+use \Killbill\Client\Client;
+use \Killbill\Client\Tenant;
+use \Killbill\Client\Account;
+
+// Killbill server
+Client::$serverUrl = "http://localhost:8080";
+
+// Set these values for your particular tenant
+$tenant = new Tenant();
+$tenant->apiKey    = 'bob';
+$tenant->apiSecret = 'lazar';
+
+// Unique id for this account
+$externalAccountId = uniqid();
+
+// Prepare the account data
+$accountData = new Account();
+$accountData->name = "Killbill php test";
+$accountData->externalKey = $externalAccountId;
+$accountData->email = "test-" . $externalAccountId . "@kill-bill.org";
+$accountData->currency = "USD";
+$accountData->paymentMethodId = null;
+$accountData->address1 = "12 rue des ecoles";
+$accountData->address2 = "Poitier";
+$accountData->company = "Renault";
+$accountData->state = "Poitou";
+$accountData->country = "France";
+$accountData->phone = "81 53 26 56";
+$accountData->length = 4;
+$accountData->billCycleDay = 12;
+$accountData->timeZone = "UTC";
+
+// Create it
+$createdAccount = $accountData->create("pierre", "PHP_TEST", "Test for " . $externalAccountId, $tenant->getTenantHeaders());
+```
+
+Using the client in a non-composer environment
+----------------------------------------------
+
+If you want to use the client but are not using [Composer](https://getcomposer.org) (yet), follow these steps:
+
+- Install composer locally: [Instruction](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx)
+- Run `composer require killbill/killbill-client`. This will download the library into the `vendor/` folder and create a `composer.json` and a `composer.lock` file that define this dependency.
+- Include the auto-generated `autoload.php` file from the `vendor/` folder.
+- You can now use the client like above described.
+- If you don't want to have an additional build step, just check the `vendor/` folder into your repository.
 
 Requirements
 ------------
@@ -61,4 +75,4 @@ The PHP library requires PHP 5.3.0 or greater with _libcurl_ compiled (e.g. you
 Support
 -------
 
-Feel free to ask questions on the [killbilling-users](https://groups.google.com/forum/?fromgroups#!forum/killbilling-users) Google Group.
+Feel free to ask questions on the [killbilling-users](https://groups.google.com/forum/?fromgroups#!forum/killbilling-users) Google Group.

composer.json

@@ -0,0 +1,23 @@
+{
+  "name": "killbill/killbill-client",
+  "description": "Official PHP client to the Killbill HTTP API",
+  "type": "library",
+  "autoload": {
+    "psr-4": {
+      "Killbill\\Client\\": "src/"
+    }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "Killbill\\Client\\": "test/"
+    }
+  },
+  "scripts": {
+    "test": "phpunit"
+  },
+  "license": "Apache",
+  "require": {},
+  "require-dev": {
+      "phpunit/phpunit": "^4.8"
+  }
+}

lib/killbill.php

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<phpunit>
+<phpunit bootstrap="vendor/autoload.php">
     <testsuite name='Kill Bill PHP client test suite'>
-        <directory suffix='_test.php'>./test</directory>
+        <directory suffix='Test.php'>./test</directory>
     </testsuite>
 </phpunit>