Added two more endpoints and check ssl cert

Author: codebyray

.phpunit.result.cache

@@ -0,0 +1 @@
+C:37:"PHPUnit\Runner\DefaultTestResultCache":259:{a:2:{s:7:"defects";a:1:{s:58:"Codebyray\LaravelVehapi\Tests\EndpointTest::test_get_years";i:3;}s:5:"times";a:2:{s:55:"Codebyray\LaravelVehapi\Tests\ExampleTest::true_is_true";d:0.079;s:58:"Codebyray\LaravelVehapi\Tests\EndpointTest::test_get_years";d:0.105;}}}

CHANGELOG.md

@@ -5,3 +5,9 @@ All notable changes to `laravel-vehapi` will be documented in this file
 ## 1.0.0 - 2021-26-03
 
 - initial release
+
+## 1.1 - 2021-20-12
+
+- Added option to bypass cURL certificate check (this is mainly for local development)
+- Added get vehicle wheel options
+- Added get vehicle options

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) RJ
+Copyright (c) CodebyRay & Vehicle Info API
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -35,14 +35,15 @@ php artisan vendor:publish --provider="Codebyray\LaravelVehapi\LaravelVehapiServ
 ```
 
 ## Setup .env file
-Add your API token & API version to your .env file:
+Add your API token, API version & API SSL check to your .env file:
 > NOTE: API version will default to v1, you DO NOT need to specify the version unless you are using a different 
 > version of Vehicle Info API. API token is required. However, it can be entered in your .env file (recommended), or the published
 > config file.
 
 ```dotenv
 VEH_API_TOKEN=YOUR_VEH_API_TOKEN
 VEH_API_VERSION=v1
+VEH_CHECK_SSL_CERT=true // Defaults to true. Change to false if testing locally.
 ```
 ## Usage
 
@@ -203,6 +204,52 @@ $vehEngines = LaravelVehapi::getEnginesByYearMakeModelTrimAndTransmission(2015,
 $vehEngines = json_encode(LaravelVehapi::getEnginesByYearMakeModelTrimAndTransmission(2015, 'Acura', 'MDX', 'FWD', '6-Speed Automatic'));
 ```
 
+Let's get all the wheel options available for a specific year, make, model, trim, transmission & engine
+```php
+/**
+ * Return wheels available for the year, make, model, transmission & engine supplied.
+ *
+ * @param int $year
+ * @param string $make
+ * @param string $model
+ * @param string $trim
+ * @param string $transmission
+ * @param string $engine
+ *
+ * @return mixed
+ */
+LaravelVehapi::getWheelsByYearMakeModelTrimTransmissionAndEngine($year, $make, $model, $trim, $transmission, $engine);
+
+// Returns associative array
+$vehWheels = LaravelVehapi::getWheelsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4');
+
+// Convert array to json format
+$vehWheels = json_encode(LaravelVehapi::getWheelsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4'));
+```
+
+Let's get all the vehicle options available for a specific year, make, model, trim, transmission & engine
+```php
+/**
+ * Return options available for the year, make, model, transmission & engine supplied.
+ *
+ * @param int $year
+ * @param string $make
+ * @param string $model
+ * @param string $trim
+ * @param string $transmission
+ * @param string $engine
+ *
+ * @return mixed
+ */
+LaravelVehapi::getOptionsByYearMakeModelTrimTransmissionAndEngine($year, $make, $model, $trim, $transmission, $engine);
+
+// Returns associative array
+$vehOptions = LaravelVehapi::getOptionsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4');
+
+// Convert array to json format
+$vehOptions = json_encode(LaravelVehapi::getOptionsByYearMakeModelTrimTransmissionAndEngine(2021, 'Acura', 'TLX', 'FWD', '10-Speed Automatic', '2.0L 272 hp I4'));
+```
+
 ### Changelog
 
 Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
@@ -216,7 +263,6 @@ If you discover any security related issues, please email dev@codebyray.com inst
 ## Credits
 
 - [CodebyRay](https://github.com/codebyray)
-- [All Contributors](../../contributors)
 
 ## License
 

config/config.php

@@ -15,4 +15,9 @@
      * Changing versions is easy, just change the version number below to switch between versions.
      */
     'veh_api_version' => env('VEH_API_VERSION', 'v1'),
+
+    /**
+     * Verify SSL cert. You should keep this as false if you are developing and testing locally.
+     */
+    'veh_check_ssl_cert' => env('VEH_CHECK_SSL_CERT', true),
 ];

src/LaravelVehapi.php

@@ -23,6 +23,7 @@ public function __construct()
     {
         $this->vehApiToken = config('laravel-vehapi.veh_api_token', null);
         $this->vehApiVersion = config('laravel-vehapi.veh_api_version', null);
+        $this->vehCheckSslCert = config('laravel-vehapi.veh_check_ssl_cert', true);
     }
 
     /**
@@ -34,7 +35,11 @@ public function __construct()
      */
     public function getAllYears($sort = 'asc')
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/years/'.$sort), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/years/'.$sort), true);
     }
 
     /**
@@ -48,7 +53,11 @@ public function getAllYears($sort = 'asc')
      */
     public function getYearsRange(int $minYear, int $maxYear, $sort = 'asc')
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/range/years/'.$minYear.'/'.$maxYear.'/'.$sort), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/range/years/'.$minYear.'/'.$maxYear.'/'.$sort), true);
     }
 
     /**
@@ -60,7 +69,11 @@ public function getYearsRange(int $minYear, int $maxYear, $sort = 'asc')
      */
     public function getAllMakes($sort = 'asc')
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/all/car/makes/'.$sort), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/all/car/makes/'.$sort), true);
     }
 
     /**
@@ -73,7 +86,11 @@ public function getAllMakes($sort = 'asc')
      */
     public function getMakesByYear(int $year, $sort = 'asc')
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/makes/'.$year.'/'.$sort), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/makes/'.$year.'/'.$sort), true);
     }
 
     /**
@@ -87,7 +104,11 @@ public function getMakesByYear(int $year, $sort = 'asc')
      */
     public function getMakesByYearsRange(int $minYear, int $maxYear, $sort = 'asc')
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/makes/in-range/'.$minYear.'/'.$maxYear.'/'.$sort), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/makes/in-range/'.$minYear.'/'.$maxYear.'/'.$sort), true);
     }
 
     /**
@@ -100,7 +121,11 @@ public function getMakesByYearsRange(int $minYear, int $maxYear, $sort = 'asc')
      */
     public function getAllModelsByMake(string $make, $sort = 'asc')
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/all/car/models/'.$make.'/'.$sort), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+        ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/all/car/models/'.$make.'/'.$sort), true);
     }
 
     /**
@@ -114,7 +139,11 @@ public function getAllModelsByMake(string $make, $sort = 'asc')
      */
     public function getModelsByYearAndMake(int $year, string $make, $sort = 'asc')
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/models/'.$year.'/'.$make.'/'.$sort), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/models/'.$year.'/'.$make.'/'.$sort), true);
     }
 
     /**
@@ -128,7 +157,11 @@ public function getModelsByYearAndMake(int $year, string $make, $sort = 'asc')
      */
     public function getTrimsByYearMakeAndModel(int $year, string $make, string $model)
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/trims/'.$year.'/'.$make.'/'.$model), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/trims/'.$year.'/'.$make.'/'.$model), true);
     }
 
     /**
@@ -143,7 +176,11 @@ public function getTrimsByYearMakeAndModel(int $year, string $make, string $mode
      */
     public function getTransmissionsByYearMakeModelAndTrim(int $year, string $make, string $model, string $trim)
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/transmissions/'.$year.'/'.$make.'/'.$model.'/'.$trim), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/transmissions/'.$year.'/'.$make.'/'.$model.'/'.$trim), true);
     }
 
     /**
@@ -159,7 +196,53 @@ public function getTransmissionsByYearMakeModelAndTrim(int $year, string $make,
      */
     public function getEnginesByYearMakeModelTrimAndTransmission(int $year, string $make, string $model, string $trim, string $transmission)
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/engines/'.$year.'/'.$make.'/'.$model.'/'.$trim.'/'.$transmission), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/engines/'.$year.'/'.$make.'/'.$model.'/'.$trim.'/'.$transmission), true);
+    }
+
+    /**
+     * Return options available for the year, make, model, transmission & engine supplied.
+     *
+     * @param int $year
+     * @param string $make
+     * @param string $model
+     * @param string $trim
+     * @param string $transmission
+     * @param string $engine
+     *
+     * @return mixed
+     */
+    public function getOptionsByYearMakeModelTrimTransmissionAndEngine(int $year, string $make, string $model, string $trim, string $transmission, string $engine)
+    {
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/options/'.$year.'/'.$make.'/'.$model.'/'.$trim.'/'.$transmission.'/'.$engine), true);
+    }
+
+    /**
+     * Return wheels available for the year, make, model, transmission & engine supplied.
+     *
+     * @param int $year
+     * @param string $make
+     * @param string $model
+     * @param string $trim
+     * @param string $transmission
+     * @param string $engine
+     *
+     * @return mixed
+     */
+    public function getWheelsByYearMakeModelTrimTransmissionAndEngine(int $year, string $make, string $model, string $trim, string $transmission, string $engine)
+    {
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-lists/get/car/wheels/'.$year.'/'.$make.'/'.$model.'/'.$trim.'/'.$transmission.'/'.$engine), true);
     }
 
     /**
@@ -171,6 +254,10 @@ public function getEnginesByYearMakeModelTrimAndTransmission(int $year, string $
      */
     public function getMakeLogo(string $make)
     {
-        return json_decode(Http::withToken($this->vehApiToken)->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-logos/img/'.$make), true);
+        return json_decode(Http::withOptions([
+            'verify' => $this->vehCheckSslCert
+            ])
+            ->withToken($this->vehApiToken)
+            ->get('https://vehapi.com/api/'.$this->vehApiVersion.'/car-logos/img/'.$make), true);
     }
 }