Merge branch 'master' of git://github.com/philsturgeon/codeigniter-restserver

Author: sekati

README.md

@@ -3,11 +3,9 @@
 A fully RESTful server implementation for CodeIgniter using one library, one
 config file and one controller.
 
-## Sponsored by: Coding Futures
-
 ## Requirements
 
-1. PHP 5.2+
+1. PHP 5.2 or greater
 2. CodeIgniter 2.1.0 to 3.0-dev
 
 _Note: for 1.7.x support download v2.2 from Downloads tab_
@@ -53,7 +51,7 @@ This means your URLs can look like this:
 	http://example.com/books.json
 	http://example.com/books?format=json
 
-Alternatively (and recommend) is using the HTTP `Accept` header, which is built for this purpose:
+This can be flaky with URI segments, so the recommend approach is using the HTTP `Accept` header:
 
 	$ curl -H "Accept: application/json" http://example.com
 
@@ -85,19 +83,19 @@ If you don't specify a response code, and the data you respond with `== FALSE` (
 
 ## Multilingual Support
 
-If your application uses language files to support multiple locales, `REST_Controller` will automatically parse the HTTP `Accept-Language` header and provide the language(s) in your actions. This information can be found in the `$this->request->lang` object:
+If your application uses language files to support multiple locales, `REST_Controller` will automatically parse the HTTP `Accept-Language` header and provide the language(s) in your actions. This information can be found in the `$this->response->lang` object:
 
 	public function __construct()
 	{
 		parent::__construct();
 
-		if (is_array($this->request->lang))
+		if (is_array($this->response->lang))
 		{
-			$this->load->language('application', $this->request->lang[0]);
+			$this->load->language('application', $this->response->lang[0]);
 		}
 		else
 		{
-			$this->load->language('application', $this->request->lang);
+			$this->load->language('application', $this->response->lang);
 		}
 	}
 
@@ -148,11 +146,27 @@ By default, the HTTP will be `X-API-KEY`. This can be configured in **config/res
 
 ## Change Log
 
+### 2.6.2
+
+* Update CodeIgniter files to 2.1.3
+* Fixed issue #165
+
+### 2.6.1
+
+* Update CodeIgniter files to 2.1.2
+* Log Table support for IPv6 & NULL parameters
+* Abstract out the processes of firing a controller method within _remap() to an separate method
+* Moved GET, POST, PUT, and DELETE parsing to separate methods, allowing them to be overridden as needed
+* Small bugfix for a PHP 5.3 strlen error
+* Fixed some PHP 5.4 warnings
+* Fix for bug in Format.php's to_html() which failed to detect if $data was really a multidimensional array.
+* Fix for empty node on XML output format, for false = 0, true = 1.
+
 ### 2.6.0
 
 * Added loads of PHPDoc comments.
 * Response where method doesn't exist is now "HTTP 405 Method Not Allowed", not "HTTP 404 Not Found".
-* Compatable with PHP 5.4.
+* Compatible with PHP 5.4.
 * Added support for gzip compression.
 * Fix the apache\_request\_header function with CGI.
 * Fixed up correctly .foo extensions to work when get arguments provided.
@@ -198,7 +212,12 @@ By default, the HTTP will be `X-API-KEY`. This can be configured in **config/res
 * key => FALSE can now be used to override the keys_enabled option for a specific method, and level is now optional. If no level is set it will assume the method has a level of 0.
 * Fixed issue where calls to ->get('foo') would error is foo was not set. Reported by  Paul Barto.
 
-## Donations
+## Contributions
+
+This project has been funded and made possible through my clients kindly allowing me to 
+open-source the functionality as I build it into their projects. I am no longer actively developing 
+features for this as I no longer require it, but I will continue to maintain pull requests and try to 
+fix issues as and when they are reported (within a week or two). 
 
-If my REST Server has helped you out, or you'd like me to do some custom work on it, [please sponsor me](http://pledgie.com/campaigns/8328)
-so I can keep working on this and other CodeIgniter projects for you all.
+Pull Requests are the best way to fix bugs or add features. I know loads of you use this, so please 
+contribute if you have improvements to be made and I'll keep releasing versions over time.

application/config/ldap.php

@@ -0,0 +1,21 @@
+<?php
+
+$config['binduser'] = 'cn=Authentication,ou=Services,dc=example,dc=org';
+$config['basedn'] = 'dc=example,dc=org';
+$config['bindpw'] = 'E984asdy2';
+
+/*
+ * The host name parameter can be a space separated list of host names.
+ * This means that the LDAP code will talk to a backup server if the main server is not operational.
+ * There will be a delay while the code times out trying to talk to the main server but things will still work.
+*/
+
+$config['server'] = 'ldapserver1.example.org ldapserver2.example.org';
+$config['port'] = NULL;
+
+/*
+ * Controls the LDAP_OPT_NETWORK_TIMEOUT option, this is how long the code will attempt to talk to the primary server if it is unreachable.
+ */
+
+$config['timeout'] = 5;
+?>

application/config/rest.php

@@ -1,5 +1,17 @@
 <?php defined('BASEPATH') OR exit('No direct script access allowed');
 
+/*
+|--------------------------------------------------------------------------
+| HTTP protocol
+|--------------------------------------------------------------------------
+|
+| Should the service accept only HTTPS requests or not?
+|
+|	Default: FALSE
+|
+*/
+$config['force_https'] = FALSE;
+
 /*
 |--------------------------------------------------------------------------
 | REST Format
@@ -49,6 +61,18 @@
 */
 $config['rest_auth'] = false;
 
+/*
+|--------------------------------------------------------------------------
+| REST Login
+|--------------------------------------------------------------------------
+|
+| Is login required and if so, which user store do we use?
+|
+| '' = use config based users, 'ldap' = use LDAP authencation
+|
+*/
+$config['auth_source'] = 'ldap';
+
 /*
 |--------------------------------------------------------------------------
 | Override auth types for specific class/method
@@ -77,7 +101,7 @@
 | REST Login usernames
 |--------------------------------------------------------------------------
 |
-| Array of usernames and passwords for login
+| Array of usernames and passwords for login, if ldap is configured this is ignored
 |
 |	array('admin' => '1234')
 |
@@ -156,13 +180,26 @@
 	  `key` varchar(40) NOT NULL,
 	  `level` int(2) NOT NULL,
 	  `ignore_limits` tinyint(1) NOT NULL DEFAULT '0',
+	  `is_private_key` tinyint(1)  NOT NULL DEFAULT '0',
+	  `ip_addresses` TEXT NULL DEFAULT NULL,
 	  `date_created` int(11) NOT NULL,
 	  PRIMARY KEY (`id`)
 	) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 |
 */
 $config['rest_enable_keys'] = FALSE;
 
+/*
+|--------------------------------------------------------------------------
+| REST Table Key Column Name
+|--------------------------------------------------------------------------
+|
+| If you are not using the default table schema as shown above, what is the 
+| name of the db column that holds the api key value?
+|
+*/
+$config['rest_key_column'] = 'key';
+
 /*
 |--------------------------------------------------------------------------
 | REST Key Length
@@ -290,4 +327,4 @@
 $config['rest_ajax_only'] = FALSE;
 
 /* End of file config.php */
-/* Location: ./system/application/config/rest.php */
+/* Location: ./system/application/config/rest.php */