_dmproadmap.rb

# frozen_string_literal: true

require 'csv'

# DMPRoadmap constants
#
# This file is a consolidation of the old custom configuration previously spread
# across the application.rb, branding.yml and the contact_us, devise, recaptcha,
# constants and wicked_pdf initializers
#
# It works in conjunction with the new Rails 5 config/credentials.yml.enc file
# for information on how to use the credentials file see:
#    https://medium.com/cedarcode/rails-5-2-credentials-9b3324851336
#
# This file's name begins with an underscore so that it is processed first and its
# values are available to all other initializers within this directory!
module DMPRoadmap
  # Base configuration for the DMPRoadmap system
  class Application < Rails::Application
    # --------------------- #
    # ORGANISATION SETTINGS #
    # --------------------- #

    # Your organisation name, used in various places throught the application
    config.x.organisation.name = 'Curation Center'
    # Your organisation's abbreviation
    config.x.organisation.abbreviation = 'CC'
    # Your organisation's homepage, used in some of the public facing pages
    config.x.organisation.url = 'https://github.com/DMPRoadmap/roadmap/wiki'
    # Your organisation's legal (official) name - used in the copyright portion of the footer
    config.x.organisation.copywrite_name = 'Curation Centre (CC)'
    # This email is used as the 'from' address for emails generated by the application
    config.x.organisation.email = 'tester@example.org'
    # This email is used as the 'from' address for the feedback_complete email to users
    config.x.organisation.do_not_reply_email 'do-not-reply@cc_curation_centre.org'
    # This email is used in email communications
    config.x.organisation.helpdesk_email = 'help@example.org'
    # Your organisation's telephone number - used on the contact us page
    config.x.organisation.telephone = '+1-123-123-1234'
    # Your organisation's address - used on the contact us page
    # rubocop:disable Naming/VariableNumber
    config.x.organisation.address = {
      line_1: 'Princess Elisabeth Station',
      line_2: '123 Freezing Cold Street',
      line_3: 'Suite 123',
      line_4: 'Polar Vortex, ABC-345',
      country: 'Antarctica'
    }
    # rubocop:enable Naming/VariableNumber

    # The Google maps link to your organisation's location - used to display the
    # Google map on the contact us page.
    # To find your organisation's Google maps URL, open maps.google.com, search for
    # your orgnaisation and then click the menu link to the left of the search box,
    # once the menu opens, click the 'share or embed' link and the 'embed' tab on
    # the dialog window that opens. DO NOT place the entire <iframe> tag below, just
    # the address!
    config.x.organisation.google_maps_link = 'https://www.google.com/maps/embed?pb=!1m18!1m12!1m3!1d29046286.09795864!2d-34.22768319424708!3d-63.61874004304689!2m3!1f0!2f0!3f0!3m2!1i1024!2i768!4f13.1!3m3!1m2!1s0x0%3A0xb57520cc078b16a9!2sPrincess%20Elisabeth%20Station!5e0!3m2!1sen!2sus!4v1587495708129!5m2!1sen!2sus'

    # Uncomment the following line if you want to redirect your users to an
    # organisational contact/help page instead of using the built-in contact_us form
    # config.x.organisation.contact_us_url = "https://example.org/contact

    # -------------------- #
    # APPLICATION SETTINGS #
    # -------------------- #

    # Used throughout the system via ApplicationService.application_name
    config.x.application.name = 'DMPRoadmap'
    # Used as the default domain when 'archiving' (aka anonymizing) a user account
    # for example `jane.doe@uni.edu` becomes `1234@removed_accounts-example.org`
    config.x.application.archived_accounts_email_suffix = '@removed_accounts-example.org'
    # Available CSV separators, the default is ','
    config.x.application.csv_separators = [',', '|', '#']
    # The largest page size allowed in requests to the API (all versions)
    config.x.application.api_max_page_size = 100
    # The link to the API documentation - used in emails about the API
    config.x.application.api_documentation_urls = {
      v0: 'https://github.com/DMPRoadmap/roadmap/wiki/API-V0-Documentation',
      v1: 'https://github.com/DMPRoadmap/roadmap/wiki/API-V1-Documentation'
    }
    # The links that appear on the home page. Add any number of links
    config.x.application.welcome_links = [
      {
        title: 'Digital Curation Centre',
        url: 'https://dcc.ac.uk/'
      }, {
        title: 'UC3: University of California Curation Center',
        url: 'https://www.cdlib.org/uc3/'
      }, {
        title: 'UK funder requirements for Data Management Plans',
        url: 'http://www.dcc.ac.uk/resources/data-management-plans/funders-requirements'
      }, {
        title: 'US funder requirements for Data Management Plans',
        url: 'https://dmptool.org/guidance'
      }, {
        title: 'DCC Checklist for a Data Management Plan',
        url: 'https://dmponline.dcc.ac.uk/files/DMP_Checklist_2013.pdf'
      }
    ]
    # The default user email preferences used when a new account is created
    config.x.application.preferences = {
      email: {
        users: {
          new_comment: false,
          admin_privileges: true,
          added_as_coowner: true,
          feedback_requested: true,
          feedback_provided: true
        },
        owners_and_coowners: {
          visibility_changed: true
        }
      }
    }
    # Setting to only take orgs from local and not allow on-the-fly creation
    config.x.application.restrict_orgs = false
    # Setting to display phone number in contributor form
    config.x.application.display_contributor_phone_number = false

    # Setting require contributor requirement of contributor name and email
    config.x.application.require_contributor_name = false
    config.x.application.require_contributor_email = false

    # Defines if Guidances/Comments in toggleable & if it's opened by default
    config.x.application.guidance_comments_toggleable = true
    config.x.application.guidance_comments_opened_by_default = true

    # ------------------- #
    # SHIBBOLETH SETTINGS #
    # ------------------- #

    # Enable shibboleth as an alternative authentication method
    # Requires server configuration and omniauth shibboleth provider configuration
    # See config/initializers/devise.rb
    config.x.shibboleth.enabled = false

    # Relative path to Shibboleth SSO Logouts
    config.x.shibboleth.login_url = '/Shibboleth.sso/Login'
    config.x.shibboleth.logout_url = '/Shibboleth.sso/Logout?return='

    # If this value is set to true your users will be presented with a list of orgs that have a
    # shibboleth identifier in the orgs_identifiers table. If it is set to false (default), the user
    # will be driven out to your federation's discovery service
    #
    # A super admin will also be able to associate orgs with their shibboleth entityIds if this is set to true
    config.x.shibboleth.use_filtered_discovery_service = false

    # ------- #
    # LOCALES #
    # ------- #

    # The default locale (use the i18n format!)
    config.x.locales.default = 'en-GB'
    # The character that separates a locale's ISO code for i18n. (e.g. `en-GB` or `en`)
    # Changing this value is not recommended!
    config.x.locales.i18n_join_character = '-'
    # The character that separates a locale's ISO code for Gettext. (e.g. `en_GB` or `en`)
    # Changing this value is not recommended!
    config.x.locales.gettext_join_character = '_'

    # ---------- #
    # THRESHOLDS #
    # ---------- #

    # Determines the number of links a funder is allowed to add to their template
    config.x.max_number_links_funder = 5
    # Determines the number of links a funder can add for sample plans for their template
    config.x.max_number_links_sample_plan = 5
    # Determines the maximum number of themes to display per column when an org admin
    # updates a template question or guidance
    config.x.max_number_themes_per_column = 5
    # default results per page
    config.x.results_per_page = 10

    # ------------- #
    # PLAN DEFAULTS #
    # ------------- #

    # The default visibility a plan receives when it is created.
    # options: 'privately_visible', 'organisationally_visible' and 'publicly_visibile'
    config.x.plans.default_visibility = 'privately_visible'

    # The percentage of answers that have been filled out that determine if a plan
    # will be marked as complete. Plan completion has implications on whether or
    # not plan visibility settings are editable by the user and whether or not the
    # plan can be submitted for feedback
    config.x.plans.default_percentage_answered = 50

    # Whether or not Super adminis can read all of the user's plans regardless of
    # the plans visibility and whether or not the plan has been shared
    config.x.plans.org_admins_read_all = true
    # Whether or not Organisational administrators can read all of the user's plans
    # regardless of the plans visibility and whether or not the plan has been shared
    config.x.plans.super_admins_read_all = true

    # Check download of a plan coversheet tickbox
    config.x.plans.download_coversheet_tickbox_checked = false

    # ---------------------------------------------------- #
    # CACHING - all values are in seconds (86400 == 1 Day) #
    # ---------------------------------------------------- #

    # Determines how long to cache results for OrgSelection::SearchService
    config.x.cache.org_selection_expiration = 86_400
    # Determines how long to cache results for the ResearchProjectsController
    config.x.cache.research_projects_expiration = 86_400

    # ---------------- #
    # Google Analytics #
    # ---------------- #
    # this is the abbreviation for the installation's root org as set in the org table
    config.x.google_analytics.tracker_root = ''

    # ------------------------------------------------------------------------ #
    # reCAPTCHA - recaptcha appears on the create account and contact us forms #
    # ------------------------------------------------------------------------ #
    config.x.recaptcha.enabled = false

    # --------------------------------------------------- #
    # Machine Actionable / Networked DMP Features (maDMP) #
    # --------------------------------------------------- #
    # Enable/disable functionality on the Project Details tab
    config.x.madmp.enable_ethical_issues = true
    config.x.madmp.enable_research_domain = true

    # This flag will enable/disable the entire Research Outputs tab. The others below will
    # just enable/disable specific functionality on the Research Outputs tab
    config.x.madmp.enable_research_outputs = true
    config.x.madmp.enable_license_selection = true
    config.x.madmp.enable_metadata_standard_selection = true
    config.x.madmp.enable_repository_selection = true

    # The following flags will allow the system to include the question and answer in the JSON output
    #   - questions with a theme equal to 'Preservation'
    config.x.madmp.extract_preservation_statements_from_themed_questions = false
    #   - questions with a theme equal to 'Data Collection'
    config.x.madmp.extract_data_quality_statements_from_themed_questions = false
    #   - questions with a theme equal to 'Ethics & privacy' or 'Storage & security'
    config.x.madmp.extract_security_privacy_statements_from_themed_questions = false

    # Specify a list of the preferred licenses types. These licenses will appear in a select
    # box on the 'Research Outputs' tab when editing a plan along with the option to select
    # 'other'. When 'other' is selected, the user is presented with the full list of licenses.
    #
    # The licenses will appear in the order you specify here.
    #
    # Note that the values you enter must match the :identifier field of the licenses table.
    # You can use the `%{latest}` markup in place of version numbers if desired.
    config.x.madmp.preferred_licenses = [
      'CC-BY-%{latest}',
      'CC-BY-SA-%{latest}',
      'CC-BY-NC-%{latest}',
      'CC-BY-NC-SA-%{latest}',
      'CC-BY-ND-%{latest}',
      'CC-BY-NC-ND-%{latest}',
      'CC0-%{latest}'
    ]
    # Link to external guidance about selecting one of the preferred licenses. A default
    # URL will be displayed if none is provided here. See app/views/research_outputs/licenses/_form
    config.x.madmp.preferred_licenses_guidance_url = 'https://creativecommons.org/about/cclicenses/'
  end
end