Merge pull request #5 from jr-cologne/bugsnag

Implement Error Handling with Bugsnag
jr-cologne · Mar 10, 2018 · 4653c73 · 4653c73
2 parents b32bab7 + 248a003
commit 4653c73
Show file tree

Hide file tree

Showing 15 changed files with 448 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ Twitter Account: [@status_crypto](https://twitter.com/status_crypto)
 ## Dependencies
 - [PHP](http://php.net/) (version 7.0 or higher)
 - [Codebird Twitter API library](https://github.com/jublonet/codebird-php) (version ^3.1)
+- [Bugsnag PHP library](https://github.com/bugsnag/bugsnag-php) (version ^3.12)
 
 ## Contributing and Support
 Feel free to contribute to or support this project. Any sort of help is much appreciated.

diff --git a/app/app.php b/app/app.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________
@@ -23,8 +23,12 @@
 
 require_once 'vendor/autoload.php';
 
+use CryptoStatus\BugsnagClient;
 use CryptoStatus\CryptoStatus;
 
+// initialize error handling
+$bugsnag_client = new BugsnagClient;
+
 $app = new CryptoStatus;
 
 // initialize app

diff --git a/app/classes/BugsnagClient.php b/app/classes/BugsnagClient.php
@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * A simple Twitter bot application which posts hourly status updates for the top 10 cryptocurrencies.
+ *
+ * PHP version >= 7.0
+ *
+ * LICENSE: MIT, see LICENSE file for more information
+ *
+ * @author JR Cologne <[email protected]>
+ * @copyright 2018 JR Cologne
+ * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
+ * @version v0.2.0
+ * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
+ *
+ * ________________________________________________________________________________
+ *
+ * BugsnagClient.php
+ *
+ * The client for handling errors with Bugsnag.
+ * 
+ */
+
+namespace CryptoStatus;
+
+class BugsnagClient {
+
+  /**
+   * Constructor, initialization of Bugsnag's error handler
+   */
+  public function __construct() {
+    $bugsnag = Bugsnag\Client::make($this->getApiKey());
+    Bugsnag\Handler::register($bugsnag);
+  }
+
+  /**
+   * Get API key from environment variables
+   * 
+   * @return string
+   * @throws BugsnagClientException if Bugsnag API key could not be retrieved
+   */
+  protected function getApiKey() : string {
+    $api_key = getenv(BUGSNAG_API_KEY);
+
+    if (empty($api_key)) {
+      throw new BugsnagClientException("Could not get Bugsnag API Key", 1);
+    }
+
+    return $api_key;
+  }
+
+}
diff --git a/app/classes/CryptoClient.php b/app/classes/CryptoClient.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________

diff --git a/app/classes/CryptoStatus.php b/app/classes/CryptoStatus.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________

diff --git a/app/classes/CurlClient.php b/app/classes/CurlClient.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________

diff --git a/app/classes/Exceptions/BugsnagClientException.php b/app/classes/Exceptions/BugsnagClientException.php
@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * A simple Twitter bot application which posts hourly status updates for the top 10 cryptocurrencies.
+ *
+ * PHP version >= 7.0
+ *
+ * LICENSE: MIT, see LICENSE file for more information
+ *
+ * @author JR Cologne <[email protected]>
+ * @copyright 2018 JR Cologne
+ * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
+ * @version v0.2.0
+ * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
+ *
+ * ________________________________________________________________________________
+ *
+ * BugsnagClientException.php
+ *
+ * The Exception of the Bugsnag client
+ * 
+ */
+
+namespace CryptoStatus\Exceptions;
+
+use \Exception;
+
+class BugsnagClientException extends Exception {
+
+}
diff --git a/app/classes/Exceptions/CryptoClientException.php b/app/classes/Exceptions/CryptoClientException.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________

diff --git a/app/classes/Exceptions/CryptoStatusException.php b/app/classes/Exceptions/CryptoStatusException.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________

diff --git a/app/classes/Exceptions/CurlClientException.php b/app/classes/Exceptions/CurlClientException.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________

diff --git a/app/classes/Exceptions/TwitterClientException.php b/app/classes/Exceptions/TwitterClientException.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________

diff --git a/app/classes/TwitterClient.php b/app/classes/TwitterClient.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________
@@ -47,7 +47,6 @@ class TwitterClient {
    * Constructor, initialization and authentication with Twitter API
    * 
    * @param Codebird $twitter_client A Cordbird instance
-   * @param string $twitter_api_credentials_file The Twitter API credentials file
    * @throws TwitterClientException if authentication with Twitter API failed
    */
   public function __construct(Codebird $twitter_client) {

diff --git a/app/config/config.php b/app/config/config.php
@@ -10,7 +10,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/CryptoStatus/blob/master/LICENSE MIT
- * @version v0.1.3
+ * @version v0.2.0
  * @link https://github.com/jr-cologne/CryptoStatus GitHub Repository
  *
  * ________________________________________________________________________________
@@ -31,3 +31,5 @@
 const CRYPTO_API = 'https://api.coinmarketcap.com/v1/';
 const CRYPTO_API_ENDPOINT = 'ticker/';
 const CRYPTO_API_LIMIT = 10;
+
+const BUGSNAG_API_KEY = 'BUGSNAG_API_KEY';
diff --git a/composer.json b/composer.json
@@ -1,7 +1,8 @@
 {
   "require": {
     "php": ">=7.0",
-    "jublonet/codebird-php": "^3.1"
+    "jublonet/codebird-php": "^3.1",
+    "bugsnag/bugsnag": "^3.12"
   },
   "autoload": {
     "psr-4": {