Merge branch 'main' into mock-endpoints

Author: rcmtcristian

.github/workflows/action-cats.yml

@@ -11,6 +11,6 @@ jobs:
     name: A cat for your effort!
     runs-on: ubuntu-latest
     steps:
-      - uses: ruairidhwm/action-cats@1.0.1
+      - uses: ruairidhwm/action-cats@1.0.2
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -35,9 +35,9 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@807578363a7869ca324a79039e6db9c843e0e100
+        uses: github/codeql-action/init@b2a92eb56d8cb930006a1c6ed86b0782dd8a4297
         with:
           languages: javascript
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@807578363a7869ca324a79039e6db9c843e0e100
+        uses: github/codeql-action/analyze@b2a92eb56d8cb930006a1c6ed86b0782dd8a4297

.github/workflows/scorecards-analysis.yml

@@ -54,7 +54,7 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: Upload to code-scanning
-        uses: github/codeql-action/upload-sarif@807578363a7869ca324a79039e6db9c843e0e100
+        uses: github/codeql-action/upload-sarif@b2a92eb56d8cb930006a1c6ed86b0782dd8a4297
         with:
           sarif_file: results.sarif
 

package.json

@@ -49,7 +49,7 @@
     "@fortawesome/free-solid-svg-icons": "^6.2.0",
     "@fortawesome/vue-fontawesome": "^2.0.8",
     "@stripe/stripe-js": "^1.35.0",
-    "@vue-stripe/vue-stripe": "^4.4.2",
+    "@vue-stripe/vue-stripe": "^4.4.4",
     "axios": "^0.27.2",
     "axios-cache-interceptor": "^0.10.7",
     "cli-plugin-eslint": "^0.1.0",
@@ -64,7 +64,7 @@
     "objection": "^3.0.1",
     "pg": "^8.7.3",
     "register-service-worker": "^1.7.1",
-    "stripe": "^8.219.0",
+    "stripe": "^11.1.0",
     "vue": "^2.6.11",
     "vue-router": "^3.5.4",
     "vuetify": "^2.6.8",
@@ -77,7 +77,7 @@
     "@vue/cli-plugin-vuex": "~4.5.0",
     "@vue/cli-service": "~4.5.0",
     "concurrently": "^7.3.0",
-    "eslint": "^8.25.0",
+    "eslint": "^8.29.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-vue": "^8.7.1",
     "husky": "^8.0.1",

server/routes/api/representatives.js

@@ -50,15 +50,34 @@ const ALLOWED_JURISDICTION_FILTERS = Object.keys(JURISDICTION_FILTER_MAP)
 // Endpoints
 
 // Get
-router.get('/:zipCode', async (req, res) => {
-  const { zipCode } = req.params
-  const { filter } = req.query
-
-  if (!zipCode.match(/^\d{5}(-\d{4})?$/)) {
+router.get('/:searchText', async (req, res) => {
+  const { searchText } = req.params
+  const filter = req.query.filter
+  const streetAddress = req.query.streetAddress
+
+  /* check if valid ZIP code 
+    ^\d{5} - the start of the line has 5 digits
+    (-\d{4})?$ the end of the line has 4 digits preceded by a dash (optionally)
+  */
+  let isValidZIPcode = /^\d{5}(-\d{4})?$/.test(searchText)
+
+  /* check if valid street address
+     ^(\d{3,})\s? the start of the line can have 3 or more digits followed by a space
+     (\w{0,})\s the next part can have 2 or more letters followed by a space
+     ([a-zA-Z]{2,30})\s the next part must be an alphanetical string with 2-30 characters followed by a space
+     ([a-zA-Z]{2,15}).?\s?  the next part must be an alphabetical string with 2-15 characters followed by a any digit (optionally) and/or space (optionally)
+     (\w{0,5})$ the end of the line can have 0-5 letters
+  */
+  let isValidAddress =
+    /^(\d{3,})\s?(\w{0,5})\s([a-zA-Z]{2,30})\s?([a-zA-Z]{2,15}).?\s?(\w{0,5})$/.test(
+      streetAddress
+    )
+
+  if (!isValidZIPcode && !isValidAddress) {
     res.status(400).send({
       error:
-        'Invalid zip code format, valid examples are 84054-6013 or 84054. The zipcode used was ' +
-        zipCode
+        'Invalid zip code or street address format, valid examples of a ZIP code are 84054-6013 or 84054. The zipcode/street address used was ' +
+        searchText
     })
     return
   }
@@ -72,14 +91,22 @@ router.get('/:zipCode', async (req, res) => {
 
   try {
     const params = {
-      search_postal: zipCode,
-      search_country: 'US',
       order: 'district_type', // https://cicero.azavea.com/docs/#order-by-district-type
       sort: 'asc',
       max: 200,
       format: 'json',
       key: CICERO_API_KEY
     }
+    // add ZIP code search as parameter.
+    // NOTE: we check it first, because, as of now, the regex use to validate ZIP codes is stricter and more accurate
+    if (isValidZIPcode) {
+      params.search_postal = searchText
+      params.search_country = 'US'
+    }
+    // add street address search as parameter
+    else if (isValidAddress) {
+      params.search_address = streetAddress
+    }
 
     if (filter != null) {
       params.district_type = JURISDICTION_FILTER_MAP[filter]
@@ -94,6 +121,7 @@ router.get('/:zipCode', async (req, res) => {
         qs.stringify(params, { arrayFormat: 'repeat' }),
 
       cache: {
+        // TODO: we are disabling the cache to test results first
         ttl: 1000 * 60 * 60 * 24 * 7 // the time until the cached value is expired in milliseconds: set to 1 week
       }
     })

src/components/SearchReps.vue

@@ -13,9 +13,9 @@
             <v-card-text>
               <v-subheader class="pa-0"> Where do you live? </v-subheader>
 
-              <v-form @submit.prevent="CreateRepList()" ref="form">
+              <v-form ref="form">
                 <v-text-field
-                  v-model="postalCode"
+                  v-model="searchText"
                   label="Postal Code"
                   required
                   @keyup="CheckInputContent"
@@ -53,19 +53,6 @@
                     State
                   </v-btn>
 
-                  <v-btn
-                    rounded
-                    dark
-                    class="ui button toggle search-reps-button"
-                    :style="{
-                      backgroundColor:
-                        currentFilter === 'local' && isActive ? 'blue' : 'gray'
-                    }"
-                    @click="FilterList('local')"
-                  >
-                    Local
-                  </v-btn>
-
                   <v-btn
                     class="search-reps-button"
                     rounded
@@ -81,17 +68,18 @@
                   </v-btn>
 
                   <v-btn
-                    class="search-reps-button"
                     rounded
                     dark
-                    :class="{ active: isActive }"
+                    class="ui button toggle search-reps-button"
                     :style="{
                       backgroundColor:
-                        currentFilter === 'school' && isActive ? 'blue' : 'gray'
+                        currentFilter === 'municipality' && isActive
+                          ? 'blue'
+                          : 'gray'
                     }"
                     @click="FilterList('school')"
                   >
-                    School
+                    Local
                   </v-btn>
                 </v-col>
               </v-row>
@@ -101,7 +89,7 @@
                   <v-btn
                     :to="{
                       name: 'Reps',
-                      params: { postalCode: postalCode }
+                      params: { searchText: searchText }
                     }"
                     clickclass="mr-4"
                     @click="CreateRepList()"
@@ -153,6 +141,7 @@
                   <take-action
                     :letter-body="letterBody"
                     :selected-rep="selectedRep"
+                    :rep-name="selectedRepName"
                   />
                 </v-col>
               </v-row>
@@ -168,7 +157,6 @@
 import RepresentativeCard from '@/components/RepresentativeCard.vue'
 import TakeAction from '@/components/TakeAction.vue'
 import axios from 'axios'
-
 export default {
     name: 'SearchReps',
     components: {
@@ -179,10 +167,11 @@ export default {
         return {
             letterBody: '',
             selectedRep: {},
+            selectedRepName: '',
             congressMembers: [],
             currentFilter: '',
             hasContent: true,
-            postalCode: this.$route.params.postalCode || '',
+            searchText: this.$route.params.searchText || '',
             listVisible: false,
             isActive: false,
             myHeight: this.$vuetify.breakpoint.mobile ? false : "100vh"
@@ -192,26 +181,49 @@ export default {
         handleRepSelected(letterBody, selectedRep, step2) {
             this.letterBody = letterBody
             this.selectedRep = selectedRep
+            this.selectedRepName = selectedRep.name
             this.step2 = step2
         },
         CheckInputContent: function () {
-          if (this.postalCode !== '') {
-              this.hasContent = true
-          } else {
-              this.hasContent = false
-          }
+
+            if (this.searchText !== '') {
+                this.hasContent = true
+            } else {
+                this.hasContent = false
+            }
         },
         async CreateRepList() {
             try {
-                this.$store.commit('setGenericValue', { key: 'zipcode', value: this.postalCode })
-                const res = await axios.get(
-                    '/api/representatives/' + this.postalCode
-                )
+                this.$store.commit('setGenericValue', { key: 'searchText', value: this.searchText })
+                // check postal code is valid with regex
+                let res = ''
+                let params = {streetAddress: this.searchText}
+                let isPostalCodeValid =  /(^\d{5}$)|(^\d{5}-\d{4}$)/.test(this.searchText);
+                let streetAddressValid = /^(\d{3,})\s?(\w{0,5})\s([a-zA-Z]{2,30})\s([a-zA-Z]{2,15})\.?\s?(\w{0,5})$/.test(this.searchText);
+
+
+                if(isPostalCodeValid) {
+                 // console.log('valid input to get representatives with postal code')
+                  res = await axios.get(
+                    '/api/representatives/' + this.searchText
+                  )
+                }
+
+                else if(streetAddressValid) {
+                  // console.log('valid input to get representatives with street address')
+                  res = await axios.get(
+                    '/api/representatives/ ', { params }
+                  )
+                }
+
                 this.isActive = false
                 this.congressMembers = res.data
                 this.hasContent = true
                 this.listVisible = true
-            } catch (e) {
+            }
+
+
+            catch (e) {
                 console.error(e)
             }
         },
@@ -222,27 +234,31 @@ export default {
                 if (!this.isActive) {
                     this.isActive = true
                     const params = {}
+
                     if (this.currentFilter != null) {
                         params.filter = this.currentFilter
-                    }
 
+
+                    params.streetAddress = this.searchText
                     const res = await axios.get(
-                        '/api/representatives/' + this.postalCode,
+                        '/api/representatives/' + this.searchText,
                         {
                             params
                         }
                     )
 
                     console.log(res)
                     this.congressMembers = res.data
+
                 } else {
                     this.isActive = false;
                     const res = await axios.get(
-                        '/api/representatives/' + this.postalCode
+                        '/api/representatives/' + this.searchText
                     )
 
                     this.congressMembers = res.data
                 }
+              }
             } catch (e) {
                 console.error(e)
             }