Fix Laravel SP, rename baseUrl to entrypoint

scriptotek · Apr 14, 2021 · b43aa53 · b43aa53
1 parent 9421780
commit b43aa53
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -77,12 +77,12 @@ $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:
+By default, the API entry point URL is generated from the region code,
+but if you're connecting to the API through a proxy, you can configure a different URL:
 
 ```
 $alma = new AlmaClient('MY_SECRET_API_KEY')
-    ->setBaseUrl('https://gw-uio.intark.uh-it.no/alma/v1');
+    ->setEntryPoint('https://gw-uio.intark.uh-it.no/alma/v1');
 ```
 
 If your Alma instance is connected to a network zone and you want to work

diff --git a/config/alma.php b/config/alma.php
@@ -21,12 +21,12 @@
         // SRU URL for institution zone
         'sru' => env('ALMA_IZ_SRU_URL'),
 
-        // Base URL for institution zone. This only needs to be specified if you
-        // use a proxy or other non-standard URL.
-        'baseUrl' => null,
+        // Entry point URL. This only needs to be specified if you use a proxy
+        // or other non-standard entry point.
+        'entrypoint' => null,
 
         // Optional list of extra headers to send with each request.
-        'extraHeaders' => [
+        'headers' => [
             // 'x-proxy-auth' => 'custom proxy auth'
         ],
     ],
@@ -43,12 +43,12 @@
         // SRU URL for institution zone
         'sru' => env('ALMA_NZ_SRU_URL'),
 
-        // Base URL for institution zone. This only needs to be specified if you
-        // use a proxy or other non-standard URL.
-        'baseUrl' => null,
+        // Entry point URL. This only needs to be specified if you use a proxy
+        // or other non-standard entry point.
+        'entrypoint' => null,
 
         // Optional list of extra headers to send with each request.
-        'extraHeaders' => [
+        'headers' => [
             // 'x-proxy-auth' => 'custom proxy auth'
         ],
     ],

diff --git a/spec/ClientSpec.php b/spec/ClientSpec.php
@@ -31,8 +31,8 @@ public function let()
     public function it_can_be_configured_with_custom_base_url()
     {
         $this->beConstructedWith('DummyKey');
-        $this->setBaseUrl('http://proxy.foxy');
-        $this->baseUrl->shouldBe('http://proxy.foxy');
+        $this->setEntryPoint('http://proxy.foxy');
+        $this->entrypoint->shouldBe('http://proxy.foxy');
     }
 
 

diff --git a/src/Client.php b/src/Client.php
@@ -41,7 +41,7 @@
  */
 class Client
 {
-    public $baseUrl;
+    public $entrypoint;
 
     /** @var string Alma zone (institution or network) */
     public $zone;
@@ -89,7 +89,7 @@ class Client
     public $sleepTimeOnServerError = 10;
 
     /** @var array Extra request headers */
-    public $extraHeaders = [];
+    public $headers = [];
 
     /**
      * @var Conf
@@ -115,7 +115,7 @@ class Client
      * Create a new client to connect to a given Alma instance.
      *
      * @param ?string                  $key            API key
-     * @param string                   $region         Hosted region code, used to build base URL
+     * @param string                   $region         Hosted region code, used to build the entrypoint URL
      * @param string                   $zone           Alma zone (Either Zones::INSTITUTION or Zones::NETWORK)
      * @param ?HttpClientInterface     $http
      * @param ?RequestFactoryInterface $requestFactory
@@ -228,33 +228,33 @@ public function setRegion($regionCode)
         if (!in_array($regionCode, ['na', 'eu', 'ap'])) {
             throw new AlmaClientException('Invalid region code');
         }
-        $this->setBaseUrl('https://api-' . $regionCode . '.hosted.exlibrisgroup.com/almaws/v1');
+        $this->setEntryPoint('https://api-' . $regionCode . '.hosted.exlibrisgroup.com/almaws/v1');
 
         return $this;
     }
 
     /**
      * Set the Alma API base url.
      *
-     * @param string $baseUrl
+     * @param string $url
      * @return $this
      */
-    public function setBaseUrl(string $baseUrl)
+    public function setEntryPoint(string $url)
     {
-        $this->baseUrl = $baseUrl;
+        $this->entrypoint = $url;
 
         return $this;
     }
 
     /**
      * Set extra request headers.
      *
-     * @param array $extraHeaders
+     * @param array $headers
      * @return $this
      */
-    public function setExtraHeaders(array $extraHeaders)
+    public function setExtraHeaders(array $headers)
     {
-        $this->extraHeaders = $extraHeaders;
+        $this->headers = $headers;
 
         return $this;
     }
@@ -277,8 +277,8 @@ public function buildUrl($url, $query = [])
 
         $url = $url[0];
 
-        if (strpos($url, $this->baseUrl) === false) {
-            $url = $this->baseUrl . $url;
+        if (strpos($url, $this->entrypoint) === false) {
+            $url = $this->entrypoint . $url;
         }
 
         return $this->uriFactory->createUri($url)
@@ -301,7 +301,7 @@ public function request(RequestInterface $request, $attempt = 1)
         if (isset($this->key)) {
             $request = $request->withHeader('Authorization', 'apikey ' . $this->key);
         }
-        foreach ($this->extraHeaders as $key => $val) {
+        foreach ($this->headers as $key => $val) {
             $request = $request->withHeader($key, $val);
         }
 

diff --git a/src/Laravel/ServiceProvider.php b/src/Laravel/ServiceProvider.php
@@ -54,18 +54,18 @@ public function register()
                 isset($app[UriFactoryInterface::class]) ? $app[UriFactoryInterface::class] : null
             );
 
-            if ($app['config']->get('alma.iz.baseUrl')) {
-                $alma->setBaseUrl($app['config']->get('alma.iz.baseUrl'));
+            if ($app['config']->get('alma.iz.entrypoint')) {
+                $alma->setEntryPoint($app['config']->get('alma.iz.entrypoint'));
             }
-            $alma->setExtraHeaders($app['config']->get('alma.extraHeaders', []));
+            $alma->setExtraHeaders($app['config']->get('alma.iz.headers', []));
 
             // Set network zone key, if any
             $alma->nz->setKey($app['config']->get('alma.nz.key'));
 
-            if ($app['config']->get('alma.nz.baseUrl')) {
-                $alma->nz->setBaseUrl($app['config']->get('alma.nz.baseUrl'));
+            if ($app['config']->get('alma.nz.entrypoint')) {
+                $alma->nz->setEntryPoint($app['config']->get('alma.nz.entrypoint'));
             }
-            $alma->nz->setExtraHeaders($app['config']->get('alma.nz.extraHeaders', []));
+            $alma->nz->setExtraHeaders($app['config']->get('alma.nz.headers', []));
 
             // Optionally, attach SRU client for institution zone
             if ($app['config']->get('alma.iz.sru')) {