README & Code Cleanup, adds CHANGELOG & CODE_OF_CONDUCT

* Cleanup README

* link corrections

* fine changes on README

* Removes autogenerated comments, corrects email

* Added CHANGELOG

* Added CODE_OF_CONDUCT

* Code Cleanup in src/

* Code cleanup in tests/

Author: montymxb

CHANGELOG.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CODE_OF_CONDUCT.md

@@ -1,14 +1,44 @@
-Parse PHP SDK
--------------
+# Parse PHP SDK
 
 [![codecov](https://codecov.io/gh/parse-community/parse-php-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/parse-community/parse-php-sdk)
 [![Build Status](https://travis-ci.org/parse-community/parse-php-sdk.svg?branch=master)](https://travis-ci.org/parse-community/parse-php-sdk)
 
 The Parse PHP SDK gives you access to the powerful Parse cloud platform
-from your PHP app or script.  Updated to work with the self-hosted Parse Server: https://github.com/parse-community/parse-server
-
-Installation
-------------
+from your PHP app or script.  Designed to work with the self-hosted Parse Server: https://github.com/parse-community/parse-server
+
+## Table of Contents
+- [Installation](#installation)
+    - [Install with Composer](#install-with-composer)
+    - [Install with Git](#install-with-git)
+    - [Install with another method](#install-with-another-method)
+- [Setup](#setup)
+    - [Initializing](#initializing)
+    - [Server URL](#server-url)
+    - [Http Clients](#http-clients)
+    - [Alternate CA files](#alternate-ca-file)
+- [Getting Started](#getting-started)
+    - [Use Declarations](#use-declarations)
+    - [Parse Objects](#parse-objects)
+    - [Users](#users)
+    - [ACLs/Security](#acls)
+    - [Queries](#queries)
+    - [Cloud Functions](#cloud-functions)
+    - [Analytics](#analytics)
+    - [Files](#files)
+    - [Push Notifications](#push)
+        - [Push to Channels](#push-to-channels)
+        - [Push with Query](#push-with-query)
+        - [Push Status](#push-status)
+    - [Server Info](#server-info)
+        - [Version](#version)
+        - [Features](#features)
+- [Contributing / Testing](#contributing--testing)
+
+## Installation
+There are various ways to install and use this sdk. We'll elaborate on a couple here. 
+Note that the Parse PHP SDK requires PHP 5.4 or newer.
+
+### Install with Composer
 
 [Get Composer], the PHP package manager. Then create a composer.json file in
  your projects root folder, containing:
@@ -28,33 +58,47 @@ and then require it from your PHP script:
 require 'vendor/autoload.php';
 ```
 
-Note: The Parse PHP SDK requires PHP 5.4 or newer.
+### Install with Git
 
-Alternative Method
-------------------
+You can clone down this sdk using your favorite github client, or via the terminal.
+```bash
+git clone https://github.com/parse-community/parse-php-sdk.git
+```
 
-If you don't want to use Composer, you can include the ```autoload.php```
-file in your code to automatically load the Parse SDK classes.
+You can then include the ```autoload.php``` file in your code to automatically load the Parse SDK classes.
 
 ```php
 require 'autoload.php';
 ```
 
-Initialization
----------------
+### Install with another method
+
+If you downloaded this sdk using any other means you can treat it like you used the git method above.
+Once it's installed you need only require the `autoload.php` to have access to the sdk.
+
+## Setup
+
+Once you have access to the sdk you'll need to set it up in order to begin working with parse-server.
+
+### Initializing
 
 After including the required files from the SDK, you need to initialize the ParseClient using your Parse API keys:
 
 ```php
 ParseClient::initialize( $app_id, $rest_key, $master_key );
-// Users of Parse Server will need to point ParseClient at their remote URL and Mount Point:
-ParseClient::setServerURL('https://my-parse-server.com:port','parse');
 ```
 
 If your server does not use or require a REST key you may initialize the ParseClient as follows, safely omitting the REST key:
 
 ```php
 ParseClient::initialize( $app_id, null, $master_key );
+```
+
+### Server URL
+
+Directly after initializing the sdk you should set the server url.
+
+```php
 // Users of Parse Server will need to point ParseClient at their remote URL and Mount Point:
 ParseClient::setServerURL('https://my-parse-server.com:port','parse');
 ```
@@ -67,15 +111,7 @@ For example if your parse server's url is `http://example.com:1337/parse` then y
 ParseClient::setServerURL('https://example.com:1337','parse');
 ```
 
-Getting Started
----------------
-
-We highly recommend you read through the [guide](http://docs.parseplatform.org/php/guide/) first. This will walk you through the basics of working with this sdk, as well as provide insight into how to best develop your project.
-
-If want to know more about what makes the php sdk tick you can read our [API Reference](http://parseplatform.org/parse-php-sdk/namespaces/Parse.html) and flip through the code on [github](https://github.com/parse-community/parse-php-sdk/).
-
-Http Clients
-------------
+### Http Clients
 
 This SDK has the ability to change the underlying http client at your convenience.
 The default is to use the curl http client if none is set, there is also a stream http client that can be used as well.
@@ -94,9 +130,7 @@ If you have a need for an additional http client you can request one by opening
 
 If you wish to build one yourself make sure your http client implements ```ParseHttpable``` for it be compatible with the SDK. Once you have a working http client that enhances the SDK feel free to submit it in a PR so we can look into adding it in.
 
-
-Alternate Certificate Authority File
-------------------------------------
+### Alternate CA File
 
 It is possible that your local setup may not be able to verify with peers over SSL/TLS. This may especially be the case if you do not have control over your local installation, such as for shared hosting.
 
@@ -109,12 +143,16 @@ Once you have your bundle you can set it as follows:
 ParseClient::setCAFile(__DIR__ . '/certs/cacert.pem');
 ```
 
+## Getting Started
 
-Usage
------
+We highly recommend you read through the [guide](http://docs.parseplatform.org/php/guide/) first. This will walk you through the basics of working with this sdk, as well as provide insight into how to best develop your project.
+
+If want to know more about what makes the php sdk tick you can read our [API Reference](http://parseplatform.org/parse-php-sdk/namespaces/Parse.html) and flip through the code on [github](https://github.com/parse-community/parse-php-sdk/).
 
 Check out the [Parse PHP Guide] for the full documentation.
 
+### Use Declarations
+
 Add the "use" declarations where you'll be using the classes. For all of the
 sample code in this file:
 
@@ -130,9 +168,14 @@ use Parse\ParseAnalytics;
 use Parse\ParseFile;
 use Parse\ParseCloud;
 use Parse\ParseClient;
+use Parse\ParsePushStatus;
+use Parse\ParseServerInfo;
 ```
 
-Objects:
+### Parse Objects
+
+Parse Objects hold your data, can be saved, queried for, serialized and more!
+Objects are at the core of this sdk, they allow you to persist your data from php without having to worry about any databasing code. 
 
 ```php
 $object = ParseObject::create("TestObject");
@@ -160,7 +203,11 @@ $encoded = $object->encode();
 $decodedObject = ParseObject::decode($encoded);
 ```
 
-Users:
+### Users
+
+Users are a special kind of object. 
+This class allows individuals to access your applications with their unique information and allows you to identify them distinctly.
+Users may also be linked with 3rd party accounts such as facebook, twitter, etc.
 
 ```php
 // Signup
@@ -184,7 +231,10 @@ try {
 $user = ParseUser::getCurrentUser();
 ```
 
-Security:
+### ACLs
+
+Access Control Lists (ACLs) allow you to granularly control access to individual Parse Objects.
+ACLs allow you to configure access to the general public, roles, and individual users themselves.
 
 ```php
 // Access only by the ParseUser in $user
@@ -201,7 +251,10 @@ $acl->setUserWriteAccess($user, true);
 $acl->setRoleWriteAccessWithName("PHPFans", true);
 ```
 
-Queries:
+### Queries
+
+Queries allow you to recall objects that you've saved to parse-server. 
+Query methods and parameters allow allow a varying degree of querying for objects, from all objects of a class to objects created within a particular date range and more.
 
 ```php
 $query = new ParseQuery("TestObject");
@@ -227,13 +280,17 @@ $query->each(function($obj) {
 });
 ```
 
-Cloud Functions:
+### Cloud Functions
+
+Directly call server-side cloud coud functions and get their results.
 
 ```php
 $results = ParseCloud::run("aCloudFunction", array("from" => "php"));
 ```
 
-Analytics:
+### Analytics
+
+A specialized Parse Object built purposely to make analytics easy.
 
 ```php
 ParseAnalytics::track("logoReaction", array(
@@ -242,7 +299,9 @@ ParseAnalytics::track("logoReaction", array(
 ));
 ```
 
-Files:
+### Files
+
+Persist files to parse-server and retrieve them at your convenience. Depending on how your server is setup there are a variety of storage options including mongodb, Amazon S3 and Google Cloud Storage. You can read more about that [here](https://github.com/parse-community/parse-server/#configuring-file-adapters).
 
 ```php
 // Get from a Parse Object:
@@ -261,10 +320,16 @@ $file = ParseFile::createFromFile(
 $file = ParseFile::createFromData($contents, "Parse.txt", "text/plain");
 ```
 
-Push:
+### Push
+
+Push notifications can be constructed and sent using this sdk. You can send pushes to predefined channels of devices, or send to a customized set of devices using the power of `ParseQuery`.
 
 In order to use Push you must first configure a [working push configuration](http://docs.parseplatform.org/parse-server/guide/#push-notifications) in your parse server instance.
 
+#### Push to Channels
+
+You can send push notifications to any channels that you've created for your users.
+
 ```php
 $data = array("alert" => "Hi!");
 
@@ -278,8 +343,13 @@ ParsePush::send(array(
     "channels" => ["PHPFans"],
     "data" => $data
 ), true);
+```
+
+#### Push with Query
 
+You can also push to devices using queries targeting the `ParseInstallation` class.
 
+```php
 // Push to Query
 $query = ParseInstallation::query();
 $query->equalTo("design", "rad");
@@ -288,8 +358,14 @@ ParsePush::send(array(
     "where" => $query,
     "data" => $data
 ), true);
+```
 
+#### Push Status
 
+If your server supports it you can extract and check the current status of your pushes.
+This allows you to monitor the success of your pushes in real time.
+
+```php
 // Get Push Status
 $response = ParsePush::send(array(
     "channels" => ["StatusFans"],
@@ -328,9 +404,22 @@ if(ParsePush::hasStatus($response)) {
 }
 ```
 
-Server Info:
+### Server Info
+
+Any server version **2.1.4** or later supports access to detailed information about itself and it's capabilities.
+You can leverage `ParseServerInfo` to check on the features and version of your server.
+
+#### Version
+Get the current version of the server you are connected to.
+
+```php
+// get the current version of the server you are connected to (2.6.5, 2.5.4, etc.)
+$version = ParseServerInfo::getVersion();
+```
+
+#### Features
+Check which features your server has and how they are configured.
 
-Get information regarding the configuration of the server you are connecting to.
 ```php
 // get the current version of the server you are connected to (2.6.5, 2.5.4, etc.)
 $version = ParseServerInfo::getVersion();
@@ -346,6 +435,9 @@ $globalConfigFeatures = ParseServerInfo::getGlobalConfigFeatures();
  *    "delete" : true
  * }
  */
+ 
+ // you can always get all feature data
+ $data = ParseServerInfo::getFeatures();
 ```
 
  You can get details on the following features as well:
@@ -362,15 +454,14 @@ $globalConfigFeatures = ParseServerInfo::getGlobalConfigFeatures();
 
  ```
 
-Contributing / Testing
-----------------------
+## Contributing / Testing
 
 See [CONTRIBUTING](CONTRIBUTING.md) for information on testing and contributing to
 the Parse PHP SDK. We welcome fixes and enhancements.
 
-[Get Composer]: https://getcomposer.org/download/
-[Parse PHP Guide]: http://docs.parseplatform.org/php/guide/
-
 -----
 
 As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.
+
+[Get Composer]: https://getcomposer.org/download/
+[Parse PHP Guide]: http://docs.parseplatform.org/php/guide/

README.md

@@ -10,7 +10,7 @@
 /**
  * Class ParseCurl - Wrapper for abstracted curl usage
  *
- * @author Ben Friedman <ben@axolsoft.com>
+ * @author Ben Friedman <friedman.benjamin@gmail.com>
  * @package Parse\HttpClients
  */
 class ParseCurl