README

Library for writing RESTful PHP clients.

The design of this library was heavily influenced by Httpful.

Requirements

Please use appropriately tagged github issues to request features or report bugs.

You can install using composer, a phar package or from source. Note that RESTful is PSR-0 compliant:

If you don't have Composer install it:

$ curl -s https://getcomposer.org/installer | php

Add this to your composer.json:

{
    "require": {
        "balanced/restful": "*"
    }
}

Refresh your dependencies:

$ php composer.phar update

Then make sure to require the autoloader and initialize both:

<?php
require(__DIR__ . '/vendor/autoload.php');

Httpful\Bootstrap::init();
RESTful\Bootstrap::init();
...

Download an Httpful phar file, which are all here:

$ curl -s -L -o httpful.phar https://github.com/downloads/nategood/httpful/httpful.phar

Download a RESTful phar file, which are all here:

$ curl -s -L -o restful.phar https://github.com/balanced/restful/downloads/restful-{VERSION}.phar

And then include both:

<?php
include(__DIR__ . '/httpful.phar');
include(__DIR__ . '/restful.phar');
...

Download Httpful source:

$ curl -s -L -o httpful.zip https://github.com/nategood/httpful/zipball/master;
$ unzip httpful.zip; mv nategood-httpful* httpful; rm httpful.zip

Download the RESTful source:

$ curl -s -L -o restful.zip https://github.com/balanced/restful/zipball/master
$ unzip restful.zip; mv balanced-restful-* restful; rm restful.zip

And then require both bootstrap files:

<?php
require(__DIR__ . "/httpful/bootstrap.php")
require(__DIR__ . "/restful/bootstrap.php")
...

TODO

$ phpunit --bootstrap vendor/autoload.php tests/

Ensure that all tests pass
Increment minor VERSION in src/RESTful/Settings and composer.json (git commit -am 'v{VERSION} release')
Tag it (git tag -a v{VERSION} -m 'v{VERSION} release')
Push the tag (git push --tag)
Packagist will see the new tag and take it from there
Build (build-phar) and upload a phar file