Add user requests

Author: danmichaelo

CHANGELOG.md

@@ -28,6 +28,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Analytics: The `getRows()` method is deprecated. Iterate over the `Report` instead.
 - Made package auto-discoverable in Laravel 5.5+.
 - Added helper method `Users::findOne()` to get the first match from a search.
+- Added support for retrieving user requests from `Bib`, `Item` and `User`.
 
 ### Changed
 

README.md

@@ -14,6 +14,7 @@ If the package doesn't fit your needs, you might take a look at the alternative
 
 ## Table of Contents
 
+  * [Table of Contents](#table-of-contents)
   * [Install using Composer](#install-using-composer)
   * [Initializing a client](#initializing-a-client)
   * [Quick intro](#quick-intro)
@@ -26,8 +27,11 @@ If the package doesn't fit your needs, you might take a look at the alternative
      * [Editing records](#editing-records)
      * [Holdings and items](#holdings-and-items)
   * [Items](#items)
-  * [Users and loans](#users-and-loans)
+  * [Users, loans, fees and requests](#users-loans-fees-and-requests)
+     * [Search](#search)
      * [Loans](#loans)
+     * [Fees](#fees)
+     * [Requests](#requests)
   * [Analytics reports](#analytics-reports)
      * [Column names](#column-names)
      * [Filters](#filters)
@@ -281,7 +285,7 @@ There is a special entrypoint to retrieve an item by barcode:
 $item = $alma->items->fromBarcode('92nf02526');
 ```
 
-## Users, loans and fees
+## Users, loans, fees and requests
 
 **Note**: Editing is not yet implemented.
 
@@ -321,6 +325,18 @@ foreach ($user->fees as $fee) {
 }
 ```
 
+### Requests
+
+Example:
+
+```php
+foreach ($user->requests as $request) {
+    echo json_encode($request, JSON_PRETTY_PRINT);
+}
+```
+
+Requests can also be retrieved from a `Bib` object or an `Item` object.
+
 ## Analytics reports
 
 To retrieve the results from a single report:

spec/Bibs/BibSpec.php

@@ -10,6 +10,7 @@
 use Scriptotek\Alma\Bibs\Holdings;
 use Scriptotek\Alma\Client as AlmaClient;
 use Scriptotek\Alma\Exception\ResourceNotFound;
+use Scriptotek\Alma\Users\Requests;
 use Scriptotek\Marc\Record;
 use spec\Scriptotek\Alma\SpecHelper;
 
@@ -94,4 +95,9 @@ public function it_catches_resource_not_found(AlmaClient $client)
 
         $this->exists()->shouldBe(false);
     }
+
+    public function it_has_requests()
+    {
+        $this->requests->shouldHaveType(Requests::class);
+    }
 }

spec/Bibs/ItemSpec.php

@@ -10,6 +10,7 @@
 use Scriptotek\Alma\Bibs\ScanInResponse;
 use Scriptotek\Alma\Conf\Library;
 use Scriptotek\Alma\Users\Loan;
+use Scriptotek\Alma\Users\Requests;
 use Scriptotek\Alma\Users\User;
 use spec\Scriptotek\Alma\SpecHelper;
 
@@ -79,4 +80,9 @@ function it_can_be_scanned_in(AlmaClient $client, Library $library)
         $this->scanIn($library)
             ->shouldHaveType(ScanInResponse::class);
     }
+
+    public function it_has_requests()
+    {
+        $this->requests->shouldHaveType(Requests::class);
+    }
 }

spec/Users/RequestSpec.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace spec\Scriptotek\Alma\Users;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Scriptotek\Alma\Client as AlmaClient;
+use Scriptotek\Alma\Users\Request;
+use Scriptotek\Alma\Users\User;
+
+class RequestSpec extends ObjectBehavior
+{
+    public function let(AlmaClient $client, User $user)
+    {
+        $this->beConstructedWith($client, $user, '123');
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType(Request::class);
+    }
+}

spec/Users/RequestsSpec.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace spec\Scriptotek\Alma\Users;
+
+use Scriptotek\Alma\Client as AlmaClient;
+use Scriptotek\Alma\Users\Requests;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use spec\Scriptotek\Alma\SpecHelper;
+
+class RequestsSpec extends ObjectBehavior
+{
+    public function let(AlmaClient $client)
+    {
+        $url = '/bibs/1/holdings/2/items/3/requests';
+        $this->beConstructedWith($client, $url);
+    }
+
+    public function it_is_countable(AlmaClient $client)
+    {
+        $client->getJSON('/bibs/1/holdings/2/items/3/requests')
+            ->shouldBeCalled()
+            ->willReturn(SpecHelper::getDummyData('item_requests_response.json'));
+
+        $this->shouldHaveCount(1);
+    }
+
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType(Requests::class);
+    }
+}

spec/Users/UserSpec.php

@@ -6,6 +6,7 @@
 use Scriptotek\Alma\Client as AlmaClient;
 use Scriptotek\Alma\Users\Fees;
 use Scriptotek\Alma\Users\Loans;
+use Scriptotek\Alma\Users\Requests;
 use Scriptotek\Alma\Users\User;
 use spec\Scriptotek\Alma\SpecHelper;
 
@@ -65,4 +66,9 @@ function it_has_fees(AlmaClient $client)
         SpecHelper::expectNoRequests($client);
         $this->fees->shouldHaveType(Fees::class);
     }
+
+    public function it_has_requests()
+    {
+        $this->requests->shouldHaveType(Requests::class);
+    }
 }

spec/data/item_requests_response.json

@@ -0,0 +1,30 @@
+{
+    "total_record_count": 1,
+    "user_request": [
+        {
+            "author": "Osipov, Andrey V.",
+            "barcode": null,
+            "comment": null,
+            "description": null,
+            "material_type": {
+                "desc": null,
+                "value": null
+            },
+            "mms_id": "999919897211902204",
+            "pickup_location": "UiO Realfagsbiblioteket",
+            "pickup_location_library": "1030310",
+            "pickup_location_type": "LIBRARY",
+            "place_in_queue": 1,
+            "request_date": "2018-07-31Z",
+            "request_id": "1403795240001204",
+            "request_status": "NOT_STARTED",
+            "request_sub_type": {
+                "desc": "Patron physical item request",
+                "value": "PATRON_PHYSICAL"
+            },
+            "request_type": "HOLD",
+            "title": "Modern electromagnetic scattering theory with applications Andrey V. Osipov, Sergei A. Tretyakov",
+            "user_primary_id": "Some User"
+        }
+    ]
+}

src/Bibs/Bib.php

@@ -6,6 +6,7 @@
 use Scriptotek\Alma\Client;
 use Scriptotek\Alma\Exception\NoLinkedNetworkZoneRecordException;
 use Scriptotek\Alma\Model\LazyResource;
+use Scriptotek\Alma\Users\Requests;
 use Scriptotek\Marc\Record as MarcRecord;
 use Scriptotek\Sru\Record as SruRecord;
 
@@ -23,11 +24,15 @@ class Bib extends LazyResource
     /* @var MarcRecord */
     protected $_marc;
 
+    /** @var Requests */
+    public $requests;
+
     public function __construct(Client $client = null, $mms_id = null)
     {
         parent::__construct($client);
         $this->mms_id = $mms_id;
         $this->holdings = Holdings::make($this->client, $this);
+        $this->requests = Requests::make($this->client, $this->url('/requests'));
     }
 
     /**

src/Bibs/Item.php

@@ -6,6 +6,7 @@
 use Scriptotek\Alma\Conf\Library;
 use Scriptotek\Alma\Model\LazyResource;
 use Scriptotek\Alma\Users\Loan;
+use Scriptotek\Alma\Users\Requests;
 use Scriptotek\Alma\Users\User;
 
 class Item extends LazyResource
@@ -16,8 +17,11 @@ class Item extends LazyResource
     /** @var Holding */
     public $holding;
 
+    /** @var Requests */
+    public $requests;
+
     /** @var string */
-    protected $item_id;
+    public $item_id;
 
     /**
      * Item constructor.
@@ -33,6 +37,7 @@ public function __construct(Client $client, Bib $bib, Holding $holding, $item_id
         $this->bib = $bib;
         $this->holding = $holding;
         $this->item_id = $item_id;
+        $this->requests = Requests::make($this->client, $this->url('/requests'));
     }
 
     /**