Updated Core and documented it a bit better. The beginnings of auth s…

…hell are there.

classes/auth/sleepy.php

@@ -0,0 +1,25 @@
+<?php defined('SYSPATH') or die('No direct script access.');
+
+class Auth_Sleepy extends Auth
+{
+	public function construct()
+	{
+
+	}
+
+	protected function _login($username, $password, $remember)
+	{
+
+	}
+
+	public function password($username)
+	{
+
+	}
+
+	public function check_password($password)
+	{
+
+	}
+
+}

classes/sleepy.php

@@ -1,8 +1,11 @@
 <?php defined('SYSPATH') or die('No direct script access.');
 
 /**
-* Sleepy
-*/
+ * Sleepy Restful Modeling
+ *
+ * @package Sleepy
+ * @author Merrick Christensen
+ */
 class Sleepy extends Sleepy_Core
 {
 

classes/sleepy/core.php

@@ -1,5 +1,11 @@
 <?php defined('SYSPATH') or die('No direct script access.');
 
+/**
+ * Sleepy Restful Modeling
+ *
+ * @package Sleepy
+ * @author Merrick Christensen
+ */
 class Sleepy_Core extends Model {
 
 	private $_decoded_response;
@@ -13,33 +19,84 @@ class Sleepy_Core extends Model {
 
 	protected $_status = Sleepy_Core::STATE_NEW;
 
-	public function __construct()
+	/**
+	 * Constructor, if you don't pass a url it will fall back
+	 * to the Sleep configuration. This is useful if you plan
+	 * on working with more then one RESTful service.
+	 *
+	 * @param string $url 
+	 * @author Merrick Christensen
+	 */
+	public function __construct($url = NULL)
 	{
-		$this->_data_url = Kohana::config('sleepy.url').$this->_data_url;
+		if($url === NULL)
+		{
+			$this->_data_url = Kohana::config('sleepy.url').$this->_data_url;
+		}
+		else
+		{
+			$this->_data_url = $url.$this->_data_url;
+		}
 	}
 
-	public function load($url = NULL)
+	/**
+	 * Take a request, execute it. If it is successful return the response.
+	 * Otherwise throw an exception.
+	 *
+	 * @param string $request 
+	 * @return object Request response
+	 * @author Merrick Christensen
+	 */
+	public function execute($request)
 	{
-		$request = $this->get_request($url);
 		$response = $request->execute();
 
-		$this->response = $response;
-
 		if($response->status() === 200)
 		{
-			return $this->load_data($response->body());
+			$this->_decoded_response = json_decode($response);
+			return $response;
 		}
 		else
-		{	
-			throw new Kohana_Exception('Sleepy Request Failed, :response', array(':response', $response));
+		{
+			throw new Kohana_Exception('Sleepy Request Failed, :response', array(':response', $response), '');
 		}
 	}
 
-	protected function load_data($data)
+	/**
+	 * Load in data from the rest service and parse it into $_data.
+	 *
+	 * @param string $url 
+	 * @return void
+	 * @author Merrick Christensen
+	 */
+	public function load($url = NULL)
+	{
+		$request = $this->get_request($url);
+		$response = $this->execute($request);
+
+		$this->load_data(); // No need to pass data pulls from instance variable
+
+	}
+
+	/**
+	 * Loads either passed JSON or instance decoded JSON to the objects $_data.
+	 *
+	 * @param string JSON $data 
+	 * @return this
+	 * @author Merrick Christensen
+	 */
+	public function load_data($data = NULL)
 	{
-		$decoded = json_decode($data);
 
-		$this->_decoded_response = $decoded;
+		if($data !== NULL)
+		{
+			$decoded = json_decode($data);
+			$this->_decoded_response = $decoded;
+		}
+		else
+		{
+			$decoded = $this->_decoded_response;
+		}
 
 		foreach($decoded as $key => $value)
 		{
@@ -64,29 +121,42 @@ public function update($url = NULL)
 		$request = $this->get_request($this->_data_url.$url);
 		$request->method('POST');
 		$request->post($this->_data);
-		$response = $request->execute();
+
+		$response = $this->execute($request);
+
+		$this->load_data();
 
 		$this->_status = Sleepy_Core::STATE_LOADED;
 	}
 
+	/**
+	 * Generates request and posts the variables to the service.
+	 * Used to create new items on the Restful service.
+	 * Calls to set $_data to returned values.
+	 *
+	 * @param string $url 
+	 * @return this
+	 * @author Merrick Christensen
+	 */
 	public function create($url = NULL)
 	{
 		$request = $this->get_request($this->_data_url.$url);
 		$request->method('POST');
-
 		$request->post($this->_data);
-		$response = $request->execute();
+		$response = $this->execute($request);
 
-		if($response->status() === 200)
-		{
-			return $this->load_data($response->body());
-		}
-		else
-		{
-			throw new Kohana_Exception('Sleepy Request Failed, :response', array(':response' => $response));
-		}
+		return $this;
 	}
 
+	/**
+	 * Used to set data from client use, generally used to set values
+	 * from form fields.
+	 *
+	 * @param array $data 
+	 * @param array $keys 
+	 * @return this
+	 * @author Merrick Christensen
+	 */
 	public function set_fields(array $data, array $keys = NULL)
 	{
 		if(is_array($keys))
@@ -102,11 +172,24 @@ public function set_fields(array $data, array $keys = NULL)
 		return $this;
 	}
 
+	/**
+	 * Check if Sleepy status is loaded.
+	 *
+	 * @return void
+	 * @author Merrick Christensen
+	 */
 	public function loaded()
 	{
 		return $this->_status === Sleepy_Core::STATE_LOADED;
 	}
 
+	/**
+	 * Generate a request form the sleepy urls.
+	 *
+	 * @param string $url 
+	 * @return Request
+	 * @author Merrick Christensen
+	 */
 	private function get_request($url = NULL)
 	{
 		if($url === NULL)
@@ -117,11 +200,24 @@ private function get_request($url = NULL)
 		return Request::factory($url);
 	}
 
+	/**
+	 * Return the last parsed JSON response.
+	 *
+	 * @return void
+	 * @author Merrick Christensen
+	 */
 	public function response()
 	{
 		return $this->_decoded_response;
 	}
 
+	/**
+	 * Get a value by key from data.
+	 *
+	 * @param string $key 
+	 * @return value
+	 * @author Merrick Christensen
+	 */
 	public function __get($key)
 	{
 		if (array_key_exists($key, $this->_data))
@@ -132,6 +228,14 @@ public function __get($key)
 		throw new Kohana_Exception('Field '.$key.' does not exist in '.get_class($this).'!', array(), '');
 	}
 
+	/**
+	 * Set data by key value.
+	 *
+	 * @param string $key 
+	 * @param string $value 
+	 * @return void
+	 * @author Merrick Christensen
+	 */
 	public function __set($key, $value)
 	{
 		if (array_key_exists($key, $this->_data))
@@ -143,11 +247,26 @@ public function __set($key, $value)
 
 	}
 
+	/**
+	 * isset any of the data properties.
+	 *
+	 * @param string $name 
+	 * @return void
+	 * @author Merrick Christensen
+	 */
 	public function __isset($name)
 	{
 		return isset($this->_data[$name]);
 	}
 
+	/**
+	 * Method doesn't exist try it on the restful service.
+	 *
+	 * @param string $name 
+	 * @param string $arguments 
+	 * @return void
+	 * @author Merrick Christensen
+	 */
 	public function __call($name, $arguments)
 	{	
 		$request = $this->get_request($this->_data_url.$name);
@@ -163,6 +282,12 @@ public function __call($name, $arguments)
 		return $response;
 	}
 
+	/**
+	 * Return data.
+	 *
+	 * @return void
+	 * @author Merrick Christensen
+	 */
 	public function as_array()
 	{
 		return $this->_data;