Add portfolios and representations

Author: danmichaelo

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- Add portfolios and representations to Bib objects.
+
 ### Fixed
 
 - Set MMS id on Bib object when initiated from SRU response.

README.md

@@ -14,19 +14,20 @@ 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)
   * [Note about lazy-loading and existence-checking](#note-about-lazy-loading-and-existence-checking)
-  * [Bibs: Bibliographic records, Holdings, Items](#bibs-bibliographic-records-holdings-items)
+  * [Bibs: Bibliographic records, Holdings, Representations, Portfolios](#bibs-bibliographic-records-holdings-representations-portfolios)
      * [Getting a single record](#getting-a-single-record)
      * [The MARC21 record](#the-marc21-record)
      * [Searching for records](#searching-for-records)
      * [Getting linked record from network zone](#getting-linked-record-from-network-zone)
      * [Editing records](#editing-records)
      * [Holdings and items](#holdings-and-items)
-  * [Items](#items)
+     * [Item by barcode](#items-by-barcode)
+     * [Electronic portfolios and collections](#electronic-portfolios-and-collections)
+     * [Digital representation and files](#digital-representation-and-files)
   * [Users, loans, fees and requests](#users-loans-fees-and-requests)
      * [Search](#search)
      * [Loans](#loans)
@@ -35,6 +36,9 @@ If the package doesn't fit your needs, you might take a look at the alternative
   * [Analytics reports](#analytics-reports)
      * [Column names](#column-names)
      * [Filters](#filters)
+  * [Task lists](#task-lists)
+     * [Lending requests](#lending-requests)
+     * [Requested resources (pick from shelf)](#requested-resources-pick-from-shelf)
   * [Laravel 5 integration](#laravel-5-integration)
   * [Future plans](#future-plans)
 
@@ -155,7 +159,7 @@ if (!$bib->exists()) {
 }
 ```
 
-## Bibs: Bibliographic records, Holdings, Items
+## Bibs: Bibliographic records, Holdings, Representations, Portfolios
 
 ### Getting a single record
 
@@ -279,14 +283,45 @@ foreach ($bib->holdings as $holding) {
 In this case, the client makes one request to fetch the list of holdings, and
 then one request per holding to fetch items.
 
-## Items
+### Item by barcode
 
 There is a special entrypoint to retrieve an item by barcode:
 
 ```php
 $item = $alma->items->fromBarcode('92nf02526');
 ```
 
+### Electronic portfolios and collections
+
+Electronic portfolios and collections are available on the `Bib` object in the same way as holdings.
+
+```php
+$bib = $alma->bibs->get('990310361044702204');
+foreach ($bib->portfolios as $portfolio) {
+    echo "{$portfolio->portfolio_id} {$portfolio->electronic_collection->service->link} ";
+    echo "{$portfolio->electronic_collection->public_name}\n";
+}
+```
+
+```php
+$bib = $alma->bibs->get('990310361044702204');
+foreach ($bib->electronic_collections as $collection) {
+    echo "{$collection->public_name}";
+}
+```
+
+### Digital representation and files
+
+```php
+$bib = $alma->bibs->get('990310361044702204');
+foreach ($bib->representations as $rep) {
+    echo "{$rep->representation_id} {$rep->label}\n";
+    foreach ($rep->files as $rep_file) {
+        echo "{$rep_file->label} {$rep_file->thumbnail_url}\n";
+    }
+}
+```
+
 ## Users, loans, fees and requests
 
 **Note**: Editing is not yet implemented.

spec/Bibs/ElectronicCollectionsSpec.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace spec\Scriptotek\Alma\Bibs;
+
+use Scriptotek\Alma\Bibs\Bib;
+use Scriptotek\Alma\Bibs\ElectronicCollections;
+use Scriptotek\Alma\Client as AlmaClient;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Scriptotek\Alma\Electronic\Collection;
+use spec\Scriptotek\Alma\SpecHelper;
+
+class ElectronicCollectionsSpec extends ObjectBehavior
+{
+    public function let(AlmaClient $client, Bib $bib)
+    {
+        $bib->mms_id = 'abc';
+        $this->beConstructedWith($client, $bib);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType(ElectronicCollections::class);
+    }
+
+    protected function expectRequest($client)
+    {
+        $client->getJSON('/bibs/abc/e-collections')
+            ->shouldBeCalled()
+            ->willReturn(SpecHelper::getDummyData('e-collections_response.json'));
+    }
+
+    public function it_is_countable(AlmaClient $client)
+    {
+        $this->expectRequest($client);
+
+        $this->shouldHaveCount(1);
+    }
+
+    public function it_provides_basic_data_without_loading_the_full_record(AlmaClient $client)
+    {
+        $this->expectRequest($client);
+
+        $c = $this->all()[0];
+
+        $c->shouldHaveType(Collection::class);
+        $c->public_name->shouldBe('SpringerLink Books Complete');
+    }
+}

spec/Bibs/FileSpec.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace spec\Scriptotek\Alma\Bibs;
+
+use Scriptotek\Alma\Bibs\Bib;
+use Scriptotek\Alma\Bibs\Representation;
+use Scriptotek\Alma\Bibs\File;
+use Scriptotek\Alma\Client as AlmaClient;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+
+class FileSpec extends ObjectBehavior
+{
+    public function let(AlmaClient $client, Bib $bib, Representation $representation)
+    {
+        $bib->mms_id = '990006312214702204';
+        $representation->representation_id = '22163771200002204';
+        $file_id = '23163771190002204';
+
+        $this->beConstructedWith($client, $bib, $representation, $file_id);
+    }
+
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(File::class);
+    }
+
+}

spec/Bibs/FilesSpec.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace spec\Scriptotek\Alma\Bibs;
+
+use Scriptotek\Alma\Bibs\Bib;
+use Scriptotek\Alma\Bibs\Representation;
+use Scriptotek\Alma\Bibs\Files;
+use Scriptotek\Alma\Client as AlmaClient;
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use spec\Scriptotek\Alma\SpecHelper;
+
+class FilesSpec extends ObjectBehavior
+{
+    public function let(AlmaClient $client, Bib $bib, Representation $representation)
+    {
+        $bib->mms_id = 'abc';
+        $representation->representation_id = '123';
+        $this->beConstructedWith($client, $bib, $representation);
+    }
+
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(Files::class);
+    }
+
+    protected function expectRequest($client)
+    {
+        $client->getJSON('/bibs/abc/representations/123/files')
+            ->shouldBeCalled()
+            ->willReturn(SpecHelper::getDummyData('files_response.json'));
+    }
+
+    public function it_is_countable(AlmaClient $client)
+    {
+        $this->expectRequest($client);
+
+        $this->shouldHaveCount(96);
+    }
+}

spec/Bibs/HoldingsSpec.php

@@ -11,55 +11,24 @@
 
 class HoldingsSpec extends ObjectBehavior
 {
-    public $sample = '{
-          "holding": [
-            {
-              "library": {
-                "value": "65144020000121",
-                "desc": "BURNS"
-              },
-              "location": {
-                "value": "UNASSIGNED",
-                "desc": "UNASSIGNED location"
-              },
-              "link": "/almaws/v1/bibs/99100383900121/holdings/2221159990000121",
-              "holding_id": "2221159990000121"
-            },
-            {
-              "library": {
-                "value": "5867020000121",
-                "desc": "Main Library"
-              },
-              "location": {
-                "value": "MICR",
-                "desc": "Microforms"
-              },
-              "link": "/almaws/v1/bibs/99100383900121/holdings/2221410000000121",
-              "holding_id": "2221410000000121"
-            }
-          ],
-          "bib_data": {
-            "title": "Data base",
-            "issn": "0095-0033",
-            "publisher": "Association for Computing Machinery",
-            "link": "/almaws/v1/bibs/99100383900121",
-            "mms_id": 99100383900121,
-            "place_of_publication": "New York :",
-            "network_number": [
-              "(CONSER)  2011250895",
-              "(CKB)954926959913",
-              "(OCoLC)604911177"
-            ]
-          },
-          "total_record_count": 2
-        }';
-
     public function let(AlmaClient $client, Bib $bib)
     {
         $bib->mms_id = 'abc';
         $this->beConstructedWith($client, $bib);
     }
 
+    public function it_is_initializable()
+    {
+        $this->shouldHaveType(Holdings::class);
+    }
+
+    protected function expectRequest($client)
+    {
+        $client->getJSON('/bibs/abc/holdings')
+            ->shouldBeCalled()
+            ->willReturn(SpecHelper::getDummyData('holdings_response.json'));
+    }
+
     public function it_provides_a_lazy_interface_to_holding_objects(AlmaClient $client, Bib $bib)
     {
         SpecHelper::expectNoRequests($client);
@@ -86,18 +55,14 @@ public function it_provides_a_lazy_array_interface_to_holding_objects(AlmaClient
 
     public function it_is_countable(AlmaClient $client)
     {
-        $client->getJSON('/bibs/abc/holdings')
-            ->shouldBeCalled()
-            ->willReturn(json_decode($this->sample));
+        $this->expectRequest($client);
 
         $this->shouldHaveCount(2);
     }
 
     public function it_provides_an_iterator_interface_to_holding_objects(AlmaClient $client)
     {
-        $client->getJSON('/bibs/abc/holdings')
-            ->shouldBeCalled()
-            ->willReturn(json_decode($this->sample));
+        $this->expectRequest($client);
 
         $this->shouldImplement('Iterator');
 
@@ -106,9 +71,7 @@ public function it_provides_an_iterator_interface_to_holding_objects(AlmaClient
 
     public function it_provides_basic_data_without_loading_the_full_record(AlmaClient $client)
     {
-        $client->getJSON('/bibs/abc/holdings')
-            ->shouldBeCalledTimes(1)
-            ->willReturn(json_decode($this->sample));
+        $this->expectRequest($client);
 
         $this->shouldHaveCount(2);
         $this->all()[0]->shouldHaveType(Holding::class);

spec/Bibs/PortfolioSpec.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace spec\Scriptotek\Alma\Bibs;
+
+use PhpSpec\ObjectBehavior;
+use Prophecy\Argument;
+use Scriptotek\Alma\Bibs\Bib;
+use Scriptotek\Alma\Bibs\Portfolio;
+use Scriptotek\Alma\Bibs\Portfolios;
+use Scriptotek\Alma\Client as AlmaClient;
+use Scriptotek\Alma\Electronic\Collection;
+use spec\Scriptotek\Alma\SpecHelper;
+
+class PortfolioSpec extends ObjectBehavior
+{
+    public function let(AlmaClient $client, Bib $bib)
+    {
+        $bib->mms_id = 'abc';
+        $portfolio_id = '123';
+        $this->beConstructedWith($client, $bib, $portfolio_id);
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType(Portfolio::class);
+    }
+
+    protected function expectRequest($client)
+    {
+        $client->getJSON('/bibs/abc/portfolios/123')
+            ->shouldBeCalled()
+            ->willReturn(SpecHelper::getDummyData('portfolio_response.json'));
+    }
+
+    public function it_fetches_data_when_needed(AlmaClient $client)
+    {
+        $this->expectRequest($client);
+
+        $this->availability->desc->shouldBe('Available');
+    }
+
+    public function it_belongs_to_collection(AlmaClient $client)
+    {
+        $this->expectRequest($client);
+
+        $this->getElectronicCollection()->shouldHaveType(Collection::class);
+        $this->electronic_collection->shouldHaveType(Collection::class);
+    }}