Finalized transition to object oriented structure, minor adjustments to framework, added docs, added base unit tests, added tools to build package

Author: Jared Hendrickson

pfSense-pkg-API/docs/CONTRIBUTING.md docs/CONTRIBUTING.mdpfSense-pkg-API/docs/CONTRIBUTING.md renamed to docs/CONTRIBUTING.md

@@ -29,7 +29,7 @@ changes will be made available upon the next release.
 Coding Conventions
 ------------------
 Make an attempt to match the format of existing code. The basic conventions are:
-- Comments are recommended as long as they are brief, meaningful, and short
+- Comments are recommended as long as they are brief, meaningful, and non-intrusive
 - Variables should be defined using snake case (e.g. snake_case)
 - Functions should be defined using snake case (e.g. snake_case())
 - Constants should be defined using upper snake case (e.g. SNAKE_CASE)
@@ -45,7 +45,7 @@ a few different components. It is strongly recommended that you familiarize your
 diving into creating endpoints. To get started writing your own endpoints, please follow the steps below:
 
 ### Things to Know ###
- - The API is based on REST principals. Unfortunately, pfSense does not allow any custom changes to the NGINX 
+ - The API is based on REST principals. Unfortunately, pfSense does not seem to allow any custom changes to the NGINX 
  configuration so alternate request methods like `PUT` and `DELETE` do not appear to be possible. To accommodate this, 
  the requested action must be defined in the endpoint path. 
     - Create actions must be a `POST` request to an endpoint ending in `/add/` 
@@ -59,7 +59,7 @@ diving into creating endpoints. To get started writing your own endpoints, pleas
 ### Writing the API model ### 
 At the core of the API endpoint is the API model. This is a class that validates client request data, writes changes
 to the pfSense configuration file, and makes any corresponding system changes. pfSense API is distributed with a 
-custom microframework to accommodate developers wanting to contribute or create their own API models and endpoints.
+custom micro-framework to accommodate developers wanting to contribute or create their own API models and endpoints.
 
 #### Getting Started ####
 To get started creating a new API model, you first need to create a new PHP file in `/files/etc/inc/api/api_models` and
@@ -76,7 +76,7 @@ class NewAPIModel extends APIBaseModel {
 
 #### Constructing the API Model ####
 In order to use the APIBaseModel framework, you must add a `__construct()` method to your new API model class and 
-initialize the APIBaseModel class as such. Additionally, you will specify your model attribute overrides within this 
+initialize the APIBaseModel class as such. Additionally, you may specify any model attribute overrides within this 
 method:
 
 ```php
@@ -111,7 +111,7 @@ privileges can be found here: https://github.com/pfsense/pfsense/blob/master/src
 - `$this->requires_auth` : Specify whether authentication and authorization is required for the API model. If set to 
 `false` clients will not have to authenticate or have privilege to access. Defaults to `true`.
 
-- `$this->set_auth_mode` : Allows you to statically specify the API authentication mode. For example, if you are 
+- `$this->set_auth_mode` : Allows you to explicitly specify the API authentication mode. For example, if you are 
 writing a model that tests user's local database credentials and do not want the model to assume the API's configured
 auth mode you would specify `$this->set_auth_mode = "local";` to always force local authentication. Defaults to the 
 API's configured auth mode in the /api/ webConfigurator page.
@@ -286,21 +286,9 @@ Often times you will need to create functions to condense redundant tasks. You c
 `$some_variable = APITools\your_custom_tool_function();`
 
 ### Adding Models and Endpoints to the Package
-After you have written your API models and endpoint and have tested it's functionality, you must specify your endpoint 
-files in the package makefile. Otherwise, it will not be included in the package in the next release. 
-
-1. Add the following lines to the `Makefile` located in this repo. **Be sure to change the file paths to match the files
-you have created**:
-```
-${MKDIR} ${STAGEDIR}${PREFIX}/www/api/v1/system/test
-${INSTALL_DATA} ${FILESDIR}${PREFIX}/www/api/v1/system/test/index.php \
-    ${STAGEDIR}${PREFIX}/www/api/v1/system/test
-```
-2. Add the following lines to the `pkg-plist` file located in this repo. Be sure to change the file paths to match the
-files you have created:
-    - For each directory created, add: `@dir /usr/local/www/api/v1/status/carp/modify`
-    - For each index.php endpoint created, add `/usr/local/www/api/v1/status/carp/modify/index.php`
-    - For each API model file created, add `/etc/inc/api/api_models/YourAPIModel.inc`
+The package Makefile and pkg-plist files are auto generated by `tools/make_package.py`. This simply pulls the files and
+directories needed to build our package from the `files` directory. For more information on building the package, refer
+to `tools/README.md`
 
 
 Questions