Merge pull request #1 from Comp-MC/main

merge changes from 17 updates to comp-mc
dutchie027 · Apr 30, 2021 · d8762fb · d8762fb
2 parents 48bc051 + 64facf1
commit d8762fb
Show file tree

Hide file tree

Showing 28 changed files with 350 additions and 658 deletions.
diff --git a/.idea/.gitignore b/.idea/.gitignore
diff --git a/README.md b/README.md
@@ -1,16 +1,10 @@
 # vultr-php
 
-[![Latest Stable Version](https://poser.pugx.org/dutchie027/vultr/v)](//packagist.org/packages/dutchie027/vultr)
-[![Total Downloads](https://poser.pugx.org/dutchie027/vultr/downloads)](//packagist.org/packages/dutchie027/vultr)
-[![License](https://poser.pugx.org/dutchie027/vultr/license)](//packagist.org/packages/dutchie027/vultr)
-[![CodeFactor](https://www.codefactor.io/repository/github/dutchie027/vultr-php/badge)](https://www.codefactor.io/repository/github/dutchie027/vultr-php)
-
 PHP Library Intended to Interact with [Vultr's v2 API](https://www.vultr.com/api/v2)
-There are a few other PHP libraries out that do similar things, but I wasn't happy that they were very monolithic and also they used cURL and not Guzzle. Further, there was no logging in any of the libraries, so I wrote this one.
 
 ## Installation
 ```php
-composer require dutchie027/vultr
+composer require comp-mc/vultr
 ```
 
 ## Usage

diff --git a/composer.json b/composer.json
@@ -1,12 +1,13 @@
 {
-    "name": "dutchie027/vultr",
-    "description": "Vultr PHP API Wrapper",
+    "name": "comp-mc/vultr",
+    "description": "Vultr PHP API Wrapper by dutchie027. Forked.",
     "keywords": ["php", "automation", "Vultr", "paas", "headless", "server administration"],
     "type": "library",
     "require": {
         "monolog/monolog": "^2.2",
         "guzzlehttp/guzzle": "^7.2",
-        "aws/aws-sdk-php": "^3.171"
+        "aws/aws-sdk-php": "^3.171",
+        "ext-json": "*"
     },
     "autoload": {
         "psr-4": {

diff --git a/composer.lock b/composer.lock
diff --git a/src/API.php b/src/API.php
@@ -15,6 +15,7 @@
 
 namespace dutchie027\Vultr;
 
+use dutchie027\Vultr\Exceptions\VultrAPIRequestException;
 use GuzzleHttp\Client as Guzzle;
 use GuzzleHttp\Psr7;
 use GuzzleHttp\Exception\RequestException;
@@ -336,7 +337,7 @@ private function getAPIToken()
      * @return object
      *
      */
-    public function account()
+    public function account(): Account
     {
         $account = new Account($this);
         return $account;
@@ -350,7 +351,7 @@ public function account()
      * @return object
      *
      */
-    public function applications()
+    public function applications(): Applications
     {
         $ap = new Applications($this);
         return $ap;
@@ -364,7 +365,7 @@ public function applications()
      * @return object
      *
      */
-    public function backups()
+    public function backups(): Backups
     {
         $bu = new Backups($this);
         return $bu;
@@ -378,7 +379,7 @@ public function backups()
      * @return object
      *
      */
-    public function bareMetal()
+    public function bareMetal(): BareMetal
     {
         $bm = new BareMetal($this);
         return $bm;
@@ -392,7 +393,7 @@ public function bareMetal()
      * @return object
      *
      */
-    public function blockStorage()
+    public function blockStorage(): BlockStorage
     {
         $bs = new BlockStorage($this);
         return $bs;
@@ -406,7 +407,7 @@ public function blockStorage()
      * @return object
      *
      */
-    public function dns()
+    public function dns(): DNS
     {
         $dns = new DNS($this);
         return $dns;
@@ -420,7 +421,7 @@ public function dns()
      * @return object
      *
      */
-    public function firewalls()
+    public function firewalls(): Firewalls
     {
         $fw = new Firewalls($this);
         return $fw;
@@ -434,7 +435,7 @@ public function firewalls()
      * @return object
      *
      */
-    public function instances()
+    public function instances(): Instances
     {
         $instances = new Instances($this);
         return $instances;
@@ -448,7 +449,7 @@ public function instances()
      * @return object
      *
      */
-    public function iso()
+    public function iso(): ISO
     {
         $iso = new ISO($this);
         return $iso;
@@ -462,7 +463,7 @@ public function iso()
      * @return object
      *
      */
-    public function loadBalancers()
+    public function loadBalancers(): LoadBalancers
     {
         $lb = new LoadBalancers($this);
         return $lb;
@@ -476,7 +477,7 @@ public function loadBalancers()
      * @return object
      *
      */
-    public function objectStorage()
+    public function objectStorage(): ObjectStorage
     {
         $os = new ObjectStorage($this);
         return $os;
@@ -490,7 +491,7 @@ public function objectStorage()
      * @return object
      *
      */
-    public function operatingSystems()
+    public function operatingSystems(): OperatingSystems
     {
         $os = new OperatingSystems($this);
         return $os;
@@ -504,7 +505,7 @@ public function operatingSystems()
      * @return object
      *
      */
-    public function plans()
+    public function plans(): Plans
     {
         $plans = new Plans($this);
         return $plans;
@@ -518,7 +519,7 @@ public function plans()
      * @return object
      *
      */
-    public function privateNetworks()
+    public function privateNetworks(): PrivateNetworks
     {
         $pn = new PrivateNetworks($this);
         return $pn;
@@ -532,7 +533,7 @@ public function privateNetworks()
      * @return object
      *
      */
-    public function regions()
+    public function regions(): Regions
     {
         $regions = new Regions($this);
         return $regions;
@@ -546,7 +547,7 @@ public function regions()
      * @return object
      *
      */
-    public function reservedIPs()
+    public function reservedIPs(): ReservedIPs
     {
         $rip = new ReservedIPs($this);
         return $rip;
@@ -560,7 +561,7 @@ public function reservedIPs()
      * @return object
      *
      */
-    public function snapshots()
+    public function snapshots(): Snapshots
     {
         $snap = new Snapshots($this);
         return $snap;
@@ -574,7 +575,7 @@ public function snapshots()
      * @return object
      *
      */
-    public function sshKeys()
+    public function sshKeys(): SSHKeys
     {
         $ssh = new SSHKeys($this);
         return $ssh;
@@ -588,7 +589,7 @@ public function sshKeys()
      * @return object
      *
      */
-    public function startupScripts()
+    public function startupScripts(): StartupScripts
     {
         $ss = new StartupScripts($this);
         return $ss;
@@ -602,7 +603,7 @@ public function startupScripts()
      * @return object
      *
      */
-    public function users()
+    public function users(): Users
     {
         $users = new Users($this);
         return $users;
@@ -682,8 +683,8 @@ public function pGenRandomString($length = 6)
      * @param $url string endpoint
      * @param $body string - usually passed as JSON
      *
-     * @return string Body Object
-     * @throws string error message
+     * @return Psr7\Stream Object
+     * @throws VultrAPIRequestException Exception with details regarding the failed request
      *
      */
     public function makeAPICall($type, $url, $body = null)
@@ -697,8 +698,9 @@ public function makeAPICall($type, $url, $body = null)
             if ($e->hasResponse()) {
                 $response = $e->getResponse();
                 $ja = json_decode($response->getBody()->getContents(), true);
-                print $ja['error'];
+                throw new VultrAPIRequestException('An error occurred while performing the request to ' . $url . ' -> ' . (isset($ja['error']) ? $ja['error'] : json_encode($ja)));
             }
+            throw new VultrAPIRequestException(('An unknown error ocurred while performing the request to ' . $url));
         }
     }
 }
diff --git a/src/Account.php b/src/Account.php
@@ -43,7 +43,6 @@ public function __construct(API $api)
      * getAccountInfo
      * Gets account info
      *
-     *
      * @return string
      *
      */

diff --git a/src/Applications.php b/src/Applications.php
@@ -107,36 +107,6 @@ public function loadApplications()
         $this->app_count = $apps['meta']['total'];
     }
 
-    /**
-     * printNames
-     * Prints Names and IDs to stdout
-     *
-     *
-     * @return void
-     *
-     */
-    public function printNames()
-    {
-        foreach ($this->ids as $id) {
-            print $this->deploy_names[$id] . " ($id)" . PHP_EOL;
-        }
-    }
-
-    /**
-     * listIds
-     * Prints Instance IDs to stdout
-     *
-     *
-     * @return void
-     *
-     */
-    public function listIds()
-    {
-        foreach ($this->ids as $id) {
-            print $id . PHP_EOL;
-        }
-    }
-
     /**
      * getNumberOfApplications
      * Returns total number of applications