Add support for setting custom base url

Author: danmichaelo

README.md

@@ -77,6 +77,13 @@ $alma = new AlmaClient('MY_SECRET_API_KEY', 'eu');
 ```
 
 where `'eu'` is the region code for Europe (use `'na'` for North America or `'ap'` for Asia Pacific).
+By default, the API base URL is generated from the region code,
+but if you're connecting to the API through a proxy, you can set the base URL directly:
+
+```
+$alma = new AlmaClient('MY_SECRET_API_KEY')
+    ->setBaseUrl('https://gw-uio.intark.uh-it.no/alma/v1');
+```
 
 If your Alma instance is connected to a network zone and you want to work
 with bib records there, you can also add an API key for the network zone:

config/alma.php

@@ -29,4 +29,13 @@
         'sru' => env('ALMA_NZ_SRU_URL'),
     ],
 
+    /*
+    |--------------------------------------------------------------------------
+    | Base URL
+    |--------------------------------------------------------------------------
+    | This is only necessary to set if you connect to a non-standard API URL,
+    | for instance though a proxy.
+    */
+    'baseUrl' => null,
+
 ];

spec/ClientSpec.php

@@ -28,6 +28,14 @@ public function let()
         return $http;
     }
 
+    public function it_can_be_constructed_with_custom_base_url()
+    {
+        $this->beConstructedWith('DummyKey');
+        $this->setBaseUrl('http://proxy.foxy');
+        $this->baseUrl->shouldBe('http://proxy.foxy');
+    }
+
+
     protected function httpWithResponseBody($body, $statusCode = 200, $headers = [])
     {
         $http = $this->let();

src/Client.php

@@ -117,6 +117,7 @@ class Client
      * @param ?HttpClientInterface     $http
      * @param ?RequestFactoryInterface $requestFactory
      * @param ?UriFactoryInterface     $uriFactory
+     * @param ?string                  $baseUrl
      *
      * @throws \ErrorException
      */
@@ -126,7 +127,8 @@ public function __construct(
         $zone = Zones::INSTITUTION,
         HttpClientInterface $http = null,
         RequestFactoryInterface $requestFactory = null,
-        UriFactoryInterface $uriFactory = null
+        UriFactoryInterface $uriFactory = null,
+        string $baseUrl = null
     ) {
         $this->http = new PluginClient(
             $http ?: HttpClient::client(),
@@ -139,7 +141,12 @@ public function __construct(
         $this->uriFactory = $uriFactory ?: HttpFactory::uriFactory();
 
         $this->key = $key;
-        $this->setRegion($region);
+
+        if (!is_null($baseUrl)) {
+            $this->setBaseUrl($baseUrl);
+        } else {
+            $this->setRegion($region);
+        }
 
         $this->zone = $zone;
 
@@ -156,7 +163,7 @@ public function __construct(
         $this->taskLists = new TaskLists($this);
 
         if ($zone == Zones::INSTITUTION) {
-            $this->nz = new self(null, $region, Zones::NETWORK, $this->http, $this->requestFactory, $this->uriFactory);
+            $this->nz = new self(null, $region, Zones::NETWORK, $this->http, $this->requestFactory, $this->uriFactory, $baseUrl);
         } elseif ($zone != Zones::NETWORK) {
             throw new AlmaClientException('Invalid zone name.');
         }
@@ -207,17 +214,32 @@ public function setKey($key)
      * Set the Alma region code ('na' for North America, 'eu' for Europe, 'ap' for Asia Pacific).
      *
      * @param $regionCode
-     *
-     * @throws \ErrorException
-     *
+     * @throws AlmaClientException
      * @return $this
      */
     public function setRegion($regionCode)
     {
         if (!in_array($regionCode, ['na', 'eu', 'ap'])) {
             throw new AlmaClientException('Invalid region code');
         }
-        $this->baseUrl = 'https://api-' . $regionCode . '.hosted.exlibrisgroup.com/almaws/v1';
+        $this->setBaseUrl('https://api-' . $regionCode . '.hosted.exlibrisgroup.com/almaws/v1');
+
+        return $this;
+    }
+
+    /**
+     * Set the Alma API base url.
+     *
+     * @param string $baseUrl
+     * @return $this
+     */
+    public function setBaseUrl(string $baseUrl)
+    {
+        $this->baseUrl = $baseUrl;
+
+        if (!is_null($this->nz)) {
+            $this->nz->setBaseUrl($baseUrl);
+        }
 
         return $this;
     }

src/Laravel/ServiceProvider.php

@@ -51,7 +51,8 @@ public function register()
                 Zones::INSTITUTION,
                 isset($app[HttpClientInterface::class]) ? $app[HttpClientInterface::class] : null,
                 isset($app[RequestFactoryInterface::class]) ? $app[RequestFactoryInterface::class] : null,
-                isset($app[UriFactoryInterface::class]) ? $app[UriFactoryInterface::class] : null
+                isset($app[UriFactoryInterface::class]) ? $app[UriFactoryInterface::class] : null,
+                $app['config']->get('alma.baseUrl')
             );
 
             // Set network zone key, if any