WRestController refactoring

Add Readme
Rename W..Action to WRest..Action

JsonResponse.php

@@ -7,7 +7,7 @@
 
 class JsonResponse extends WRestResponse{
 
-	public function getContentType()
+	protected function _getContentType()
 	{
 		return "application/json";
 	}

README.md

@@ -0,0 +1,245 @@
+Yii Rest Extension
+===================
+
+Extension organize REST API on Yii app 
+
+[Weavora's](http://weavora.com) Git Repo - [https://github.com/weavora/wrest](https://github.com/weavora/wrest)
+
+**Features**:
+
+* Fast configuration
+* Provide simple REST CRUD interface (get, list, update, create, delete actions)
+* CRUD actions integrate with Model scenarios
+
+Configuration
+-----
+
+1) Download and extract source into protected/extensions/ folder.
+
+2) There are config settings for import section below:
+
+```php
+<?php
+// main.php
+return array(
+	...
+	'import' => array(
+		...
+		'ext.wrest.*',
+	),
+	...
+);
+```
+
+3) Add REST routes
+
+```php
+<?php
+// main.php
+...
+'urlManager'=>array(
+	'urlFormat'=>'path',
+	'rules'=>array(
+		...
+		//rest url patterns
+		array('api/<model>/delete', 'pattern'=>'api/<model:\w+>/<_id:\d+>', 'verb'=>'DELETE'),
+		array('api/<model>/update', 'pattern'=>'api/<model:\w+>/<_id:\d+>', 'verb'=>'PUT'),
+		array('api/<model>/list', 'pattern'=>'api/<model:\w+>', 'verb'=>'GET'),
+		array('api/<model>/get', 'pattern'=>'api/<model:\w+>/<_id:\d+>', 'verb'=>'GET'),
+		array('api/<model>/create', 'pattern'=>'api/<model:\w+>', 'verb'=>'POST'),
+		...
+	),
+),
+...
+```
+
+4) All your models must use WRestModelBehavior:
+
+```php
+<?php
+// User.php
+class User extends CActiveRecord{
+	...
+	public function behaviors()
+	{
+		return array(
+			...
+			'RestModelBehavior' => array(
+				'class' => 'WRestModelBehavior',
+			)
+			...
+		);
+	}
+	...
+}
+```
+
+5) Create 'api' folder in /protected/controllers/. Here will be determined all your REST API controllers.
+
+6) Extend all your REST controlles from WRestController instead of Controller.
+
+Usage
+-----
+
+1) Create model, determine relations, behavior etc.
+
+```php
+// User.php
+<?php
+
+class User extends CActiveRecord
+{
+
+	public function tableName()
+	{
+		return "user";
+	}
+
+	public static function model($className = __CLASS__)
+	{
+		return parent::model($className);
+	}
+
+	public function behaviors()
+	{
+		return array(
+			'RestModelBehavior' => array(
+				'class' => 'WRestModelBehavior',
+			)
+		);
+	}
+
+	public function rules(){
+		return array(
+			array('username, password', 'required'),
+			array('email', 'safe'),
+		);
+	}
+
+}
+```
+
+2) Create controller in /protected/controllers/api folder, extend it's from WRestController and define allow rest actions
+
+```php
+<?php 
+// api/UserController.php
+
+class UserController extends WRestController{
+
+	protected $_modelName = "user"; //model to be used as resource
+
+
+	public function actions() //determine which of the standard actions will support the controller
+	{
+		return array(
+			'list' => array( //use for get list of objects
+				'class' => 'WRestListAction',
+				'filterBy' => array( //this param user in `where` expression when forming an db query
+					'account_id' => 'account_id', // 'name_in_table' => 'request_param_name'
+				),
+				'limit' => 'limit', //request parameter name, which will contain limit of object
+				'page' => 'page', //request parameter name, which will contain requested page num
+				'order' => 'order', //request parameter name, which will contain ordering for sort
+			),
+			'delete' => 'WRestDeleteAction',
+			'get' => 'WRestGetAction',
+			'create' => 'WRestCreateAction', //provide 'scenario' param
+			'update' => array(
+				'class' => 'WRestUpdateAction',
+				'scenario' => 'update', //as well as in WRestCreateAction optional param
+		);
+	}
+}
+```
+
+
+Custom action sample
+--------------------
+
+```php
+<?php
+// api/UserController.php
+
+class UserController extends WRestController{
+
+	protected $_modelName = "user"; //model to be used as resource
+
+	...
+
+	public function actionUpdate()
+	{
+		$this->sendResponse(200, array(
+			'method' => 'put',
+			'action' => 'update',
+		));
+	}
+
+	...
+
+}
+```
+
+Use with Access layer filter
+-----------------
+
+For provide access layer for REST actions use [wacf](https://github.com/weavora/yii-wacf)
+
+```php
+<?php
+// api/UserController.php
+
+class UserController extends WRestController
+{
+
+	protected $modelName = "user";
+
+	public function filters()
+	{
+		return array(
+			'accessControl',
+		);
+	}
+
+	public function accessRules()
+	{
+		return array(
+			array(
+				'allow',
+				'actions' => array('get', 'list', 'create'),
+				'roles' => array('member'),
+			),
+			array(
+				'allow',
+				'roles' => array('member'),
+				'actions' => array('delete', 'update'),
+				'resource' => array(
+					'model' => 'User',
+					'params' => 'id',
+					'ownerField' => 'account_id',
+				),
+			),
+			array(
+				'deny',
+			),
+		);
+	}
+
+	public function actions()
+	{
+		return array(
+			'list' => array(
+				'class' => 'ListAction',
+				'filterBy' => array(
+					'account_id' => 'account_id',
+				),
+				'limit' => 'limit',
+			),
+			'delete' => 'DeleteAction',
+			'get' => 'GetAction',
+			'create' => 'CreateAction',
+			'update' => 'UpdateAction',
+		);
+	}
+}
+```

WHttpRequest.php

@@ -10,6 +10,13 @@ class WHttpRequest extends CHttpRequest
 
 	private $_restParams = array();
 
+	/**
+	 * Default response format
+	 * either 'json' or 'xml'
+	 */
+	private $_format = 'json';
+	private $_formatAttributeName = 'format';
+
 	public function getPut($name, $defaultValue = null)
 	{
 		if ($this->_restParams === array())
@@ -79,4 +86,22 @@ public function getParam($name,$defaultValue=null)
 		return $param ? $param : $defaultValue;
 	}
 
+	public function setFormat($format = null)
+	{
+		if ($format && in_array($format, $this->_availableFormats)) {
+			$this->_format = $format;
+		}
+		if (!$this->_format) {
+			//get format from one of requests type
+			$format = Yii::app()->request->getParam($this->_formatAttributeName);
+			$format = (empty($format)) ? Yii::app()->request->getPut($this->_formatAttributeName) : $format;
+			$format = (empty($format)) ? Yii::app()->request->getDelete($this->_formatAttributeName) : $format;
+			$this->_format = $format;
+		}
+	}
+
+	public function getFormat(){
+		return $this->_format;
+	}
+
 }