Develop

README.md

@@ -1,5 +1,5 @@
 # COmanage Registry (Pupal Eclosion)
 
-This is the development repository for COmanage Registry v5.0.0.
+This is the repository for COmanage Registry v5+.
 
-For production deployments, see [this repository](https://github.com/Internet2/comanage-registry) instead.
+For v4, see [this repository](https://github.com/Internet2/comanage-registry) instead.

app/availableplugins/ApiConnector/config/plugin.json

@@ -0,0 +1,48 @@
+{
+  "types": {
+    "api": [
+      "ApiSourceEndpoints"
+    ],
+    "external_identity_source": [
+      "ApiSources"
+    ]
+  },
+  "schema": {
+    "tables": {
+      "api_sources": {
+        "columns": {
+          "id": {},
+          "external_identity_source_id": {}
+        },
+        "indexes": {
+          "api_sources_i1": { "columns": [ "external_identity_source_id" ] }
+        }
+      },
+      "api_source_endpoints": {
+        "columns": {
+          "id": {},
+          "api_id": {},
+          "external_identity_source_id": {}
+        },
+        "indexes": {
+          "api_source_endpoints_i1": { "columns": [ "api_id" ] },
+          "api_source_endpoints_i2": { "columns": [ "external_identity_source_id" ] }
+        }
+      },
+      "api_source_records": {
+        "columns": {
+          "id": {},
+          "api_source_id": { "type": "integer", "foreignkey": { "table": "api_sources", "column": "id" } },
+          "source_key": { "type": "string", "size": 1024 },
+          "source_record": { "type": "text" }
+        },
+        "indexes": {
+          "api_source_records_i1": { "columns": [ "api_source_id" ] },
+          "api_source_records_i2": { "columns": [ "api_source_id", "source_key" ] }
+        },
+        "changelog": false,
+        "clone_relation": true
+      }
+    }
+  }
+}

app/availableplugins/ApiConnector/config/routes.php

@@ -55,21 +55,21 @@
 
   $builder->delete(
     '/{id}/v2/sorPeople/{sorlabel}/{sorid}',
-    ['plugin' => 'ApiConnector', 'controller' => 'ApiV2', 'action' => 'delete']
+    ['plugin' => 'ApiConnector', 'controller' => 'SorApiV2', 'action' => 'delete']
   )
   ->setPass(['id', 'sorlabel', 'sorid'])
   ->setPatterns(['id' => '[0-9]+']);
 
   $builder->get(
     '/{id}/v2/sorPeople/{sorlabel}/{sorid}',
-    ['plugin' => 'ApiConnector', 'controller' => 'ApiV2', 'action' => 'get']
+    ['plugin' => 'ApiConnector', 'controller' => 'SorApiV2', 'action' => 'get']
   )
   ->setPass(['id', 'sorlabel', 'sorid'])
   ->setPatterns(['id' => '[0-9]+']);
 
   $builder->put(
     '/{id}/v2/sorPeople/{sorlabel}/{sorid}',
-    ['plugin' => 'ApiConnector', 'controller' => 'ApiV2', 'action' => 'upsert']
+    ['plugin' => 'ApiConnector', 'controller' => 'SorApiV2', 'action' => 'upsert']
   )
   ->setPass(['id', 'sorlabel', 'sorid'])
   ->setPatterns(['id' => '[0-9]+']);

app/availableplugins/ApiConnector/resources/locales/en_US/api_connector.po

@@ -25,6 +25,13 @@
 msgid "controller.ApiSources"
 #msgstr "{0,plural,=1{API Source} other{API Sources}}"
 
+# XXX this should autodetect and use the controller key?
+msgid "field.api_source_id"
+msgstr "API Source"
+
+msgid "field.ApiSourceEndpoints.external_identity_source_id"
+msgstr "API Source"
+
 msgid "field.ApiSources.push_mode"
 msgstr "Push Mode"
 

app/availableplugins/ApiConnector/src/Controller/ApiSourceEndpointsController.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * COmanage Registry Api Source Endpoints Controller
+ *
+ * Portions licensed to the University Corporation for Advanced Internet
+ * Development, Inc. ("UCAID") under one or more contributor license agreements.
+ * See the NOTICE file distributed with this work for additional information
+ * regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with the
+ * License. You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * @link          https://www.internet2.edu/comanage COmanage Project
+ * @package       registry-plugins
+ * @since         COmanage Registry v5.2.0
+ * @license       Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
+ */
+
+declare(strict_types=1);
+
+namespace ApiConnector\Controller;
+
+use Cake\Routing\Router;
+use App\Controller\StandardPluginController;
+
+class ApiSourceEndpointsController extends StandardPluginController {
+  protected array $paginate = [
+    'order' => [
+      'ApiSourceEndpoints.id' => 'asc'
+    ]
+  ];
+
+  /**
+   * Callback run prior to the request render.
+   *
+   * @since  COmanage Registry v5.2.0
+   * @param  EventInterface $event Cake Event
+   * @return \Cake\Http\Response   HTTP Response
+   */
+
+  public function beforeRender(\Cake\Event\EventInterface $event) {
+    $link = $this->getPrimaryLink(true);
+
+    if(!empty($link->value)) {
+      $this->set('vv_bc_parent_obj', $this->ApiSourceEndpoints->Apis->get($link->value));
+      $this->set('vv_bc_parent_displayfield', $this->ApiSourceEndpoints->Apis->getDisplayField());
+      $this->set('vv_bc_parent_primarykey', $this->ApiSourceEndpoints->Apis->getPrimaryKey());
+    }
+
+    $vv_obj = $this->viewBuilder()->getVar('vv_obj');
+
+    if(!empty($vv_obj->external_identity_source->api_source->id)) {
+      // For consistency with other plugins, the data model points to the External Identity Source
+      // but the API points to Api Source.
+
+      $this->set(
+        'vv_push_endpoint',
+        Router::url(
+          url: '/api/apisource/' 
+                . $vv_obj->external_identity_source->api_source->id
+                . '/v2/sorPeople/' 
+                . $vv_obj->external_identity_source->sor_label,
+          full: true
+        )
+      );
+    }
+
+    return parent::beforeRender($event);
+  }
+}

app/availableplugins/ApiConnector/src/Controller/ApiSourcesController.php

@@ -29,11 +29,12 @@
 
 namespace ApiConnector\Controller;
 
+use Cake\Event\EventInterface;
 use Cake\Routing\Router;
 use App\Controller\StandardPluginController;
 
 class ApiSourcesController extends StandardPluginController {
-  public $paginate = [
+  protected array $paginate = [
     'order' => [
       'ApiSources.id' => 'asc'
     ]
@@ -42,24 +43,20 @@ class ApiSourcesController extends StandardPluginController {
   /**
    * Callback run prior to the request render.
    *
+   * @param   EventInterface  $event  Cake Event
+   *
+   * @return Response|void
    * @since  COmanage Registry v5.0.0
-   * @param  EventInterface $event Cake Event
-   * @return \Cake\Http\Response   HTTP Response
    */
 
-  public function beforeRender(\Cake\Event\EventInterface $event) {
-    $apiSource = $this->ApiSources->get(
-      $this->request->getParam('pass.0'), 
-      ['contain' => 'ExternalIdentitySources']
-    );
-
-    $this->set(
-      'vv_push_endpoint',
-      Router::url(
-        url: '/api/apisource/' . $apiSource->id . '/v2/sorPeople/' . $apiSource->external_identity_source->sor_label,
-        full: true
-      )
-    );
+  public function beforeRender(EventInterface $event) {
+    $link = $this->getPrimaryLink(true);
+
+    if(!empty($link->value)) {
+      $this->set('vv_bc_parent_obj', $this->ApiSources->ExternalIdentitySources->get($link->value));
+      $this->set('vv_bc_parent_displayfield', $this->ApiSources->ExternalIdentitySources->getDisplayField());
+      $this->set('vv_bc_parent_primarykey', $this->ApiSources->ExternalIdentitySources->getPrimaryKey());
+    }
 
     return parent::beforeRender($event);
   }