anich/chomp

A framework for consumption only REST APIs

dev-master 2016-06-08 03:01 UTC

Requires

• php: >=5.5.0
• guzzlehttp/guzzle: ~6.0

Requires (Dev)

• mockery/mockery: dev-master
• phpunit/phpunit: 4.6.*

MIT

• Alexander Nicholson

README

Chomp is a Library for extending consumption-only RESTful APIs.

Installation via Composer

$ composer require anich/chomp dev-master

Basic Usage

// YourResource.php
<?php

namespace Your\Namespace;

class YourResource extends \ANich\Chomp\Resource
{
    protected $baseUri = 'http://link/to/your/api.com/api/v1/resources/';
}

// OtherFile.php
<?php

require('vendor/autoload.php');

$chomp = new Chomp;
$resource = $chomp->get('\Your\Namespace\YourResource', '1');

echo $resource->id; // 1
echo $resource->title; // Lorem Title.
echo $resource->body; // Lorem ipsum dolor sit amet, consectetur...

Modifiers

// YourResource.php
<?php

namespace Your\Namespace;

class YourResource extends \ANich\Chomp\Resource
{
    protected $baseUri = 'http://link/to/your/api.com/api/v1/resources/';
    
    public function titleModifier($title);
    {
    	return 'Title: '.$title;
	}
}

// OtherFile.php
<?php

require('vendor/autoload.php');

$chomp = new Chomp;
$resource = $chomp->get('\Your\Namespace\YourResource', '1');

echo $resource->title; // Title: Lorem Title.

(Name your modifiers: fieldModifier)

Running Tests

vendor/bin/phpunit tests

or

composer test

Contributing

Please see CONTRIBUTING

Changelog

Please see CHANGELOG

License

This library is licensed under the MIT license. Please see LICENSE