feat: Migrate authenticated user search

Resolves #52 (closed)

Resolves #53 (closed)

This MR includes the following:

• Updates the OpenAPI spec
• Adds RestClient support to fetch people from fdndb-api
• Adds process of fetching from fdndb before ldap
• Adds authenticated user search for uid, name, and email
• Adds testing
• Eliminates a bit of code smell

spec/openapi.yaml

@@ -12,6 +12,51 @@ servers:
     description: Production endpoints for Eclipse Foundation profile data
 
 paths:
+  /account/profile:
+    get:
+      tags:
+        - User Profile
+      summary: Search for user or get current user
+      description: Retrieve information about a user with given params, or the user making the request.
+      security:
+        - OAuth2: [eclipsefdn_view_all_profiles]
+      parameters:
+        - name: uid
+          in: query
+          description: A user uid.
+          required: false
+          schema:
+            type: integer
+        - name: name
+          in: query
+          description: An EF username.
+          required: false
+          schema:
+            type: string
+        - name: mail
+          in: query
+          description: A user email.
+          required: false
+          schema:
+            type: string
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/EfUsers"
+        403:
+          description: Invalid authentication
+        404:
+          description: User not found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Error"
+        500:
+          description: Error while retrieving data.
+
   /account/profile/{name}:
     get:
       tags:
@@ -19,6 +64,8 @@ paths:
       summary: Retrieve user
       description: Retrieve profile information about a specified user.
       operationId: RetrieveUser
+      security:
+        - OAuth2: [eclipsefdn_view_all_profiles]
       parameters:
         - name: name
           in: path
@@ -35,43 +82,6 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/EfUser"
-              example:
-                uid: 9
-                name: cguindon
-                mail: chris.guindon@eclipse-foundation.org
-                picture: https://secure.gravatar.com/avatar/fbbbb03860062596a5cf11105dcc7d47.jpg?d=mm&s=185&r=G
-                eca:
-                  signed: true
-                  can_contribute_spec_project: true
-                is_committer: true
-                friends:
-                  friend_id: 6104
-                first_name: Christopher
-                last_name: Guindon
-                github_handle: chrisguindon
-                twitter_handle: chrisguindon
-                org: Eclipse Foundation
-                org_id: null
-                job_title: Lead Web Application Developper
-                website: http://www.chrisguindon.com/
-                country:
-                  code: CA
-                  name: Canada
-                bio: Hello world! When I am not at a computer, which is rare, I spend my time playing the drums, watching hockey or at the top of a hill snowboarding. I am also very passionate about music and live concerts!
-                interests:
-                  - Snowboarding
-                  - webdev
-                  - php
-                  - javascript
-                  - Drums
-                working_groups_interests:
-                  - adoptium
-                  - oniro
-                forums_url: "https://api.eclipse.org/account/profile/chrisguindon/forum"
-                projects_url: "https://api.eclipse.org/account/profile/chrisguindon/projects"
-                gerrit_url: "https://api.eclipse.org/account/profile/chrisguindon/gerrit"
-                mailinglist_url: "https://api.eclipse.org/account/profile/chrisguindon/mailing-list"
-                mpc_favorites_url: "https://api.eclipse.org/marketplace/favorites/?name=chrisguindon"
         404:
           description: User not found
           content:
@@ -81,7 +91,7 @@ paths:
         500:
           description: Error while retrieving data.
       deprecated: false
-  
+
   /github/profile/{handle}:
     get:
       tags:
@@ -89,6 +99,8 @@ paths:
       summary: Retrieve user
       description: Retrieve profile information about a specified user.
       operationId: RetrieveUser
+      security:
+        - OAuth2: [eclipsefdn_view_all_profiles]
       parameters:
         - name: handle
           in: path
@@ -105,43 +117,6 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/EfUser"
-              example:
-                uid: 9
-                name: cguindon
-                mail: chris.guindon@eclipse-foundation.org
-                picture: https://secure.gravatar.com/avatar/fbbbb03860062596a5cf11105dcc7d47.jpg?d=mm&s=185&r=G
-                eca:
-                  signed: true
-                  can_contribute_spec_project: true
-                is_committer: true
-                friends:
-                  friend_id: 6104
-                first_name: Christopher
-                last_name: Guindon
-                github_handle: chrisguindon
-                twitter_handle: chrisguindon
-                org: Eclipse Foundation
-                org_id: null
-                job_title: Lead Web Application Developper
-                website: http://www.chrisguindon.com/
-                country:
-                  code: CA
-                  name: Canada
-                bio: Hello world! When I am not at a computer, which is rare, I spend my time playing the drums, watching hockey or at the top of a hill snowboarding. I am also very passionate about music and live concerts!
-                interests:
-                  - Snowboarding
-                  - webdev
-                  - php
-                  - javascript
-                  - Drums
-                working_groups_interests:
-                  - adoptium
-                  - oniro
-                forums_url: "https://api.eclipse.org/account/profile/chrisguindon/forum"
-                projects_url: "https://api.eclipse.org/account/profile/chrisguindon/projects"
-                gerrit_url: "https://api.eclipse.org/account/profile/chrisguindon/gerrit"
-                mailinglist_url: "https://api.eclipse.org/account/profile/chrisguindon/mailing-list"
-                mpc_favorites_url: "https://api.eclipse.org/marketplace/favorites/?name=chrisguindon"
         404:
           description: User not found
           content:
@@ -290,6 +265,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/UserDeleteRequests"
+        403:
+          description: Invalid authentication
         404:
           description: User not found
           content:
@@ -358,12 +335,14 @@ paths:
           schema:
             type: integer
       responses:
-        200: 
+        200:
           description: Success
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/UserDeleteRequests"
+        403:
+          description: Invalid authentication
         500:
           description: Error while retrieving data.
 
@@ -383,12 +362,14 @@ paths:
           schema:
             type: integer
       responses:
-        200: 
+        200:
           description: Success
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/UserDeleteRequest"
+        403:
+          description: Invalid authentication
         404:
           description: Delete Request not found.
           content:
@@ -419,7 +400,7 @@ paths:
             schema:
               $ref: "#/components/schemas/RequestStatusUpdate"
       responses:
-        204: 
+        204:
           description: Success - No content
         400:
           description: Bad Request - invalid request body.
@@ -427,6 +408,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Error"
+        403:
+          description: Invalid authentication
         404:
           description: Delete Request not found.
           content:
@@ -450,8 +433,10 @@ paths:
           schema:
             type: integer
       responses:
-        204: 
+        204:
           description: Success - No content
+        403:
+          description: Invalid authentication
         404:
           description: Delete Request not found.
           content:
@@ -477,6 +462,11 @@ components:
       example: 3553
 
   schemas:
+    EfUsers:
+      type: array
+      items:
+        $ref: "#/components/schemas/EfUser"
+
     EfUser:
       type: object
       properties:
@@ -515,8 +505,6 @@ components:
           description: The user's last name.
         publisher_agreements:
           type: object
-          propertyNames:
-            description: The publisher agreement name.
           additionalProperties:
             $ref: "#/components/schemas/PublisherAgreement"
         github_handle:
@@ -581,43 +569,6 @@ components:
             - type: string
             - type: "null"
           description: The user's Marketplace favorites URL.
-      example:
-        uid: 9
-        name: cguindon
-        mail: chris.guindon@eclipse-foundation.org
-        picture: https://secure.gravatar.com/avatar/fbbbb03860062596a5cf11105dcc7d47.jpg?d=mm&s=185&r=G
-        eca:
-          signed: true
-          can_contribute_spec_project: true
-        is_committer: true
-        friends:
-          friend_id: 6104
-        first_name: Christopher
-        last_name: Guindon
-        github_handle: chrisguindon
-        twitter_handle: chrisguindon
-        org: Eclipse Foundation
-        org_id: null
-        job_title: Lead Web Application Developper
-        website: http://www.chrisguindon.com/
-        country:
-          code: CA
-          name: Canada
-        bio: Hello world! When I am not at a computer, which is rare, I spend my time playing the drums, watching hockey or at the top of a hill snowboarding. I am also very passionate about music and live concerts!
-        interests:
-          - Snowboarding
-          - webdev
-          - php
-          - javascript
-          - Drums
-        working_groups_interests:
-          - adoptium
-          - oniro
-        forums_url: "https://api.eclipse.org/account/profile/chrisguindon/forum"
-        projects_url: "https://api.eclipse.org/account/profile/chrisguindon/projects"
-        gerrit_url: "https://api.eclipse.org/account/profile/chrisguindon/gerrit"
-        mailinglist_url: "https://api.eclipse.org/account/profile/chrisguindon/mailing-list"
-        mpc_favorites_url: "https://api.eclipse.org/marketplace/favorites/?name=chrisguindon"
 
     Eca:
       type: object
@@ -628,9 +579,6 @@ components:
         can_contribute_spec_project:
           type: boolean
           description: Flag determining whether users can contribute to a spec project.
-      example:
-        signed: true
-        can_contribute_spec_project: true
 
     Friends:
       type: object
@@ -638,21 +586,20 @@ components:
         friend_id:
           type: integer
           description: The friend's userid.
-      example:
-        friend_id: 6104
 
     Country:
       type: object
       properties:
         code:
-          type: string
+          oneOf:
+            - type: string
+            - type: "null"
           description: The country code.
         name:
-          type: string
+          oneOf:
+            - type: string
+            - type: "null"
           description: The country name.
-      example:
-        code: CA
-        name: Canada
 
     PublisherAgreement:
       type: object
@@ -734,7 +681,7 @@ components:
           description: The active date for tis record
         relation:
           $ref: "#/components/schemas/Relation"
-        
+
     Relation:
       type: object
       properties:
@@ -756,7 +703,7 @@ components:
         type:
           type: string
           description: The type code.
-        description: 
+        description:
           type: string
           description: The type description.
 
@@ -811,12 +758,10 @@ components:
         url:
           type: string
           description: The URL pointing to the resource
-    
+
     RequestStatusUpdate:
       type: object
       properties:
         status:
           type: integer
           description: The desired status for updating the delete request.
-
-