diff --git a/docs/index.html b/docs/index.html index 6b279cf..48b5683 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,3 +1,3 @@ -Youyesyet 0.2.2-SNAPSHOT

Youyesyet 0.2.2-SNAPSHOT

Released under the GNU General Public License,version 2.0 or (at your option) any later version

Canvassing tool for referenda.

Installation

To install, add the following dependency to your project or build file:

[youyesyet "0.2.2-SNAPSHOT"]

Topics

Namespaces

youyesyet.cache

Caching wrappers for queries for youyesyet auto-generated by Application Description Language framework at 20181004T214223.033Z

youyesyet.canvasser-app.ajax

Canvasser app transciever for ajax packets.

Public variables and functions:

youyesyet.canvasser-app.core

Canvasser app navigation and routing.

youyesyet.canvasser-app.gis

Canvasser app map stuff.

youyesyet.canvasser-app.handlers

Canvasser app event handlers.

youyesyet.canvasser-app.state

Canvasser app client state.

Public variables and functions:

youyesyet.canvasser-app.subscriptions

Canvasser app event subscriptions.

Public variables and functions:

    youyesyet.canvasser-app.ui-utils

    Canvasser app user interface widgets.

    youyesyet.canvasser-app.views.about

    Canvasser app about panel.

    Public variables and functions:

    youyesyet.canvasser-app.views.building

    Canvasser app households in building panel.

    Public variables and functions:

    youyesyet.canvasser-app.views.dwelling

    Canvasser app electors in household panel.

    youyesyet.canvasser-app.views.elector

    Canvasser app single elector panel.

    Public variables and functions:

    youyesyet.canvasser-app.views.followup

    Canvasser followup request form panel.

    Public variables and functions:

    youyesyet.canvasser-app.views.gdpr

    Canvasser app electors in household panel.

    Public variables and functions:

    youyesyet.canvasser-app.views.issue

    Canvasser app current issue detail panel.

    Public variables and functions:

    youyesyet.canvasser-app.views.issues

    Canvasser app current issues list panel.

    Public variables and functions:

    youyesyet.canvasser-app.views.map

    Canvasser app map view panel.

    youyesyet.config

    Read configuration.

    Public variables and functions:

    youyesyet.db.core

    Database access functions, mostly from Luminus template.

    Public variables and functions:

    youyesyet.handler

    Handlers for starting and stopping the webapp.

    Public variables and functions:

    youyesyet.layout

    Render web pages using Selmer templating markup.

    youyesyet.locality

    TODO: write docs

    Public variables and functions:

    youyesyet.locality

    Public variables and functions:

    youyesyet.middleware

    Plumbing, mainly boilerplate from Luminus.

    youyesyet.oauth

    Handle oauth with multiple authenticating authorities.

    youyesyet.outqueue

    Queue of messages waiting to be sent to the server.

    youyesyet.outqueue

    Queue of messages waiting to be sent to the server.

    youyesyet.routes.auto

    User interface routes for Youyesyet auto-generated by Application Description Language framework at 20190502T100146.996Z

    Public variables and functions:

    youyesyet.routes.auto-json

    JSON routes for youyesyet auto-generated by Application Description Language framework at 20190502T100145.444Z

    Public variables and functions:

    youyesyet.routes.home

    Routes/pages available to unauthenticated users.

    Public variables and functions:

    youyesyet.routes.issue-experts

    Routes/pages available to issue experts.

    youyesyet.routes.logged-in

    Routes/pages available to authenticated users.

    Public variables and functions:

    youyesyet.routes.manual

    Manual overrides for auto-generated routes

    Public variables and functions:

      youyesyet.routes.oauth

      OAuth authentication routes - not finished, does not work yet.

      Public variables and functions:

      youyesyet.routes.rest

      Manually maintained routes which handle data transfer to/from the canvasser app.

      youyesyet.routes.roles

      Routes/pages available to authenticated users in specific roles.

      youyesyet.routes.services

      REST API.

      Public variables and functions:

      youyesyet.utils

      TODO: write docs

      Public variables and functions:

      youyesyet.utils

      Public variables and functions:

      youyesyet.validation

      TODO: write docs

      Public variables and functions:

        youyesyet.validation

        Public variables and functions:

          \ No newline at end of file +Youyesyet 0.2.2-SNAPSHOT

          Youyesyet 0.2.2-SNAPSHOT

          Released under the GNU General Public License,version 2.0 or (at your option) any later version

          Canvassing tool for referenda.

          Installation

          To install, add the following dependency to your project or build file:

          [youyesyet "0.2.2-SNAPSHOT"]

          Topics

          Namespaces

          youyesyet.cache

          Caching wrappers for queries for youyesyet auto-generated by Application Description Language framework at 20190502T102201.269Z

          youyesyet.canvasser-app.ajax

          Canvasser app transciever for ajax packets.

          Public variables and functions:

          youyesyet.canvasser-app.core

          Canvasser app navigation and routing.

          youyesyet.canvasser-app.gis

          Canvasser app map stuff.

          youyesyet.canvasser-app.handlers

          Canvasser app event handlers.

          youyesyet.canvasser-app.state

          Canvasser app client state.

          Public variables and functions:

          youyesyet.canvasser-app.subscriptions

          Canvasser app event subscriptions.

          Public variables and functions:

            youyesyet.canvasser-app.ui-utils

            Canvasser app user interface widgets.

            youyesyet.canvasser-app.views.about

            Canvasser app about panel.

            Public variables and functions:

            youyesyet.canvasser-app.views.building

            Canvasser app households in building panel.

            Public variables and functions:

            youyesyet.canvasser-app.views.dwelling

            Canvasser app electors in household panel.

            youyesyet.canvasser-app.views.elector

            Canvasser app single elector panel.

            Public variables and functions:

            youyesyet.canvasser-app.views.followup

            Canvasser followup request form panel.

            Public variables and functions:

            youyesyet.canvasser-app.views.gdpr

            Canvasser app electors in household panel.

            Public variables and functions:

            youyesyet.canvasser-app.views.issue

            Canvasser app current issue detail panel.

            Public variables and functions:

            youyesyet.canvasser-app.views.issues

            Canvasser app current issues list panel.

            Public variables and functions:

            youyesyet.canvasser-app.views.map

            Canvasser app map view panel.

            youyesyet.config

            Read configuration; largely unaltered from Luminus default.

            Public variables and functions:

            youyesyet.db.core

            Database access functions, mostly from Luminus template.

            Public variables and functions:

            youyesyet.handler

            Handlers for starting and stopping the webapp.

            Public variables and functions:

            youyesyet.layout

            Render web pages using Selmer templating markup.

            youyesyet.locality

            TODO: write docs

            Public variables and functions:

            youyesyet.locality

            Public variables and functions:

            youyesyet.middleware

            Plumbing, mainly boilerplate from Luminus.

            youyesyet.oauth

            Handle oauth with multiple authenticating authorities.

            youyesyet.outqueue

            Queue of messages waiting to be sent to the server.

            youyesyet.outqueue

            Queue of messages waiting to be sent to the server.

            youyesyet.routes.auto

            User interface routes for Youyesyet auto-generated by Application Description Language framework at 20190502T102204.626Z

            Public variables and functions:

            youyesyet.routes.auto-json

            JSON routes for youyesyet auto-generated by Application Description Language framework at 20190502T102202.387Z

            Public variables and functions:

            youyesyet.routes.home

            Routes/pages available to unauthenticated users.

            Public variables and functions:

            youyesyet.routes.issue-experts

            Routes/pages available to issue experts.

            youyesyet.routes.logged-in

            Routes/pages available to authenticated users.

            Public variables and functions:

            youyesyet.routes.manual

            Manual overrides for auto-generated routes

            Public variables and functions:

              youyesyet.routes.oauth

              OAuth authentication routes - not finished, does not work yet.

              Public variables and functions:

              youyesyet.routes.rest

              Manually maintained routes which handle data transfer to/from the canvasser app.

              youyesyet.routes.roles

              Routes/pages available to authenticated users in specific roles.

              youyesyet.routes.services

              REST API.

              Public variables and functions:

              youyesyet.utils

              TODO: write docs

              Public variables and functions:

              youyesyet.utils

              Public variables and functions:

              youyesyet.validation

              TODO: write docs

              Public variables and functions:

                youyesyet.validation

                Public variables and functions:

                  \ No newline at end of file diff --git a/docs/youyesyet.cache.html b/docs/youyesyet.cache.html index 993cdd5..cbe470d 100644 --- a/docs/youyesyet.cache.html +++ b/docs/youyesyet.cache.html @@ -1,3 +1,3 @@ -youyesyet.cache documentation

                  youyesyet.cache

                  Caching wrappers for queries for youyesyet auto-generated by Application Description Language framework at 20181004T214223.033Z

                  get-address

                  Auto-generated function to select one record from the addresses table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@490531d1. Results will be held in cache for 1000000 seconds.

                  get-authority

                  Auto-generated function to select one record from the authorities table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@352cf516. Results will be held in cache for 10000000 seconds.

                  get-canvasser

                  Auto-generated function to select one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@771caed2. Results will be held in cache for 10000 seconds.

                  get-canvasser-by-username

                  Auto-generated function to select one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@771caed2. Results will be held in cache for 10000 seconds.

                  get-district

                  Auto-generated function to select one record from the districts table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@1c48b9f5. Results will be held in cache for 10000000 seconds.

                  get-dwelling

                  Auto-generated function to select one record from the dwellings table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@f0e6e3d6. Results will be held in cache for 1000000 seconds.

                  get-elector

                  Auto-generated function to select one record from the electors table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@c7611432. Results will be held in cache for 100000 seconds.

                  get-followupmethod

                  Auto-generated function to select one record from the followupmethods table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 10000000 seconds.

                  get-followuprequest

                  Auto-generated function to select one record from the followuprequests table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@ae10eaf. Results will be held in cache for 100 seconds.

                  get-gender

                  Auto-generated function to select one record from the genders table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 1000000 seconds.

                  get-intention

                  Auto-generated function to select one record from the intentions table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@27b31781. Results will be held in cache for 100 seconds.

                  get-issue

                  Auto-generated function to select one record from the issues table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@606826e4. Results will be held in cache for 1000 seconds.

                  get-option

                  Auto-generated function to select one record from the options table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 10000000 seconds.

                  get-role

                  Auto-generated function to select one record from the roles table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a81570c6. Results will be held in cache for 10000000 seconds.

                  get-role-by-name

                  Auto-generated function to select one record from the roles table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a81570c6. Results will be held in cache for 10000000 seconds.

                  get-team

                  Auto-generated function to select one record from the teams table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@31118d64. Results will be held in cache for 10000 seconds.

                  get-visit

                  Auto-generated function to select one record from the visits table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a7611ce6. Results will be held in cache for 100 seconds.

                  list-addresses

                  Auto-generated function to select all records from the addresses table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address :postcode :district_id :latitude :longitude :dwellings :locality :id). Results will be held in cache for 1000000 seconds.

                  list-authorities

                  Auto-generated function to select all records from the authorities table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Results will be held in cache for 10000000 seconds.

                  list-canvassers

                  Auto-generated function to select all records from the canvassers table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised :roles :expertise :teams :id). Results will be held in cache for 10000 seconds.

                  list-districts

                  Auto-generated function to select all records from the districts table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :id). Results will be held in cache for 10000000 seconds.

                  list-dwellings

                  Auto-generated function to select all records from the dwellings table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :sub-address :electors :id). Results will be held in cache for 1000000 seconds.

                  list-electors

                  Auto-generated function to select all records from the electors table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :dwelling_id :phone :email :gender :signature :id). Results will be held in cache for 100000 seconds.

                  list-followupmethods

                  Auto-generated function to select all records from the followupmethods table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  list-followuprequests

                  Auto-generated function to select all records from the followuprequests table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked :actions :id). Results will be held in cache for 100 seconds.

                  list-genders

                  Auto-generated function to select all records from the genders table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 1000000 seconds.

                  list-intentions

                  Auto-generated function to select all records from the intentions table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:visit_id :elector_id :option_id :locality :id). Results will be held in cache for 100 seconds.

                  list-issues

                  Auto-generated function to select all records from the issues table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:url :current :brief :experts :id). Results will be held in cache for 1000 seconds.

                  list-options

                  Auto-generated function to select all records from the options table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  list-roles

                  Auto-generated function to select all records from the roles table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :members :id). Results will be held in cache for 10000000 seconds.

                  list-teams

                  Auto-generated function to select all records from the teams table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :district_id :latitude :longitude :members :organisers :events :id). Results will be held in cache for 10000 seconds.

                  list-visits

                  Auto-generated function to select all records from the visits table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :canvasser_id :date :id). Results will be held in cache for 100 seconds.

                  search-strings-addresses

                  Auto-generated function to select all records from the addresses table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address :postcode :district_id :latitude :longitude :dwellings :locality :id). Results will be held in cache for 1000000 seconds.

                  search-strings-authorities

                  Auto-generated function to select all records from the authorities table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Results will be held in cache for 10000000 seconds.

                  search-strings-canvassers

                  Auto-generated function to select all records from the canvassers table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised :roles :expertise :teams :id). Results will be held in cache for 10000 seconds.

                  search-strings-districts

                  Auto-generated function to select all records from the districts table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :id). Results will be held in cache for 10000000 seconds.

                  search-strings-dwellings

                  Auto-generated function to select all records from the dwellings table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :sub-address :electors :id). Results will be held in cache for 1000000 seconds.

                  search-strings-electors

                  Auto-generated function to select all records from the electors table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :dwelling_id :phone :email :gender :signature :id). Results will be held in cache for 100000 seconds.

                  search-strings-followupmethods

                  Auto-generated function to select all records from the followupmethods table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  search-strings-followuprequests

                  Auto-generated function to select all records from the followuprequests table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked :actions :id). Results will be held in cache for 100 seconds.

                  search-strings-genders

                  Auto-generated function to select all records from the genders table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 1000000 seconds.

                  search-strings-intentions

                  Auto-generated function to select all records from the intentions table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:visit_id :elector_id :option_id :locality :id). Results will be held in cache for 100 seconds.

                  search-strings-issues

                  Auto-generated function to select all records from the issues table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:url :current :brief :experts :id). Results will be held in cache for 1000 seconds.

                  search-strings-options

                  Auto-generated function to select all records from the options table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  search-strings-roles

                  Auto-generated function to select all records from the roles table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :members :id). Results will be held in cache for 10000000 seconds.

                  search-strings-teams

                  Auto-generated function to select all records from the teams table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :district_id :latitude :longitude :members :organisers :events :id). Results will be held in cache for 10000 seconds.

                  search-strings-visits

                  Auto-generated function to select all records from the visits table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :canvasser_id :date :id). Results will be held in cache for 100 seconds.

                  \ No newline at end of file +youyesyet.cache documentation

                  youyesyet.cache

                  Caching wrappers for queries for youyesyet auto-generated by Application Description Language framework at 20190502T102201.269Z

                  get-address

                  Auto-generated function to select one record from the addresses table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@490531d1. Results will be held in cache for 1000000 seconds.

                  get-authority

                  Auto-generated function to select one record from the authorities table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@352cf516. Results will be held in cache for 10000000 seconds.

                  get-canvasser

                  Auto-generated function to select one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@771caed2. Results will be held in cache for 10000 seconds.

                  get-canvasser-by-username

                  Auto-generated function to select one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@771caed2. Results will be held in cache for 10000 seconds.

                  get-district

                  Auto-generated function to select one record from the districts table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@1c48b9f5. Results will be held in cache for 10000000 seconds.

                  get-dwelling

                  Auto-generated function to select one record from the dwellings table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@f0e6e3d6. Results will be held in cache for 1000000 seconds.

                  get-elector

                  Auto-generated function to select one record from the electors table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@c7611432. Results will be held in cache for 100000 seconds.

                  get-followupmethod

                  Auto-generated function to select one record from the followupmethods table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 10000000 seconds.

                  get-followuprequest

                  Auto-generated function to select one record from the followuprequests table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@ae10eaf. Results will be held in cache for 100 seconds.

                  get-gender

                  Auto-generated function to select one record from the genders table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 1000000 seconds.

                  get-intention

                  Auto-generated function to select one record from the intentions table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@27b31781. Results will be held in cache for 100 seconds.

                  get-issue

                  Auto-generated function to select one record from the issues table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@606826e4. Results will be held in cache for 1000 seconds.

                  get-option

                  Auto-generated function to select one record from the options table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 10000000 seconds.

                  get-role

                  Auto-generated function to select one record from the roles table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a81570c6. Results will be held in cache for 10000000 seconds.

                  get-role-by-name

                  Auto-generated function to select one record from the roles table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a81570c6. Results will be held in cache for 10000000 seconds.

                  get-team

                  Auto-generated function to select one record from the teams table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@31118d64. Results will be held in cache for 10000 seconds.

                  get-visit

                  Auto-generated function to select one record from the visits table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a7611ce6. Results will be held in cache for 100 seconds.

                  list-addresses

                  Auto-generated function to select all records from the addresses table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address :postcode :district_id :latitude :longitude :dwellings :locality :id). Results will be held in cache for 1000000 seconds.

                  list-authorities

                  Auto-generated function to select all records from the authorities table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Results will be held in cache for 10000000 seconds.

                  list-canvassers

                  Auto-generated function to select all records from the canvassers table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised :roles :expertise :teams :id). Results will be held in cache for 10000 seconds.

                  list-districts

                  Auto-generated function to select all records from the districts table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :id). Results will be held in cache for 10000000 seconds.

                  list-dwellings

                  Auto-generated function to select all records from the dwellings table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :sub-address :electors :id). Results will be held in cache for 1000000 seconds.

                  list-electors

                  Auto-generated function to select all records from the electors table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :dwelling_id :phone :email :gender :signature :id). Results will be held in cache for 100000 seconds.

                  list-followupmethods

                  Auto-generated function to select all records from the followupmethods table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  list-followuprequests

                  Auto-generated function to select all records from the followuprequests table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked :actions :id). Results will be held in cache for 100 seconds.

                  list-genders

                  Auto-generated function to select all records from the genders table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 1000000 seconds.

                  list-intentions

                  Auto-generated function to select all records from the intentions table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:visit_id :elector_id :option_id :locality :id). Results will be held in cache for 100 seconds.

                  list-issues

                  Auto-generated function to select all records from the issues table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:url :current :brief :experts :id). Results will be held in cache for 1000 seconds.

                  list-options

                  Auto-generated function to select all records from the options table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  list-roles

                  Auto-generated function to select all records from the roles table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :members :id). Results will be held in cache for 10000000 seconds.

                  list-teams

                  Auto-generated function to select all records from the teams table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :district_id :latitude :longitude :members :organisers :events :id). Results will be held in cache for 10000 seconds.

                  list-visits

                  Auto-generated function to select all records from the visits table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :canvasser_id :date :id). Results will be held in cache for 100 seconds.

                  search-strings-addresses

                  Auto-generated function to select all records from the addresses table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address :postcode :district_id :latitude :longitude :dwellings :locality :id). Results will be held in cache for 1000000 seconds.

                  search-strings-authorities

                  Auto-generated function to select all records from the authorities table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Results will be held in cache for 10000000 seconds.

                  search-strings-canvassers

                  Auto-generated function to select all records from the canvassers table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised :roles :expertise :teams :id). Results will be held in cache for 10000 seconds.

                  search-strings-districts

                  Auto-generated function to select all records from the districts table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :id). Results will be held in cache for 10000000 seconds.

                  search-strings-dwellings

                  Auto-generated function to select all records from the dwellings table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :sub-address :electors :id). Results will be held in cache for 1000000 seconds.

                  search-strings-electors

                  Auto-generated function to select all records from the electors table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :dwelling_id :phone :email :gender :signature :id). Results will be held in cache for 100000 seconds.

                  search-strings-followupmethods

                  Auto-generated function to select all records from the followupmethods table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  search-strings-followuprequests

                  Auto-generated function to select all records from the followuprequests table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked :actions :id). Results will be held in cache for 100 seconds.

                  search-strings-genders

                  Auto-generated function to select all records from the genders table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 1000000 seconds.

                  search-strings-intentions

                  Auto-generated function to select all records from the intentions table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:visit_id :elector_id :option_id :locality :id). Results will be held in cache for 100 seconds.

                  search-strings-issues

                  Auto-generated function to select all records from the issues table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:url :current :brief :experts :id). Results will be held in cache for 1000 seconds.

                  search-strings-options

                  Auto-generated function to select all records from the options table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  search-strings-roles

                  Auto-generated function to select all records from the roles table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :members :id). Results will be held in cache for 10000000 seconds.

                  search-strings-teams

                  Auto-generated function to select all records from the teams table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :district_id :latitude :longitude :members :organisers :events :id). Results will be held in cache for 10000 seconds.

                  search-strings-visits

                  Auto-generated function to select all records from the visits table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :canvasser_id :date :id). Results will be held in cache for 100 seconds.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.ajax.html b/docs/youyesyet.canvasser-app.ajax.html index 6e0c7dc..81fed2e 100644 --- a/docs/youyesyet.canvasser-app.ajax.html +++ b/docs/youyesyet.canvasser-app.ajax.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.ajax documentation

                  youyesyet.canvasser-app.ajax

                  Canvasser app transciever for ajax packets.

                  default-headers

                  (default-headers request)

                  TODO: write docs

                  load-interceptors!

                  (load-interceptors!)

                  TODO: write docs

                  local-uri?

                  (local-uri? {:keys [uri]})

                  TODO: write docs

                  \ No newline at end of file +youyesyet.canvasser-app.ajax documentation

                  youyesyet.canvasser-app.ajax

                  Canvasser app transciever for ajax packets.

                  default-headers

                  (default-headers request)

                  TODO: write docs

                  load-interceptors!

                  (load-interceptors!)

                  TODO: write docs

                  local-uri?

                  (local-uri? {:keys [uri]})

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.core.html b/docs/youyesyet.canvasser-app.core.html index 7e880d7..30d3a6f 100644 --- a/docs/youyesyet.canvasser-app.core.html +++ b/docs/youyesyet.canvasser-app.core.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.core documentation

                  youyesyet.canvasser-app.core

                  Canvasser app navigation and routing.

                  about-page

                  (about-page)

                  TODO: write docs

                  building-page

                  (building-page)

                  TODO: write docs

                  dwelling-page

                  (dwelling-page)

                  TODO: write docs

                  elector-page

                  (elector-page)

                  TODO: write docs

                  followup-page

                  (followup-page)

                  TODO: write docs

                  gdpr-page

                  (gdpr-page)

                  TODO: write docs

                  hook-browser-navigation!

                  (hook-browser-navigation!)

                  TODO: write docs

                  init!

                  (init!)

                  TODO: write docs

                  issue-page

                  (issue-page)

                  TODO: write docs

                  issues-page

                  (issues-page)

                  TODO: write docs

                  map-page

                  (map-page)

                  TODO: write docs

                  mount-components

                  (mount-components)

                  TODO: write docs

                  page

                  (page)

                  Render the single page of the app, taking the current panel from the :page key in the state map.

                  pages

                  TODO: write docs

                  \ No newline at end of file +youyesyet.canvasser-app.core documentation

                  youyesyet.canvasser-app.core

                  Canvasser app navigation and routing.

                  about-page

                  (about-page)

                  TODO: write docs

                  building-page

                  (building-page)

                  TODO: write docs

                  dwelling-page

                  (dwelling-page)

                  TODO: write docs

                  elector-page

                  (elector-page)

                  TODO: write docs

                  followup-page

                  (followup-page)

                  TODO: write docs

                  gdpr-page

                  (gdpr-page)

                  TODO: write docs

                  hook-browser-navigation!

                  (hook-browser-navigation!)

                  Interceptor for the browser back button.

                  init!

                  (init!)

                  Initialise the app.

                  issue-page

                  (issue-page)

                  TODO: write docs

                  issues-page

                  (issues-page)

                  TODO: write docs

                  map-page

                  (map-page)

                  TODO: write docs

                  mount-components

                  (mount-components)

                  TODO: write docs

                  page

                  (page)

                  Render the single page of the app, taking the current panel from the :page key in the state map.

                  pages

                  Dispatcher table for pages.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.gis.html b/docs/youyesyet.canvasser-app.gis.html index af43ad5..43e4823 100644 --- a/docs/youyesyet.canvasser-app.gis.html +++ b/docs/youyesyet.canvasser-app.gis.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.gis documentation

                  youyesyet.canvasser-app.gis

                  Canvasser app map stuff.

                  add-map-pin

                  (add-map-pin address view)

                  Add a map-pin at this address in this map view

                  get-current-location

                  (get-current-location)

                  TODO: write docs

                  map-pin-click-handler

                  (map-pin-click-handler id)

                  On clicking on the pin, navigate to the electors at the address. This way of doing it adds an antry in the browser location history, so back links work.

                  map-remove-pins

                  (map-remove-pins view)

                  Remove all pins from this map view. Side-effecty; liable to be problematic.

                  pin-image

                  (pin-image address)

                  select the name of a suitable pin image for this address

                  refresh-map-pins

                  (refresh-map-pins)

                  Refresh the map pins on this map. Side-effecty; liable to be problematic.

                  \ No newline at end of file +youyesyet.canvasser-app.gis documentation

                  youyesyet.canvasser-app.gis

                  Canvasser app map stuff.

                  add-map-pin

                  (add-map-pin address view)

                  Add an appropriate map-pin at this address in this map view.

                  get-current-location

                  (get-current-location)

                  TODO: write docs

                  map-pin-click-handler

                  (map-pin-click-handler id)

                  On clicking on the pin, navigate to the electors at the address. This way of doing it adds an antry in the browser location history, so back links work.

                  map-remove-pins

                  (map-remove-pins view)

                  Remove all pins from this map view. Side-effecty; liable to be problematic.

                  pin-image

                  (pin-image address)

                  Return the name of a suitable pin image for this address.

                  refresh-map-pins

                  (refresh-map-pins)

                  Refresh the map pins on the current map. Side-effecty; liable to be problematic.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.handlers.html b/docs/youyesyet.canvasser-app.handlers.html index ee9e011..c302f44 100644 --- a/docs/youyesyet.canvasser-app.handlers.html +++ b/docs/youyesyet.canvasser-app.handlers.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.handlers documentation

                  youyesyet.canvasser-app.handlers

                  Canvasser app event handlers.

                  add-to-feedback

                  (add-to-feedback db x)

                  Add x to the feedback in this db.

                  add-to-key

                  (add-to-key db k x)

                  Return a copy of db with x added to the front of the list of items held against the key k

                  add-to-outqueue

                  (add-to-outqueue db message)

                  TODO: write docs

                  clear-messages

                  (clear-messages state)

                  Return a state like this state except with the error and feedback messages set nil

                  coerce-to-number

                  (coerce-to-number v)

                  TODO: write docs

                  compose-packet

                  (compose-packet item)

                  TODO: write docs

                  do-update-elector

                  (do-update-elector db elector)

                  TODO: write docs

                  feedback-messages

                  TODO: write docs

                  get-elector

                  (get-elector elector-id state)(get-elector elector-id state address)

                  Return the elector at this address (or the current address if not specified) with this id.

                  handle-forbidden

                  (handle-forbidden response & forms)

                  If response has status 403 (forbidden) redirect to the login page.

                  remove-from-feedback

                  (remove-from-feedback db x)

                  Remove x from the feedback in this db.

                  remove-from-key

                  (remove-from-key db k x)

                  TODO: write docs

                  remove-from-outqueue

                  (remove-from-outqueue db x)

                  TODO: write docs

                  source-host

                  TODO: write docs

                  \ No newline at end of file +youyesyet.canvasser-app.handlers documentation

                  youyesyet.canvasser-app.handlers

                  Canvasser app event handlers.

                  add-to-feedback

                  (add-to-feedback db x)

                  Add x to the feedback in this db.

                  add-to-key

                  (add-to-key db k x)

                  Return a copy of db with x added to the front of the list of items held against the key k

                  add-to-outqueue

                  (add-to-outqueue db message)

                  Add the supplied message to the output queue in this db.

                  clear-messages

                  (clear-messages state)

                  Return a state like this state except with the error and feedback messages set nil

                  coerce-to-number

                  (coerce-to-number v)

                  TODO: write docs

                  compose-packet

                  (compose-packet item)

                  TODO: write docs

                  do-update-elector

                  (do-update-elector db elector)

                  TODO: write docs

                  feedback-messages

                  TODO: write docs

                  get-elector

                  (get-elector elector-id state)(get-elector elector-id state address)

                  Return the elector at this address (or the current address if not specified) with this id.

                  handle-forbidden

                  (handle-forbidden response & forms)

                  If response has status 403 (forbidden) redirect to the login page.

                  remove-from-feedback

                  (remove-from-feedback db x)

                  Remove x from the feedback in this db.

                  remove-from-key

                  (remove-from-key db k x)

                  Remove x from the values of key k in map db.

                  remove-from-outqueue

                  (remove-from-outqueue db x)

                  Remove x from the output queue in this db.

                  source-host

                  The base URL of the host from which the app was loaded.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.state.html b/docs/youyesyet.canvasser-app.state.html index 6391925..b103b92 100644 --- a/docs/youyesyet.canvasser-app.state.html +++ b/docs/youyesyet.canvasser-app.state.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.state documentation

                  youyesyet.canvasser-app.state

                  Canvasser app client state.

                  default-db

                  TODO: write docs

                  \ No newline at end of file +youyesyet.canvasser-app.state documentation

                  youyesyet.canvasser-app.state

                  Canvasser app client state.

                  default-db

                  The default configuration state of the app, when first loaded. This is the constructor for the atom in which the state of the user interface is held. The atom gets updated by ‘events’ registered in handler.cljs, q.v.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.ui-utils.html b/docs/youyesyet.canvasser-app.ui-utils.html index 7b444d3..6a95fda 100644 --- a/docs/youyesyet.canvasser-app.ui-utils.html +++ b/docs/youyesyet.canvasser-app.ui-utils.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.ui-utils documentation

                  youyesyet.canvasser-app.ui-utils

                  Canvasser app user interface widgets.

                  error-panel

                  (error-panel message)

                  TODO: write docs

                  log-and-dispatch

                  (log-and-dispatch arg)

                  TODO: write docs

                  navbar

                  (navbar)

                  TODO: write docs

                  \ No newline at end of file +youyesyet.canvasser-app.ui-utils documentation

                  youyesyet.canvasser-app.ui-utils

                  Canvasser app user interface widgets.

                  error-panel

                  (error-panel message)

                  Generate and return an error panel with this message.

                  log-and-dispatch

                  (log-and-dispatch event)

                  TODO: write docs

                  navbar

                  (navbar)

                  Generate and return a navigation bar representing the current state of the app.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.about.html b/docs/youyesyet.canvasser-app.views.about.html index cd0aeef..5761770 100644 --- a/docs/youyesyet.canvasser-app.views.about.html +++ b/docs/youyesyet.canvasser-app.views.about.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.about documentation

                  youyesyet.canvasser-app.views.about

                  Canvasser app about panel.

                  panel

                  (panel)

                  Generate the about panel.

                  \ No newline at end of file +youyesyet.canvasser-app.views.about documentation

                  youyesyet.canvasser-app.views.about

                  Canvasser app about panel.

                  panel

                  (panel)

                  Generate the about panel.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.building.html b/docs/youyesyet.canvasser-app.views.building.html index 19edbe4..fe73a4b 100644 --- a/docs/youyesyet.canvasser-app.views.building.html +++ b/docs/youyesyet.canvasser-app.views.building.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.building documentation

                  youyesyet.canvasser-app.views.building

                  Canvasser app households in building panel.

                  panel

                  (panel)

                  Generate the building panel.

                  \ No newline at end of file +youyesyet.canvasser-app.views.building documentation

                  youyesyet.canvasser-app.views.building

                  Canvasser app households in building panel.

                  panel

                  (panel)

                  Generate the building panel.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.dwelling.html b/docs/youyesyet.canvasser-app.views.dwelling.html index 7efbd0f..d1884a7 100644 --- a/docs/youyesyet.canvasser-app.views.dwelling.html +++ b/docs/youyesyet.canvasser-app.views.dwelling.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.dwelling documentation

                  youyesyet.canvasser-app.views.dwelling

                  Canvasser app electors in household panel.

                  gender-cell

                  (gender-cell elector)

                  TODO: write docs

                  genders-row

                  (genders-row electors)

                  TODO: write docs

                  go-to-gdpr-for-elector

                  (go-to-gdpr-for-elector elector)

                  TODO: write docs

                  name-cell

                  (name-cell elector)

                  TODO: write docs

                  names-row

                  (names-row electors)

                  TODO: write docs

                  panel

                  (panel)

                  Generate the electors panel.

                  \ No newline at end of file +youyesyet.canvasser-app.views.dwelling documentation

                  youyesyet.canvasser-app.views.dwelling

                  Canvasser app electors in household panel.

                  gender-cell

                  (gender-cell elector)

                  TODO: write docs

                  genders-row

                  (genders-row electors)

                  TODO: write docs

                  go-to-gdpr-for-elector

                  (go-to-gdpr-for-elector elector)

                  TODO: write docs

                  name-cell

                  (name-cell elector)

                  TODO: write docs

                  names-row

                  (names-row electors)

                  TODO: write docs

                  panel

                  (panel)

                  Generate the electors panel.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.elector.html b/docs/youyesyet.canvasser-app.views.elector.html index 1bfd605..3ca6f7c 100644 --- a/docs/youyesyet.canvasser-app.views.elector.html +++ b/docs/youyesyet.canvasser-app.views.elector.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.elector documentation

                  youyesyet.canvasser-app.views.elector

                  Canvasser app single elector panel.

                  gender-row

                  (gender-row elector)

                  Generate a row containing a cell showing the gender of this elector.

                  issue-row

                  (issue-row elector)

                  Generate a row containing an issue cell for a particular elector

                  name-row

                  (name-row elector)

                  Generate a row containing a cell showing the name of this elector.

                  option-row

                  (option-row elector option)

                  Generate a row showing this option for this elector.

                  panel

                  (panel)

                  Generate the elector panel.

                  \ No newline at end of file +youyesyet.canvasser-app.views.elector documentation

                  youyesyet.canvasser-app.views.elector

                  Canvasser app single elector panel.

                  gender-row

                  (gender-row elector)

                  Generate a row containing a cell showing the gender of this elector.

                  issue-row

                  (issue-row elector)

                  Generate a row containing an issue cell for a particular elector

                  name-row

                  (name-row elector)

                  Generate a row containing a cell showing the name of this elector.

                  option-row

                  (option-row elector option)

                  Generate a row showing this option for this elector.

                  panel

                  (panel)

                  Generate the elector panel.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.followup.html b/docs/youyesyet.canvasser-app.views.followup.html index 5bb7a06..be239c1 100644 --- a/docs/youyesyet.canvasser-app.views.followup.html +++ b/docs/youyesyet.canvasser-app.views.followup.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.followup documentation

                  youyesyet.canvasser-app.views.followup

                  Canvasser followup request form panel.

                  panel

                  (panel)

                  Generate the followup-request panel.

                  \ No newline at end of file +youyesyet.canvasser-app.views.followup documentation

                  youyesyet.canvasser-app.views.followup

                  Canvasser followup request form panel.

                  panel

                  (panel)

                  Generate the followup-request panel.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.gdpr.html b/docs/youyesyet.canvasser-app.views.gdpr.html index f652524..b65dc27 100644 --- a/docs/youyesyet.canvasser-app.views.gdpr.html +++ b/docs/youyesyet.canvasser-app.views.gdpr.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.gdpr documentation

                  youyesyet.canvasser-app.views.gdpr

                  Canvasser app electors in household panel.

                  gdpr-did-mount

                  (gdpr-did-mount)

                  TODO: write docs

                  gdpr-render

                  (gdpr-render)

                  TODO: write docs

                  panel

                  (panel)

                  A reagent class for the GDPR consent form

                  sig-pad

                  TODO: write docs

                  \ No newline at end of file +youyesyet.canvasser-app.views.gdpr documentation

                  youyesyet.canvasser-app.views.gdpr

                  Canvasser app electors in household panel.

                  gdpr-did-mount

                  (gdpr-did-mount)

                  TODO: write docs

                  gdpr-render

                  (gdpr-render)

                  TODO: write docs

                  panel

                  (panel)

                  A reagent class for the GDPR consent form

                  sig-pad

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.issue.html b/docs/youyesyet.canvasser-app.views.issue.html index fb3e08f..098e085 100644 --- a/docs/youyesyet.canvasser-app.views.issue.html +++ b/docs/youyesyet.canvasser-app.views.issue.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.issue documentation

                  youyesyet.canvasser-app.views.issue

                  Canvasser app current issue detail panel.

                  panel

                  (panel)

                  Generate the issue panel.

                  \ No newline at end of file +youyesyet.canvasser-app.views.issue documentation

                  youyesyet.canvasser-app.views.issue

                  Canvasser app current issue detail panel.

                  panel

                  (panel)

                  Generate the issue panel.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.issues.html b/docs/youyesyet.canvasser-app.views.issues.html index 6a7c2a2..e712085 100644 --- a/docs/youyesyet.canvasser-app.views.issues.html +++ b/docs/youyesyet.canvasser-app.views.issues.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.issues documentation

                  youyesyet.canvasser-app.views.issues

                  Canvasser app current issues list panel.

                  panel

                  (panel)

                  Generate the issues panel.

                  \ No newline at end of file +youyesyet.canvasser-app.views.issues documentation

                  youyesyet.canvasser-app.views.issues

                  Canvasser app current issues list panel.

                  panel

                  (panel)

                  Generate the issues panel.

                  \ No newline at end of file diff --git a/docs/youyesyet.canvasser-app.views.map.html b/docs/youyesyet.canvasser-app.views.map.html index 48145de..5fa9fb5 100644 --- a/docs/youyesyet.canvasser-app.views.map.html +++ b/docs/youyesyet.canvasser-app.views.map.html @@ -1,3 +1,3 @@ -youyesyet.canvasser-app.views.map documentation

                  youyesyet.canvasser-app.views.map

                  Canvasser app map view panel.

                  *map-provider*

                  TODO: write docs

                  map-did-mount

                  (map-did-mount)

                  Select the actual map provider to use.

                  map-did-mount-mapbox

                  (map-did-mount-mapbox)

                  Did-mount function loading map tile data from MapBox (proprietary).

                  map-did-mount-osm

                  (map-did-mount-osm)

                  Did-mount function loading map tile data from Open Street Map.

                  map-render

                  (map-render)

                  Render the actual div containing the map.

                  osm-attrib

                  TODO: write docs

                  osm-url

                  TODO: write docs

                  panel

                  (panel)

                  A reagent class for the map object.

                  \ No newline at end of file +youyesyet.canvasser-app.views.map documentation

                  youyesyet.canvasser-app.views.map

                  Canvasser app map view panel.

                  *map-provider*

                  TODO: write docs

                  map-did-mount

                  (map-did-mount)

                  Select the actual map provider to use.

                  map-did-mount-mapbox

                  (map-did-mount-mapbox)

                  Did-mount function loading map tile data from MapBox (proprietary).

                  map-did-mount-osm

                  (map-did-mount-osm)

                  Did-mount function loading map tile data from Open Street Map.

                  map-render

                  (map-render)

                  Render the actual div containing the map.

                  osm-attrib

                  TODO: write docs

                  osm-url

                  TODO: write docs

                  panel

                  (panel)

                  A reagent class for the map object.

                  \ No newline at end of file diff --git a/docs/youyesyet.config.html b/docs/youyesyet.config.html index 8eee63f..1ae0293 100644 --- a/docs/youyesyet.config.html +++ b/docs/youyesyet.config.html @@ -1,3 +1,3 @@ -youyesyet.config documentation

                  youyesyet.config

                  Read configuration.

                  env

                  TODO: write docs

                  \ No newline at end of file +youyesyet.config documentation

                  youyesyet.config

                  Read configuration; largely unaltered from Luminus default.

                  env

                  Configuration, loaded at startup time from properties. Note that this conficuration is used only when not running in a Servlet context.

                  \ No newline at end of file diff --git a/docs/youyesyet.db.core.html b/docs/youyesyet.db.core.html index 4f10075..81330c0 100644 --- a/docs/youyesyet.db.core.html +++ b/docs/youyesyet.db.core.html @@ -1,3 +1,3 @@ -youyesyet.db.core documentation

                  youyesyet.db.core

                  Database access functions, mostly from Luminus template.

                  *db*

                  dynamic

                  TODO: write docs

                  create-address!

                  creates a new address record

                  create-address!-sqlvec

                  creates a new address record (sqlvec)

                  create-authority!

                  creates a new authority record

                  create-authority!-sqlvec

                  creates a new authority record (sqlvec)

                  create-canvasser!

                  creates a new canvasser record

                  create-canvasser!-sqlvec

                  creates a new canvasser record (sqlvec)

                  create-district!

                  creates a new district record

                  create-district!-sqlvec

                  creates a new district record (sqlvec)

                  create-dwelling!

                  creates a new dwelling record

                  create-dwelling!-sqlvec

                  creates a new dwelling record (sqlvec)

                  create-elector!

                  creates a new elector record

                  create-elector!-sqlvec

                  creates a new elector record (sqlvec)

                  create-event!

                  creates a new event record

                  create-event!-sqlvec

                  creates a new event record (sqlvec)

                  create-followupaction!

                  creates a new followupaction record

                  create-followupaction!-sqlvec

                  creates a new followupaction record (sqlvec)

                  create-followupmethod!

                  creates a new followupmethod record

                  create-followupmethod!-sqlvec

                  creates a new followupmethod record (sqlvec)

                  create-followuprequest!

                  creates a new followuprequest record

                  create-followuprequest!-sqlvec

                  creates a new followuprequest record (sqlvec)

                  create-gender!

                  creates a new gender record

                  create-gender!-sqlvec

                  creates a new gender record (sqlvec)

                  create-intention!

                  creates a new intention record

                  create-intention!-sqlvec

                  creates a new intention record (sqlvec)

                  create-issue!

                  creates a new issue record

                  create-issue!-sqlvec

                  creates a new issue record (sqlvec)

                  create-option!

                  creates a new option record

                  create-option!-sqlvec

                  creates a new option record (sqlvec)

                  create-role!

                  creates a new role record

                  create-role!-sqlvec

                  creates a new role record (sqlvec)

                  create-team!

                  creates a new team record

                  create-team!-sqlvec

                  creates a new team record (sqlvec)

                  create-visit!

                  creates a new visit record

                  create-visit!-sqlvec

                  creates a new visit record (sqlvec)

                  delete-address!

                  updates an existing address record

                  delete-address!-sqlvec

                  updates an existing address record (sqlvec)

                  delete-authority!

                  updates an existing authority record

                  delete-authority!-sqlvec

                  updates an existing authority record (sqlvec)

                  delete-canvasser!

                  updates an existing canvasser record

                  delete-canvasser!-sqlvec

                  updates an existing canvasser record (sqlvec)

                  delete-district!

                  updates an existing district record

                  delete-district!-sqlvec

                  updates an existing district record (sqlvec)

                  delete-dwelling!

                  updates an existing dwelling record

                  delete-dwelling!-sqlvec

                  updates an existing dwelling record (sqlvec)

                  delete-elector!

                  updates an existing elector record

                  delete-elector!-sqlvec

                  updates an existing elector record (sqlvec)

                  delete-event!

                  updates an existing event record

                  delete-event!-sqlvec

                  updates an existing event record (sqlvec)

                  delete-followupaction!

                  updates an existing followupaction record

                  delete-followupaction!-sqlvec

                  updates an existing followupaction record (sqlvec)

                  delete-followupmethod!

                  updates an existing followupmethod record

                  delete-followupmethod!-sqlvec

                  updates an existing followupmethod record (sqlvec)

                  delete-followuprequest!

                  updates an existing followuprequest record

                  delete-followuprequest!-sqlvec

                  updates an existing followuprequest record (sqlvec)

                  delete-gender!

                  updates an existing gender record

                  delete-gender!-sqlvec

                  updates an existing gender record (sqlvec)

                  delete-intention!

                  updates an existing intention record

                  delete-intention!-sqlvec

                  updates an existing intention record (sqlvec)

                  delete-issue!

                  updates an existing issue record

                  delete-issue!-sqlvec

                  updates an existing issue record (sqlvec)

                  delete-option!

                  updates an existing option record

                  delete-option!-sqlvec

                  updates an existing option record (sqlvec)

                  delete-role!

                  updates an existing role record

                  delete-role!-sqlvec

                  updates an existing role record (sqlvec)

                  delete-team!

                  updates an existing team record

                  delete-team!-sqlvec

                  updates an existing team record (sqlvec)

                  delete-visit!

                  updates an existing visit record

                  delete-visit!-sqlvec

                  updates an existing visit record (sqlvec)

                  get-address

                  selects an existing address record

                  get-address-sqlvec

                  selects an existing address record (sqlvec)

                  get-authority

                  selects an existing authority record

                  get-authority-sqlvec

                  selects an existing authority record (sqlvec)

                  get-canvasser

                  selects an existing canvasser record

                  get-canvasser-by-username

                  selects an existing canvasser record

                  get-canvasser-by-username-sqlvec

                  selects an existing canvasser record (sqlvec)

                  get-canvasser-sqlvec

                  selects an existing canvasser record (sqlvec)

                  get-district

                  selects an existing district record

                  get-district-sqlvec

                  selects an existing district record (sqlvec)

                  get-dwelling

                  selects an existing dwelling record

                  get-dwelling-sqlvec

                  selects an existing dwelling record (sqlvec)

                  get-elector

                  selects an existing elector record

                  get-elector-sqlvec

                  selects an existing elector record (sqlvec)

                  get-event

                  selects an existing event record

                  get-event-sqlvec

                  selects an existing event record (sqlvec)

                  get-followupaction

                  selects an existing followupaction record

                  get-followupaction-sqlvec

                  selects an existing followupaction record (sqlvec)

                  get-followupmethod

                  selects an existing followupmethod record

                  get-followupmethod-sqlvec

                  selects an existing followupmethod record (sqlvec)

                  get-followuprequest

                  selects an existing followuprequest record

                  get-followuprequest-sqlvec

                  selects an existing followuprequest record (sqlvec)

                  get-gender

                  selects an existing gender record

                  get-gender-sqlvec

                  selects an existing gender record (sqlvec)

                  get-intention

                  selects an existing intention record

                  get-intention-sqlvec

                  selects an existing intention record (sqlvec)

                  get-issue

                  selects an existing issue record

                  get-issue-sqlvec

                  selects an existing issue record (sqlvec)

                  get-last-visit-by-canvasser

                  returns the most recent visit record of the canvasser with the specified :id

                  get-locality-for-visit

                  returns the locality of the address of this visit

                  get-option

                  selects an existing option record

                  get-option-sqlvec

                  selects an existing option record (sqlvec)

                  get-role

                  selects an existing role record

                  get-role-by-name

                  selects an existing role record

                  get-role-by-name-sqlvec

                  selects an existing role record (sqlvec)

                  get-role-sqlvec

                  selects an existing role record (sqlvec)

                  get-team

                  selects an existing team record

                  get-team-sqlvec

                  selects an existing team record (sqlvec)

                  get-visit

                  selects an existing visit record

                  get-visit-sqlvec

                  selects an existing visit record (sqlvec)

                  list-addresses

                  lists all existing address records

                  list-addresses-by-district

                  lists all existing district records related to a given address

                  list-addresses-by-district-sqlvec

                  lists all existing district records related to a given address (sqlvec)

                  list-addresses-by-locality

                  lists all existing address records in a given locality

                  list-addresses-sqlvec

                  lists all existing address records (sqlvec)

                  list-authorities

                  lists all existing authority records

                  list-authorities-sqlvec

                  lists all existing authority records (sqlvec)

                  list-canvassers

                  lists all existing canvasser records

                  list-canvassers-by-address

                  lists all existing address records related to a given canvasser

                  list-canvassers-by-address-sqlvec

                  lists all existing address records related to a given canvasser (sqlvec)

                  list-canvassers-by-authority

                  lists all existing authority records related to a given canvasser

                  list-canvassers-by-authority-sqlvec

                  lists all existing authority records related to a given canvasser (sqlvec)

                  list-canvassers-by-elector

                  lists all existing elector records related to a given canvasser

                  list-canvassers-by-elector-sqlvec

                  lists all existing elector records related to a given canvasser (sqlvec)

                  list-canvassers-by-issues

                  links all existing issue records related to a given canvasser

                  list-canvassers-by-issues-sqlvec

                  links all existing issue records related to a given canvasser (sqlvec)

                  list-canvassers-by-roles

                  links all existing canvasser records related to a given role

                  list-canvassers-by-roles-sqlvec

                  links all existing canvasser records related to a given role (sqlvec)

                  list-canvassers-sqlvec

                  lists all existing canvasser records (sqlvec)

                  list-districts

                  lists all existing district records

                  list-districts-sqlvec

                  lists all existing district records (sqlvec)

                  list-dwellings

                  lists all existing dwelling records

                  list-dwellings-by-address

                  lists all existing dwelling records related to a given address

                  list-dwellings-by-address-sqlvec

                  lists all existing dwelling records related to a given address (sqlvec)

                  list-dwellings-sqlvec

                  lists all existing dwelling records (sqlvec)

                  list-elector-intentions

                  short form of list-intentions-by-elector, returning far less data, for use in youyesyet.routes.rest/get-local-data, q.v.

                  list-electors

                  lists all existing elector records

                  list-electors-by-dwelling

                  lists all existing elector records related to a given dwelling

                  list-electors-by-dwelling-sqlvec

                  lists all existing elector records related to a given dwelling (sqlvec)

                  list-electors-by-gender

                  lists all existing gender records related to a given elector

                  list-electors-by-gender-sqlvec

                  lists all existing gender records related to a given elector (sqlvec)

                  list-electors-sqlvec

                  lists all existing elector records (sqlvec)

                  list-events

                  lists all existing event records

                  list-events-by-teams

                  links all existing team records related to a given event

                  list-events-by-teams-sqlvec

                  links all existing team records related to a given event (sqlvec)

                  list-events-sqlvec

                  lists all existing event records (sqlvec)

                  list-followupactions

                  lists all existing followupaction records

                  list-followupactions-by-canvasser

                  lists all existing canvasser records related to a given followupaction

                  list-followupactions-by-canvasser-sqlvec

                  lists all existing canvasser records related to a given followupaction (sqlvec)

                  list-followupactions-by-followuprequest

                  lists all existing followuprequest records related to a given followupaction

                  list-followupactions-by-followuprequest-sqlvec

                  lists all existing followuprequest records related to a given followupaction (sqlvec)

                  list-followupactions-sqlvec

                  lists all existing followupaction records (sqlvec)

                  list-followupmethods

                  lists all existing followupmethod records

                  list-followupmethods-sqlvec

                  lists all existing followupmethod records (sqlvec)

                  list-followuprequests

                  lists all existing followuprequest records

                  list-followuprequests-by-canvasser

                  lists all existing canvasser records related to a given followuprequest

                  list-followuprequests-by-canvasser-sqlvec

                  lists all existing canvasser records related to a given followuprequest (sqlvec)

                  list-followuprequests-by-elector

                  lists all existing elector records related to a given followuprequest

                  list-followuprequests-by-elector-sqlvec

                  lists all existing elector records related to a given followuprequest (sqlvec)

                  list-followuprequests-by-followupmethod

                  lists all existing followupmethod records related to a given followuprequest

                  list-followuprequests-by-followupmethod-sqlvec

                  lists all existing followupmethod records related to a given followuprequest (sqlvec)

                  list-followuprequests-by-issue

                  lists all existing issue records related to a given followuprequest

                  list-followuprequests-by-issue-sqlvec

                  lists all existing issue records related to a given followuprequest (sqlvec)

                  list-followuprequests-by-visit

                  lists all existing visit records related to a given followuprequest

                  list-followuprequests-by-visit-sqlvec

                  lists all existing visit records related to a given followuprequest (sqlvec)

                  list-followuprequests-sqlvec

                  lists all existing followuprequest records (sqlvec)

                  list-genders

                  lists all existing gender records

                  list-genders-sqlvec

                  lists all existing gender records (sqlvec)

                  list-intentions

                  lists all existing intention records

                  list-intentions-by-elector

                  lists all existing elector records related to a given intention

                  list-intentions-by-elector-sqlvec

                  lists all existing elector records related to a given intention (sqlvec)

                  list-intentions-by-option

                  lists all existing option records related to a given intention

                  list-intentions-by-option-sqlvec

                  lists all existing option records related to a given intention (sqlvec)

                  list-intentions-by-visit

                  lists all existing visit records related to a given intention

                  list-intentions-by-visit-sqlvec

                  lists all existing visit records related to a given intention (sqlvec)

                  list-intentions-sqlvec

                  lists all existing intention records (sqlvec)

                  list-issues

                  lists all existing issue records

                  list-issues-sqlvec

                  lists all existing issue records (sqlvec)

                  list-members-by-team

                  links all existing canvasser records related to a given team

                  list-members-by-team-sqlvec

                  links all existing canvasser records related to a given team (sqlvec)

                  list-open-requests

                  lists all existing followuprequest records which have not been closed and which the :expert has expertise to answer.

                  list-options

                  lists all existing option records

                  list-options-sqlvec

                  lists all existing option records (sqlvec)

                  list-organisers-by-team

                  links all existing canvasser records related to a given team

                  list-organisers-by-team-sqlvec

                  links all existing canvasser records related to a given team (sqlvec)

                  list-roles

                  lists all existing role records

                  list-roles-by-canvasser

                  links all existing role records related to a given canvasser

                  list-roles-by-canvasser-sqlvec

                  links all existing role records related to a given canvasser (sqlvec)

                  list-roles-sqlvec

                  lists all existing role records (sqlvec)

                  list-teams

                  lists all existing team records

                  list-teams-by-canvasser

                  links all existing team records related to a given canvasser

                  list-teams-by-canvasser-sqlvec

                  links all existing team records related to a given canvasser (sqlvec)

                  list-teams-by-district

                  lists all existing district records related to a given team

                  list-teams-by-district-sqlvec

                  lists all existing district records related to a given team (sqlvec)

                  list-teams-sqlvec

                  lists all existing team records (sqlvec)

                  list-visits

                  lists all existing visit records

                  list-visits-by-address

                  lists all existing address records related to a given visit

                  list-visits-by-address-sqlvec

                  lists all existing address records related to a given visit (sqlvec)

                  list-visits-by-canvasser

                  lists all existing canvasser records related to a given visit

                  list-visits-by-canvasser-sqlvec

                  lists all existing canvasser records related to a given visit (sqlvec)

                  list-visits-sqlvec

                  lists all existing visit records (sqlvec)

                  search-strings-addresses

                  selects existing address records having any string field matching the parameter of the same name by substring match

                  search-strings-addresses-sqlvec

                  selects existing address records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-authorities

                  selects existing authority records having any string field matching the parameter of the same name by substring match

                  search-strings-authorities-sqlvec

                  selects existing authority records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-canvassers

                  selects existing canvasser records having any string field matching the parameter of the same name by substring match

                  search-strings-canvassers-sqlvec

                  selects existing canvasser records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-districts

                  selects existing district records having any string field matching the parameter of the same name by substring match

                  search-strings-districts-sqlvec

                  selects existing district records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-dwellings

                  selects existing dwelling records having any string field matching the parameter of the same name by substring match

                  search-strings-dwellings-sqlvec

                  selects existing dwelling records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-electors

                  selects existing elector records having any string field matching the parameter of the same name by substring match

                  search-strings-electors-sqlvec

                  selects existing elector records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-events

                  selects existing event records having any string field matching the parameter of the same name by substring match

                  search-strings-events-sqlvec

                  selects existing event records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-followupactions

                  selects existing followupaction records having any string field matching the parameter of the same name by substring match

                  search-strings-followupactions-sqlvec

                  selects existing followupaction records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-followupmethods

                  selects existing followupmethod records having any string field matching the parameter of the same name by substring match

                  search-strings-followupmethods-sqlvec

                  selects existing followupmethod records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-followuprequests

                  selects existing followuprequest records having any string field matching the parameter of the same name by substring match

                  search-strings-followuprequests-sqlvec

                  selects existing followuprequest records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-genders

                  selects existing gender records having any string field matching the parameter of the same name by substring match

                  search-strings-genders-sqlvec

                  selects existing gender records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-intentions

                  selects existing intention records having any string field matching the parameter of the same name by substring match

                  search-strings-intentions-sqlvec

                  selects existing intention records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-issues

                  selects existing issue records having any string field matching the parameter of the same name by substring match

                  search-strings-issues-sqlvec

                  selects existing issue records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-options

                  selects existing option records having any string field matching the parameter of the same name by substring match

                  search-strings-options-sqlvec

                  selects existing option records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-roles

                  selects existing role records having any string field matching the parameter of the same name by substring match

                  search-strings-roles-sqlvec

                  selects existing role records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-teams

                  selects existing team records having any string field matching the parameter of the same name by substring match

                  search-strings-teams-sqlvec

                  selects existing team records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-visits

                  selects existing visit records having any string field matching the parameter of the same name by substring match

                  search-strings-visits-sqlvec

                  selects existing visit records having any string field matching the parameter of the same name by substring match (sqlvec)

                  to-date

                  (to-date sql-date)

                  TODO: write docs

                  to-pg-json

                  (to-pg-json value)

                  TODO: write docs

                  update-address!

                  updates an existing address record

                  update-address!-sqlvec

                  updates an existing address record (sqlvec)

                  update-authority!

                  updates an existing authority record

                  update-authority!-sqlvec

                  updates an existing authority record (sqlvec)

                  update-canvasser!

                  updates an existing canvasser record

                  update-canvasser!-sqlvec

                  updates an existing canvasser record (sqlvec)

                  update-district!

                  updates an existing district record

                  update-district!-sqlvec

                  updates an existing district record (sqlvec)

                  update-dwelling!

                  updates an existing dwelling record

                  update-dwelling!-sqlvec

                  updates an existing dwelling record (sqlvec)

                  update-elector!

                  updates an existing elector record

                  update-elector!-sqlvec

                  updates an existing elector record (sqlvec)

                  update-event!

                  updates an existing event record

                  update-event!-sqlvec

                  updates an existing event record (sqlvec)

                  update-followupaction!

                  updates an existing followupaction record

                  update-followupaction!-sqlvec

                  updates an existing followupaction record (sqlvec)

                  update-followupmethod!

                  updates an existing followupmethod record

                  update-followupmethod!-sqlvec

                  updates an existing followupmethod record (sqlvec)

                  update-followuprequest!

                  updates an existing followuprequest record

                  update-followuprequest!-sqlvec

                  updates an existing followuprequest record (sqlvec)

                  update-gender!

                  updates an existing gender record

                  update-gender!-sqlvec

                  updates an existing gender record (sqlvec)

                  update-intention!

                  updates an existing intention record

                  update-intention!-sqlvec

                  updates an existing intention record (sqlvec)

                  update-issue!

                  updates an existing issue record

                  update-issue!-sqlvec

                  updates an existing issue record (sqlvec)

                  update-option!

                  updates an existing option record

                  update-option!-sqlvec

                  updates an existing option record (sqlvec)

                  update-role!

                  updates an existing role record

                  update-role!-sqlvec

                  updates an existing role record (sqlvec)

                  update-team!

                  updates an existing team record

                  update-team!-sqlvec

                  updates an existing team record (sqlvec)

                  update-visit!

                  updates an existing visit record

                  update-visit!-sqlvec

                  updates an existing visit record (sqlvec)

                  \ No newline at end of file +youyesyet.db.core documentation

                  youyesyet.db.core

                  Database access functions, mostly from Luminus template.

                  *db*

                  dynamic

                  Primary connection to the main database. TODO: this does not yet enable sharding.

                  create-address!

                  creates a new address record

                  create-address!-sqlvec

                  creates a new address record (sqlvec)

                  create-authority!

                  creates a new authority record

                  create-authority!-sqlvec

                  creates a new authority record (sqlvec)

                  create-canvasser!

                  creates a new canvasser record

                  create-canvasser!-sqlvec

                  creates a new canvasser record (sqlvec)

                  create-district!

                  creates a new district record

                  create-district!-sqlvec

                  creates a new district record (sqlvec)

                  create-dwelling!

                  creates a new dwelling record

                  create-dwelling!-sqlvec

                  creates a new dwelling record (sqlvec)

                  create-elector!

                  creates a new elector record

                  create-elector!-sqlvec

                  creates a new elector record (sqlvec)

                  create-event!

                  creates a new event record

                  create-event!-sqlvec

                  creates a new event record (sqlvec)

                  create-followupaction!

                  creates a new followupaction record

                  create-followupaction!-sqlvec

                  creates a new followupaction record (sqlvec)

                  create-followupmethod!

                  creates a new followupmethod record

                  create-followupmethod!-sqlvec

                  creates a new followupmethod record (sqlvec)

                  create-followuprequest!

                  creates a new followuprequest record

                  create-followuprequest!-sqlvec

                  creates a new followuprequest record (sqlvec)

                  create-gender!

                  creates a new gender record

                  create-gender!-sqlvec

                  creates a new gender record (sqlvec)

                  create-intention!

                  creates a new intention record

                  create-intention!-sqlvec

                  creates a new intention record (sqlvec)

                  create-issue!

                  creates a new issue record

                  create-issue!-sqlvec

                  creates a new issue record (sqlvec)

                  create-option!

                  creates a new option record

                  create-option!-sqlvec

                  creates a new option record (sqlvec)

                  create-role!

                  creates a new role record

                  create-role!-sqlvec

                  creates a new role record (sqlvec)

                  create-team!

                  creates a new team record

                  create-team!-sqlvec

                  creates a new team record (sqlvec)

                  create-visit!

                  creates a new visit record

                  create-visit!-sqlvec

                  creates a new visit record (sqlvec)

                  delete-address!

                  deletes an existing address record

                  delete-address!-sqlvec

                  deletes an existing address record (sqlvec)

                  delete-authority!

                  deletes an existing authority record

                  delete-authority!-sqlvec

                  deletes an existing authority record (sqlvec)

                  delete-canvasser!

                  deletes an existing canvasser record

                  delete-canvasser!-sqlvec

                  deletes an existing canvasser record (sqlvec)

                  delete-district!

                  deletes an existing district record

                  delete-district!-sqlvec

                  deletes an existing district record (sqlvec)

                  delete-dwelling!

                  deletes an existing dwelling record

                  delete-dwelling!-sqlvec

                  deletes an existing dwelling record (sqlvec)

                  delete-elector!

                  deletes an existing elector record

                  delete-elector!-sqlvec

                  deletes an existing elector record (sqlvec)

                  delete-event!

                  deletes an existing event record

                  delete-event!-sqlvec

                  deletes an existing event record (sqlvec)

                  delete-followupaction!

                  deletes an existing followupaction record

                  delete-followupaction!-sqlvec

                  deletes an existing followupaction record (sqlvec)

                  delete-followupmethod!

                  deletes an existing followupmethod record

                  delete-followupmethod!-sqlvec

                  deletes an existing followupmethod record (sqlvec)

                  delete-followuprequest!

                  deletes an existing followuprequest record

                  delete-followuprequest!-sqlvec

                  deletes an existing followuprequest record (sqlvec)

                  delete-gender!

                  deletes an existing gender record

                  delete-gender!-sqlvec

                  deletes an existing gender record (sqlvec)

                  delete-intention!

                  deletes an existing intention record

                  delete-intention!-sqlvec

                  deletes an existing intention record (sqlvec)

                  delete-issue!

                  deletes an existing issue record

                  delete-issue!-sqlvec

                  deletes an existing issue record (sqlvec)

                  delete-option!

                  deletes an existing option record

                  delete-option!-sqlvec

                  deletes an existing option record (sqlvec)

                  delete-role!

                  deletes an existing role record

                  delete-role!-sqlvec

                  deletes an existing role record (sqlvec)

                  delete-team!

                  deletes an existing team record

                  delete-team!-sqlvec

                  deletes an existing team record (sqlvec)

                  delete-visit!

                  deletes an existing visit record

                  delete-visit!-sqlvec

                  deletes an existing visit record (sqlvec)

                  get-address

                  selects an existing address record

                  get-address-sqlvec

                  selects an existing address record (sqlvec)

                  get-authority

                  selects an existing authority record

                  get-authority-sqlvec

                  selects an existing authority record (sqlvec)

                  get-canvasser

                  selects an existing canvasser record

                  get-canvasser-by-username

                  selects an existing canvasser record

                  get-canvasser-by-username-sqlvec

                  selects an existing canvasser record (sqlvec)

                  get-canvasser-sqlvec

                  selects an existing canvasser record (sqlvec)

                  get-district

                  selects an existing district record

                  get-district-sqlvec

                  selects an existing district record (sqlvec)

                  get-dwelling

                  selects an existing dwelling record

                  get-dwelling-sqlvec

                  selects an existing dwelling record (sqlvec)

                  get-elector

                  selects an existing elector record

                  get-elector-sqlvec

                  selects an existing elector record (sqlvec)

                  get-event

                  selects an existing event record

                  get-event-sqlvec

                  selects an existing event record (sqlvec)

                  get-followupaction

                  selects an existing followupaction record

                  get-followupaction-sqlvec

                  selects an existing followupaction record (sqlvec)

                  get-followupmethod

                  selects an existing followupmethod record

                  get-followupmethod-sqlvec

                  selects an existing followupmethod record (sqlvec)

                  get-followuprequest

                  selects an existing followuprequest record

                  get-followuprequest-sqlvec

                  selects an existing followuprequest record (sqlvec)

                  get-gender

                  selects an existing gender record

                  get-gender-sqlvec

                  selects an existing gender record (sqlvec)

                  get-intention

                  selects an existing intention record

                  get-intention-sqlvec

                  selects an existing intention record (sqlvec)

                  get-issue

                  selects an existing issue record

                  get-issue-sqlvec

                  selects an existing issue record (sqlvec)

                  get-last-visit-by-canvasser

                  returns the most recent visit record of the canvasser with the specified :id

                  get-locality-for-visit

                  returns the locality of the address of this visit

                  get-option

                  selects an existing option record

                  get-option-sqlvec

                  selects an existing option record (sqlvec)

                  get-role

                  selects an existing role record

                  get-role-by-name

                  selects an existing role record

                  get-role-by-name-sqlvec

                  selects an existing role record (sqlvec)

                  get-role-sqlvec

                  selects an existing role record (sqlvec)

                  get-team

                  selects an existing team record

                  get-team-sqlvec

                  selects an existing team record (sqlvec)

                  get-visit

                  selects an existing visit record

                  get-visit-sqlvec

                  selects an existing visit record (sqlvec)

                  list-addresses

                  lists all existing address records

                  list-addresses-by-canvasser

                  lists all existing address records related to a given canvasser

                  list-addresses-by-canvasser-sqlvec

                  lists all existing address records related to a given canvasser (sqlvec)

                  list-addresses-by-dwelling

                  lists all existing address records related to a given dwelling

                  list-addresses-by-dwelling-sqlvec

                  lists all existing address records related to a given dwelling (sqlvec)

                  list-addresses-by-locality

                  lists all existing address records in a given locality

                  list-addresses-by-visit

                  lists all existing address records related to a given visit

                  list-addresses-by-visit-sqlvec

                  lists all existing address records related to a given visit (sqlvec)

                  list-addresses-sqlvec

                  lists all existing address records (sqlvec)

                  list-authorities

                  lists all existing authority records

                  list-authorities-by-canvasser

                  lists all existing authority records related to a given canvasser

                  list-authorities-by-canvasser-sqlvec

                  lists all existing authority records related to a given canvasser (sqlvec)

                  list-authorities-sqlvec

                  lists all existing authority records (sqlvec)

                  list-canvassers

                  lists all existing canvasser records

                  list-canvassers-by-followupaction

                  lists all existing canvasser records related to a given followupaction

                  list-canvassers-by-followupaction-sqlvec

                  lists all existing canvasser records related to a given followupaction (sqlvec)

                  list-canvassers-by-followuprequest

                  lists all existing canvasser records related to a given followuprequest

                  list-canvassers-by-followuprequest-sqlvec

                  lists all existing canvasser records related to a given followuprequest (sqlvec)

                  list-canvassers-by-issue

                  links all existing canvasser records related to a given issue

                  list-canvassers-by-issue-sqlvec

                  links all existing canvasser records related to a given issue (sqlvec)

                  list-canvassers-by-role

                  links all existing canvasser records related to a given role

                  list-canvassers-by-role-sqlvec

                  links all existing canvasser records related to a given role (sqlvec)

                  list-canvassers-by-visit

                  lists all existing canvasser records related to a given visit

                  list-canvassers-by-visit-sqlvec

                  lists all existing canvasser records related to a given visit (sqlvec)

                  list-canvassers-sqlvec

                  lists all existing canvasser records (sqlvec)

                  list-districts

                  lists all existing district records

                  list-districts-by-address

                  lists all existing district records related to a given address

                  list-districts-by-address-sqlvec

                  lists all existing district records related to a given address (sqlvec)

                  list-districts-by-team

                  lists all existing district records related to a given team

                  list-districts-by-team-sqlvec

                  lists all existing district records related to a given team (sqlvec)

                  list-districts-sqlvec

                  lists all existing district records (sqlvec)

                  list-dwellings

                  lists all existing dwelling records

                  list-dwellings-by-address

                  lists all existing dwelling records related to a given address

                  list-dwellings-by-address-sqlvec

                  lists all existing dwelling records related to a given address (sqlvec)

                  list-dwellings-by-elector

                  lists all existing dwelling records related to a given elector

                  list-dwellings-by-elector-sqlvec

                  lists all existing dwelling records related to a given elector (sqlvec)

                  list-dwellings-sqlvec

                  lists all existing dwelling records (sqlvec)

                  list-elector-intentions

                  short form of list-intentions-by-elector, returning far less data, for use in youyesyet.routes.rest/get-local-data, q.v.

                  list-electors

                  lists all existing elector records

                  list-electors-by-canvasser

                  lists all existing elector records related to a given canvasser

                  list-electors-by-canvasser-sqlvec

                  lists all existing elector records related to a given canvasser (sqlvec)

                  list-electors-by-dwelling

                  lists all existing elector records related to a given dwelling

                  list-electors-by-dwelling-sqlvec

                  lists all existing elector records related to a given dwelling (sqlvec)

                  list-electors-by-followuprequest

                  lists all existing elector records related to a given followuprequest

                  list-electors-by-followuprequest-sqlvec

                  lists all existing elector records related to a given followuprequest (sqlvec)

                  list-electors-by-intention

                  lists all existing elector records related to a given intention

                  list-electors-by-intention-sqlvec

                  lists all existing elector records related to a given intention (sqlvec)

                  list-electors-sqlvec

                  lists all existing elector records (sqlvec)

                  list-events

                  lists all existing event records

                  list-events-by-team

                  links all existing event records related to a given team

                  list-events-by-team-sqlvec

                  links all existing event records related to a given team (sqlvec)

                  list-events-sqlvec

                  lists all existing event records (sqlvec)

                  list-followupactions

                  lists all existing followupaction records

                  list-followupactions-by-followuprequest

                  lists all existing followupaction records related to a given followuprequest

                  list-followupactions-by-followuprequest-sqlvec

                  lists all existing followupaction records related to a given followuprequest (sqlvec)

                  list-followupactions-sqlvec

                  lists all existing followupaction records (sqlvec)

                  list-followupmethods

                  lists all existing followupmethod records

                  list-followupmethods-by-followuprequest

                  lists all existing followupmethod records related to a given followuprequest

                  list-followupmethods-by-followuprequest-sqlvec

                  lists all existing followupmethod records related to a given followuprequest (sqlvec)

                  list-followupmethods-sqlvec

                  lists all existing followupmethod records (sqlvec)

                  list-followuprequests

                  lists all existing followuprequest records

                  list-followuprequests-by-followupaction

                  lists all existing followuprequest records related to a given followupaction

                  list-followuprequests-by-followupaction-sqlvec

                  lists all existing followuprequest records related to a given followupaction (sqlvec)

                  list-followuprequests-sqlvec

                  lists all existing followuprequest records (sqlvec)

                  list-genders

                  lists all existing gender records

                  list-genders-by-elector

                  lists all existing gender records related to a given elector

                  list-genders-by-elector-sqlvec

                  lists all existing gender records related to a given elector (sqlvec)

                  list-genders-sqlvec

                  lists all existing gender records (sqlvec)

                  list-intentions

                  lists all existing intention records

                  list-intentions-sqlvec

                  lists all existing intention records (sqlvec)

                  list-issues

                  lists all existing issue records

                  list-issues-by-canvasser

                  links all existing issue records related to a given canvasser

                  list-issues-by-canvasser-sqlvec

                  links all existing issue records related to a given canvasser (sqlvec)

                  list-issues-by-followuprequest

                  lists all existing issue records related to a given followuprequest

                  list-issues-by-followuprequest-sqlvec

                  lists all existing issue records related to a given followuprequest (sqlvec)

                  list-issues-sqlvec

                  lists all existing issue records (sqlvec)

                  list-members-by-team

                  links all existing canvasser records related to a given team

                  list-members-by-team-sqlvec

                  links all existing canvasser records related to a given team (sqlvec)

                  list-open-requests

                  lists all existing followuprequest records which have not been closed and which the :expert has expertise to answer.

                  list-options

                  lists all existing option records

                  list-options-by-intention

                  lists all existing option records related to a given intention

                  list-options-by-intention-sqlvec

                  lists all existing option records related to a given intention (sqlvec)

                  list-options-sqlvec

                  lists all existing option records (sqlvec)

                  list-organisers-by-team

                  links all existing canvasser records related to a given team

                  list-organisers-by-team-sqlvec

                  links all existing canvasser records related to a given team (sqlvec)

                  list-roles

                  lists all existing role records

                  list-roles-by-canvasser

                  links all existing role records related to a given canvasser

                  list-roles-by-canvasser-sqlvec

                  links all existing role records related to a given canvasser (sqlvec)

                  list-roles-sqlvec

                  lists all existing role records (sqlvec)

                  list-teams

                  lists all existing team records

                  list-teams-by-canvasser

                  links all existing team records related to a given canvasser

                  list-teams-by-canvasser-sqlvec

                  links all existing team records related to a given canvasser (sqlvec)

                  list-teams-by-event

                  links all existing team records related to a given event

                  list-teams-by-event-sqlvec

                  links all existing team records related to a given event (sqlvec)

                  list-teams-sqlvec

                  lists all existing team records (sqlvec)

                  list-visits

                  lists all existing visit records

                  list-visits-by-followuprequest

                  lists all existing visit records related to a given followuprequest

                  list-visits-by-followuprequest-sqlvec

                  lists all existing visit records related to a given followuprequest (sqlvec)

                  list-visits-by-intention

                  lists all existing visit records related to a given intention

                  list-visits-by-intention-sqlvec

                  lists all existing visit records related to a given intention (sqlvec)

                  list-visits-sqlvec

                  lists all existing visit records (sqlvec)

                  search-strings-addresses

                  selects existing address records having any string field matching the parameter of the same name by substring match

                  search-strings-addresses-sqlvec

                  selects existing address records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-authorities

                  selects existing authority records having any string field matching the parameter of the same name by substring match

                  search-strings-authorities-sqlvec

                  selects existing authority records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-canvassers

                  selects existing canvasser records having any string field matching the parameter of the same name by substring match

                  search-strings-canvassers-sqlvec

                  selects existing canvasser records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-districts

                  selects existing district records having any string field matching the parameter of the same name by substring match

                  search-strings-districts-sqlvec

                  selects existing district records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-dwellings

                  selects existing dwelling records having any string field matching the parameter of the same name by substring match

                  search-strings-dwellings-sqlvec

                  selects existing dwelling records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-electors

                  selects existing elector records having any string field matching the parameter of the same name by substring match

                  search-strings-electors-sqlvec

                  selects existing elector records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-events

                  selects existing event records having any string field matching the parameter of the same name by substring match

                  search-strings-events-sqlvec

                  selects existing event records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-followupactions

                  selects existing followupaction records having any string field matching the parameter of the same name by substring match

                  search-strings-followupactions-sqlvec

                  selects existing followupaction records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-followupmethods

                  selects existing followupmethod records having any string field matching the parameter of the same name by substring match

                  search-strings-followupmethods-sqlvec

                  selects existing followupmethod records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-followuprequests

                  selects existing followuprequest records having any string field matching the parameter of the same name by substring match

                  search-strings-followuprequests-sqlvec

                  selects existing followuprequest records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-genders

                  selects existing gender records having any string field matching the parameter of the same name by substring match

                  search-strings-genders-sqlvec

                  selects existing gender records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-intentions

                  selects existing intention records having any string field matching the parameter of the same name by substring match

                  search-strings-intentions-sqlvec

                  selects existing intention records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-issues

                  selects existing issue records having any string field matching the parameter of the same name by substring match

                  search-strings-issues-sqlvec

                  selects existing issue records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-options

                  selects existing option records having any string field matching the parameter of the same name by substring match

                  search-strings-options-sqlvec

                  selects existing option records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-roles

                  selects existing role records having any string field matching the parameter of the same name by substring match

                  search-strings-roles-sqlvec

                  selects existing role records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-teams

                  selects existing team records having any string field matching the parameter of the same name by substring match

                  search-strings-teams-sqlvec

                  selects existing team records having any string field matching the parameter of the same name by substring match (sqlvec)

                  search-strings-visits

                  selects existing visit records having any string field matching the parameter of the same name by substring match

                  search-strings-visits-sqlvec

                  selects existing visit records having any string field matching the parameter of the same name by substring match (sqlvec)

                  to-date

                  (to-date sql-date)

                  Return the SQL date sql-date as a Java date.

                  to-pg-json

                  (to-pg-json value)

                  Render this value as JavaScript Object Notation.

                  update-address!

                  updates an existing address record

                  update-address!-sqlvec

                  updates an existing address record (sqlvec)

                  update-authority!

                  updates an existing authority record

                  update-authority!-sqlvec

                  updates an existing authority record (sqlvec)

                  update-canvasser!

                  updates an existing canvasser record

                  update-canvasser!-sqlvec

                  updates an existing canvasser record (sqlvec)

                  update-district!

                  updates an existing district record

                  update-district!-sqlvec

                  updates an existing district record (sqlvec)

                  update-dwelling!

                  updates an existing dwelling record

                  update-dwelling!-sqlvec

                  updates an existing dwelling record (sqlvec)

                  update-elector!

                  updates an existing elector record

                  update-elector!-sqlvec

                  updates an existing elector record (sqlvec)

                  update-event!

                  updates an existing event record

                  update-event!-sqlvec

                  updates an existing event record (sqlvec)

                  update-followupaction!

                  updates an existing followupaction record

                  update-followupaction!-sqlvec

                  updates an existing followupaction record (sqlvec)

                  update-followupmethod!

                  updates an existing followupmethod record

                  update-followupmethod!-sqlvec

                  updates an existing followupmethod record (sqlvec)

                  update-followuprequest!

                  updates an existing followuprequest record

                  update-followuprequest!-sqlvec

                  updates an existing followuprequest record (sqlvec)

                  update-gender!

                  updates an existing gender record

                  update-gender!-sqlvec

                  updates an existing gender record (sqlvec)

                  update-intention!

                  updates an existing intention record

                  update-intention!-sqlvec

                  updates an existing intention record (sqlvec)

                  update-issue!

                  updates an existing issue record

                  update-issue!-sqlvec

                  updates an existing issue record (sqlvec)

                  update-option!

                  updates an existing option record

                  update-option!-sqlvec

                  updates an existing option record (sqlvec)

                  update-role!

                  updates an existing role record

                  update-role!-sqlvec

                  updates an existing role record (sqlvec)

                  update-team!

                  updates an existing team record

                  update-team!-sqlvec

                  updates an existing team record (sqlvec)

                  update-visit!

                  updates an existing visit record

                  update-visit!-sqlvec

                  updates an existing visit record (sqlvec)

                  \ No newline at end of file diff --git a/docs/youyesyet.handler.html b/docs/youyesyet.handler.html index 767d9a1..d47b288 100644 --- a/docs/youyesyet.handler.html +++ b/docs/youyesyet.handler.html @@ -1,3 +1,3 @@ -youyesyet.handler documentation

                  youyesyet.handler

                  Handlers for starting and stopping the webapp.

                  app

                  TODO: write docs

                  app-routes

                  TODO: write docs

                  destroy

                  (destroy)

                  destroy will be called when your application shuts down, put any clean up code here

                  init

                  (init)

                  init will be called once when app is deployed as a servlet on an app server such as Tomcat put any initialization code here

                  init-app

                  TODO: write docs

                  \ No newline at end of file +youyesyet.handler documentation

                  youyesyet.handler

                  Handlers for starting and stopping the webapp.

                  app

                  The youyesyet server-side web-app (not to be confused with the client- side canvasser-app, q.v.)

                  app-routes

                  All routes served as part of the youyesyet (server-side) web-app (not to be confused with the client-side canvasser-app, q.v.).

                  destroy

                  (destroy)

                  destroy will be called when your application shuts down, put any clean up code here

                  init

                  (init)

                  init will be called once when app is deployed as a servlet on an app server such as Tomcat put any initialization code here

                  init-app

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.layout.html b/docs/youyesyet.layout.html index e06b71a..80917ba 100644 --- a/docs/youyesyet.layout.html +++ b/docs/youyesyet.layout.html @@ -1,3 +1,4 @@ -youyesyet.layout documentation

                  youyesyet.layout

                  Render web pages using Selmer templating markup.

                  *app-context*

                  dynamic

                  TODO: write docs

                  *user*

                  dynamic

                  TODO: write docs

                  error-page

                  (error-page error-details)

                  error-details should be a map containing the following keys: :status - error status :title - error title (optional) :message - detailed error message (optional) returns a response map with the error page as the body and the status specified by the status key

                  get-user-roles

                  Return, as a set, the names of the roles of which this user is a member.

                  render

                  (render template & [params])

                  renders the HTML template located relative to resources/templates in the context of this session and with these parameters.

                  render-with-session

                  (render-with-session template session & [params])

                  renders the HTML template located relative to resources/templates in the context of this session and with these parameters.

                  \ No newline at end of file +youyesyet.layout documentation

                  youyesyet.layout

                  Render web pages using Selmer templating markup.

                  *app-context*

                  dynamic

                  TODO: write docs

                  *user*

                  dynamic

                  The current user, in circumstances in which we do not have a session. Normally the user is held on a key in the session.

                  +

                  TODO: is this necessary? Is it safe?

                  error-page

                  (error-page error-details)

                  error-details should be a map containing the following keys: :status - error status :title - error title (optional) :message - detailed error message (optional) returns a response map with the error page as the body and the status specified by the status key

                  get-user-roles

                  Return, as a set, the names of the roles of which this user is a member.

                  render

                  (render template & [params])

                  renders the HTML template located relative to resources/templates in the context of this session and with these parameters.

                  render-with-session

                  (render-with-session template session & [params])

                  renders the HTML template located relative to resources/templates in the context of this session and with these parameters.

                  \ No newline at end of file diff --git a/docs/youyesyet.locality.html b/docs/youyesyet.locality.html index a8f6ff2..8e5cbd6 100644 --- a/docs/youyesyet.locality.html +++ b/docs/youyesyet.locality.html @@ -1,3 +1,3 @@ -youyesyet.locality documentation

                  youyesyet.locality

                  locality

                  (locality latitude longitude)

                  Compute the locality index for this latitude/longitude pair.

                  neighbouring-localities

                  (neighbouring-localities locality)

                  Return this locality with the localities immediately north east, north, north west, east, west, south west, south and south east of it.

                  \ No newline at end of file +youyesyet.locality documentation

                  youyesyet.locality

                  locality

                  (locality latitude longitude)

                  Compute the locality index for this latitude/longitude pair.

                  neighbouring-localities

                  (neighbouring-localities locality)

                  Return this locality with the localities immediately north east, north, north west, east, west, south west, south and south east of it.

                  \ No newline at end of file diff --git a/docs/youyesyet.middleware.html b/docs/youyesyet.middleware.html index 3abbf96..f67218a 100644 --- a/docs/youyesyet.middleware.html +++ b/docs/youyesyet.middleware.html @@ -1,3 +1,3 @@ -youyesyet.middleware documentation

                  youyesyet.middleware

                  Plumbing, mainly boilerplate from Luminus.

                  wrap-base

                  (wrap-base handler)

                  TODO: write docs

                  wrap-context

                  (wrap-context handler)

                  TODO: write docs

                  wrap-csrf

                  (wrap-csrf handler)

                  TODO: write docs

                  wrap-formats

                  (wrap-formats handler)

                  TODO: write docs

                  wrap-internal-error

                  (wrap-internal-error handler)

                  TODO: write docs

                  wrap-user

                  (wrap-user handler)

                  Dynamically bind user to the user in the session, if any, so that it is available in layout/render, q.v.

                  \ No newline at end of file +youyesyet.middleware documentation

                  youyesyet.middleware

                  Plumbing, mainly boilerplate from Luminus.

                  wrap-base

                  (wrap-base handler)

                  TODO: write docs

                  wrap-context

                  (wrap-context handler)

                  TODO: write docs

                  wrap-csrf

                  (wrap-csrf handler)

                  TODO: write docs

                  wrap-formats

                  (wrap-formats handler)

                  TODO: write docs

                  wrap-internal-error

                  (wrap-internal-error handler)

                  TODO: write docs

                  wrap-user

                  (wrap-user handler)

                  Dynamically bind user to the user in the session, if any, so that it is available in layout/render, q.v.

                  \ No newline at end of file diff --git a/docs/youyesyet.oauth.html b/docs/youyesyet.oauth.html index 12773a8..6f766b6 100644 --- a/docs/youyesyet.oauth.html +++ b/docs/youyesyet.oauth.html @@ -1,3 +1,3 @@ -youyesyet.oauth documentation

                  youyesyet.oauth

                  Handle oauth with multiple authenticating authorities.

                  auth-redirect-uri

                  (auth-redirect-uri request-token authority)

                  Gets the URI the user should be redirected to when authenticating.

                  authority!

                  TODO: write docs

                  fetch-access-token

                  (fetch-access-token request_token authority)

                  TODO: write docs

                  fetch-request-token

                  (fetch-request-token request auth)(fetch-request-token request)

                  Fetches a request token from the authority implied by this request.

                  get-authorities

                  (get-authorities _)

                  Fetch the authorities from the database and return a map of them.

                  oauth-callback-uri

                  (oauth-callback-uri {:keys [headers]})

                  Generates the oauth request callback URI.

                  \ No newline at end of file +youyesyet.oauth documentation

                  youyesyet.oauth

                  Handle oauth with multiple authenticating authorities.

                  auth-redirect-uri

                  (auth-redirect-uri request-token authority)

                  Gets the URI the user should be redirected to when authenticating.

                  authority!

                  TODO: write docs

                  fetch-access-token

                  (fetch-access-token request_token authority)

                  TODO: write docs

                  fetch-request-token

                  (fetch-request-token request auth)(fetch-request-token request)

                  Fetches a request token from the authority implied by this request.

                  get-authorities

                  (get-authorities _)

                  Fetch the authorities from the database and return a map of them.

                  oauth-callback-uri

                  (oauth-callback-uri {:keys [headers]})

                  Generates the oauth request callback URI.

                  \ No newline at end of file diff --git a/docs/youyesyet.outqueue.html b/docs/youyesyet.outqueue.html index b424904..b406019 100644 --- a/docs/youyesyet.outqueue.html +++ b/docs/youyesyet.outqueue.html @@ -1,3 +1,3 @@ -youyesyet.outqueue documentation

                  youyesyet.outqueue

                  Queue of messages waiting to be sent to the server.

                  add!

                  (add! q item)

                  Add this item to the queue.

                  count

                  (count q)

                  Return the count of items currently in the queue.

                  lock!

                  (lock! q)

                  TODO: write docs

                  locked?

                  (locked? q)

                  TODO: write docs

                  maybe-process-next

                  (maybe-process-next q process)

                  Apply this process, assumed to be a function of one argument, to the next item in the queue, if the queue is not currently locked; return the value returned by process.

                  new-queue

                  (new-queue)(new-queue items)

                  Create a new queue

                  peek

                  (peek q)

                  Look at the next item which could be removed from the queue.

                  queue?

                  (queue? x)

                  True if x is a queue, else false.

                  take!

                  (take! q)

                  Return the first item from the queue, rebind the queue to the remaining items. If the queue is empty return nil.

                  unlock!

                  (unlock! q)(unlock! q value)

                  TODO: write docs

                  \ No newline at end of file +youyesyet.outqueue documentation

                  youyesyet.outqueue

                  Queue of messages waiting to be sent to the server.

                  add!

                  (add! q item)

                  Add this item to the queue q.

                  count

                  (count q)

                  Return the count of items currently in the queue q.

                  lock!

                  (lock! q)

                  Lock the queue q.

                  locked?

                  (locked? q)

                  True if this queue q is locked, else false.

                  maybe-process-next

                  (maybe-process-next q process)

                  Apply this process, assumed to be a function of one argument, to the next item in the queue q, if the queue is not currently locked; return the value returned by process.

                  new-queue

                  (new-queue)(new-queue items)

                  Create a new queue

                  peek

                  (peek q)

                  Look at the next item which could be removed from the queue q.

                  queue?

                  (queue? x)

                  True if x is a queue, else false.

                  take!

                  (take! q)

                  Return the first item from the queue q, rebind the queue to the remaining items. If the queue is empty return nil.

                  unlock!

                  (unlock! q)(unlock! q value)

                  Unlock the queue q if not value is supplied; if a value is supplied, unlock only if that value is true, otherwise lock.

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.auto-json.html b/docs/youyesyet.routes.auto-json.html index e7e59d2..6ade069 100644 --- a/docs/youyesyet.routes.auto-json.html +++ b/docs/youyesyet.routes.auto-json.html @@ -1,3 +1,3 @@ -youyesyet.routes.auto-json documentation

                  youyesyet.routes.auto-json

                  JSON routes for youyesyet auto-generated by Application Description Language framework at 20190502T100145.444Z

                  auto-rest-routes

                  TODO: write docs

                  create-address!

                  (create-address! request)

                  Auto-generated method to insert one record to the addresses table. Expects the following key(s) to be present in params: (:address :postcode :district_id :latitude :longitude). Returns a map containing the keys #{"id"} identifying the record created.

                  create-authority!

                  (create-authority! request)

                  Auto-generated method to insert one record to the authorities table. Expects the following key(s) to be present in params: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Returns a map containing the keys #{"id"} identifying the record created.

                  create-canvasser!

                  (create-canvasser! request)

                  Auto-generated method to insert one record to the canvassers table. Expects the following key(s) to be present in params: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised). Returns a map containing the keys #{"id"} identifying the record created.

                  create-district!

                  (create-district! request)

                  Auto-generated method to insert one record to the districts table. Expects the following key(s) to be present in params: (:name). Returns a map containing the keys #{"id"} identifying the record created.

                  create-dwelling!

                  (create-dwelling! request)

                  Auto-generated method to insert one record to the dwellings table. Expects the following key(s) to be present in params: (:address_id :sub-address). Returns a map containing the keys #{"id"} identifying the record created.

                  create-elector!

                  (create-elector! request)

                  Auto-generated method to insert one record to the electors table. Expects the following key(s) to be present in params: (:name :dwelling_id :phone :email :gender :signature). Returns a map containing the keys #{"id"} identifying the record created.

                  create-event!

                  (create-event! request)

                  Auto-generated method to insert one record to the events table. Expects the following key(s) to be present in params: (:name :date :time :decription :cancelled). Returns a map containing the keys #{"id"} identifying the record created.

                  create-followupaction!

                  (create-followupaction! request)

                  Auto-generated method to insert one record to the followupactions table. Expects the following key(s) to be present in params: (:request_id :actor :date :notes :closed). Returns a map containing the keys #{"id"} identifying the record created.

                  create-followupmethod!

                  (create-followupmethod! request)

                  Auto-generated method to insert one record to the followupmethods table. Expects the following key(s) to be present in params: (:id). Returns a map containing the keys #{"id"} identifying the record created.

                  create-followuprequest!

                  (create-followuprequest! request)

                  Auto-generated method to insert one record to the followuprequests table. Expects the following key(s) to be present in params: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked). Returns a map containing the keys #{"id"} identifying the record created.

                  create-gender!

                  (create-gender! request)

                  Auto-generated method to insert one record to the genders table. Expects the following key(s) to be present in params: (:id). Returns a map containing the keys #{"id"} identifying the record created.

                  create-intention!

                  (create-intention! request)

                  Auto-generated method to insert one record to the intentions table. Expects the following key(s) to be present in params: (:visit_id :elector_id :option_id :locality). Returns a map containing the keys #{"id"} identifying the record created.

                  create-issue!

                  (create-issue! request)

                  Auto-generated method to insert one record to the issues table. Expects the following key(s) to be present in params: (:url :current :brief :id). Returns a map containing the keys #{"id"} identifying the record created.

                  create-option!

                  (create-option! request)

                  Auto-generated method to insert one record to the options table. Expects the following key(s) to be present in params: (:id). Returns a map containing the keys #{"id"} identifying the record created.

                  create-role!

                  (create-role! request)

                  Auto-generated method to insert one record to the roles table. Expects the following key(s) to be present in params: (:name :id). Returns a map containing the keys #{"id"} identifying the record created.

                  create-team!

                  (create-team! request)

                  Auto-generated method to insert one record to the teams table. Expects the following key(s) to be present in params: (:name :district_id :latitude :longitude). Returns a map containing the keys #{"id"} identifying the record created.

                  create-visit!

                  (create-visit! request)

                  Auto-generated method to insert one record to the visits table. Expects the following key(s) to be present in params: (:address_id :canvasser_id :date). Returns a map containing the keys #{"id"} identifying the record created.

                  delete-address!

                  (delete-address! request)

                  Auto-generated method to delete one record from the addresses table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-authority!

                  (delete-authority! request)

                  Auto-generated method to delete one record from the authorities table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-canvasser!

                  (delete-canvasser! request)

                  Auto-generated method to delete one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-district!

                  (delete-district! request)

                  Auto-generated method to delete one record from the districts table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-dwelling!

                  (delete-dwelling! request)

                  Auto-generated method to delete one record from the dwellings table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-elector!

                  (delete-elector! request)

                  Auto-generated method to delete one record from the electors table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-event!

                  (delete-event! request)

                  Auto-generated method to delete one record from the events table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-followupaction!

                  (delete-followupaction! request)

                  Auto-generated method to delete one record from the followupactions table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-followupmethod!

                  (delete-followupmethod! request)

                  Auto-generated method to delete one record from the followupmethods table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-followuprequest!

                  (delete-followuprequest! request)

                  Auto-generated method to delete one record from the followuprequests table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-gender!

                  (delete-gender! request)

                  Auto-generated method to delete one record from the genders table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-intention!

                  (delete-intention! request)

                  Auto-generated method to delete one record from the intentions table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-issue!

                  (delete-issue! request)

                  Auto-generated method to delete one record from the issues table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-option!

                  (delete-option! request)

                  Auto-generated method to delete one record from the options table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-role!

                  (delete-role! request)

                  Auto-generated method to delete one record from the roles table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-team!

                  (delete-team! request)

                  Auto-generated method to delete one record from the teams table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-visit!

                  (delete-visit! request)

                  Auto-generated method to delete one record from the visits table. Expects the following key(s) to be present in params: #{"id"}.

                  get-address

                  TODO: write docs

                  get-authority

                  TODO: write docs

                  get-canvasser

                  TODO: write docs

                  get-canvasser-by-username

                  TODO: write docs

                  get-district

                  TODO: write docs

                  get-dwelling

                  TODO: write docs

                  get-elector

                  TODO: write docs

                  get-event

                  (get-event request)

                  Auto-generated method to select one record from the events table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3ac90901.

                  get-followupaction

                  (get-followupaction request)

                  Auto-generated method to select one record from the followupactions table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@6b32af0e.

                  get-followupmethod

                  TODO: write docs

                  get-followuprequest

                  TODO: write docs

                  get-gender

                  TODO: write docs

                  get-intention

                  TODO: write docs

                  get-issue

                  TODO: write docs

                  get-option

                  TODO: write docs

                  get-role

                  TODO: write docs

                  get-role-by-name

                  TODO: write docs

                  get-team

                  TODO: write docs

                  get-visit

                  TODO: write docs

                  list-addresses

                  TODO: write docs

                  list-addresses-by-district

                  (list-addresses-by-district {:keys [params]})

                  TODO: write docs

                  list-authorities

                  TODO: write docs

                  list-canvassers

                  TODO: write docs

                  list-canvassers-by-address

                  (list-canvassers-by-address {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-authority

                  (list-canvassers-by-authority {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-elector

                  (list-canvassers-by-elector {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-issues

                  (list-canvassers-by-issues {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-roles

                  (list-canvassers-by-roles {:keys [params]})

                  TODO: write docs

                  list-districts

                  TODO: write docs

                  list-dwellings

                  TODO: write docs

                  list-dwellings-by-address

                  (list-dwellings-by-address {:keys [params]})

                  TODO: write docs

                  list-electors

                  TODO: write docs

                  list-electors-by-dwelling

                  (list-electors-by-dwelling {:keys [params]})

                  TODO: write docs

                  list-electors-by-gender

                  (list-electors-by-gender {:keys [params]})

                  TODO: write docs

                  list-events

                  (list-events request)

                  Auto-generated method to select all records from the events table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :teams :date :time :decription :cancelled :id).

                  list-events-by-teams

                  (list-events-by-teams {:keys [params]})

                  TODO: write docs

                  list-followupactions

                  (list-followupactions request)

                  Auto-generated method to select all records from the followupactions table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request_id :actor :date :notes :closed :id).

                  list-followupactions-by-canvasser

                  (list-followupactions-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-followupactions-by-followuprequest

                  (list-followupactions-by-followuprequest {:keys [params]})

                  TODO: write docs

                  list-followupmethods

                  TODO: write docs

                  list-followuprequests

                  TODO: write docs

                  list-followuprequests-by-canvasser

                  (list-followuprequests-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-followuprequests-by-elector

                  (list-followuprequests-by-elector {:keys [params]})

                  TODO: write docs

                  list-followuprequests-by-followupmethod

                  (list-followuprequests-by-followupmethod {:keys [params]})

                  TODO: write docs

                  list-followuprequests-by-issue

                  (list-followuprequests-by-issue {:keys [params]})

                  TODO: write docs

                  list-followuprequests-by-visit

                  (list-followuprequests-by-visit {:keys [params]})

                  TODO: write docs

                  list-genders

                  TODO: write docs

                  list-intentions

                  TODO: write docs

                  list-intentions-by-elector

                  (list-intentions-by-elector {:keys [params]})

                  TODO: write docs

                  list-intentions-by-option

                  (list-intentions-by-option {:keys [params]})

                  TODO: write docs

                  list-intentions-by-visit

                  (list-intentions-by-visit {:keys [params]})

                  TODO: write docs

                  list-issues

                  TODO: write docs

                  list-members-by-team

                  (list-members-by-team {:keys [params]})

                  TODO: write docs

                  list-options

                  TODO: write docs

                  list-organisers-by-team

                  (list-organisers-by-team {:keys [params]})

                  TODO: write docs

                  list-roles

                  TODO: write docs

                  list-teams

                  TODO: write docs

                  list-teams-by-canvasser

                  (list-teams-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-teams-by-district

                  (list-teams-by-district {:keys [params]})

                  TODO: write docs

                  list-visits

                  TODO: write docs

                  list-visits-by-address

                  (list-visits-by-address {:keys [params]})

                  TODO: write docs

                  list-visits-by-canvasser

                  (list-visits-by-canvasser {:keys [params]})

                  TODO: write docs

                  search-strings-addresses

                  TODO: write docs

                  search-strings-authorities

                  TODO: write docs

                  search-strings-canvassers

                  TODO: write docs

                  search-strings-districts

                  TODO: write docs

                  search-strings-dwellings

                  TODO: write docs

                  search-strings-electors

                  TODO: write docs

                  search-strings-events

                  (search-strings-events request)

                  Auto-generated method to select all records from the events table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :teams :date :time :decription :cancelled :id).

                  search-strings-followupactions

                  (search-strings-followupactions request)

                  Auto-generated method to select all records from the followupactions table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request_id :actor :date :notes :closed :id).

                  search-strings-followupmethods

                  TODO: write docs

                  search-strings-followuprequests

                  TODO: write docs

                  search-strings-genders

                  TODO: write docs

                  search-strings-intentions

                  TODO: write docs

                  search-strings-issues

                  TODO: write docs

                  search-strings-options

                  TODO: write docs

                  search-strings-roles

                  TODO: write docs

                  search-strings-teams

                  TODO: write docs

                  search-strings-visits

                  TODO: write docs

                  update-address!

                  (update-address! request)

                  Auto-generated method to update one record in the addresses table. Expects the following key(s) to be present in params: (:address :district_id :id :latitude :longitude :postcode).

                  update-authority!

                  (update-authority! request)

                  Auto-generated method to update one record in the authorities table. Expects the following key(s) to be present in params: (:access-token-uri :authorize-uri :consumer-key :consumer-secret :id :request-token-uri).

                  update-canvasser!

                  (update-canvasser! request)

                  Auto-generated method to update one record in the canvassers table. Expects the following key(s) to be present in params: (:address_id :authorised :authority_id :avatar :bio :elector_id :email :fullname :id :phone :username).

                  update-district!

                  (update-district! request)

                  Auto-generated method to update one record in the districts table. Expects the following key(s) to be present in params: (:id :name).

                  update-dwelling!

                  (update-dwelling! request)

                  Auto-generated method to update one record in the dwellings table. Expects the following key(s) to be present in params: (:address_id :id :sub-address).

                  update-elector!

                  (update-elector! request)

                  Auto-generated method to update one record in the electors table. Expects the following key(s) to be present in params: (:dwelling_id :email :gender :id :name :phone :signature).

                  update-event!

                  (update-event! request)

                  Auto-generated method to update one record in the events table. Expects the following key(s) to be present in params: (:cancelled :date :decription :id :name :time).

                  update-followupaction!

                  (update-followupaction! request)

                  Auto-generated method to update one record in the followupactions table. Expects the following key(s) to be present in params: (:actor :closed :date :id :notes :request_id).

                  update-followupmethod!

                  (update-followupmethod! request)

                  Auto-generated method to update one record in the followupmethods table. Expects the following key(s) to be present in params: (:id).

                  update-followuprequest!

                  (update-followuprequest! request)

                  Auto-generated method to update one record in the followuprequests table. Expects the following key(s) to be present in params: (:elector_id :id :issue_detail :issue_id :locked :locked_by :method_detail :method_id :visit_id).

                  update-gender!

                  (update-gender! request)

                  Auto-generated method to update one record in the genders table. Expects the following key(s) to be present in params: (:id).

                  update-intention!

                  (update-intention! request)

                  Auto-generated method to update one record in the intentions table. Expects the following key(s) to be present in params: (:elector_id :id :locality :option_id :visit_id).

                  update-issue!

                  (update-issue! request)

                  Auto-generated method to update one record in the issues table. Expects the following key(s) to be present in params: (:brief :current :id :url).

                  update-option!

                  (update-option! request)

                  Auto-generated method to update one record in the options table. Expects the following key(s) to be present in params: (:id).

                  update-role!

                  (update-role! request)

                  Auto-generated method to update one record in the roles table. Expects the following key(s) to be present in params: (:id :name).

                  update-team!

                  (update-team! request)

                  Auto-generated method to update one record in the teams table. Expects the following key(s) to be present in params: (:district_id :id :latitude :longitude :name).

                  update-visit!

                  (update-visit! request)

                  Auto-generated method to update one record in the visits table. Expects the following key(s) to be present in params: (:address_id :canvasser_id :date :id).

                  \ No newline at end of file +youyesyet.routes.auto-json documentation

                  youyesyet.routes.auto-json

                  JSON routes for youyesyet auto-generated by Application Description Language framework at 20190502T102202.387Z

                  auto-rest-routes

                  TODO: write docs

                  create-address!

                  (create-address! request)

                  Auto-generated function to insert one record to the addresses table. Expects the following key(s) to be present in params: (:address :postcode :district_id :latitude :longitude). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 1000000 seconds.

                  create-authority!

                  (create-authority! request)

                  Auto-generated function to insert one record to the authorities table. Expects the following key(s) to be present in params: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 10000000 seconds.

                  create-canvasser!

                  (create-canvasser! request)

                  Auto-generated function to insert one record to the canvassers table. Expects the following key(s) to be present in params: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 10000 seconds.

                  create-district!

                  (create-district! request)

                  Auto-generated function to insert one record to the districts table. Expects the following key(s) to be present in params: (:name). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 10000000 seconds.

                  create-dwelling!

                  (create-dwelling! request)

                  Auto-generated function to insert one record to the dwellings table. Expects the following key(s) to be present in params: (:address_id :sub-address). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 1000000 seconds.

                  create-elector!

                  (create-elector! request)

                  Auto-generated function to insert one record to the electors table. Expects the following key(s) to be present in params: (:name :dwelling_id :phone :email :gender :signature). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 100000 seconds.

                  create-event!

                  (create-event! request)

                  Auto-generated function to insert one record to the events table. Expects the following key(s) to be present in params: (:name :date :time :decription :cancelled). Returns a map containing the keys #{"id"} identifying the record created.

                  create-followupaction!

                  (create-followupaction! request)

                  Auto-generated function to insert one record to the followupactions table. Expects the following key(s) to be present in params: (:request_id :actor :date :notes :closed). Returns a map containing the keys #{"id"} identifying the record created.

                  create-followupmethod!

                  (create-followupmethod! request)

                  Auto-generated function to insert one record to the followupmethods table. Expects the following key(s) to be present in params: (:id). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 10000000 seconds.

                  create-followuprequest!

                  (create-followuprequest! request)

                  Auto-generated function to insert one record to the followuprequests table. Expects the following key(s) to be present in params: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 100 seconds.

                  create-gender!

                  (create-gender! request)

                  Auto-generated function to insert one record to the genders table. Expects the following key(s) to be present in params: (:id). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 1000000 seconds.

                  create-intention!

                  (create-intention! request)

                  Auto-generated function to insert one record to the intentions table. Expects the following key(s) to be present in params: (:visit_id :elector_id :option_id :locality). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 100 seconds.

                  create-issue!

                  (create-issue! request)

                  Auto-generated function to insert one record to the issues table. Expects the following key(s) to be present in params: (:url :current :brief :id). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 1000 seconds.

                  create-option!

                  (create-option! request)

                  Auto-generated function to insert one record to the options table. Expects the following key(s) to be present in params: (:id). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 10000000 seconds.

                  create-role!

                  (create-role! request)

                  Auto-generated function to insert one record to the roles table. Expects the following key(s) to be present in params: (:name :id). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 10000000 seconds.

                  create-team!

                  (create-team! request)

                  Auto-generated function to insert one record to the teams table. Expects the following key(s) to be present in params: (:name :district_id :latitude :longitude). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 10000 seconds.

                  create-visit!

                  (create-visit! request)

                  Auto-generated function to insert one record to the visits table. Expects the following key(s) to be present in params: (:address_id :canvasser_id :date). Returns a map containing the keys #{"id"} identifying the record created. Results will be held in cache for 100 seconds.

                  delete-address!

                  (delete-address! request)

                  Auto-generated function to delete one record from the addresses table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 1000000 seconds.

                  delete-authority!

                  (delete-authority! request)

                  Auto-generated function to delete one record from the authorities table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 10000000 seconds.

                  delete-canvasser!

                  (delete-canvasser! request)

                  Auto-generated function to delete one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 10000 seconds.

                  delete-district!

                  (delete-district! request)

                  Auto-generated function to delete one record from the districts table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 10000000 seconds.

                  delete-dwelling!

                  (delete-dwelling! request)

                  Auto-generated function to delete one record from the dwellings table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 1000000 seconds.

                  delete-elector!

                  (delete-elector! request)

                  Auto-generated function to delete one record from the electors table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 100000 seconds.

                  delete-event!

                  (delete-event! request)

                  Auto-generated function to delete one record from the events table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-followupaction!

                  (delete-followupaction! request)

                  Auto-generated function to delete one record from the followupactions table. Expects the following key(s) to be present in params: #{"id"}.

                  delete-followupmethod!

                  (delete-followupmethod! request)

                  Auto-generated function to delete one record from the followupmethods table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 10000000 seconds.

                  delete-followuprequest!

                  (delete-followuprequest! request)

                  Auto-generated function to delete one record from the followuprequests table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 100 seconds.

                  delete-gender!

                  (delete-gender! request)

                  Auto-generated function to delete one record from the genders table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 1000000 seconds.

                  delete-intention!

                  (delete-intention! request)

                  Auto-generated function to delete one record from the intentions table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 100 seconds.

                  delete-issue!

                  (delete-issue! request)

                  Auto-generated function to delete one record from the issues table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 1000 seconds.

                  delete-option!

                  (delete-option! request)

                  Auto-generated function to delete one record from the options table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 10000000 seconds.

                  delete-role!

                  (delete-role! request)

                  Auto-generated function to delete one record from the roles table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 10000000 seconds.

                  delete-team!

                  (delete-team! request)

                  Auto-generated function to delete one record from the teams table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 10000 seconds.

                  delete-visit!

                  (delete-visit! request)

                  Auto-generated function to delete one record from the visits table. Expects the following key(s) to be present in params: #{"id"}. Results will be held in cache for 100 seconds.

                  get-address

                  (get-address request)

                  Auto-generated function to select one record from the addresses table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@490531d1. Results will be held in cache for 1000000 seconds.

                  get-authority

                  (get-authority request)

                  Auto-generated function to select one record from the authorities table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@352cf516. Results will be held in cache for 10000000 seconds.

                  get-canvasser

                  (get-canvasser request)

                  Auto-generated function to select one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@771caed2. Results will be held in cache for 10000 seconds.

                  get-canvasser-by-username

                  (get-canvasser-by-username request)

                  Auto-generated function to select one record from the canvassers table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@771caed2. Results will be held in cache for 10000 seconds.

                  get-district

                  (get-district request)

                  Auto-generated function to select one record from the districts table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@1c48b9f5. Results will be held in cache for 10000000 seconds.

                  get-dwelling

                  (get-dwelling request)

                  Auto-generated function to select one record from the dwellings table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@f0e6e3d6. Results will be held in cache for 1000000 seconds.

                  get-elector

                  (get-elector request)

                  Auto-generated function to select one record from the electors table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@c7611432. Results will be held in cache for 100000 seconds.

                  get-event

                  (get-event request)

                  Auto-generated function to select one record from the events table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3ac90901.

                  get-followupaction

                  (get-followupaction request)

                  Auto-generated function to select one record from the followupactions table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@6b32af0e.

                  get-followupmethod

                  (get-followupmethod request)

                  Auto-generated function to select one record from the followupmethods table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 10000000 seconds.

                  get-followuprequest

                  (get-followuprequest request)

                  Auto-generated function to select one record from the followuprequests table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@ae10eaf. Results will be held in cache for 100 seconds.

                  get-gender

                  (get-gender request)

                  Auto-generated function to select one record from the genders table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 1000000 seconds.

                  get-intention

                  (get-intention request)

                  Auto-generated function to select one record from the intentions table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@27b31781. Results will be held in cache for 100 seconds.

                  get-issue

                  (get-issue request)

                  Auto-generated function to select one record from the issues table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@606826e4. Results will be held in cache for 1000 seconds.

                  get-option

                  (get-option request)

                  Auto-generated function to select one record from the options table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@3c72487c. Results will be held in cache for 10000000 seconds.

                  get-role

                  (get-role request)

                  Auto-generated function to select one record from the roles table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a81570c6. Results will be held in cache for 10000000 seconds.

                  get-role-by-name

                  (get-role-by-name request)

                  Auto-generated function to select one record from the roles table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a81570c6. Results will be held in cache for 10000000 seconds.

                  get-team

                  (get-team request)

                  Auto-generated function to select one record from the teams table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@31118d64. Results will be held in cache for 10000 seconds.

                  get-visit

                  (get-visit request)

                  Auto-generated function to select one record from the visits table. Expects the following key(s) to be present in params: #{"id"}. Returns a map containing the following keys: clojure.lang.LazySeq@a7611ce6. Results will be held in cache for 100 seconds.

                  list-addresses

                  (list-addresses request)

                  Auto-generated function to select all records from the addresses table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address :postcode :district_id :latitude :longitude :dwellings :locality :id). Results will be held in cache for 1000000 seconds.

                  list-addresses-by-canvasser

                  (list-addresses-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-addresses-by-dwelling

                  (list-addresses-by-dwelling {:keys [params]})

                  TODO: write docs

                  list-addresses-by-visit

                  (list-addresses-by-visit {:keys [params]})

                  TODO: write docs

                  list-authorities

                  (list-authorities request)

                  Auto-generated function to select all records from the authorities table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Results will be held in cache for 10000000 seconds.

                  list-authorities-by-canvasser

                  (list-authorities-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-canvassers

                  (list-canvassers request)

                  Auto-generated function to select all records from the canvassers table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised :roles :expertise :teams :id). Results will be held in cache for 10000 seconds.

                  list-canvassers-by-followupaction

                  (list-canvassers-by-followupaction {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-followuprequest

                  (list-canvassers-by-followuprequest {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-issue

                  (list-canvassers-by-issue {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-role

                  (list-canvassers-by-role {:keys [params]})

                  TODO: write docs

                  list-canvassers-by-visit

                  (list-canvassers-by-visit {:keys [params]})

                  TODO: write docs

                  list-districts

                  (list-districts request)

                  Auto-generated function to select all records from the districts table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :id). Results will be held in cache for 10000000 seconds.

                  list-districts-by-address

                  (list-districts-by-address {:keys [params]})

                  TODO: write docs

                  list-districts-by-team

                  (list-districts-by-team {:keys [params]})

                  TODO: write docs

                  list-dwellings

                  (list-dwellings request)

                  Auto-generated function to select all records from the dwellings table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :sub-address :electors :id). Results will be held in cache for 1000000 seconds.

                  list-dwellings-by-address

                  (list-dwellings-by-address {:keys [params]})

                  TODO: write docs

                  list-dwellings-by-elector

                  (list-dwellings-by-elector {:keys [params]})

                  TODO: write docs

                  list-electors

                  (list-electors request)

                  Auto-generated function to select all records from the electors table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :dwelling_id :phone :email :gender :signature :id). Results will be held in cache for 100000 seconds.

                  list-electors-by-canvasser

                  (list-electors-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-electors-by-dwelling

                  (list-electors-by-dwelling {:keys [params]})

                  TODO: write docs

                  list-electors-by-followuprequest

                  (list-electors-by-followuprequest {:keys [params]})

                  TODO: write docs

                  list-electors-by-intention

                  (list-electors-by-intention {:keys [params]})

                  TODO: write docs

                  list-events

                  (list-events request)

                  Auto-generated function to select all records from the events table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :teams :date :time :decription :cancelled :id).

                  list-events-by-team

                  (list-events-by-team {:keys [params]})

                  TODO: write docs

                  list-followupactions

                  (list-followupactions request)

                  Auto-generated function to select all records from the followupactions table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request_id :actor :date :notes :closed :id).

                  list-followupactions-by-followuprequest

                  (list-followupactions-by-followuprequest {:keys [params]})

                  TODO: write docs

                  list-followupmethods

                  (list-followupmethods request)

                  Auto-generated function to select all records from the followupmethods table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  list-followupmethods-by-followuprequest

                  (list-followupmethods-by-followuprequest {:keys [params]})

                  TODO: write docs

                  list-followuprequests

                  (list-followuprequests request)

                  Auto-generated function to select all records from the followuprequests table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked :actions :id). Results will be held in cache for 100 seconds.

                  list-followuprequests-by-followupaction

                  (list-followuprequests-by-followupaction {:keys [params]})

                  TODO: write docs

                  list-genders

                  (list-genders request)

                  Auto-generated function to select all records from the genders table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 1000000 seconds.

                  list-genders-by-elector

                  (list-genders-by-elector {:keys [params]})

                  TODO: write docs

                  list-intentions

                  (list-intentions request)

                  Auto-generated function to select all records from the intentions table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:visit_id :elector_id :option_id :locality :id). Results will be held in cache for 100 seconds.

                  list-issues

                  (list-issues request)

                  Auto-generated function to select all records from the issues table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:url :current :brief :experts :id). Results will be held in cache for 1000 seconds.

                  list-issues-by-canvasser

                  (list-issues-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-issues-by-followuprequest

                  (list-issues-by-followuprequest {:keys [params]})

                  TODO: write docs

                  list-members-by-team

                  (list-members-by-team {:keys [params]})

                  TODO: write docs

                  list-options

                  (list-options request)

                  Auto-generated function to select all records from the options table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  list-options-by-intention

                  (list-options-by-intention {:keys [params]})

                  TODO: write docs

                  list-organisers-by-team

                  (list-organisers-by-team {:keys [params]})

                  TODO: write docs

                  list-roles

                  (list-roles request)

                  Auto-generated function to select all records from the roles table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :members :id). Results will be held in cache for 10000000 seconds.

                  list-roles-by-canvasser

                  (list-roles-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-teams

                  (list-teams request)

                  Auto-generated function to select all records from the teams table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :district_id :latitude :longitude :members :organisers :events :id). Results will be held in cache for 10000 seconds.

                  list-teams-by-canvasser

                  (list-teams-by-canvasser {:keys [params]})

                  TODO: write docs

                  list-teams-by-event

                  (list-teams-by-event {:keys [params]})

                  TODO: write docs

                  list-visits

                  (list-visits request)

                  Auto-generated function to select all records from the visits table. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :canvasser_id :date :id). Results will be held in cache for 100 seconds.

                  list-visits-by-followuprequest

                  (list-visits-by-followuprequest {:keys [params]})

                  TODO: write docs

                  list-visits-by-intention

                  (list-visits-by-intention {:keys [params]})

                  TODO: write docs

                  search-strings-addresses

                  (search-strings-addresses request)

                  Auto-generated function to select all records from the addresses table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address :postcode :district_id :latitude :longitude :dwellings :locality :id). Results will be held in cache for 1000000 seconds.

                  search-strings-authorities

                  (search-strings-authorities request)

                  Auto-generated function to select all records from the authorities table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request-token-uri :access-token-uri :authorize-uri :consumer-key :consumer-secret :id). Results will be held in cache for 10000000 seconds.

                  search-strings-canvassers

                  (search-strings-canvassers request)

                  Auto-generated function to select all records from the canvassers table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:username :fullname :avatar :bio :elector_id :address_id :phone :email :authority_id :authorised :roles :expertise :teams :id). Results will be held in cache for 10000 seconds.

                  search-strings-districts

                  (search-strings-districts request)

                  Auto-generated function to select all records from the districts table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :id). Results will be held in cache for 10000000 seconds.

                  search-strings-dwellings

                  (search-strings-dwellings request)

                  Auto-generated function to select all records from the dwellings table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :sub-address :electors :id). Results will be held in cache for 1000000 seconds.

                  search-strings-electors

                  (search-strings-electors request)

                  Auto-generated function to select all records from the electors table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :dwelling_id :phone :email :gender :signature :id). Results will be held in cache for 100000 seconds.

                  search-strings-events

                  (search-strings-events request)

                  Auto-generated function to select all records from the events table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :teams :date :time :decription :cancelled :id).

                  search-strings-followupactions

                  (search-strings-followupactions request)

                  Auto-generated function to select all records from the followupactions table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:request_id :actor :date :notes :closed :id).

                  search-strings-followupmethods

                  (search-strings-followupmethods request)

                  Auto-generated function to select all records from the followupmethods table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  search-strings-followuprequests

                  (search-strings-followuprequests request)

                  Auto-generated function to select all records from the followuprequests table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:elector_id :visit_id :issue_id :issue_detail :method_id :method_detail :locked_by :locked :actions :id). Results will be held in cache for 100 seconds.

                  search-strings-genders

                  (search-strings-genders request)

                  Auto-generated function to select all records from the genders table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 1000000 seconds.

                  search-strings-intentions

                  (search-strings-intentions request)

                  Auto-generated function to select all records from the intentions table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:visit_id :elector_id :option_id :locality :id). Results will be held in cache for 100 seconds.

                  search-strings-issues

                  (search-strings-issues request)

                  Auto-generated function to select all records from the issues table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:url :current :brief :experts :id). Results will be held in cache for 1000 seconds.

                  search-strings-options

                  (search-strings-options request)

                  Auto-generated function to select all records from the options table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:id). Results will be held in cache for 10000000 seconds.

                  search-strings-roles

                  (search-strings-roles request)

                  Auto-generated function to select all records from the roles table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :members :id). Results will be held in cache for 10000000 seconds.

                  search-strings-teams

                  (search-strings-teams request)

                  Auto-generated function to select all records from the teams table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:name :district_id :latitude :longitude :members :organisers :events :id). Results will be held in cache for 10000 seconds.

                  search-strings-visits

                  (search-strings-visits request)

                  Auto-generated function to select all records from the visits table with any text field matching the value of the key :pattern which should be in the request. If the keys (:limit :offset) are present in the request then they will be used to page through the data. Returns a sequence of maps each containing the following keys: (:address_id :canvasser_id :date :id). Results will be held in cache for 100 seconds.

                  update-address!

                  (update-address! request)

                  Auto-generated function to update one record in the addresses table. Expects the following key(s) to be present in params: (:address :district_id :id :latitude :longitude :postcode). Results will be held in cache for 1000000 seconds.

                  update-authority!

                  (update-authority! request)

                  Auto-generated function to update one record in the authorities table. Expects the following key(s) to be present in params: (:access-token-uri :authorize-uri :consumer-key :consumer-secret :id :request-token-uri). Results will be held in cache for 10000000 seconds.

                  update-canvasser!

                  (update-canvasser! request)

                  Auto-generated function to update one record in the canvassers table. Expects the following key(s) to be present in params: (:address_id :authorised :authority_id :avatar :bio :elector_id :email :fullname :id :phone :username). Results will be held in cache for 10000 seconds.

                  update-district!

                  (update-district! request)

                  Auto-generated function to update one record in the districts table. Expects the following key(s) to be present in params: (:id :name). Results will be held in cache for 10000000 seconds.

                  update-dwelling!

                  (update-dwelling! request)

                  Auto-generated function to update one record in the dwellings table. Expects the following key(s) to be present in params: (:address_id :id :sub-address). Results will be held in cache for 1000000 seconds.

                  update-elector!

                  (update-elector! request)

                  Auto-generated function to update one record in the electors table. Expects the following key(s) to be present in params: (:dwelling_id :email :gender :id :name :phone :signature). Results will be held in cache for 100000 seconds.

                  update-event!

                  (update-event! request)

                  Auto-generated function to update one record in the events table. Expects the following key(s) to be present in params: (:cancelled :date :decription :id :name :time).

                  update-followupaction!

                  (update-followupaction! request)

                  Auto-generated function to update one record in the followupactions table. Expects the following key(s) to be present in params: (:actor :closed :date :id :notes :request_id).

                  update-followupmethod!

                  (update-followupmethod! request)

                  Auto-generated function to update one record in the followupmethods table. Expects the following key(s) to be present in params: (:id). Results will be held in cache for 10000000 seconds.

                  update-followuprequest!

                  (update-followuprequest! request)

                  Auto-generated function to update one record in the followuprequests table. Expects the following key(s) to be present in params: (:elector_id :id :issue_detail :issue_id :locked :locked_by :method_detail :method_id :visit_id). Results will be held in cache for 100 seconds.

                  update-gender!

                  (update-gender! request)

                  Auto-generated function to update one record in the genders table. Expects the following key(s) to be present in params: (:id). Results will be held in cache for 1000000 seconds.

                  update-intention!

                  (update-intention! request)

                  Auto-generated function to update one record in the intentions table. Expects the following key(s) to be present in params: (:elector_id :id :locality :option_id :visit_id). Results will be held in cache for 100 seconds.

                  update-issue!

                  (update-issue! request)

                  Auto-generated function to update one record in the issues table. Expects the following key(s) to be present in params: (:brief :current :id :url). Results will be held in cache for 1000 seconds.

                  update-option!

                  (update-option! request)

                  Auto-generated function to update one record in the options table. Expects the following key(s) to be present in params: (:id). Results will be held in cache for 10000000 seconds.

                  update-role!

                  (update-role! request)

                  Auto-generated function to update one record in the roles table. Expects the following key(s) to be present in params: (:id :name). Results will be held in cache for 10000000 seconds.

                  update-team!

                  (update-team! request)

                  Auto-generated function to update one record in the teams table. Expects the following key(s) to be present in params: (:district_id :id :latitude :longitude :name). Results will be held in cache for 10000 seconds.

                  update-visit!

                  (update-visit! request)

                  Auto-generated function to update one record in the visits table. Expects the following key(s) to be present in params: (:address_id :canvasser_id :date :id). Results will be held in cache for 100 seconds.

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.auto.html b/docs/youyesyet.routes.auto.html index 20250cc..a05a1cb 100644 --- a/docs/youyesyet.routes.auto.html +++ b/docs/youyesyet.routes.auto.html @@ -1,3 +1,3 @@ -youyesyet.routes.auto documentation

                  youyesyet.routes.auto

                  User interface routes for Youyesyet auto-generated by Application Description Language framework at 20190502T100146.996Z

                  auto-selmer-routes

                  TODO: write docs

                  get-form-addresses-Address

                  (get-form-addresses-Address request)

                  TODO: write docs

                  get-form-authorities-Authority

                  (get-form-authorities-Authority request)

                  TODO: write docs

                  get-form-canvassers-Canvasser

                  (get-form-canvassers-Canvasser request)

                  TODO: write docs

                  get-form-districts-District

                  (get-form-districts-District request)

                  TODO: write docs

                  get-form-dwellings-Dwelling

                  (get-form-dwellings-Dwelling request)

                  TODO: write docs

                  get-form-electors-Elector

                  (get-form-electors-Elector request)

                  TODO: write docs

                  get-form-events-Events

                  (get-form-events-Events request)

                  TODO: write docs

                  get-form-followupactions-Followupaction

                  (get-form-followupactions-Followupaction request)

                  TODO: write docs

                  get-form-followupmethods-Followupmethod

                  (get-form-followupmethods-Followupmethod request)

                  TODO: write docs

                  get-form-followuprequests-Followuprequest

                  (get-form-followuprequests-Followuprequest request)

                  TODO: write docs

                  get-form-genders-Gender

                  (get-form-genders-Gender request)

                  TODO: write docs

                  get-form-intentions-Intention

                  (get-form-intentions-Intention request)

                  TODO: write docs

                  get-form-issues-Issue

                  (get-form-issues-Issue request)

                  TODO: write docs

                  get-form-options-Option

                  (get-form-options-Option request)

                  TODO: write docs

                  get-form-roles-Role

                  (get-form-roles-Role request)

                  TODO: write docs

                  get-form-teams-Team

                  (get-form-teams-Team request)

                  TODO: write docs

                  get-form-visits-Visit

                  (get-form-visits-Visit request)

                  TODO: write docs

                  get-list-addresses-Addresses

                  (get-list-addresses-Addresses request)

                  TODO: write docs

                  get-list-authorities-Authorities

                  (get-list-authorities-Authorities request)

                  TODO: write docs

                  get-list-canvassers-Canvassers

                  (get-list-canvassers-Canvassers request)

                  TODO: write docs

                  get-list-districts-Districts

                  (get-list-districts-Districts request)

                  TODO: write docs

                  get-list-dwellings-Dwellings

                  (get-list-dwellings-Dwellings request)

                  TODO: write docs

                  get-list-electors-Electors

                  (get-list-electors-Electors request)

                  TODO: write docs

                  get-list-events-Events

                  (get-list-events-Events request)

                  TODO: write docs

                  get-list-followupactions-Followupactions

                  (get-list-followupactions-Followupactions request)

                  TODO: write docs

                  get-list-followupmethods-Followupmethods

                  (get-list-followupmethods-Followupmethods request)

                  TODO: write docs

                  get-list-followuprequests-Followuprequests

                  (get-list-followuprequests-Followuprequests request)

                  TODO: write docs

                  get-list-genders-Genders

                  (get-list-genders-Genders request)

                  TODO: write docs

                  get-list-intentions-Intentions

                  (get-list-intentions-Intentions request)

                  TODO: write docs

                  get-list-issues-Issues

                  (get-list-issues-Issues request)

                  TODO: write docs

                  get-list-options-Options

                  (get-list-options-Options request)

                  TODO: write docs

                  get-list-roles-Roles

                  (get-list-roles-Roles request)

                  TODO: write docs

                  get-list-teams-Teams

                  (get-list-teams-Teams request)

                  TODO: write docs

                  get-list-visits-Visits

                  (get-list-visits-Visits request)

                  TODO: write docs

                  index

                  (index r)

                  TODO: write docs

                  post-form-addresses-Address

                  (post-form-addresses-Address request)

                  TODO: write docs

                  post-form-authorities-Authority

                  (post-form-authorities-Authority request)

                  TODO: write docs

                  post-form-canvassers-Canvasser

                  (post-form-canvassers-Canvasser request)

                  TODO: write docs

                  post-form-districts-District

                  (post-form-districts-District request)

                  TODO: write docs

                  post-form-dwellings-Dwelling

                  (post-form-dwellings-Dwelling request)

                  TODO: write docs

                  post-form-electors-Elector

                  (post-form-electors-Elector request)

                  TODO: write docs

                  post-form-events-Events

                  (post-form-events-Events request)

                  TODO: write docs

                  post-form-followupactions-Followupaction

                  (post-form-followupactions-Followupaction request)

                  TODO: write docs

                  post-form-followupmethods-Followupmethod

                  (post-form-followupmethods-Followupmethod request)

                  TODO: write docs

                  post-form-followuprequests-Followuprequest

                  (post-form-followuprequests-Followuprequest request)

                  TODO: write docs

                  post-form-genders-Gender

                  (post-form-genders-Gender request)

                  TODO: write docs

                  post-form-intentions-Intention

                  (post-form-intentions-Intention request)

                  TODO: write docs

                  post-form-issues-Issue

                  (post-form-issues-Issue request)

                  TODO: write docs

                  post-form-options-Option

                  (post-form-options-Option request)

                  TODO: write docs

                  post-form-roles-Role

                  (post-form-roles-Role request)

                  TODO: write docs

                  post-form-teams-Team

                  (post-form-teams-Team request)

                  TODO: write docs

                  post-form-visits-Visit

                  (post-form-visits-Visit request)

                  TODO: write docs

                  post-list-addresses-Addresses

                  (post-list-addresses-Addresses request)

                  TODO: write docs

                  post-list-authorities-Authorities

                  (post-list-authorities-Authorities request)

                  TODO: write docs

                  post-list-canvassers-Canvassers

                  (post-list-canvassers-Canvassers request)

                  TODO: write docs

                  post-list-districts-Districts

                  (post-list-districts-Districts request)

                  TODO: write docs

                  post-list-dwellings-Dwellings

                  (post-list-dwellings-Dwellings request)

                  TODO: write docs

                  post-list-electors-Electors

                  (post-list-electors-Electors request)

                  TODO: write docs

                  post-list-events-Events

                  (post-list-events-Events request)

                  TODO: write docs

                  post-list-followupactions-Followupactions

                  (post-list-followupactions-Followupactions request)

                  TODO: write docs

                  post-list-followupmethods-Followupmethods

                  (post-list-followupmethods-Followupmethods request)

                  TODO: write docs

                  post-list-followuprequests-Followuprequests

                  (post-list-followuprequests-Followuprequests request)

                  TODO: write docs

                  post-list-genders-Genders

                  (post-list-genders-Genders request)

                  TODO: write docs

                  post-list-intentions-Intentions

                  (post-list-intentions-Intentions request)

                  TODO: write docs

                  post-list-issues-Issues

                  (post-list-issues-Issues request)

                  TODO: write docs

                  post-list-options-Options

                  (post-list-options-Options request)

                  TODO: write docs

                  post-list-roles-Roles

                  (post-list-roles-Roles request)

                  TODO: write docs

                  post-list-teams-Teams

                  (post-list-teams-Teams request)

                  TODO: write docs

                  post-list-visits-Visits

                  (post-list-visits-Visits request)

                  TODO: write docs

                  raw-resolve-handler

                  (raw-resolve-handler n)

                  Prefer the manually-written version of the handler with name n, if it exists, to the automatically generated one

                  resolve-handler

                  TODO: write docs

                  \ No newline at end of file +youyesyet.routes.auto documentation

                  youyesyet.routes.auto

                  User interface routes for Youyesyet auto-generated by Application Description Language framework at 20190502T102204.626Z

                  auto-selmer-routes

                  TODO: write docs

                  get-form-addresses-Address

                  (get-form-addresses-Address request)

                  TODO: write docs

                  get-form-authorities-Authority

                  (get-form-authorities-Authority request)

                  TODO: write docs

                  get-form-canvassers-Canvasser

                  (get-form-canvassers-Canvasser request)

                  TODO: write docs

                  get-form-districts-District

                  (get-form-districts-District request)

                  TODO: write docs

                  get-form-dwellings-Dwelling

                  (get-form-dwellings-Dwelling request)

                  TODO: write docs

                  get-form-electors-Elector

                  (get-form-electors-Elector request)

                  TODO: write docs

                  get-form-events-Events

                  (get-form-events-Events request)

                  TODO: write docs

                  get-form-followupactions-Followupaction

                  (get-form-followupactions-Followupaction request)

                  TODO: write docs

                  get-form-followupmethods-Followupmethod

                  (get-form-followupmethods-Followupmethod request)

                  TODO: write docs

                  get-form-followuprequests-Followuprequest

                  (get-form-followuprequests-Followuprequest request)

                  TODO: write docs

                  get-form-genders-Gender

                  (get-form-genders-Gender request)

                  TODO: write docs

                  get-form-intentions-Intention

                  (get-form-intentions-Intention request)

                  TODO: write docs

                  get-form-issues-Issue

                  (get-form-issues-Issue request)

                  TODO: write docs

                  get-form-options-Option

                  (get-form-options-Option request)

                  TODO: write docs

                  get-form-roles-Role

                  (get-form-roles-Role request)

                  TODO: write docs

                  get-form-teams-Team

                  (get-form-teams-Team request)

                  TODO: write docs

                  get-form-visits-Visit

                  (get-form-visits-Visit request)

                  TODO: write docs

                  get-list-addresses-Addresses

                  (get-list-addresses-Addresses request)

                  TODO: write docs

                  get-list-authorities-Authorities

                  (get-list-authorities-Authorities request)

                  TODO: write docs

                  get-list-canvassers-Canvassers

                  (get-list-canvassers-Canvassers request)

                  TODO: write docs

                  get-list-districts-Districts

                  (get-list-districts-Districts request)

                  TODO: write docs

                  get-list-dwellings-Dwellings

                  (get-list-dwellings-Dwellings request)

                  TODO: write docs

                  get-list-electors-Electors

                  (get-list-electors-Electors request)

                  TODO: write docs

                  get-list-events-Events

                  (get-list-events-Events request)

                  TODO: write docs

                  get-list-followupactions-Followupactions

                  (get-list-followupactions-Followupactions request)

                  TODO: write docs

                  get-list-followupmethods-Followupmethods

                  (get-list-followupmethods-Followupmethods request)

                  TODO: write docs

                  get-list-followuprequests-Followuprequests

                  (get-list-followuprequests-Followuprequests request)

                  TODO: write docs

                  get-list-genders-Genders

                  (get-list-genders-Genders request)

                  TODO: write docs

                  get-list-intentions-Intentions

                  (get-list-intentions-Intentions request)

                  TODO: write docs

                  get-list-issues-Issues

                  (get-list-issues-Issues request)

                  TODO: write docs

                  get-list-options-Options

                  (get-list-options-Options request)

                  TODO: write docs

                  get-list-roles-Roles

                  (get-list-roles-Roles request)

                  TODO: write docs

                  get-list-teams-Teams

                  (get-list-teams-Teams request)

                  TODO: write docs

                  get-list-visits-Visits

                  (get-list-visits-Visits request)

                  TODO: write docs

                  index

                  (index r)

                  TODO: write docs

                  post-form-addresses-Address

                  (post-form-addresses-Address request)

                  TODO: write docs

                  post-form-authorities-Authority

                  (post-form-authorities-Authority request)

                  TODO: write docs

                  post-form-canvassers-Canvasser

                  (post-form-canvassers-Canvasser request)

                  TODO: write docs

                  post-form-districts-District

                  (post-form-districts-District request)

                  TODO: write docs

                  post-form-dwellings-Dwelling

                  (post-form-dwellings-Dwelling request)

                  TODO: write docs

                  post-form-electors-Elector

                  (post-form-electors-Elector request)

                  TODO: write docs

                  post-form-events-Events

                  (post-form-events-Events request)

                  TODO: write docs

                  post-form-followupactions-Followupaction

                  (post-form-followupactions-Followupaction request)

                  TODO: write docs

                  post-form-followupmethods-Followupmethod

                  (post-form-followupmethods-Followupmethod request)

                  TODO: write docs

                  post-form-followuprequests-Followuprequest

                  (post-form-followuprequests-Followuprequest request)

                  TODO: write docs

                  post-form-genders-Gender

                  (post-form-genders-Gender request)

                  TODO: write docs

                  post-form-intentions-Intention

                  (post-form-intentions-Intention request)

                  TODO: write docs

                  post-form-issues-Issue

                  (post-form-issues-Issue request)

                  TODO: write docs

                  post-form-options-Option

                  (post-form-options-Option request)

                  TODO: write docs

                  post-form-roles-Role

                  (post-form-roles-Role request)

                  TODO: write docs

                  post-form-teams-Team

                  (post-form-teams-Team request)

                  TODO: write docs

                  post-form-visits-Visit

                  (post-form-visits-Visit request)

                  TODO: write docs

                  post-list-addresses-Addresses

                  (post-list-addresses-Addresses request)

                  TODO: write docs

                  post-list-authorities-Authorities

                  (post-list-authorities-Authorities request)

                  TODO: write docs

                  post-list-canvassers-Canvassers

                  (post-list-canvassers-Canvassers request)

                  TODO: write docs

                  post-list-districts-Districts

                  (post-list-districts-Districts request)

                  TODO: write docs

                  post-list-dwellings-Dwellings

                  (post-list-dwellings-Dwellings request)

                  TODO: write docs

                  post-list-electors-Electors

                  (post-list-electors-Electors request)

                  TODO: write docs

                  post-list-events-Events

                  (post-list-events-Events request)

                  TODO: write docs

                  post-list-followupactions-Followupactions

                  (post-list-followupactions-Followupactions request)

                  TODO: write docs

                  post-list-followupmethods-Followupmethods

                  (post-list-followupmethods-Followupmethods request)

                  TODO: write docs

                  post-list-followuprequests-Followuprequests

                  (post-list-followuprequests-Followuprequests request)

                  TODO: write docs

                  post-list-genders-Genders

                  (post-list-genders-Genders request)

                  TODO: write docs

                  post-list-intentions-Intentions

                  (post-list-intentions-Intentions request)

                  TODO: write docs

                  post-list-issues-Issues

                  (post-list-issues-Issues request)

                  TODO: write docs

                  post-list-options-Options

                  (post-list-options-Options request)

                  TODO: write docs

                  post-list-roles-Roles

                  (post-list-roles-Roles request)

                  TODO: write docs

                  post-list-teams-Teams

                  (post-list-teams-Teams request)

                  TODO: write docs

                  post-list-visits-Visits

                  (post-list-visits-Visits request)

                  TODO: write docs

                  raw-resolve-handler

                  (raw-resolve-handler n)

                  Prefer the manually-written version of the handler with name n, if it exists, to the automatically generated one

                  resolve-handler

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.home.html b/docs/youyesyet.routes.home.html index 4e0adee..176017f 100644 --- a/docs/youyesyet.routes.home.html +++ b/docs/youyesyet.routes.home.html @@ -1,3 +1,3 @@ -youyesyet.routes.home documentation

                  youyesyet.routes.home

                  Routes/pages available to unauthenticated users.

                  about-page

                  (about-page)

                  TODO: write docs

                  call-me-page

                  (call-me-page request)

                  TODO: write docs

                  home-page

                  (home-page)

                  TODO: write docs

                  home-routes

                  TODO: write docs

                  login-page

                  (login-page request)

                  This is very temporary. We’re going to do authentication by oauth.

                  motd

                  (motd)

                  TODO: write docs

                  \ No newline at end of file +youyesyet.routes.home documentation

                  youyesyet.routes.home

                  Routes/pages available to unauthenticated users.

                  about-page

                  (about-page)

                  TODO: write docs

                  call-me-page

                  (call-me-page request)

                  TODO: write docs

                  home-page

                  (home-page)

                  TODO: write docs

                  home-routes

                  TODO: write docs

                  login-page

                  (login-page request)

                  This is very temporary. We’re going to do authentication by oauth.

                  motd

                  (motd)

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.issue-experts.html b/docs/youyesyet.routes.issue-experts.html index 22e0ed6..470cc94 100644 --- a/docs/youyesyet.routes.issue-experts.html +++ b/docs/youyesyet.routes.issue-experts.html @@ -1,3 +1,3 @@ -youyesyet.routes.issue-experts documentation

                  youyesyet.routes.issue-experts

                  Routes/pages available to issue experts.

                  get-and-lock-followuprequest!

                  (get-and-lock-followuprequest! id user)

                  Return the followuprequest record indicated by this id, provided that it is unlocked. As a side effect, lock it to this user.

                  get-followup-request-page

                  (get-followup-request-page request)

                  TODO: write docs

                  issue-expert-routes

                  TODO: write docs

                  list-page

                  (list-page request)

                  TODO: write docs

                  post-followup-action

                  (post-followup-action request)

                  From this request, create a followupaction record, and, if an option_id is present in the params, an intention record; show the request list on success, the request form on failure.

                  release-followuprequest!

                  (release-followuprequest! id user)

                  Release the lock held on the followuprequest record indicated by this id held by this user, if present.

                  \ No newline at end of file +youyesyet.routes.issue-experts documentation

                  youyesyet.routes.issue-experts

                  Routes/pages available to issue experts.

                  get-and-lock-followuprequest!

                  (get-and-lock-followuprequest! id user)

                  Return the followuprequest record indicated by this id, provided that it is unlocked. As a side effect, lock it to this user.

                  get-followup-request-page

                  (get-followup-request-page request)

                  TODO: write docs

                  issue-expert-routes

                  TODO: write docs

                  list-page

                  (list-page request)

                  TODO: write docs

                  post-followup-action

                  (post-followup-action request)

                  From this request, create a followupaction record, and, if an option_id is present in the params, an intention record; show the request list on success, the request form on failure.

                  release-followuprequest!

                  (release-followuprequest! id user)

                  Release the lock held on the followuprequest record indicated by this id held by this user, if present.

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.oauth.html b/docs/youyesyet.routes.oauth.html index 475f8e9..3affe79 100644 --- a/docs/youyesyet.routes.oauth.html +++ b/docs/youyesyet.routes.oauth.html @@ -1,3 +1,3 @@ -youyesyet.routes.oauth documentation

                  youyesyet.routes.oauth

                  OAuth authentication routes - not finished, does not work yet.

                  oauth-callback

                  (oauth-callback request_token {:keys [session]})

                  Handles the callback from the authority.

                  oauth-init

                  (oauth-init request)

                  Initiates the OAuth with the authority implied by this request

                  oauth-routes

                  TODO: write docs

                  \ No newline at end of file +youyesyet.routes.oauth documentation

                  youyesyet.routes.oauth

                  OAuth authentication routes - not finished, does not work yet.

                  oauth-callback

                  (oauth-callback request_token {:keys [session]})

                  Handles the callback from the authority.

                  oauth-init

                  (oauth-init request)

                  Initiates the OAuth with the authority implied by this request

                  oauth-routes

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.rest.html b/docs/youyesyet.routes.rest.html index 17df879..d335c09 100644 --- a/docs/youyesyet.routes.rest.html +++ b/docs/youyesyet.routes.rest.html @@ -1,3 +1,3 @@ -youyesyet.routes.rest documentation

                  youyesyet.routes.rest

                  Manually maintained routes which handle data transfer to/from the canvasser app.

                  create-intention-and-visit!

                  (create-intention-and-visit! request)

                  Doing visit creation logic server side; request params are expected to include an option_id, an elector_id and an address_id, or an option and a location. If no address_id is provided, we simply create an intention record from the option_id and the locality; if an address_id is provided, we need to check whether the last visit by the current user was to the same address, if so use that as the visit_id, if not create a new visit record.

                  create-request-and-visit!

                  (create-request-and-visit! request)

                  Doing visit creation logic server side; request params are expected to include an issue, an elector_id and an address_id (and also a method_id and method_detail). Ye cannae reasonably create a request without having recorded the visit, so let’s not muck about.

                  current-visit-id

                  (current-visit-id request)

                  Return the id of the current visit by the current user, creating it if necessary.

                  get-local-data

                  (get-local-data request)

                  Get data local to the user of the canvasser app. Expects arguments latitude and longitude, or locality. Returns a block of data for that locality

                  in-get-local-data

                  Local data is volatile, because hopefully canvassers are updating it as they work. So cache for only 90 seconds.

                  last-visit-by-current-user

                  (last-visit-by-current-user request)

                  Return the most recent visit by the currently logged in user

                  rest-routes

                  TODO: write docs

                  update-elector-signature!

                  (update-elector-signature! request)

                  Set the signature in the params of this request as the signature for the elector whose id is in the params of this request.

                  \ No newline at end of file +youyesyet.routes.rest documentation

                  youyesyet.routes.rest

                  Manually maintained routes which handle data transfer to/from the canvasser app.

                  create-intention-and-visit!

                  (create-intention-and-visit! request)

                  Doing visit creation logic server side; request params are expected to include an option_id, an elector_id and an address_id, or an option and a location. If no address_id is provided, we simply create an intention record from the option_id and the locality; if an address_id is provided, we need to check whether the last visit by the current user was to the same address, if so use that as the visit_id, if not create a new visit record.

                  create-request-and-visit!

                  (create-request-and-visit! request)

                  Doing visit creation logic server side; request params are expected to include an issue, an elector_id and an address_id (and also a method_id and method_detail). Ye cannae reasonably create a request without having recorded the visit, so let’s not muck about.

                  current-visit-id

                  (current-visit-id request)

                  Return the id of the current visit by the current user, creating it if necessary.

                  get-local-data

                  (get-local-data request)

                  Get data local to the user of the canvasser app. Expects arguments latitude and longitude, or locality. Returns a block of data for that locality

                  in-get-local-data

                  Local data is volatile, because hopefully canvassers are updating it as they work. So cache for only 90 seconds.

                  last-visit-by-current-user

                  (last-visit-by-current-user request)

                  Return the most recent visit by the currently logged in user

                  rest-routes

                  TODO: write docs

                  update-elector-signature!

                  (update-elector-signature! request)

                  Set the signature in the params of this request as the signature for the elector whose id is in the params of this request.

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.roles.html b/docs/youyesyet.routes.roles.html index 6bcff5c..8fc327c 100644 --- a/docs/youyesyet.routes.roles.html +++ b/docs/youyesyet.routes.roles.html @@ -1,3 +1,3 @@ -youyesyet.routes.roles documentation

                  youyesyet.routes.roles

                  Routes/pages available to authenticated users in specific roles.

                  admins-page

                  (admins-page request)

                  TODO: write docs

                  analysts-page

                  (analysts-page request)

                  My expectation is that analysts will do a lot of their work through QGIS or some other geographical information system; so there isn’t a need to put anything sophisticated here.

                  canvassers-page

                  (canvassers-page request)

                  TODO: write docs

                  roles-page

                  (roles-page request)

                  TODO: write docs

                  roles-routes

                  TODO: write docs

                  team-organisers-page

                  (team-organisers-page request)

                  TODO: write docs

                  \ No newline at end of file +youyesyet.routes.roles documentation

                  youyesyet.routes.roles

                  Routes/pages available to authenticated users in specific roles.

                  admins-page

                  (admins-page request)

                  TODO: write docs

                  analysts-page

                  (analysts-page request)

                  My expectation is that analysts will do a lot of their work through QGIS or some other geographical information system; so there isn’t a need to put anything sophisticated here.

                  canvassers-page

                  (canvassers-page request)

                  TODO: write docs

                  roles-page

                  (roles-page request)

                  TODO: write docs

                  roles-routes

                  TODO: write docs

                  team-organisers-page

                  (team-organisers-page request)

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.routes.services.html b/docs/youyesyet.routes.services.html index 78c1be2..3e8c2d0 100644 --- a/docs/youyesyet.routes.services.html +++ b/docs/youyesyet.routes.services.html @@ -1,3 +1,3 @@ -youyesyet.routes.services documentation

                  youyesyet.routes.services

                  REST API.

                  service-routes

                  TODO: write docs

                  \ No newline at end of file +youyesyet.routes.services documentation

                  youyesyet.routes.services

                  REST API.

                  service-routes

                  TODO: write docs

                  \ No newline at end of file diff --git a/docs/youyesyet.utils.html b/docs/youyesyet.utils.html index 4b993d9..683730b 100644 --- a/docs/youyesyet.utils.html +++ b/docs/youyesyet.utils.html @@ -1,3 +1,3 @@ -youyesyet.utils documentation

                  youyesyet.utils

                  coerce-to-number

                  (coerce-to-number v)

                  TODO: write docs

                  \ No newline at end of file +youyesyet.utils documentation

                  youyesyet.utils

                  coerce-to-number

                  (coerce-to-number v)

                  TODO: write docs

                  \ No newline at end of file diff --git a/project.clj b/project.clj index 97ea793..5a15078 100644 --- a/project.clj +++ b/project.clj @@ -63,7 +63,7 @@ :main ^:skip-aot youyesyet.core :migratus {:store :database :db ~(get (System/getenv) "DATABASE_URL")} - :plugins [[lein-adl "0.1.6"] + :plugins [[lein-adl "0.1.7-SNAPSHOT"] [lein-cljsbuild "1.1.7"] [lein-codox "0.10.7-multilang"] [lein-cprop "1.0.3"] @@ -81,7 +81,7 @@ :doc/format :markdown} :languages [:clojure :clojurescript] :source-paths ["src/clj" "src/cljc" "src/cljs"] - :source-uri "https://github.com/simon-brooke/html-to-md/blob/master/{filepath}#L{line}" + :source-uri "https://github.com/simon-brooke/youyesyet/blob/master/{filepath}#L{line}" :output-path "docs"} diff --git a/src/clj/youyesyet/authorisation.clj b/src/clj/youyesyet/authorisation.clj deleted file mode 100644 index 8b13789..0000000 --- a/src/clj/youyesyet/authorisation.clj +++ /dev/null @@ -1 +0,0 @@ - diff --git a/src/clj/youyesyet/config.clj b/src/clj/youyesyet/config.clj index 2de50fa..fad5ccc 100644 --- a/src/clj/youyesyet/config.clj +++ b/src/clj/youyesyet/config.clj @@ -1,11 +1,14 @@ -(ns ^{:doc "Read configuration." +(ns ^{:doc "Read configuration; largely unaltered from Luminus default." :author "Simon Brooke"} youyesyet.config (:require [cprop.core :refer [load-config]] [cprop.source :as source] [mount.core :refer [args defstate]])) -(defstate env :start (load-config +(defstate env + "Configuration, loaded at startup time from properties. **Note** that + this conficuration is used only when not running in a Servlet context." + :start (load-config :merge [(args) (source/from-system-props) diff --git a/src/clj/youyesyet/db/core.clj b/src/clj/youyesyet/db/core.clj index 033ec72..cb5980b 100644 --- a/src/clj/youyesyet/db/core.clj +++ b/src/clj/youyesyet/db/core.clj @@ -19,10 +19,12 @@ PreparedStatement])) (defstate ^:dynamic *db* - :start (conman/connect! {:jdbc-url-env (env :database-url) - :jdbc-url "jdbc:postgresql://127.0.0.1/youyesyet_dev?user=youyesyet&password=thisisnotsecure" - :driver-class-name "org.postgresql.Driver"}) - :stop (conman/disconnect! *db*)) + "Primary connection to the main database. TODO: this does not yet enable + sharding." + :start (conman/connect! {:jdbc-url-env (env :database-url) + :jdbc-url "jdbc:postgresql://127.0.0.1/youyesyet_dev?user=youyesyet&password=thisisnotsecure" + :driver-class-name "org.postgresql.Driver"}) + :stop (conman/disconnect! *db*)) (add-json-type generate-string parse-string) (add-jsonb-type generate-string parse-string) @@ -31,7 +33,9 @@ (conman/bind-connection *db* "sql/queries.auto.sql" "sql/queries.sql") (hugsql/def-sqlvec-fns "sql/queries.auto.sql") -(defn to-date [^java.sql.Date sql-date] +(defn to-date + "Return the SQL date `sql-date` as a Java date." + [^java.sql.Date sql-date] (-> sql-date (.getTime) (java.util.Date.))) (extend-protocol jdbc/IResultSetReadColumn @@ -59,10 +63,12 @@ (set-parameter [v ^PreparedStatement stmt ^long idx] (.setTimestamp stmt idx (Timestamp. (.getTime v))))) -(defn to-pg-json [value] - (doto (PGobject.) - (.setType "jsonb") - (.setValue (generate-string value)))) +(defn to-pg-json + "Render this `value` as JavaScript Object Notation." + [value] + (doto (PGobject.) + (.setType "jsonb") + (.setValue (generate-string value)))) (extend-type clojure.lang.IPersistentVector jdbc/ISQLParameter diff --git a/src/clj/youyesyet/handler.clj b/src/clj/youyesyet/handler.clj index 983df79..282375f 100644 --- a/src/clj/youyesyet/handler.clj +++ b/src/clj/youyesyet/handler.clj @@ -44,8 +44,8 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (mount/defstate init-app - :start ((or (:init defaults) identity)) - :stop ((or (:stop defaults) identity))) + :start ((or (:init defaults) identity)) + :stop ((or (:stop defaults) identity))) (defn init "init will be called once when @@ -67,6 +67,8 @@ (def app-routes + "All routes served as part of the `youyesyet` (server-side) web-app (not + to be confused with the client-side `canvasser-app`, q.v.)." (routes (-> #'home-routes (wrap-routes middleware/wrap-csrf) @@ -101,4 +103,7 @@ :message "The page you requested has not yet been implemented"}))))) -(def app (middleware/wrap-base #'app-routes)) +(def app + "The `youyesyet` server-side web-app (not to be confused with the client- + side `canvasser-app`, q.v.)" + (middleware/wrap-base #'app-routes)) diff --git a/src/clj/youyesyet/layout.clj b/src/clj/youyesyet/layout.clj index 3254100..a9f51af 100644 --- a/src/clj/youyesyet/layout.clj +++ b/src/clj/youyesyet/layout.clj @@ -40,7 +40,15 @@ (declare ^:dynamic *app-context*) -(def ^:dynamic *user* nil) +;; "Bound to the servlet context, if we're running as a servlet; otherwise +;; from configuration. See [[youyesyet.middleware/wrap-context]]." + +(def ^:dynamic *user* + "The current user, in circumstances in which we do not have a session. + Normally the user is held on a key in the session. + + TODO: is this necessary? Is it *safe*?" + nil) (parser/set-resource-path! (clojure.java.io/resource "templates")) (parser/add-tag! :csrf-field (fn [_ _] (anti-forgery-field))) diff --git a/src/cljc/youyesyet/outqueue.cljc b/src/cljc/youyesyet/outqueue.cljc index 8386d4a..69955dc 100644 --- a/src/cljc/youyesyet/outqueue.cljc +++ b/src/cljc/youyesyet/outqueue.cljc @@ -45,7 +45,7 @@ (defn add! - "Add this item to the queue." + "Add this `item` to the queue `q`." [q item] (swap! q (fn [a] @@ -54,7 +54,7 @@ (defn queue? - "True if x is a queue, else false." + "True if `x` is a queue, else false." [x] (try (let [q (deref x) @@ -68,17 +68,20 @@ (defn peek - "Look at the next item which could be removed from the queue." + "Look at the next item which could be removed from the queue `q`." [q] (last (:items (deref q)))) (defn locked? + "True if this queue `q` is locked, else false." [q] (:locked (deref q))) (defn unlock! + "Unlock the queue `q` if not `value` is supplied; if a `value` is + supplied, unlock only if that value is `true`, otherwise lock." ([q ] (unlock! q true)) ([q value] @@ -86,18 +89,19 @@ (defn lock! + "Lock the queue `q`." [q] (unlock! q false)) (defn count - "Return the count of items currently in the queue." + "Return the count of items currently in the queue `q`." [q] (count (deref q))) (defn take! - "Return the first item from the queue, rebind the queue to the remaining + "Return the first item from the queue `q`, rebind the queue to the remaining items. If the queue is empty return nil." [q] (swap! q (fn [a] @@ -109,8 +113,8 @@ (defn maybe-process-next - "Apply this process, assumed to be a function of one argument, to the next - item in the queue, if the queue is not currently locked; return the value + "Apply this `process`, assumed to be a function of one argument, to the next + item in the queue `q`, if the queue is not currently locked; return the value returned by process." [q process] (if (and (queue? q)(not (locked? q))) @@ -122,5 +126,4 @@ (catch #?(:clj Exception :cljs js/Object) any #?(:clj (print (.getMessage any)) :cljs (js/console.log (str any)))) - (finally (unlock! q))) - )) + (finally (unlock! q))))) diff --git a/src/cljc/youyesyet/utils.cljc b/src/cljc/youyesyet/utils.cljc index fd07386..de5b9b9 100644 --- a/src/cljc/youyesyet/utils.cljc +++ b/src/cljc/youyesyet/utils.cljc @@ -27,7 +27,7 @@ (defn coerce-to-number [v] "If it is possible to do so, coerce `v` to a number" - ;; TODO: this doesn't work in cljs. + ;; TODO: this doesn't work in cljs. Fix if possible. (if (number? v) v (try (read-string (str v)) diff --git a/src/cljs/youyesyet/canvasser_app/ajax.cljs b/src/cljs/youyesyet/canvasser_app/ajax.cljs index 7684b8a..61805a9 100644 --- a/src/cljs/youyesyet/canvasser_app/ajax.cljs +++ b/src/cljs/youyesyet/canvasser_app/ajax.cljs @@ -28,9 +28,12 @@ (defn local-uri? [{:keys [uri]}] + "Return `true` if the supplied `uri` has no protocol part." (not (re-find #"^\w+?://" (str uri)))) (defn default-headers [request] + "Copy the current uri and cross site request forgery token into the headers + of this request." (if (local-uri? request) (-> request (update :uri #(str js/context %)) diff --git a/src/cljs/youyesyet/canvasser_app/core.cljs b/src/cljs/youyesyet/canvasser_app/core.cljs index f6daa12..bb80e17 100644 --- a/src/cljs/youyesyet/canvasser_app/core.cljs +++ b/src/cljs/youyesyet/canvasser_app/core.cljs @@ -53,33 +53,48 @@ (enable-console-print!) (defn about-page [] + "Return the content for the 'about' page." (about/panel)) (defn building-page [] + "Return the content for the single building page, for the current address." (building/panel)) (defn dwelling-page [] + "Return the content for the single dwelling page, for the current + dwelling." (dwelling/panel)) (defn elector-page [] + "Return the content for the elector page, for the current dwelling." (elector/panel)) (defn gdpr-page [] + "Return the content for the general data protection regulation consent + page." (gdpr/panel)) (defn followup-page [] + "Return the content for the followup-request page, for the current elector + and selected issue." (followup/panel)) (defn issues-page [] + "Return the content for the current issues page - list of currently + prompted for issues." (issues/panel)) (defn issue-page [] + "Return the content for the current issue page: canned text prompt for the + canvasser to say to the elector on this issue." (issue/panel)) (defn map-page [] + "Return the content for the main map page. Map showing current location." (maps/panel)) (def pages + "Dispatcher table for pages." {:about #'about-page :building #'building-page :dwelling #'dwelling-page @@ -173,7 +188,9 @@ ;; ------------------------- ;; History ;; must be called after routes have been defined -(defn hook-browser-navigation! [] +(defn hook-browser-navigation! + "Interceptor for the browser back button." + [] (doto (History.) (events/listen HistoryEventType/NAVIGATE @@ -187,7 +204,9 @@ (defn mount-components [] (r/render [#'page] (.getElementById js/document "app"))) -(defn init! [] +(defn init! + "Initialise the app." + [] (rf/dispatch-sync [:initialize-db]) (rf/dispatch [:get-current-location]) (rf/dispatch [:fetch-locality]) diff --git a/src/cljs/youyesyet/canvasser_app/gis.cljs b/src/cljs/youyesyet/canvasser_app/gis.cljs index 1cd9c28..21497be 100644 --- a/src/cljs/youyesyet/canvasser_app/gis.cljs +++ b/src/cljs/youyesyet/canvasser_app/gis.cljs @@ -38,7 +38,7 @@ ;; references, so do it here. (defn get-current-location [] - "Get the current location from the device, setting it in the database and + "Return the current location from the device, setting it in the database and returning the locality." (try (if (.-geolocation js/navigator) @@ -61,7 +61,7 @@ (defn pin-image - "select the name of a suitable pin image for this address" + "Return the name of a suitable pin image for this `address`." [address] (let [intentions (set @@ -93,7 +93,7 @@ (defn add-map-pin - "Add a map-pin at this address in this map view" + "Add an appropriate map-pin at this `address` in this map `view`." [address view] (let [lat (:latitude address) lng (:longitude address) @@ -110,12 +110,16 @@ (.latLng js/L lat lng) (clj->js {:icon pin :title (:address address)}))] - (.on (.addTo marker view) "click" (fn [_] (map-pin-click-handler (str (:id address))))) + (.on + (.addTo marker view) + "click" + (fn [_] (map-pin-click-handler (str (:id address))))) marker)) (defn map-remove-pins - "Remove all pins from this map `view`. Side-effecty; liable to be problematic." + "Remove all pins from this map `view`. Side-effecty; liable to be + problematic." [view] (if view (.eachLayer view @@ -126,7 +130,8 @@ (defn refresh-map-pins - "Refresh the map pins on this map. Side-effecty; liable to be problematic." + "Refresh the map pins on the current map. Side-effecty; liable to be + problematic." [] (let [view (map-remove-pins @(subscribe [:view])) addresses @(subscribe [:addresses])] diff --git a/src/cljs/youyesyet/canvasser_app/handlers.cljs b/src/cljs/youyesyet/canvasser_app/handlers.cljs index 80bd7e6..a8c0158 100644 --- a/src/cljs/youyesyet/canvasser_app/handlers.cljs +++ b/src/cljs/youyesyet/canvasser_app/handlers.cljs @@ -44,11 +44,13 @@ (merge state {:error '() :feedback '()})) -(def source-host (assoc - (url js/window.location) - :path "/" - :query nil - :anchor nil)) +(def source-host + "The base URL of the host from which the app was loaded." + (assoc + (url js/window.location) + :path "/" + :query nil + :anchor nil)) (defn handle-forbidden @@ -86,6 +88,7 @@ (defn add-to-outqueue + "Add the supplied `message` to the output queue in this `db`." [db message] (dispatch [:process-queue]) (add-to-key db :outqueue message)) @@ -98,6 +101,7 @@ (defn remove-from-key + "Remove `x` from the values of key `k` in map `db`." [db k x] (assoc db k (remove #(= x %) (db k)))) @@ -109,6 +113,7 @@ (defn remove-from-outqueue + "Remove `x` from the output queue in this `db`." [db x] (remove-from-key db :outqueue x)) diff --git a/src/cljs/youyesyet/canvasser_app/state.cljs b/src/cljs/youyesyet/canvasser_app/state.cljs index dcb7fae..cd22014 100644 --- a/src/cljs/youyesyet/canvasser_app/state.cljs +++ b/src/cljs/youyesyet/canvasser_app/state.cljs @@ -26,11 +26,10 @@ ;;;; ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;;; This is the constructor for the atom in which the state of the user interface is held. -;;; The atom gets updated by 'events' registered in handler.cljs, q.v. - - (def default-db + "The default configuration state of the app, when first loaded. + This is the constructor for the atom in which the state of the user interface + is held. The atom gets updated by 'events' registered in handler.cljs, q.v." { ;;; any confirmation message to display :feedback '("Welcome to the canvasser app!") ;;; message of the day diff --git a/src/cljs/youyesyet/canvasser_app/ui_utils.cljs b/src/cljs/youyesyet/canvasser_app/ui_utils.cljs index 6609e35..0f20f73 100644 --- a/src/cljs/youyesyet/canvasser_app/ui_utils.cljs +++ b/src/cljs/youyesyet/canvasser_app/ui_utils.cljs @@ -28,9 +28,10 @@ ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(defn log-and-dispatch [arg] - (js/console.log (str "Dispatching " arg)) - (rf/dispatch arg)) +(defn log-and-dispatch [event] + "Log this `event` and dispatch it." + (js/console.log (str "Dispatching " event)) + (rf/dispatch event)) (defn back-link @@ -44,6 +45,8 @@ (defn big-link + "Generate a big link with this `text` which, when selected, either opens + the url which is this `target` if supplied, or else invokes this `handler`." [text & {:keys [target handler]}] [:div.big-link-container {:key (gensym "big-link")} [:a.big-link (merge {} @@ -53,6 +56,10 @@ (defn nav-link [uri title page collapsed?] + "Generate and return a navigaton link for this `uri` with the text which is + this `title`; the `uri` is expected to be the uri of this `page`, and if + this `page` is the currently selected page, the lin should be highlighted to + indicate this." (let [selected-page @(rf/subscribe [:page])] [:li.nav-item {:class (when (= page selected-page) "active") @@ -63,6 +70,7 @@ (defn error-panel + "Generate and return an error panel with this `message`." [message] [:div [:h1.error message] @@ -70,7 +78,10 @@ (back-link)]]) -(defn navbar [] +(defn navbar + "Generate and return a navigation bar representing the current state of the + app." + [] (r/with-let [collapsed? (r/atom true)] [:div {:id "nav"} [:img {:id "nav-icon" diff --git a/src/cljs/youyesyet/canvasser_app/views/dwelling.cljs b/src/cljs/youyesyet/canvasser_app/views/dwelling.cljs index 88d5bee..56869a5 100644 --- a/src/cljs/youyesyet/canvasser_app/views/dwelling.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/dwelling.cljs @@ -47,7 +47,7 @@ :page :gdpr}])) -(defn gender-cell +(defn- gender-cell [elector] (let [gender (:gender elector) image (if gender (name gender) "Unknown")] @@ -56,21 +56,21 @@ [:img {:src (str "img/gender/" image ".png") :alt image}]]])) -(defn genders-row +(defn- genders-row [electors] [:tr (map #(gender-cell %) electors)]) -(defn name-cell +(defn- name-cell [elector] [:td {:key (str "name-" (:id elector)) :on-click #(go-to-gdpr-for-elector elector)} (:name elector)]) -(defn names-row +(defn- names-row [electors] [:tr (map diff --git a/src/cljs/youyesyet/canvasser_app/views/gdpr.cljs b/src/cljs/youyesyet/canvasser_app/views/gdpr.cljs index 4372039..773be54 100644 --- a/src/cljs/youyesyet/canvasser_app/views/gdpr.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/gdpr.cljs @@ -1,4 +1,5 @@ -(ns ^{:doc "Canvasser app electors in household panel." +(ns ^{:doc "The General Data Protection Regulations consent panel, + incorporating a signature widget." :author "Simon Brooke"} youyesyet.canvasser-app.views.gdpr (:require [re-frame.core :refer [reg-sub subscribe dispatch]] @@ -31,7 +32,7 @@ ;; OK, the idea here is a GDPR consent form to be signed by the elector (def sig-pad - ;; something the signature pad will be bound to + "An atom that the signature pad will be bound to, when instantiated." (atom nil)) @@ -52,6 +53,8 @@ nil) (defn gdpr-render + "Return a renderer for the GDPR consent form, incorporating the signature + widget." [] (let [elector @(subscribe [:elector])] [:div @@ -79,12 +82,13 @@ (defn gdpr-did-mount + "Instantiate the `sig-pad` atom, q.v." [] (reset! sig-pad (js/SignaturePad. (.getElementById js/document "signature-pad")))) (defn panel - "A reagent class for the GDPR consent form" + "Return the GDPR consent form." [] (js/console.log "gdpr.panel") (reagent/create-class {:reagent-render gdpr-render