Fixed errors and typos

Author: ahsankhatri

CHANGELOG.md

@@ -2,15 +2,22 @@
 
 All notable changes to `Firestore PHP` will be documented in this file.
 
-## 2.0.0 - 2019-02-XX
+## 2.0.1 - 2019-02-25
+ - Documentation error and typos fixed.
+ - Saving last response when Guzzle's `BadResponseException` exception throws.
+ - Had to use `git mv` to rename files changed in `2.0.0`
+ - Added `has` method to validate key existence.
+
+## 2.0.0 - 2019-02-23
  - Added Firebase Authentication
- - All files prefixed changed from `FireStore` to `Firestore`
+ - All files prefixed changed from `FireStore` to `Firestore` (notice the `s` in *store*)
  - Added `Bytes` support.
  - Exception handling support added.
  - Support added to list all documents, batch listing with query parameter.
  - Pagination support for bulk and document listing.
  - Improved naming convention throughout the package.
- - Many more..
+ - `FireStoreApiClient` changed to `FirestoreClient`
+ - Documentation updated
 
 ## 1.0.1 - 2019-01-16
  - Add method for casting floating point values

README.md

@@ -24,7 +24,7 @@ or install it by adding it to `composer.json` then run `composer update`
 
 ```javascript
 "require": {
-    "ahsankhatri/ahsankhatri/firestore-php": "^2.0",
+    "ahsankhatri/firestore-php": "^2.0",
 }
 ```
 
@@ -43,7 +43,7 @@ If you use Composer, these dependencies should be handled automatically. If you
 #### Initialization
 
 ```php
-$firestoreClient = new FirestoreApiClient('project-id', 'AIzaxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', [
+$firestoreClient = new FirestoreClient('project-id', 'AIzaxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', [
     'database' => '(default)',
 ]);
 ```
@@ -84,7 +84,7 @@ $document->setNull('null', null);
 $document->setString('string', 'abc123');
 $document->setInteger('integer', 123456);
 $document->setArray('arrayRaw', ['string'=>'abc123']);
-$document->setBytes('bytes', 'bytesdata');
+$document->setBytes('bytes', new FirestoreBytes('bytesdata'));
 $document->setArray('arrayObject', new FirestoreArray(['string' => 'abc123']));
 $document->setTimestamp('timestamp', new FirestoreTimestamp);
 $document->setGeoPoint('geopoint', new FirestoreGeoPoint(1.11,1.11));
@@ -154,6 +154,19 @@ $collections = $firestoreClient->listDocuments('users', [
 
 **Note:** You can pass custom parameters as supported by [firestore list document](https://firebase.google.com/docs/firestore/reference/rest/v1/projects.databases.documents/list#query-parameters)
 
+#### Get field from document
+
+```php
+$document->get('bytes')->parseValue(); // will return bytes decoded value.
+
+// Catch field that doesn't exist in document
+try {
+    $document->get('allowed_notification');
+} catch (\MrShan0\PHPFirestore\Exceptions\Client\FieldNotFound $e) {
+    // Set default value
+}
+```
+
 ### Firebase Authentication
 
 #### Sign in with Email and Password.

src/Attributes/FireStoreDeleteAttribute.php src/Attributes/FirestoreDeleteAttribute.php

@@ -152,6 +152,7 @@ private function authRequest($method, $resource, array $options = [])
 
             return FirestoreHelper::decode((string) $this->client->getLastResponse()->getBody());
         } catch (BadResponseException $exception) {
+            $this->setLastResponse($exception->getResponse());
             $this->handleError($exception);
         }
     }

src/Authentication/FirestoreAuthentication.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace MrShan0\PHPFirestore\Exceptions\Client;
+
+class FieldTypeError extends \Exception
+{
+    public function __construct($response)
+    {
+        $message = 'Unexpected field type detected. Received type: '.$response;
+        parent::__construct($message);
+    }
+}

src/Contracts/FireStoreDataTypeContract.php src/Contracts/FirestoreDataTypeContract.php

@@ -350,6 +350,7 @@ public function request($method, $path, array $options = [], array $parameters =
             $this->setLastResponse($response);
             $body = FirestoreHelper::decode((string) $response->getBody());
         } catch (BadResponseException $exception) {
+            $this->setLastResponse($exception->getResponse());
             $this->handleError($exception);
         }
 

src/Exceptions/Client/FieldTypeError.php

@@ -2,16 +2,17 @@
 
 namespace MrShan0\PHPFirestore;
 
-use Exception;
 use DateTime;
+use Exception;
 use MrShan0\PHPFirestore\Attributes\FirestoreDeleteAttribute;
 use MrShan0\PHPFirestore\Exceptions\Client\FieldNotFound;
+use MrShan0\PHPFirestore\Exceptions\Client\FieldTypeError;
 use MrShan0\PHPFirestore\Fields\FirestoreArray;
+use MrShan0\PHPFirestore\Fields\FirestoreBytes;
 use MrShan0\PHPFirestore\Fields\FirestoreGeoPoint;
 use MrShan0\PHPFirestore\Fields\FirestoreObject;
 use MrShan0\PHPFirestore\Fields\FirestoreReference;
 use MrShan0\PHPFirestore\Fields\FirestoreTimestamp;
-use MrShan0\PHPFirestore\Fields\FirestoreBytes;
 use MrShan0\PHPFirestore\Helpers\FirestoreHelper;
 
 class FirestoreDocument {
@@ -347,7 +348,7 @@ public function getNull($value)
     /**
      * @return void
      */
-    public function setBytes($fieldName, $value)
+    public function setBytes($fieldName, FirestoreBytes $value)
     {
         $this->fields[$fieldName] = [
             'bytesValue' => FirestoreHelper::base64encode($value->getData()),
@@ -365,6 +366,8 @@ public function getBytes($value)
     }
 
     /**
+     * A placeholder to delete particular keys from database
+     *
      * @param string $fieldName
      *
      * @return string
@@ -375,7 +378,7 @@ public function setDelete($fieldName)
     }
 
     /**
-     * A placeholder to delete particular keys from database
+     * Delete keys in bulk
      *
      * @param  string|array
      *
@@ -409,6 +412,17 @@ public function _getRawField($fieldName)
         throw new FieldNotFound($fieldName);
     }
 
+    /**
+     * Check whether document has such field or not.
+     *
+     * @param  string $fieldName
+     * @return boolean
+     */
+    public function has($fieldName)
+    {
+        return (array_key_exists($fieldName, $this->fields) && !$this->fields[$fieldName] instanceof FirestoreDeleteAttribute);
+    }
+
     /**
      * Extract value from object by key
      *
@@ -419,7 +433,7 @@ public function _getRawField($fieldName)
      */
     public function get($fieldName)
     {
-        if (array_key_exists($fieldName, $this->fields) && !$this->fields[$fieldName] instanceof FirestoreDeleteAttribute) {
+        if ($this->has($fieldName)) {
             $result = $this->castValue($this->fields[$fieldName]);
 
             return $result;