Add sandbox mode and Shipping class (ptondereau#4)

* Add sandbox parameter

* Add sandbox parameter to constructors

* Add Shipping service

* Update readme

* Fix code style notices

* Fix indentation according to CI reqs

Despite it looks weird now

* Stupid CI :)

* Fix review notes

README.md

@@ -47,6 +47,8 @@ You can register the all or some Ups facade in the `aliases` key of your `config
 * `'UPSTimeInTransit' => 'Ptondereau\LaravelUpsApi\Facades\UpsTimeInTransit'`
 * `'UPSTracking' => 'Ptondereau\LaravelUpsApi\Facades\UpsTracking'`
 * `'UPSTradeability' => 'Ptondereau\LaravelUpsApi\Facades\UpsTradeability'`
+* `'UPSShipping' => 'Ptondereau\LaravelUpsApi\Facades\UpsShipping'`
+
 
 
 ## Configuration
@@ -67,6 +69,7 @@ You also need to add env variables into your .env with your credentials:
 UPS_ACCESS_KEY=key
 UPS_USER_ID=userId
 UPS_PASSWORD=password
+UPS_SANDBOX=true
 ```
 
 ## Usage

config/ups.php

@@ -14,4 +14,5 @@
     'access_key' => env('UPS_ACCESS_KEY', 'test'),
     'user_id'    => env('UPS_USER_ID', 'test'),
     'password'   => env('UPS_PASSWORD', 'test'),
+    'sandbox'    => env('UPS_SANDBOX', true),
 ];

src/Facades/UpsShipping.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Ptondereau\LaravelUpsApi\Facades;
+
+use Illuminate\Support\Facades\Facade;
+
+/**
+ * This is the Tradeability facade class.
+ *
+ * @author Pierre Tondereau <[email protected]>
+ */
+class UpsShipping extends Facade
+{
+    /**
+     * Get the registered name of the component.
+     *
+     * @return string
+     */
+    protected static function getFacadeAccessor()
+    {
+        return 'ups.shipping';
+    }
+}

src/UpsApiServiceProvider.php

@@ -13,6 +13,7 @@
 use Ups\TimeInTransit;
 use Ups\Tracking;
 use Ups\Tradeability;
+use Ups\Shipping;
 
 /**
  * This is the Ups Api service provider class.
@@ -45,6 +46,7 @@ public function register()
         $this->registerTimeInTransit();
         $this->registerLocator();
         $this->registerTradeability();
+        $this->registerShipping();
     }
 
     /**
@@ -73,7 +75,12 @@ protected function registerAddressValidation()
         $this->app->singleton('ups.address-validation', function (Container $app) {
             $config = $app->config->get('ups');
 
-            return new AddressValidation($config['access_key'], $config['user_id'], $config['password']);
+            return new AddressValidation(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
         });
     }
 
@@ -87,7 +94,12 @@ protected function registerQuantumView()
         $this->app->singleton('ups.quantum-view', function (Container $app) {
             $config = $app->config->get('ups');
 
-            return new QuantumView($config['access_key'], $config['user_id'], $config['password']);
+            return new QuantumView(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
         });
     }
 
@@ -101,7 +113,12 @@ protected function registerTracking()
         $this->app->singleton('ups.tracking', function (Container $app) {
             $config = $app->config->get('ups');
 
-            return new Tracking($config['access_key'], $config['user_id'], $config['password']);
+            return new Tracking(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
         });
     }
 
@@ -115,7 +132,12 @@ protected function registerRate()
         $this->app->singleton('ups.rate', function (Container $app) {
             $config = $app->config->get('ups');
 
-            return new Rate($config['access_key'], $config['user_id'], $config['password']);
+            return new Rate(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
         });
     }
 
@@ -129,7 +151,12 @@ protected function registerTimeInTransit()
         $this->app->singleton('ups.time-in-transit', function (Container $app) {
             $config = $app->config->get('ups');
 
-            return new TimeInTransit($config['access_key'], $config['user_id'], $config['password']);
+            return new TimeInTransit(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
         });
     }
 
@@ -143,7 +170,12 @@ protected function registerLocator()
         $this->app->singleton('ups.locator', function (Container $app) {
             $config = $app->config->get('ups');
 
-            return new Locator($config['access_key'], $config['user_id'], $config['password']);
+            return new Locator(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
         });
     }
 
@@ -157,7 +189,31 @@ protected function registerTradeability()
         $this->app->singleton('ups.tradeability', function (Container $app) {
             $config = $app->config->get('ups');
 
-            return new Tradeability($config['access_key'], $config['user_id'], $config['password']);
+            return new Tradeability(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
+        });
+    }
+
+    /**
+     * Register the Tradeability class.
+     *
+     * @return void
+     */
+    protected function registerShipping()
+    {
+        $this->app->singleton('ups.shipping', function (Container $app) {
+            $config = $app->config->get('ups');
+
+            return new Shipping(
+                $config['access_key'],
+                $config['user_id'],
+                $config['password'],
+                $config['sandbox']
+            );
         });
     }
 
@@ -176,6 +232,7 @@ public function provides()
             'ups.time-in-transit',
             'ups.locator',
             'ups.tradeability',
+            'ups.shipping',
         ];
     }
 }

tests/ConfigTest.php

@@ -25,4 +25,9 @@ public function testPasswordConfig()
     {
         $this->assertEquals(Config::get('ups.password'), 'test');
     }
+
+    public function testSandboxConfig()
+    {
+        $this->assertTrue(Config::get('ups.sandbox'));
+    }
 }

tests/Facades/UpsShippingTest.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace Ptondereau\Tests\LaravelUpsApi\Facades;
+
+use GrahamCampbell\TestBenchCore\FacadeTrait;
+use Ptondereau\LaravelUpsApi\Facades\UpsShipping;
+use Ptondereau\Tests\LaravelUpsApi\TestCase;
+use Ups\Shipping;
+
+/**
+ * This is the UpsTradeabilityTest facade test class.
+ *
+ * @author Pierre Tondereau <[email protected]>
+ */
+class UpsShippingTest extends TestCase
+{
+    use FacadeTrait;
+
+    /**
+     * Get the facade accessor.
+     *
+     * @return string
+     */
+    protected function getFacadeAccessor()
+    {
+        return 'ups.shipping';
+    }
+
+    /**
+     * Get the facade class.
+     *
+     * @return string
+     */
+    protected function getFacadeClass()
+    {
+        return UpsShipping::class;
+    }
+
+    /**
+     * Get the facade root.
+     *
+     * @return string
+     */
+    protected function getFacadeRoot()
+    {
+        return Shipping::class;
+    }
+}

tests/ServiceProviderTest.php

@@ -10,6 +10,7 @@
 use Ups\TimeInTransit;
 use Ups\Tracking;
 use Ups\Tradeability;
+use Ups\Shipping;
 
 /**
  * This is the service provider test class.
@@ -54,4 +55,9 @@ public function testTradeabilityIsInjectable()
     {
         $this->assertIsInjectable(Tradeability::class);
     }
+
+    public function testShippingIsInjectable()
+    {
+        $this->assertIsInjectable(Shipping::class);
+    }
 }