Add REST endpoint for mappings

NatLibFi · Oct 1, 2018 · 6432aae · 6432aae
1 parent a8ec734
commit 6432aae
Show file tree

Hide file tree

Showing 5 changed files with 145 additions and 9 deletions.
diff --git a/controller/RestController.php b/controller/RestController.php
@@ -621,6 +621,36 @@ public function data($request)
         return $this->returnDataResults($results, $format);
     }
 
+    /**
+     * Get the mappings associated with a concept, enriched with labels and notations.
+     * Returns a JSKOS-compatible JSON object.
+     * @param Request $request
+     */
+    public function mappings(Request $request)
+    {
+        $vocab = $request->getVocab();
+
+        if ($request->getUri()) {
+            $uri = $request->getUri();
+        } else if ($vocab !== null) { // whole vocabulary - redirect to download URL
+            return $this->redirectToVocabData($request);
+        } else {
+            return $this->returnError(400, 'Bad Request', "uri parameter missing");
+        }
+
+        $results = $vocab->getConceptInfo($uri, $request->getContentLang());
+        $concept = $results[0];
+
+        $ret = [];
+        foreach ($concept->getMappingProperties() as $mappingProperty) {
+            foreach ($mappingProperty->getValues() as $mappingPropertyValue) {
+                $ret[] = $mappingPropertyValue->asJskos();
+            }
+        }
+
+        return $this->returnJson($ret);
+    }
+
     /**
      * Used for querying labels for a uri.
      * @param Request $request

diff --git a/model/Concept.php b/model/Concept.php
@@ -430,14 +430,14 @@ public function getMappingProperties()
                             }
 
                             if ($response) {
-                                $ret[$prop]->addValue(new ConceptMappingPropertyValue($this->model, $this->vocab, $response, $prop), $this->clang);
+                                $ret[$prop]->addValue(new ConceptMappingPropertyValue($this->model, $this->vocab, $response, $this->resource, $prop), $this->clang);
 
                                 $this->processExternalResource($response);
 
                                 continue;
                             }
                         }
-                        $ret[$prop]->addValue(new ConceptMappingPropertyValue($this->model, $this->vocab, $val, $prop, $this->clang), $this->clang);
+                        $ret[$prop]->addValue(new ConceptMappingPropertyValue($this->model, $this->vocab, $val, $this->resource, $prop, $this->clang), $this->clang);
                     }
                 }
             }

diff --git a/model/ConceptMappingPropertyValue.php b/model/ConceptMappingPropertyValue.php
@@ -1,18 +1,32 @@
 <?php
 
+use EasyRdf\Resource;
+
 /**
  * Class for handling concept property values.
  */
 class ConceptMappingPropertyValue extends VocabularyDataObject
 {
     /** property type */
     private $type;
+    private $source;
     private $clang;
     private $labelcache;
 
-    public function __construct($model, $vocab, $resource, $prop, $clang = '')
+    /**
+     * ConceptMappingPropertyValue constructor.
+     *
+     * @param Model $model
+     * @param Vocabulary $vocab  Target vocabulary
+     * @param Resource $target   Target concept resource
+     * @param Resource $source   Source concept resource
+     * @param string $prop       Mapping property
+     * @param ?string $clang     Preferred label language (nullable)
+     */
+    public function __construct(Model $model, Vocabulary $vocab, Resource $target, Resource $source, string $prop, $clang = '')
     {
-        parent::__construct($model, $vocab, $resource);
+        parent::__construct($model, $vocab, $target);
+        $this->source = $source;
         $this->type = $prop;
         $this->clang = $clang;
         $this->labelcache = array();
@@ -148,5 +162,58 @@ public function getNotation()
         return null;
     }
 
+    /**
+     * Return the mapping as a JSKOS-compatible array.
+     * @return array
+     */
+    public function asJskos()
+    {
+        $ret = [
+            'type' => [$this->type],
+            'from' => [
+                'memberSet' => [
+                    [
+                        'uri' => (string) $this->source->getUri(),
+                    ]
+                ]
+            ],
+            'to' => [
+                'memberSet' => [
+                    [
+                        'uri' => (string) $this->getUri()
+                    ]
+                ]
+            ]
+        ];
+
+        $fromScheme = $this->vocab->getDefaultConceptScheme();
+        if (isset($fromScheme)) {
+            $ret['fromScheme'] = [
+                'uri' => (string) $fromScheme,
+            ];
+        }
+
+        $exvocab = $this->getExvocab();
+        if (isset($exvocab)) {
+            $ret['toScheme'] = [
+                'uri' => (string) $exvocab->getDefaultConceptScheme(),
+            ];
+        }
+
+        $notation = $this->getNotation();
+        if (isset($notation)) {
+            $ret['to']['memberSet'][0]['notation'] = (string) $notation;
+        }
+
+        $label = $this->getLabel();
+        if (isset($label)) {
+            $ret['to']['memberSet'][0]['prefLabel'] = [
+                $label->getLang() => $label->getValue(),
+            ];
+        }
+
+        return $ret;
+    }
+
 }
 
diff --git a/rest.php b/rest.php
@@ -53,6 +53,8 @@
             $controller->topConcepts($request);
         } elseif ($parts[2] == 'data') {
             $controller->data($request);
+        } elseif ($parts[2] == 'mappings') {
+            $controller->mappings($request);
         } elseif ($parts[2] == 'search') {
             $controller->search($request);
         } elseif ($parts[2] == 'label') {

diff --git a/tests/ConceptMappingPropertyValueTest.php b/tests/ConceptMappingPropertyValueTest.php
@@ -26,7 +26,8 @@ protected function setUp() {
    */
   public function testConstructor() {
     $resourcestub = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
-    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $resourcestub, 'skos:exactMatch');
+    $sourcestub = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
+    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $resourcestub, $sourcestub, 'skos:exactMatch');
     $this->assertEquals('skos:exactMatch', $mapping->getType());
   }
 
@@ -45,6 +46,7 @@ public function testGetLabelFromExternalVocabulary() {
    * @covers ConceptMappingPropertyValue::queryLabel
    */
   public function testGetLabelResortsToUri() {
+    $mocksource = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $mockres = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $labelmap = array(
       array('en', null),
@@ -57,7 +59,7 @@ public function testGetLabelResortsToUri() {
     );
     $mockres->method('getLiteral')->will($this->returnValueMap($litmap));
     $mockres->method('getUri')->will($this->returnValue('http://thisdoesntexistatalland.sefsf/2j2h4/'));
-    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, null);
+    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, $mocksource, 'skos:exactMatch');
     $this->assertEquals('http://thisdoesntexistatalland.sefsf/2j2h4/', $mapping->getLabel());
   }
 
@@ -66,14 +68,15 @@ public function testGetLabelResortsToUri() {
    * @covers ConceptMappingPropertyValue::queryLabel
    */
   public function testGetLabelWithAndWithoutLang() {
+    $mocksource = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $mockres = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $labelmap = array(
       array('en', 'english'),
       array(null, 'default')
     );
     $mockres->method('label')->will($this->returnValueMap($labelmap));
     $mockres->method('getUri')->will($this->returnValue('http://thisdoesntexistatalland.sefsf/2j2h4/'));
-    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, null);
+    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, $mocksource, 'skos:exactMatch');
     $this->assertEquals('english', $mapping->getLabel('en'));
     $this->assertEquals('default', $mapping->getLabel());
   }
@@ -83,6 +86,7 @@ public function testGetLabelWithAndWithoutLang() {
    * @covers ConceptMappingPropertyValue::queryLabel
    */
   public function testGetLabelWithLiteralAndLang() {
+    $mocksource = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $mockres = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $labelmap = array(
       array('en', null),
@@ -95,7 +99,7 @@ public function testGetLabelWithLiteralAndLang() {
     );
     $mockres->method('getLiteral')->will($this->returnValueMap($litmap));
     $mockres->method('getUri')->will($this->returnValue('http://thisdoesntexistatalland.sefsf/2j2h4/'));
-    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, null);
+    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, $mocksource, 'skos:exactMatch');
     $this->assertEquals('english lit', $mapping->getLabel('en'));
     $this->assertEquals('default lit', $mapping->getLabel());
   }
@@ -104,6 +108,7 @@ public function testGetLabelWithLiteralAndLang() {
    * @covers ConceptMappingPropertyValue::getNotation
    */
   public function testGetNotation() {
+    $mocksource = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $mockres = $this->getMockBuilder('EasyRdf\Resource')->disableOriginalConstructor()->getMock();
     $mocklit = $this->getMockBuilder('EasyRdf\Literal')->disableOriginalConstructor()->getMock();
     $mocklit->method('getValue')->will($this->returnValue('666'));
@@ -112,7 +117,7 @@ public function testGetNotation() {
         array(null,null,null,null),
     );
     $mockres->method('get')->will($this->returnValueMap($map));
-    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, null);
+    $mapping = new ConceptMappingPropertyValue($this->model, $this->vocab, $mockres, $mocksource, 'skos:exactMatch');
     $this->assertEquals(666, $mapping->getNotation());
   }
 
@@ -165,4 +170,36 @@ public function testToString() {
     $this->assertEquals('Eel', $propvals['Eelhttp://www.skosmos.skos/test/ta115']->__toString());
   }
 
+  /**
+   * @covers ConceptMappingPropertyValue::asJskos
+   */
+  public function testAsJskos() {
+    $propvals = $this->props['skos:exactMatch']->getValues();
+    $this->assertEquals([
+      'type' => [
+        'skos:exactMatch',
+      ],
+      'toScheme' => [
+        'uri' => 'http://www.skosmos.skos/test/conceptscheme',
+      ],
+      'from' => [
+        'memberSet' => [
+          [
+            'uri' => 'http://www.skosmos.skos/mapping/m1',
+          ]
+        ]
+      ],
+      'to' => [
+        'memberSet' => [
+          [
+            'uri' => 'http://www.skosmos.skos/test/ta115',
+            'prefLabel' => [
+              'en' => 'Eel',
+            ]
+          ]
+        ]
+      ],
+    ], $propvals['Eelhttp://www.skosmos.skos/test/ta115']->asJskos());
+  }
+
 }