diff --git a/app/views/answers/_status.html.erb b/app/views/answers/_status.html.erb
index 3b317d8d04..91287cb020 100644
--- a/app/views/answers/_status.html.erb
+++ b/app/views/answers/_status.html.erb
@@ -8,5 +8,17 @@
<%= _('Answered')%>
<%= _(' by %{user_name}') %{ :user_name => answer.user.name } if answer.user.present? %>
-
+
+ <% n_question_to_remove = answer_remove_list(answer).size %>
+ <% if n_question_to_remove > 0 %>
+
+ <%= _('This answer removes ') + n_question_to_remove.to_s + _(' questions from your plan.') %>
+
+ <% end %>
+ <% email_list = email_trigger_list(answer) %>
+ <% unless email_list.blank? %>
+
+ <%= _('This answer triggers email(s) to ') + email_list %>
+
+ <% end %>
<% end %>
diff --git a/app/views/api/v0/departments/index.json.jbuilder b/app/views/api/v0/departments/index.json.jbuilder
new file mode 100644
index 0000000000..98ec7f6dbe
--- /dev/null
+++ b/app/views/api/v0/departments/index.json.jbuilder
@@ -0,0 +1,7 @@
+json.prettify!
+
+json.array! @departments.each do |department|
+ json.code department.code
+ json.name department.name
+ json.id department.id
+end
diff --git a/app/views/api/v0/departments/users.json.jbuilder b/app/views/api/v0/departments/users.json.jbuilder
new file mode 100644
index 0000000000..b4b84ff242
--- /dev/null
+++ b/app/views/api/v0/departments/users.json.jbuilder
@@ -0,0 +1,10 @@
+json.prettify!
+
+json.array! @users.group_by(&:department).each do |department, users|
+ json.code department&.code
+ json.name department&.name
+ json.id department&.id
+ json.users users.each do |u|
+ json.email u.email
+ end
+end
diff --git a/app/views/api/v0/plans/index.json.jbuilder b/app/views/api/v0/plans/index.json.jbuilder
index 2e1f07ed1d..2ca50ee9b6 100644
--- a/app/views/api/v0/plans/index.json.jbuilder
+++ b/app/views/api/v0/plans/index.json.jbuilder
@@ -14,17 +14,21 @@ json.array! @plans.each do |plan|
json.id plan.template.family_id
end
json.funder do
- json.name (plan.template.org.funder? ? plan.template.org.name : plan.funder_name)
+ json.name (plan.template.org.funder? ? plan.template.org.name : plan.funder&.name)
end
json.principal_investigator do
- json.name plan.principal_investigator
- json.email plan.principal_investigator_email
- json.phone plan.principal_investigator_phone
+ investigator = plan.contributors.investigation.first
+
+ json.name investigator.name
+ json.email investigator.email
+ json.phone investigator.phone
end
+
json.data_contact do
- json.name plan.data_contact
- json.email plan.data_contact_email
- json.phone plan.data_contact_phone
+ data_contact = plan.contributors.data_curation.first
+ json.name data_contact.name
+ json.email data_contact.email
+ json.phone data_contact.phones
end
json.users plan.roles.each do |role|
json.email role.user.email
diff --git a/app/views/api/v0/statistics/plans.json.jbuilder b/app/views/api/v0/statistics/plans.json.jbuilder
index d6812674d6..3b10be4b90 100644
--- a/app/views/api/v0/statistics/plans.json.jbuilder
+++ b/app/views/api/v0/statistics/plans.json.jbuilder
@@ -15,12 +15,12 @@ json.plans @org_plans.each do |plan|
json.name (plan.template.org.funder? ? plan.template.org.name : '')
end
- json.principal_investigator do
- json.name plan.principal_investigator
+ json.principal_investigator
+ json.name plan.contributors.investigation.first&.name
end
json.data_contact do
- json.info plan.data_contact
+ json.info plan.contributors.data_curation.first&.name
end
json.description plan.description
diff --git a/app/views/api/v1/_standard_response.json.jbuilder b/app/views/api/v1/_standard_response.json.jbuilder
new file mode 100644
index 0000000000..7541daca0e
--- /dev/null
+++ b/app/views/api/v1/_standard_response.json.jbuilder
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# locals: response, request, total_items
+
+total_items ||= 0
+paginator = Api::V1::PaginationPresenter.new(current_url: request.path,
+ per_page: @per_page,
+ total_items: total_items,
+ current_page: @page)
+
+json.prettify!
+json.ignore_nil!
+
+json.application @application
+json.source "#{request.method} #{request.path}"
+json.time Time.now.to_formatted_s(:iso8601)
+json.caller @caller
+json.code response.status
+json.message Rack::Utils::HTTP_STATUS_CODES[response.status]
+
+# Pagination Links
+if total_items.positive?
+ json.page @page
+ json.per_page @per_page
+ json.total_items total_items
+
+ # Prepare the base URL by removing the old pagination params
+ json.prev paginator.prev_page_link if paginator.prev_page?
+ json.next paginator.next_page_link if paginator.next_page?
+else
+ json.total_items 0
+end
diff --git a/app/views/api/v1/contributors/_show.json.jbuilder b/app/views/api/v1/contributors/_show.json.jbuilder
new file mode 100644
index 0000000000..757f5db7c9
--- /dev/null
+++ b/app/views/api/v1/contributors/_show.json.jbuilder
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# locals: contributor, is_contact
+
+is_contact ||= false
+
+json.name contributor.name
+json.mbox contributor.email
+
+unless is_contact
+ if contributor.selected_roles.any?
+ roles = contributor.selected_roles.map do |role|
+ Api::V1::ContributorPresenter.role_as_uri(role: role)
+ end
+ json.role roles if roles.any?
+ end
+end
+
+if contributor.org.present?
+ json.affiliation do
+ json.partial! "api/v1/orgs/show", org: contributor.org
+ end
+end
+
+orcid = contributor.identifier_for_scheme(scheme: "orcid")
+if orcid.present?
+ id = Api::V1::ContributorPresenter.contributor_id(
+ identifiers: contributor.identifiers
+ )
+ if is_contact
+ json.contact_id do
+ json.partial! "api/v1/identifiers/show", identifier: id
+ end
+ else
+ json.contributor_id do
+ json.partial! "api/v1/identifiers/show", identifier: id
+ end
+ end
+end
diff --git a/app/views/api/v1/datasets/_show.json.jbuilder b/app/views/api/v1/datasets/_show.json.jbuilder
new file mode 100644
index 0000000000..e70fe44546
--- /dev/null
+++ b/app/views/api/v1/datasets/_show.json.jbuilder
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# locals: plan
+
+presenter = Api::V1::PlanPresenter.new(plan: plan)
+
+json.title "Generic Dataset"
+json.personal_data "unknown"
+json.sensitive_data "unknown"
+
+json.dataset_id do
+ json.partial! "api/v1/identifiers/show", identifier: presenter.identifier
+end
+
+json.distribution [plan] do |distribution|
+ json.title "PDF - #{distribution.title}"
+ json.data_access "open"
+ json.download_url plan_export_url(distribution, format: :pdf)
+ json.format do
+ json.array! ["application/pdf"]
+ end
+end
diff --git a/app/views/api/v1/error.json.jbuilder b/app/views/api/v1/error.json.jbuilder
new file mode 100644
index 0000000000..6cf9443c02
--- /dev/null
+++ b/app/views/api/v1/error.json.jbuilder
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+json.partial! "api/v1/standard_response"
+
+json.items []
+json.errors @payload[:errors]
diff --git a/app/views/api/v1/heartbeat.json.jbuilder b/app/views/api/v1/heartbeat.json.jbuilder
new file mode 100644
index 0000000000..af0fcdbdbb
--- /dev/null
+++ b/app/views/api/v1/heartbeat.json.jbuilder
@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+json.partial! "api/v1/standard_response"
+
+json.items []
diff --git a/app/views/api/v1/identifiers/_show.json.jbuilder b/app/views/api/v1/identifiers/_show.json.jbuilder
new file mode 100644
index 0000000000..c219222aee
--- /dev/null
+++ b/app/views/api/v1/identifiers/_show.json.jbuilder
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# locals: identifier
+
+json.type identifier&.identifier_format
+json.identifier identifier&.value
diff --git a/app/views/api/v1/orgs/_show.json.jbuilder b/app/views/api/v1/orgs/_show.json.jbuilder
new file mode 100644
index 0000000000..69b7ebaa0a
--- /dev/null
+++ b/app/views/api/v1/orgs/_show.json.jbuilder
@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# locals: org
+
+json.name org.name
+json.abbreviation org.abbreviation
+json.region org.region&.abbreviation
+
+if org.identifiers.any?
+ json.affiliation_id do
+ id = Api::V1::OrgPresenter.affiliation_id(identifiers: org.identifiers)
+ json.partial! "api/v1/identifiers/show", identifier: id
+ end
+end
diff --git a/app/views/api/v1/plans/_cost.json.jbuilder b/app/views/api/v1/plans/_cost.json.jbuilder
new file mode 100644
index 0000000000..ad36e3540e
--- /dev/null
+++ b/app/views/api/v1/plans/_cost.json.jbuilder
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# locals: cost
+
+json.title cost[:title]
+json.description cost[:description]
+json.currency_code cost[:currency_code]
+json.value cost[:value]
diff --git a/app/views/api/v1/plans/_funding.json.jbuilder b/app/views/api/v1/plans/_funding.json.jbuilder
new file mode 100644
index 0000000000..bd3a6cc280
--- /dev/null
+++ b/app/views/api/v1/plans/_funding.json.jbuilder
@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# locals: plan
+
+json.name plan.funder&.name
+
+if plan.funder.present?
+ id = Api::V1::OrgPresenter.affiliation_id(identifiers: plan.funder.identifiers)
+
+ if id.present?
+ json.funder_id do
+ json.partial! "api/v1/identifiers/show", identifier: id
+ end
+ end
+end
+
+if plan.grant_id.present? && plan.grant.present?
+ json.grant_id do
+ json.partial! "api/v1/identifiers/show", identifier: plan.grant
+ end
+end
+json.funding_status plan.grant.present? ? "granted" : "planned"
diff --git a/app/views/api/v1/plans/_project.json.jbuilder b/app/views/api/v1/plans/_project.json.jbuilder
new file mode 100644
index 0000000000..bb4ba3ef0f
--- /dev/null
+++ b/app/views/api/v1/plans/_project.json.jbuilder
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# locals: plan
+
+json.title plan.title
+json.description plan.description
+
+start_date = plan.start_date || Time.now
+json.start start_date.to_formatted_s(:iso8601)
+
+end_date = plan.end_date || Time.now + 2.years
+json.end end_date&.to_formatted_s(:iso8601)
+
+if plan.funder.present? || plan.grant_id.present?
+ json.funding [plan] do
+ json.partial! "api/v1/plans/funding", plan: plan
+ end
+end
diff --git a/app/views/api/v1/plans/_show.json.jbuilder b/app/views/api/v1/plans/_show.json.jbuilder
new file mode 100644
index 0000000000..169ccd9268
--- /dev/null
+++ b/app/views/api/v1/plans/_show.json.jbuilder
@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# locals: plan
+
+json.schema "https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard/tree/master/examples/JSON/JSON-schema/1.0"
+
+presenter = Api::V1::PlanPresenter.new(plan: plan)
+# A JSON representation of a Data Management Plan in the
+# RDA Common Standard format
+json.title plan.title
+json.description plan.description
+json.language Api::V1::LanguagePresenter.three_char_code(
+ lang: ApplicationService.default_language
+)
+json.created plan.created_at.to_formatted_s(:iso8601)
+json.modified plan.updated_at.to_formatted_s(:iso8601)
+
+# TODO: Update this to pull from the appropriate question once the work is complete
+json.ethical_issues_exist "unknown"
+# json.ethical_issues_description ""
+# json.ethical_issues_report ""
+
+id = presenter.identifier
+if id.present?
+ json.dmp_id do
+ json.partial! "api/v1/identifiers/show", identifier: id
+ end
+end
+
+if presenter.data_contact.present?
+ json.contact do
+ json.partial! "api/v1/contributors/show", contributor: presenter.data_contact,
+ is_contact: true
+ end
+end
+
+unless @minimal
+ if presenter.contributors.any?
+ json.contributor presenter.contributors do |contributor|
+ json.partial! "api/v1/contributors/show", contributor: contributor,
+ is_contact: false
+ end
+ end
+
+ if presenter.costs.any?
+ json.cost presenter.costs do |cost|
+ json.partial! "api/v1/plans/cost", cost: cost
+ end
+ end
+
+ json.project [plan] do |pln|
+ json.partial! "api/v1/plans/project", plan: pln
+ end
+
+ json.dataset [plan] do |dataset|
+ json.partial! "api/v1/datasets/show", plan: plan, dataset: dataset
+ end
+
+ json.extension [plan.template] do |template|
+ json.set! ApplicationService.application_name.split("-").first.to_sym do
+ json.template do
+ json.id template.id
+ json.title template.title
+ end
+ end
+ end
+end
diff --git a/app/views/api/v1/plans/index.json.jbuilder b/app/views/api/v1/plans/index.json.jbuilder
new file mode 100644
index 0000000000..48d9ef740f
--- /dev/null
+++ b/app/views/api/v1/plans/index.json.jbuilder
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+json.partial! "api/v1/standard_response", total_items: @total_items
+
+json.items @items do |item|
+ json.dmp do
+ json.partial! "api/v1/plans/show", plan: item
+ end
+end
diff --git a/app/views/api/v1/templates/index.json.jbuilder b/app/views/api/v1/templates/index.json.jbuilder
new file mode 100644
index 0000000000..ba5991f3d8
--- /dev/null
+++ b/app/views/api/v1/templates/index.json.jbuilder
@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+json.partial! "api/v1/standard_response", total_items: @total_items
+
+json.items @items do |template|
+ presenter = Api::V1::TemplatePresenter.new(template: template)
+
+ json.dmp_template do
+ json.title presenter.title
+ json.description template.description
+ json.version template.version
+ json.created template.created_at.to_formatted_s(:iso8601)
+ json.modified template.updated_at.to_formatted_s(:iso8601)
+
+ json.affiliation do
+ json.partial! "api/v1/orgs/show", org: template.org
+ end
+
+ json.template_id do
+ identifier = Api::V1::ConversionService.to_identifier(context: @application,
+ value: template.id)
+ json.partial! "api/v1/identifiers/show", identifier: identifier
+ end
+ end
+end
diff --git a/app/views/api/v1/token.json.jbuilder b/app/views/api/v1/token.json.jbuilder
new file mode 100644
index 0000000000..07be549839
--- /dev/null
+++ b/app/views/api/v1/token.json.jbuilder
@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+json.prettify!
+json.ignore_nil!
+
+json.access_token @token
+json.token_type @token_type
+json.expires_in @expiration
+json.created_at Time.now.to_formatted_s(:iso8601)
diff --git a/app/views/branded/devise/registrations/_personal_details.html.erb b/app/views/branded/devise/registrations/_personal_details.html.erb
deleted file mode 100644
index 021f50cbd2..0000000000
--- a/app/views/branded/devise/registrations/_personal_details.html.erb
+++ /dev/null
@@ -1,114 +0,0 @@
-<%#
- DMPTool customization overview:
- ------------------------------------------
- 1. Added default_org var
- 2. Added if 'shibbolized' check for Org selector/text
- 3. Removed shib account linking link
- %>
-<% default_org = Org.find_by(is_other: true) %>
-<%= form_for(resource, namespace: current_user.id, as: resource_name, url: registration_path(resource_name), html: {method: :put, id: 'personal_details_registration_form' }) do |f| %>
-
- <%= sanitize _("Please note that your email address is also your username. If you change this remember to use your new email address on sign in. If your account is created with your institutional credentials you must contact us to change your email or organisation.") %>
-
- <%= f.label(:accept_terms,
- raw("#{ f.check_box(:accept_terms, "aria-required": true, "data-validation-error": _('You must agree to the term and conditions.')) } #{_('I accept the')} #{_('terms and conditions')}")) %>
+
+
+
+
+
+ <%= _("Create account") %>
+
+
+ <%= _("This will create an account and link it to your credentials.") %>
+
+
+
+ <%# --------------------------------------------------- %>
+ <%# Start DMPTool Customization %>
+ <%# This is the only change to this Devise page! %>
+ <%# Add the org info so that JS hides the Org selector %>
+ <%# --------------------------------------------------- %>
+ <%= hidden_field_tag "default_org_id", @user&.org&.id %>
+ <%= hidden_field_tag "default_org_name", @user&.org&.name %>
+ <%# --------------------------------------------------- %>
+ <%# End DMPTool Customization %>
+ <%# --------------------------------------------------- %>
+ <%= render partial: 'shared/create_account_form', locals: { resource: resource } %>
+
+
<% end %>
-<% end %>
\ No newline at end of file
+<% end %>
diff --git a/app/views/branded/layouts/_branding.html.erb b/app/views/branded/layouts/_branding.html.erb
index f6e42e65ef..32352d8c92 100644
--- a/app/views/branded/layouts/_branding.html.erb
+++ b/app/views/branded/layouts/_branding.html.erb
@@ -1,6 +1,6 @@
<% if user_signed_in? && !current_user.org.is_other? %>
-<% end %>
\ No newline at end of file
+<% end %>
diff --git a/app/views/branded/layouts/_constants.html.erb b/app/views/branded/layouts/_constants.html.erb
index 862c3a6765..f0176b289c 100644
--- a/app/views/branded/layouts/_constants.html.erb
+++ b/app/views/branded/layouts/_constants.html.erb
@@ -28,8 +28,11 @@ constants_json = {
AJAX_LOADING: _('Loading ...'),
AJAX_UNABLE_TO_LOAD_TEMPLATE_SECTION: _('Unable to load the section\'s content at this time.'),
- AJAX_UNABLE_TO_LOAD_TEMPLATE_SECTION_QUESTION: _('Unable to load the question\'s content at this time.')
+ AJAX_UNABLE_TO_LOAD_TEMPLATE_SECTION_QUESTION: _('Unable to load the question\'s content at this time.'),
+
+ AUTOCOMPLETE_ARIA_HELPER: _("%{n} results are available, use up and down arrows to navigate suggestions. Use the Enter key to select a suggestion or the Escape key to close the suggestions."),
+ AUTOCOMPLETE_ARIA_HELPER_EMPTY: _("No results are available for your entry.")
}.to_json
%>
-
\ No newline at end of file
+
diff --git a/app/views/branded/layouts/_fixed_menu.html.erb b/app/views/branded/layouts/_fixed_menu.html.erb
index 295746cd9e..e508af9f01 100644
--- a/app/views/branded/layouts/_fixed_menu.html.erb
+++ b/app/views/branded/layouts/_fixed_menu.html.erb
@@ -18,7 +18,7 @@
-
<%= render partial: 'shared/sign_in_options' %>
+
<%= render partial: 'shared/get_started' %>
<% end %>
<% end %>
diff --git a/app/views/branded/layouts/_footer.html.erb b/app/views/branded/layouts/_footer.html.erb
index fae87839da..ec4af9b9da 100644
--- a/app/views/branded/layouts/_footer.html.erb
+++ b/app/views/branded/layouts/_footer.html.erb
@@ -49,6 +49,11 @@
<%= _('Copyright 2010-%{current_year} The Regents of the University of California') % {
current_year: Date.today.year
} %>
+ <% version = Rails.configuration.x.dmptool.version %>
+ <% if version.present? %>
+
+ <%= _("Version: %{number}") % { number: version } %>
+ <% end %>
<% end %>
- <% if @plans.length > 0 %>
- <%= link_to sanitize(_('Download plans (new window)%{open_in_new_window_text}') %
+ <% if @plans.length > 0 %>
+ <% unless @super_admin %>
+ <%= link_to sanitize(_('Download plans (new window)%{open_in_new_window_text}') %
{ open_in_new_window_text: _('Opens in new window') },
tags: %w{ span em }),
org_admin_download_plans_path(format: :csv),
target: '_blank',
class: 'btn btn-default pull-right has-new-window-popup-info' %>
- <%= paginable_renderise(
- partial: '/paginable/plans/org_admin',
- controller: 'paginable/plans',
- action: 'org_admin',
- scope: @plans,
- query_params: { sort_field: 'plans.updated_at', sort_direction: :desc }) %>
+ <% end %>
+
diff --git a/app/views/org_admin/questions/_form.html.erb b/app/views/org_admin/questions/_form.html.erb
index 6560c745ce..18c4f873e7 100644
--- a/app/views/org_admin/questions/_form.html.erb
+++ b/app/views/org_admin/questions/_form.html.erb
@@ -1,8 +1,8 @@
<% question_default_value_tooltip = _('Anything you enter here will display in the answer box. If you want an answer in a certain format (e.g. tables), you can enter that style here.') %>
-
<% end %>
<% if q_format.textfield? || q_format.textarea? %>
@@ -48,6 +48,13 @@
<%= _('No additional comment area will be displayed.')%>
<% end %>
+
+
+ <% if conditions.count > 0 %>
+
<%= _('Question conditions') %>
+ <%= raw condition_to_text(conditions) %>
+ <% end %>
+
<% if !question.section.phase.template.org.funder? %>
<% example_answer = question.example_answers(template.base_org.id).first %>
@@ -62,7 +69,7 @@
<%= sanitize example_answer.text %>
<% end %>
-
+
<% end %>
<% end %>
@@ -83,7 +90,7 @@
<% end %>
+
+
+<%# If the user is a super admin then they can edit these identifiers %>
+<% if editable %>
+ <% if !org.new_record? %>
+ <%
+ schemes = presenter.schemes.select do |s|
+ %w[ror fundref].include?(s.name)
+ end
+ schemes.each do |scheme| %>
+
+ <% end %>
+
+ <%
+ # Shibboleth Org identifiers are only for use by installations that have
+ # a curated list of Orgs that can use institutional login
+ shib = presenter.scheme_by_name(name: "shibboleth").first
+ if shib.present?
+ shib_id = presenter.id_for_scheme(scheme: shib)
+ %>
+
+
<%= _("If any of the above identifiers are incorrect or missing, please contact us to have them updated.").html_safe % { contact_us_url: contact_us_path } %>
-<% end %>
\ No newline at end of file
+<% end %>
diff --git a/app/views/orgs/_org_link.html.erb b/app/views/orgs/_org_link.html.erb
deleted file mode 100644
index 44b70eb6a8..0000000000
--- a/app/views/orgs/_org_link.html.erb
+++ /dev/null
@@ -1,15 +0,0 @@
-
\ No newline at end of file
diff --git a/app/views/orgs/_profile_form.html.erb b/app/views/orgs/_profile_form.html.erb
index 439911bb51..1cf9eddb3a 100644
--- a/app/views/orgs/_profile_form.html.erb
+++ b/app/views/orgs/_profile_form.html.erb
@@ -1,21 +1,50 @@
+<%# locals: org, url, method %>
+
<%
shared_links_tooltip = _('Links will be displayed next to your organisation\'s logo')
org_config_info_tooltip = _('This information can only be changed by a system administrator. Contact the Help Desk if you have questions or to request changes.')
%>
-<%= form_for(org, url: url, html: { multipart: true, method: method, id: "edit_org_profile_form" } ) do |f| %>
-
+ <% end %>
+
+ <% if current_user.can_super_admin? %>
+
+
+ <%= f.label :managed do %>
+ <%= f.check_box :managed, id: "org_managed", "aria-required": true,
+ title: _("A managed Org is one that can have its own Guidance and/or Templates. An unmanaged Org is one that was automatically created by the system when a user entered/selected it.") %>
+ <%= _('Managed? (allows Org Admins to access the Admin menu)') %>
+ <% end %>
+
+
+ <% end %>
+
+ <% unless org.tracker.present?
+ org.build_tracker
+ end %>
-<% end %>
\ No newline at end of file
+<% end %>
diff --git a/app/views/orgs/admin_edit.html.erb b/app/views/orgs/admin_edit.html.erb
index 56d2f48cda..2d37230ce4 100644
--- a/app/views/orgs/admin_edit.html.erb
+++ b/app/views/orgs/admin_edit.html.erb
@@ -1,7 +1,10 @@
-<% title org.id.present? ? _('Organisation details') : _('New organisation') %>
+<% title _('Organisation details') %>
+
<%= link_to _('Remove'), super_admin_api_client_path(client), method: :delete, data: { confirm: _("You are about to delete '%{client_name}'. They will no longer be able to access the API. Are you sure?") % { :client_name => client.name }} %>
\ No newline at end of file
+
diff --git a/app/views/paginable/plans/_org_admin.html.erb b/app/views/paginable/plans/_org_admin.html.erb
index 1ea1cd663b..c92cb3fd20 100644
--- a/app/views/paginable/plans/_org_admin.html.erb
+++ b/app/views/paginable/plans/_org_admin.html.erb
@@ -1,11 +1,25 @@
+
+<% if @clicked_through %>
+
<%= _(<<-TEXT
+ The data on the usage dashboard is historical in nature. This means that the number of records below may not
+ match the count shown on the usage dashboard. For example if one of your users created a plan in October and
+ then removed that plan in November, it would have been included on the usage dashboard's total for October but
+ would not appear in the list below.
+ TEXT
+ ) %>
+<% end %>
+
+
<%= _("Note: You can filter this table by 'Created' dates. Enter the month abbreviation and a 4 digit year into the search box above. For example: 'Oct 2019' or 'Jun 2013'.").html_safe %>
<%= _(<<-TEXT
+ The data on the usage dashboard is historical in nature. This means that the number of records below may not
+ match the count shown on the usage dashboard. For example if one of your users joined in October and then
+ moved to a different organization or deactivated their account, they would have been included on the usage
+ dashboard's total for October but would not appear in the list below.
+ TEXT
+ ) %>
+<% end %>
+
+
<%= _("Note: You can filter this table by 'Created date'. Enter the month abbreviation and a 4 digit year into the search box above. For example: 'Oct 2019' or 'Jun 2013'.").html_safe %>
@@ -15,7 +26,7 @@
<%= _('Plans') %>
<%= _('Current Privileges') %>
<%= _('Active') %>
-
<%= _('Privileges') %>
+
<%= _('Identifiers') %>
@@ -62,6 +73,11 @@
<%# The content of this column get updated through AJAX whenever the permission for an user are updated %>
<%= render partial: 'users/current_privileges', locals: { user: user } %>
+
+ <%# Do not allow a user to change their own permissions or a super admin's permissions if they are not a super admin %>
+ <% unless current_user == user || !is_super_admin && user.can_super_admin? %>
+ <%= link_to( _('Edit'), admin_grant_permissions_user_path(user)) %>
+ <% end %>
<% if is_super_admin %>
@@ -74,9 +90,9 @@
<% end %>
- <%# Do not allow a user to change their own permissions or a super admin's permissions if they are not a super admin %>
- <% unless current_user == user || !is_super_admin && user.can_super_admin? %>
- <%= link_to( _('Edit'), admin_grant_permissions_user_path(user)) %>
+ <% presenter = IdentifierPresenter.new(identifiable: user) %>
+ <% presenter.identifiers.each do |identifier| %>
+
+ <% if i != section.questions.length - 1 %>
+
+ <% end %>
<% if i != section.questions.length - 1 %>
diff --git a/app/views/plans/_edit_details.html.erb b/app/views/plans/_edit_details.html.erb
index 375e84c0ee..61a6016260 100644
--- a/app/views/plans/_edit_details.html.erb
+++ b/app/views/plans/_edit_details.html.erb
@@ -1,223 +1,23 @@
-<% project_title_tooltip = _('If applying for funding, state the name exactly as in the grant proposal.') %>
-<% project_abstract_tooltip = _("Briefly summarise your research project to help others understand the purposes for which the data are being collected or created.") %>
-<% id_tooltip = _('A pertinent ID as determined by the funder and/or organisation.') %>
+<%# locals: plan %>
-
<%= _('To help you write your plan, %{application_name} can show you guidance from a variety of organisations.') %
- {application_name: Rails.configuration.branding[:application][:name]} %>
-
-
-
- <% if @all_guidance_groups.length > @important_ggs.length %>
-
<%= _('Find guidance from additional organisations below') %>
-
- <% if @all_guidance_groups.length > @important_ggs.length %>
-
-
-
-
-
-
-
<%= _('Select Guidance') %>
-
- <%= _('To help you write your plan, %{application_name} can show you guidance from a variety of organisations. Please choose up to 6 organisations of the following organisations who offer guidance relevant to your plan.') %
- {application_name: Rails.configuration.branding[:application][:name]} %>
-
-
<%= _("Don't forget to save your changes after making your selections.") %>
<%= _("There is no additional guidance for this template.") %>
+<% end %>
+
+<% if all_guidance_groups.length > important_ggs.length %>
+
+
+
+
+
+
+
<%= _('Select Guidance') %>
+
+ <%= _('To help you write your plan, %{application_name} can show you guidance from a variety of organisations. Please choose up to 6 organisations of the following organisations who offer guidance relevant to your plan.') % { application_name: app_name } %>
+
+
<%= _("Don't forget to save your changes after making your selections.") %>
+
+<% project_title_tooltip = _('If applying for funding, state the name exactly as in the grant proposal.') %>
+<% project_abstract_tooltip = _("Briefly summarise your research project to help others understand the purposes for which the data are being collected or created.") %>
+<% id_tooltip = _('A pertinent ID as determined by the funder and/or organisation.') %>
+
+
+ <%= form.label(:start_date, _("Project Start"), class: "control-label") %>
+ <%= form.date_field :start_date, class: "form-control",
+ data: { toggle: "tooltip" },
+ title: _("The estimated date on which you will begin this project.") %>
+
+
+ <%= form.label(:end_date, _("Project End"), class: "control-label") %>
+ <%= form.date_field :end_date, class: "form-control",
+ data: { toggle: "tooltip" },
+ title: _("The estimated date on which you will complete this project.") %>
+
+
+
+<%# if DOI minting is enabled %>
+<% landing_page = plan.landing_page %>
+<% if Rails.configuration.x.doi&.active && landing_page.present? %>
+
+ <%= grant_fields.text_field(:value, class: "form-control",
+ data: { toggle: "tooltip" },
+ title: _("Provide a URL to the award's landing page if possible, if not please provide the award/grant number.")) %>
+ <%= grant_fields.hidden_field :id %>
+
<% primary_research_org_message = _('No research organisation associated with this plan or my research organisation is not listed') %>
<%= label_tag(:plan_no_org) do %>
- <%= check_box_tag(:plan_no_org) %>
+ <%= check_box_tag(:plan_no_org, "0", false, class: "toggle-autocomplete") %>
<%= primary_research_org_message %>
<% end %>
@@ -74,26 +75,27 @@
* <%= required_primary_funding_tooltip %><%= _('Select the primary funding organisation') %>
<% primary_funding_message = _('No funder associated with this plan or my funder is not listed') %>
<%= label_tag(:plan_no_funder) do %>
- <%= check_box_tag(:plan_no_funder) %>
+ <%= check_box_tag(:plan_no_funder, "0", false, class: "toggle-autocomplete") %>
<%= primary_funding_message %>
<% end %>
diff --git a/app/views/plans/overview.html.erb b/app/views/plans/overview.html.erb
index a0636502cf..05d60ff3d2 100644
--- a/app/views/plans/overview.html.erb
+++ b/app/views/plans/overview.html.erb
@@ -1,13 +1,14 @@
<%# locals: { plan } %>
+
<% title "#{plan.title}" %>
<% phase[:sections].each do |section| %>
- <% if display_section?(@hash[:customization], section, @show_custom_sections) %>
+ <% if display_section?(@hash[:customization], section, @show_custom_sections) && num_section_questions(@plan, section, phase) > 0 %>
<% if @show_sections_questions %>
<%= section[:title] %>
<% end %>
<% section[:questions].each do |question| %>
+ <% if remove_list(@plan).include?(question[:id]) %>
+ <% next %>
+ <% end %>
<% if !@public_plan && @show_sections_questions%>
<%# Hack: for DOCX export - otherwise, bold highlighting of question inconsistent. %>
diff --git a/app/views/shared/export/_plan_coversheet.erb b/app/views/shared/export/_plan_coversheet.erb
index 2d4796de67..1962224469 100644
--- a/app/views/shared/export/_plan_coversheet.erb
+++ b/app/views/shared/export/_plan_coversheet.erb
@@ -1,6 +1,6 @@
<%= @plan.title %>
-
<%= _("A Data Management Plan created using ") + Rails.configuration.branding[:application][:name] %>
+
<%= _("A Data Management Plan created using %{application_name}") % { application_name: Rails.configuration.branding[:application].fetch(:name, "DMPRoadmap") } %>
<%# Using tags as the htmltoword gem does not recognise css styles defined %>
@@ -14,10 +14,12 @@
<% end %>
<% end %>
<% if @plan.grant_number.present? %>
diff --git a/app/views/shared/export/_plan_txt.erb b/app/views/shared/export/_plan_txt.erb
index 0462c8d69a..474d85355a 100644
--- a/app/views/shared/export/_plan_txt.erb
+++ b/app/views/shared/export/_plan_txt.erb
@@ -26,11 +26,14 @@
<% if phase[:title] == @selected_phase.title %>
<%= (@hash[:phases].many? ? "#{phase[:title]}" : "") %>
<% phase[:sections].each do |section| %>
- <% if display_section?(@hash[:customization], section, @show_custom_sections) %>
+ <% if display_section?(@hash[:customization], section, @show_custom_sections) && num_section_questions(@plan, section, phase) > 0 %>
<% if @show_sections_questions %>
<%= "#{section[:title]}\n" %>
<% end %>
<% section[:questions].each do |question| %>
+ <% if remove_list(@plan).include?(question[:id]) %>
+ <% next %>
+ <% end %>
<%# text in this case is an array to accomodate for option_based %>
<% if @show_sections_questions %>
<% if question[:text].respond_to?(:each) %>
diff --git a/app/views/shared/org_selectors/_combined.html.erb b/app/views/shared/org_selectors/_combined.html.erb
new file mode 100644
index 0000000000..8d4c4581f7
--- /dev/null
+++ b/app/views/shared/org_selectors/_combined.html.erb
@@ -0,0 +1,49 @@
+<%# locals: form, default_org, required, funder_only, label %>
+
+<%# Note the 'data' args in the org_name definition. These are used by the utils/autocomplete.js to determine how to process the AJAX call to the controller. In this case it will make a POST to OrgsController#search with the { org: { name: 'foo' } } params %>
+
+<%
+# Whether or not the org selection is required
+required = required || false
+# Whether or not to restrict the Orgs to funders
+funder_only = funder_only || false
+# The label to use
+label = label || _("Organisation")
+
+presenter = OrgSelectionPresenter.new(orgs: [default_org],
+ selection: default_org)
+placeholder = _("Begin typing to see a list of suggestions.")
+%>
+
+<%= form.label :org_name, label %>
+<%= form.text_field :org_name, class: "form-control autocomplete",
+ placeholder: placeholder,
+ value: presenter.name,
+ aria: {
+ label: placeholder,
+ autocomplete: "list",
+ required: required
+ },
+ data: {
+ url: orgs_search_path(
+ type: "combined",
+ funder_only: funder_only.to_s
+ ),
+ method: "POST",
+ namespace: "org",
+ attribute: "name"
+ } %>
+
+
+
+<%# crosswalk contains an array of hashes that contain the Org name, id,
+ identifiers like ROR and other info used by the OrgSelectionService %>
+<%= form.hidden_field :org_crosswalk, value: presenter.crosswalk %>
+<%# gets updated with the matching record from crosswalk when the user
+ selects or enters something %>
+<%= form.hidden_field :org_id, value: default_org,
+ class: "autocomplete-result" %>
+
+
+ <%= _("A new entry will be created for the organisation you have named above. Please double check that your organisation does not appear in the list in a slightly different form.").html_safe %>
+
diff --git a/app/views/shared/org_selectors/_external_only.html.erb b/app/views/shared/org_selectors/_external_only.html.erb
new file mode 100644
index 0000000000..612db36404
--- /dev/null
+++ b/app/views/shared/org_selectors/_external_only.html.erb
@@ -0,0 +1,44 @@
+<%# locals: form, default_org, required, include_locals, include_externals %>
+
+<%# Note the 'data' args in the org_name definition. These are used by the utils/autocomplete.js to determine how to process the AJAX call to the controller. In this case it will make a POST to OrgsController#search with the { org: { name: 'foo' } } params %>
+
+<%
+# Whether or not the org selection is required
+required = required || false
+# The label to use
+label = label || _("Organisation")
+
+presenter = OrgSelectionPresenter.new(orgs: [default_org],
+ selection: default_org)
+placeholder = _("Begin typing to see a list of suggestions.")
+%>
+
+<%= form.label :org_name, label %>
+<%= form.text_field :org_name, class: "form-control autocomplete",
+ placeholder: placeholder,
+ value: presenter.name,
+ aria: {
+ label: placeholder,
+ autocomplete: "list",
+ required: required
+ },
+ data: {
+ url: orgs_search_path(type: "external"),
+ method: "POST",
+ namespace: "org",
+ attribute: "name"
+ } %>
+
+
+
+<%# crosswalk contains an array of hashes that contain the Org name, id,
+ identifiers like ROR and other info used by the OrgSelectionService %>
+<%= form.hidden_field :org_crosswalk, value: presenter.crosswalk %>
+<%# gets updated with the matching record from crosswalk when the user
+ selects or enters something %>
+<%= form.hidden_field :org_id, value: default_org,
+ class: "autocomplete-result" %>
+
+
+ <%= _("A new entry will be created for the organisation you have named above. Please double check that your organisation does not appear in the list in a slightly different form.").html_safe %>
+
diff --git a/app/views/shared/org_selectors/_local_only.html.erb b/app/views/shared/org_selectors/_local_only.html.erb
new file mode 100644
index 0000000000..4c10cce1d5
--- /dev/null
+++ b/app/views/shared/org_selectors/_local_only.html.erb
@@ -0,0 +1,47 @@
+<%# locals: form, orgs, default_org, required %>
+
+<%
+# Whether or not the org selection is required
+required = required || false
+# The label to use
+label = label || _("Organisation")
+# Allows the hidden id field to be renamed for instances where there are
+# multiple org selectors on the same form
+id_field = id_field || :org_id
+
+presenter = OrgSelectionPresenter.new(orgs: orgs, selection: default_org)
+placeholder = _("Begin typing to see a list of suggestions.")
+%>
+
+<%= form.label :org_name, label %>
+<%= form.text_field :org_name, class: "form-control autocomplete",
+ placeholder: placeholder,
+ value: presenter.name,
+ aria: {
+ label: placeholder,
+ autocomplete: "list",
+ required: required
+ },
+ data: { source: "" } %>
+
+
+
+<%# sources contains an array of Org names %>
+<%= form.hidden_field :org_sources, value: presenter.select_list %>
+<%# crosswalk contains an array of hashes that contain the Org name, id,
+ identifiers like ROR and other info used by the OrgSelectionService %>
+<%= form.hidden_field :org_crosswalk, value: presenter.crosswalk %>
+<%# gets updated with the matching record from crosswalk when the user
+ selects or enters something %>
+<% if form.object[id_field]&.to_s =~ /[0-9]+/ || form.object[id_field].nil? %>
+ <% val = presenter.crosswalk_entry_from_org_id(value: form.object[id_field]) %>
+ <%= form.hidden_field id_field, value: val, class: "autocomplete-result",
+ autocomplete: "off" %>
+<% else %>
+ <%= form.hidden_field :org_id, class: "autocomplete-result",
+ autocomplete: "off" %>
+<% end %>
+
+
+ <%= _("The name you entered was not one of the listed suggestions!") %>
+
+<% end %>
diff --git a/app/views/super_admin/api_clients/edit.html.erb b/app/views/super_admin/api_clients/edit.html.erb
new file mode 100644
index 0000000000..7a5a5262b6
--- /dev/null
+++ b/app/views/super_admin/api_clients/edit.html.erb
@@ -0,0 +1,8 @@
+<% title _('Editing API client') %>
+
+ <%= _('Editing API Client') %>
+ <%= link_to(_('View all API clients'), super_admin_api_clients_path,
+ class: 'btn btn-default pull-right', role: 'button') %>
+
+
+<%= render 'form' %>
diff --git a/app/views/super_admin/api_clients/email_credentials.js.erb b/app/views/super_admin/api_clients/email_credentials.js.erb
new file mode 100644
index 0000000000..bdfbbb9c97
--- /dev/null
+++ b/app/views/super_admin/api_clients/email_credentials.js.erb
@@ -0,0 +1,6 @@
+var msg = '<%= _("The credentials have been sent to %{email}.") % { email: @api_client.contact_email } %>';
+
+<%# TODO: replace this with the notificationHelper.js once we move to Rails 5 %>
+var notification = document.getElementById("notification-area");
+notification.append(msg);
+notification.classList.remove('hide');
\ No newline at end of file
diff --git a/app/views/super_admin/api_clients/index.html.erb b/app/views/super_admin/api_clients/index.html.erb
new file mode 100644
index 0000000000..ed11626bf8
--- /dev/null
+++ b/app/views/super_admin/api_clients/index.html.erb
@@ -0,0 +1,24 @@
+<% title _('API Clients') %>
+
+
\ No newline at end of file
diff --git a/app/views/super_admin/api_clients/new.html.erb b/app/views/super_admin/api_clients/new.html.erb
new file mode 100644
index 0000000000..dbdeb61bca
--- /dev/null
+++ b/app/views/super_admin/api_clients/new.html.erb
@@ -0,0 +1,8 @@
+<% title _('New API client') %>
+
+ <%= _('New API Client') %>
+ <%= link_to(_('View all API clients'), super_admin_api_clients_path,
+ class: 'btn btn-default pull-right', role: 'button') %>
+
+
+<%= render 'form' %>
diff --git a/app/views/super_admin/api_clients/refresh_credentials.js.erb b/app/views/super_admin/api_clients/refresh_credentials.js.erb
new file mode 100644
index 0000000000..213ed90052
--- /dev/null
+++ b/app/views/super_admin/api_clients/refresh_credentials.js.erb
@@ -0,0 +1,9 @@
+var msg = '<%= _("Successsfully refreshed the client credentials.") %>';
+
+var form = document.getElementById("edit_api_client_<%= @api_client.id %>");
+form.innerHTML = '<%= escape_javascript(render partial: "/super_admin/api_clients/form") %>';
+
+<%# TODO: replace this with the notificationHelper.js once we move to Rails 5 %>
+var notification = document.getElementById("notification-area");
+notification.append(msg);
+notification.classList.remove('hide');
\ No newline at end of file
diff --git a/app/views/super_admin/notifications/_form.html.erb b/app/views/super_admin/notifications/_form.html.erb
index 74c539670d..2b0fc6eab3 100644
--- a/app/views/super_admin/notifications/_form.html.erb
+++ b/app/views/super_admin/notifications/_form.html.erb
@@ -28,6 +28,13 @@
* <%= _('Move the mouse pointer over the bars of a chart to see numbers.') %>
+
* <%= _('Move the mouse pointer over the bars of a chart to see numbers. Click on the bar to see the list of these users/plans to interrogate statistics in more detail') %>
<%= (_("Please refer to the API documentation at: %{api_documentation_url}") % { api_documentation_url: "#{api_docs}" }).html_safe %>
+
+
Note that no invitations or emails will be sent out to DMP contacts because this is a test system. All email communication from plans created via the API will be sent to this address.
+
+
+ <%= _("Do not share these credentials. They for use with the %{external_application} application. If you do share your credentials with another application we reserve the right to revoke your access to the API.") % { external_application: @api_client.name.capitalize } %>
+
+
<%= _("If you did not request access to the %{tool_name} API or did not request for your credentials to be renewed, please contact us at %{helpdesk_email}") % { tool_name: tool_name, helpdesk_email: helpdesk_email } %>
+ <%= raw user_name + _(" is creating a Data Management Plan and has answered ") + answer_text + _(" to ") + question_title + _(" in a plan called ") + plan_title + _(" based on the template ") + template_title %>
+
+
+ <%= raw message %>
+
+ <%= render partial: 'email_signature' %>
+<% end %>
\ No newline at end of file
diff --git a/config/application.rb b/config/application.rb
index 58cab41a23..9be06f1d3e 100644
--- a/config/application.rb
+++ b/config/application.rb
@@ -127,6 +127,9 @@ class Application < Rails::Application
config.branding = config_for(:branding).deep_symbolize_keys
end
+ # org abbreviation for the root google analytics tracker that gets planted on every page
+ # config.x.tracker_root = "DMPRoadmap"
+
# The default visibility setting for new plans
# organisationally_visible - Any member of the user's org can view, export and duplicate the plan
# publicly_visibile - (NOT advisable because plans will show up in Public DMPs page by default)
diff --git a/config/branding.yml.sample b/config/branding.yml.sample
index 2eae0c9ba7..5df29e8487 100644
--- a/config/branding.yml.sample
+++ b/config/branding.yml.sample
@@ -8,6 +8,7 @@ defaults: &defaults
url: 'https://github.com/DMPRoadmap/roadmap/wiki'
copywrite_name: 'Curation Centre (CC)'
email: 'tester@cc_curation_centre.org'
+ do_not_reply_email: 'do-not-reply@cc_curation_centre.org'
helpdesk_email: 'someone@somewhere.com'
welcome_links:
- link1:
@@ -42,6 +43,7 @@ defaults: &defaults
api_documentation_url: 'https://github.com/DMPRoadmap/roadmap/wiki/API-Documentation'
api_max_page_size: 100
archived_accounts_email_suffix: '@removed_accounts-example.org'
+ use_recaptcha: false
preferences:
email:
diff --git a/config/deploy.rb b/config/deploy.rb
index 7dfca7b3e9..5532637203 100644
--- a/config/deploy.rb
+++ b/config/deploy.rb
@@ -1,12 +1,12 @@
-# config valid only for current version of Capistrano
-lock "3.13.0"
-
# Default branch is :master
ask :branch, `git rev-parse --abbrev-ref HEAD`.chomp unless ENV['BRANCH']
set :branch, ENV['BRANCH'] if ENV['BRANCH']
set :default_env, { path: "/dmp/local/bin:$PATH" }
+# Gets the current Git tag and revision
+set :version_number, `git describe --tags`
+
# Include optional Gem groups
# TODO: For some reason this does not work
#set :bundle_with, %w{ aws mysql }.join(' ')
@@ -23,9 +23,11 @@
'config/secrets.yml',
'config/initializers/contact_us.rb',
'config/initializers/devise.rb',
+ 'config/initializers/dmptool_version.rb',
'config/initializers/dragonfly.rb',
'config/initializers/recaptcha.rb',
- 'config/initializers/wicked_pdf.rb'
+ 'config/initializers/wicked_pdf.rb',
+ 'config/initializers/external_apis/open_aire.rb'
# Default value for linked_dirs is []
append :linked_dirs, 'log',
@@ -43,9 +45,9 @@
after :deploy, 'cleanup:copy_tinymce_skins'
after :deploy, 'cleanup:copy_logo'
after :deploy, 'cleanup:copy_favicon'
+ after :deploy, 'git:version'
after :deploy, 'cleanup:remove_example_configs'
after :deploy, 'cleanup:restart_passenger'
- after :deploy, 'git:symlink_git'
end
namespace :config do
@@ -59,10 +61,11 @@
end
namespace :git do
- desc "Symlink the git executable into the bin/ dir"
- task :symlink_git do
+ desc 'Add the version file so that we can display the git version in the footer'
+ task :version do
on roles(:app), wait: 1 do
- execute "ln -s /bin/git #{release_path}/bin/"
+ execute "touch #{release_path}/.version"
+ execute "echo '#{fetch :version_number}' >> #{release_path}/.version"
end
end
end
diff --git a/config/environments/development.rb b/config/environments/development.rb
index 434970b6a0..b093c9d885 100644
--- a/config/environments/development.rb
+++ b/config/environments/development.rb
@@ -50,3 +50,6 @@
end
end
+
+Rails.application.routes.default_url_options[:host] = "dmproadmap.org"
+
diff --git a/config/environments/production.rb b/config/environments/production.rb
index 175d17bf36..efd303e930 100644
--- a/config/environments/production.rb
+++ b/config/environments/production.rb
@@ -82,3 +82,6 @@
config.active_record.dump_schema_after_migration = false
end
+
+Rails.application.routes.default_url_options[:host] = "dmproadmap.org"
+
diff --git a/config/environments/stage.rb b/config/environments/stage.rb
index 4e6f302219..e34819d2df 100644
--- a/config/environments/stage.rb
+++ b/config/environments/stage.rb
@@ -32,7 +32,7 @@
config.action_dispatch.best_standards_support = :builtin
# Raise exception on mass assignment protection for Active Record models
- config.active_record.mass_assignment_sanitizer = :strict
+ # config.active_record.mass_assignment_sanitizer = :strict
config.action_mailer.perform_deliveries = false
diff --git a/config/environments/test.rb b/config/environments/test.rb
index 59a9b326b5..9dde4a2f8d 100644
--- a/config/environments/test.rb
+++ b/config/environments/test.rb
@@ -45,3 +45,6 @@
# config.action_view.raise_on_missing_translations = true
end
+
+Rails.application.routes.default_url_options[:host] = "example.org"
+
diff --git a/config/initializers/external_apis/doi.rb b/config/initializers/external_apis/doi.rb
new file mode 100644
index 0000000000..1a0fb82677
--- /dev/null
+++ b/config/initializers/external_apis/doi.rb
@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# These configuration settings are meant to work with your DOI minting
+# authority. If you opt to mint DOIs for your DMPs then you can add
+# your configuration options here and then add extend the
+# `app/services/external_apis/doi.rb` to communicate with their API.
+#
+# To disable thiis feature, simply set 'active' to false
+Rails.configuration.x.doi.landing_page_url = "https://my.doi.org/"
+Rails.configuration.x.doi.api_base_url = "https://my.doi.org/api/"
+Rails.configuration.x.doi.auth_path = "auth_path"
+Rails.configuration.x.doi.heartbeat_path = "heartbeat"
+Rails.configuration.x.doi.mint_path = "doi"
+Rails.configuration.x.doi.active = false
diff --git a/config/initializers/external_apis/open_aire.rb b/config/initializers/external_apis/open_aire.rb
new file mode 100644
index 0000000000..5a861cc088
--- /dev/null
+++ b/config/initializers/external_apis/open_aire.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# These configuration settings are used to communicate with the
+# Open Aire Research Project Registry API. For more information about
+# the API and to verify that your configuration settings are correct,
+Rails.configuration.x.open_aire.api_base_url = "https://api.openaire.eu/"
+# The api_url should contain `%s. This is where the funder is appended!
+Rails.configuration.x.open_aire.search_path = "projects/dspace/%s/ALL/ALL"
+Rails.configuration.x.open_aire.default_funder = "H2020"
+Rails.configuration.x.open_aire.active = true
diff --git a/config/initializers/external_apis/ror.rb b/config/initializers/external_apis/ror.rb
new file mode 100644
index 0000000000..caa4d21bce
--- /dev/null
+++ b/config/initializers/external_apis/ror.rb
@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# These configuration settings are used to communicate with the
+# Research Organization Registry (ROR) API. For more information about
+# the API and to verify that your configuration settings are correct,
+# please refer to: https://github.com/ror-community/ror-api
+Rails.configuration.x.ror.landing_page_url = "https://ror.org/"
+Rails.configuration.x.ror.api_base_url = "https://api.ror.org/"
+Rails.configuration.x.ror.heartbeat_path = "heartbeat"
+Rails.configuration.x.ror.search_path = "organizations"
+Rails.configuration.x.ror.max_pages = 2
+Rails.configuration.x.ror.max_results_per_page = 20
+Rails.configuration.x.ror.max_redirects = 3
+Rails.configuration.x.ror.active = true
diff --git a/config/routes.rb b/config/routes.rb
index 52071c6d7b..d73256faca 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -10,7 +10,7 @@
get "/users/sign_out", :to => "devise/sessions#destroy"
end
- delete '/users/identifiers/:id', to: 'user_identifiers#destroy', as: 'destroy_user_identifier'
+ delete '/users/identifiers/:id', to: 'identifiers#destroy', as: 'destroy_user_identifier'
get '/orgs/shibboleth', to: 'orgs#shibboleth_ds', as: 'shibboleth_ds'
get '/orgs/shibboleth/:org_name', to: 'orgs#shibboleth_ds_passthru'
@@ -18,6 +18,28 @@
get '/users/ldap_username', to: 'users#ldap_username'
post '/users/ldap_account', to: 'users#ldap_account'
+ # ------------------------------------------
+ # Start DMPTool customizations
+ # ------------------------------------------
+ # GET is triggered by user clicking an org in the list
+ get '/orgs/shibboleth/:id', to: 'orgs#shibboleth_ds_passthru'
+ # POST is triggered by user selecting an org from autocomplete
+ post '/orgs/shibboleth/:id', to: 'orgs#shibboleth_ds_passthru'
+ # ------------------------------------------
+ # End DMPTool Customization
+ # ------------------------------------------
+
+ # ------------------------------------------
+ # Start DMPTool customizations
+ # ------------------------------------------
+ # Handle logouts when on the localhost dev environment
+ unless %w[stage production].include?(Rails.env)
+ get "/Shibboleth.sso/Logout", to: redirect("/")
+ end
+ # ------------------------------------------
+ # End DMPTool Customization
+ # ------------------------------------------
+
resources :users, path: 'users', only: [] do
resources :org_swaps, only: [:create],
controller: "super_admin/org_swaps"
@@ -76,8 +98,8 @@
# End DMPTool customizations
# ------------------------------------------
- #post 'contact_form' => 'contacts', as: 'localized_contact_creation'
- #get 'contact_form' => 'contacts#new', as: 'localized_contact_form'
+ # AJAX call used to search for Orgs based on user input into autocompletes
+ post "orgs" => "orgs#search", as: "orgs_search"
resources :orgs, :path => 'org/admin', only: [] do
member do
@@ -132,6 +154,8 @@
resource :export, only: [:show], controller: "plan_exports"
+ resources :contributors, except: %i[show]
+
member do
get 'answer'
get 'share'
@@ -146,7 +170,6 @@
resources :usage, only: [:index]
post 'usage_plans_by_template', controller: 'usage', action: 'plans_by_template'
- post 'usage_filter', controller: 'usage', action: 'filter'
get 'usage_all_plans_by_template', controller: 'usage', action: 'all_plans_by_template'
get 'usage_global_statistics', controller: 'usage', action: 'global_statistics'
get 'usage_org_statistics', controller: 'usage', action: 'org_statistics'
@@ -167,6 +190,15 @@
namespace :api, defaults: {format: :json} do
namespace :v0 do
+ resources :departments, only: [:create, :index] do
+ collection do
+ get :users
+ patch :unassign_users
+ end
+ member do
+ patch :assign_users
+ end
+ end
resources :guidances, only: [:index], controller: 'guidance_groups', path: 'guidances'
resources :plans, only: [:create, :index]
resources :templates, only: :index
@@ -181,6 +213,14 @@
end
end
end
+
+ namespace :v1 do
+ get :heartbeat, controller: "base_api"
+ post :authenticate, controller: "authentication"
+
+ resources :plans, only: [:create, :show, :index]
+ resources :templates, only: [:index]
+ end
end
namespace :paginable do
@@ -195,6 +235,11 @@
get 'publicly_visible/:page', action: :publicly_visible, on: :collection, as: :publicly_visible
get 'org_admin/:page', action: :org_admin, on: :collection, as: :org_admin
get 'org_admin_other_user/:page', action: :org_admin_other_user, on: :collection, as: :org_admin_other_user
+
+ # Paginable actions for contributors
+ resources :contributors, only: %i[index] do
+ get "index/:page", action: :index, on: :collection, as: :index
+ end
end
# Paginable actions for users
resources :users, only: [] do
@@ -228,6 +273,10 @@
resources :departments, only: [] do
get 'index/:page', action: :index, on: :collection, as: :index
end
+ # Paginable actions for api_clients
+ resources :api_clients, only: [] do
+ get 'index/:page', action: :index, on: :collection, as: :index
+ end
end
resources :template_options, only: [:index], constraints: { format: /json/ }
@@ -239,6 +288,15 @@
get 'user_plans'
end
end
+
+ resources :question_options, only: [:destroy], controller: "question_options"
+
+ resources :questions, only: [] do
+ get 'open_conditions'
+ resources :conditions, only: [:new, :show] do
+ end
+ end
+
resources :plans, only: [:index] do
member do
get 'feedback_complete'
@@ -300,7 +358,19 @@
get :search
end
end
- resources :notifications, except: [:show]
+
+ resources :notifications, except: [:show] do
+ member do
+ post 'enable', constraints: {format: [:json]}
+ end
+ end
+
+ resources :api_clients do
+ member do
+ get :email_credentials
+ get :refresh_credentials
+ end
+ end
end
get "research_projects/search", action: "search",
diff --git a/config/webpack/loaders/erb.js b/config/webpack/loaders/erb.js
index a4049f1323..1c33dfac95 100644
--- a/config/webpack/loaders/erb.js
+++ b/config/webpack/loaders/erb.js
@@ -5,7 +5,7 @@ module.exports = {
use: [{
loader: 'rails-erb-loader',
options: {
- runner: (/^win/.test(process.platform) ? 'ruby ' : '') + 'bin/rails runner'
+ runner: (/^win/.test(process.platform) ? '/dmp/local/bin/ruby ' : '') + 'bin/rails runner'
}
}]
}
diff --git a/db/migrate/20190724134426_create_conditions.rb b/db/migrate/20190724134426_create_conditions.rb
new file mode 100644
index 0000000000..4b5c075120
--- /dev/null
+++ b/db/migrate/20190724134426_create_conditions.rb
@@ -0,0 +1,14 @@
+class CreateConditions < ActiveRecord::Migration
+ def change
+ create_table :conditions do |t|
+ t.references :question, index: true, foreign_key: true
+ t.text :option_list
+ t.integer :action_type
+ t.integer :number
+ t.text :remove_data
+ t.text :webhook_data
+
+ t.timestamps null: false
+ end
+ end
+end
diff --git a/db/migrate/20200121190035_add_managed_to_orgs.rb b/db/migrate/20200121190035_add_managed_to_orgs.rb
new file mode 100644
index 0000000000..795001968b
--- /dev/null
+++ b/db/migrate/20200121190035_add_managed_to_orgs.rb
@@ -0,0 +1,5 @@
+class AddManagedToOrgs < ActiveRecord::Migration
+ def change
+ add_column :orgs, :managed, :boolean, default: false, null: false
+ end
+end
diff --git a/db/migrate/20200123162357_create_identifiers.rb b/db/migrate/20200123162357_create_identifiers.rb
new file mode 100644
index 0000000000..ace6e8d7d6
--- /dev/null
+++ b/db/migrate/20200123162357_create_identifiers.rb
@@ -0,0 +1,14 @@
+class CreateIdentifiers < ActiveRecord::Migration
+ def change
+ create_table :identifiers do |t|
+ t.string :value, null: false
+ t.text :attrs
+ t.references :identifier_scheme, null: false
+ t.references :identifiable, polymorphic: true
+ t.timestamps
+ end
+
+ add_index :identifiers, [:identifiable_type, :identifiable_id]
+ add_index :identifiers, [:identifier_scheme_id, :value]
+ end
+end
diff --git a/db/migrate/20200130160919_contextualize_identifier_schemes.rb b/db/migrate/20200130160919_contextualize_identifier_schemes.rb
new file mode 100644
index 0000000000..09db8da094
--- /dev/null
+++ b/db/migrate/20200130160919_contextualize_identifier_schemes.rb
@@ -0,0 +1,8 @@
+class ContextualizeIdentifierSchemes < ActiveRecord::Migration
+ def change
+ add_column :identifier_schemes, :for_auth, :boolean, default: false
+ add_column :identifier_schemes, :for_orgs, :boolean, default: false
+ add_column :identifier_schemes, :for_plans, :boolean, default: false
+ add_column :identifier_schemes, :for_users, :boolean, default: false
+ end
+end
diff --git a/db/migrate/20200203190734_add_funder_and_org_to_plans.rb b/db/migrate/20200203190734_add_funder_and_org_to_plans.rb
new file mode 100644
index 0000000000..1ef20ac91c
--- /dev/null
+++ b/db/migrate/20200203190734_add_funder_and_org_to_plans.rb
@@ -0,0 +1,6 @@
+class AddFunderAndOrgToPlans < ActiveRecord::Migration
+ def change
+ add_reference :plans, :org, foreign_key: true
+ add_column :plans, :funder_id, :integer, index: true
+ end
+end
diff --git a/db/migrate/20200207212113_create_api_clients.rb b/db/migrate/20200207212113_create_api_clients.rb
new file mode 100644
index 0000000000..440cc91cb5
--- /dev/null
+++ b/db/migrate/20200207212113_create_api_clients.rb
@@ -0,0 +1,15 @@
+class CreateApiClients < ActiveRecord::Migration
+ def change
+ create_table :api_clients do |t|
+ t.string :name, null: false, index: true
+ t.string :description
+ t.string :homepage
+ t.string :contact_name
+ t.string :contact_email, null: false
+ t.string :client_id, null: false
+ t.string :client_secret, null: false
+ t.date :last_access
+ t.timestamps null: false
+ end
+ end
+end
diff --git a/db/migrate/20200212145931_add_enabled_to_notifications.rb b/db/migrate/20200212145931_add_enabled_to_notifications.rb
new file mode 100644
index 0000000000..183a011f49
--- /dev/null
+++ b/db/migrate/20200212145931_add_enabled_to_notifications.rb
@@ -0,0 +1,5 @@
+class AddEnabledToNotifications < ActiveRecord::Migration
+ def change
+ add_column :notifications, :enabled, :boolean, default: true
+ end
+end
diff --git a/db/migrate/20200213203124_add_last_api_access_to_users.rb b/db/migrate/20200213203124_add_last_api_access_to_users.rb
new file mode 100644
index 0000000000..96bdf9b216
--- /dev/null
+++ b/db/migrate/20200213203124_add_last_api_access_to_users.rb
@@ -0,0 +1,5 @@
+class AddLastApiAccessToUsers < ActiveRecord::Migration
+ def change
+ add_column :users, :last_api_access, :datetime
+ end
+end
diff --git a/db/migrate/20200215190747_add_context_to_identifier_schemes.rb b/db/migrate/20200215190747_add_context_to_identifier_schemes.rb
new file mode 100644
index 0000000000..2d919ecbfc
--- /dev/null
+++ b/db/migrate/20200215190747_add_context_to_identifier_schemes.rb
@@ -0,0 +1,15 @@
+class AddContextToIdentifierSchemes < ActiveRecord::Migration
+ def change
+ remove_column :identifier_schemes, :for_auth
+ remove_column :identifier_schemes, :for_orgs
+ remove_column :identifier_schemes, :for_plans
+ remove_column :identifier_schemes, :for_users
+ rename_column :identifier_schemes, :user_landing_url, :identifier_prefix
+
+ add_column :identifier_schemes, :context, :integer, index: true
+
+ change_column :identifiers, :identifier_scheme_id, :integer, null: true
+ add_index :identifiers, [:identifier_scheme_id, :identifiable_id, :identifiable_type],
+ name: 'index_identifiers_on_scheme_and_type_and_id'
+ end
+end
diff --git a/db/migrate/20200218213103_create_contributors.rb b/db/migrate/20200218213103_create_contributors.rb
new file mode 100644
index 0000000000..598e92c25c
--- /dev/null
+++ b/db/migrate/20200218213103_create_contributors.rb
@@ -0,0 +1,13 @@
+class CreateContributors < ActiveRecord::Migration
+ def change
+ create_table :contributors do |t|
+ t.string :name
+ t.string :email, index: true
+ t.string :phone
+ t.integer :roles, index: true, null: false
+ t.references :org, index: true
+ t.references :plan, index: true, null: false
+ t.timestamps
+ end
+ end
+end
\ No newline at end of file
diff --git a/db/migrate/20200218213414_add_start_and_end_dates_to_plans.rb b/db/migrate/20200218213414_add_start_and_end_dates_to_plans.rb
new file mode 100644
index 0000000000..81aa24a245
--- /dev/null
+++ b/db/migrate/20200218213414_add_start_and_end_dates_to_plans.rb
@@ -0,0 +1,7 @@
+class AddStartAndEndDatesToPlans < ActiveRecord::Migration
+ def change
+ add_column :plans, :grant_id, :integer, index: true
+ add_column :plans, :start_date, :datetime
+ add_column :plans, :end_date, :datetime
+ end
+end
diff --git a/db/migrate/20200313153356_add_versionable_to_question_options.rb b/db/migrate/20200313153356_add_versionable_to_question_options.rb
new file mode 100644
index 0000000000..b7af8e2aa7
--- /dev/null
+++ b/db/migrate/20200313153356_add_versionable_to_question_options.rb
@@ -0,0 +1,7 @@
+class AddVersionableToQuestionOptions < ActiveRecord::Migration
+ def change
+ add_column :question_options, :versionable_id, :string, limit: 36
+
+ add_index :question_options, :versionable_id
+ end
+end
diff --git a/db/migrate/20200323213847_add_api_client_id_to_plans.rb b/db/migrate/20200323213847_add_api_client_id_to_plans.rb
new file mode 100644
index 0000000000..2ed2278766
--- /dev/null
+++ b/db/migrate/20200323213847_add_api_client_id_to_plans.rb
@@ -0,0 +1,5 @@
+class AddApiClientIdToPlans < ActiveRecord::Migration
+ def change
+ add_column :plans, :api_client_id, :integer, index: true
+ end
+end
diff --git a/db/migrate/20200514102523_create_trackers.rb b/db/migrate/20200514102523_create_trackers.rb
new file mode 100644
index 0000000000..6f403ad4b8
--- /dev/null
+++ b/db/migrate/20200514102523_create_trackers.rb
@@ -0,0 +1,10 @@
+class CreateTrackers < ActiveRecord::Migration
+ def change
+ create_table :trackers do |t|
+ t.references :org, index: true, foreign_key: true
+ t.string :code
+
+ t.timestamps null: false
+ end
+ end
+end
diff --git a/db/migrate/20200601121822_add_filtered_to_stats.rb b/db/migrate/20200601121822_add_filtered_to_stats.rb
new file mode 100644
index 0000000000..434baa027f
--- /dev/null
+++ b/db/migrate/20200601121822_add_filtered_to_stats.rb
@@ -0,0 +1,5 @@
+class AddFilteredToStats < ActiveRecord::Migration
+ def change
+ add_column :stats, :filtered, :boolean, default: false
+ end
+end
diff --git a/db/schema.rb b/db/schema.rb
index 095472314b..4c6a5bae9f 100644
--- a/db/schema.rb
+++ b/db/schema.rb
@@ -11,10 +11,7 @@
#
# It's strongly recommended that you check this file into your version control system.
-ActiveRecord::Schema.define(version: 20190507091025) do
-
- # These are extensions that must be enabled in order to support this database
- enable_extension "plpgsql"
+ActiveRecord::Schema.define(version: 20200601121822) do
create_table "annotations", force: :cascade do |t|
t.integer "question_id", limit: 4
@@ -54,12 +51,62 @@
add_index "answers_question_options", ["answer_id"], name: "index_answers_question_options_on_answer_id", using: :btree
+ create_table "api_clients", force: :cascade do |t|
+ t.string "name", limit: 255, null: false
+ t.string "description", limit: 255
+ t.string "homepage", limit: 255
+ t.string "contact_name", limit: 255
+ t.string "contact_email", limit: 255, null: false
+ t.string "client_id", limit: 255, null: false
+ t.string "client_secret", limit: 255, null: false
+ t.date "last_access"
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ end
+
+ add_index "api_clients", ["name"], name: "index_api_clients_on_name", using: :btree
+
+ create_table "ar_internal_metadata", primary_key: "key", force: :cascade do |t|
+ t.string "value", limit: 255
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ end
+
+ create_table "conditions", force: :cascade do |t|
+ t.integer "question_id", limit: 4
+ t.text "option_list", limit: 65535
+ t.integer "action_type", limit: 4
+ t.integer "number", limit: 4
+ t.text "remove_data", limit: 65535
+ t.text "webhook_data", limit: 65535
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ end
+
+ add_index "conditions", ["question_id"], name: "index_conditions_on_question_id", using: :btree
+
+ create_table "contributors", force: :cascade do |t|
+ t.string "name", limit: 255
+ t.string "email", limit: 255
+ t.string "phone", limit: 255
+ t.integer "roles", limit: 4, null: false
+ t.integer "org_id", limit: 4
+ t.integer "plan_id", limit: 4, null: false
+ t.datetime "created_at"
+ t.datetime "updated_at"
+ end
+
+ add_index "contributors", ["email"], name: "index_contributors_on_email", using: :btree
+ add_index "contributors", ["org_id"], name: "index_contributors_on_org_id", using: :btree
+ add_index "contributors", ["plan_id"], name: "index_contributors_on_plan_id", using: :btree
+ add_index "contributors", ["roles"], name: "index_contributors_on_roles", using: :btree
+
create_table "departments", force: :cascade do |t|
- t.string "name"
- t.string "code"
- t.integer "org_id"
- t.datetime "created_at", null: false
- t.datetime "updated_at", null: false
+ t.string "name", limit: 255
+ t.string "code", limit: 255
+ t.integer "org_id", limit: 4
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
end
add_index "departments", ["org_id"], name: "index_departments_on_org_id", using: :btree
@@ -95,15 +142,30 @@
add_index "guidances", ["guidance_group_id"], name: "index_guidances_on_guidance_group_id", using: :btree
create_table "identifier_schemes", force: :cascade do |t|
- t.string "name", limit: 255
- t.string "description", limit: 255
+ t.string "name", limit: 255
+ t.string "description", limit: 255
t.boolean "active"
t.datetime "created_at"
t.datetime "updated_at"
- t.string "logo_url", limit: 255
- t.string "user_landing_url", limit: 255
+ t.string "logo_url", limit: 255
+ t.string "identifier_prefix", limit: 255
+ t.integer "context", limit: 4
+ end
+
+ create_table "identifiers", force: :cascade do |t|
+ t.string "value", limit: 255, null: false
+ t.text "attrs", limit: 65535
+ t.integer "identifier_scheme_id", limit: 4
+ t.integer "identifiable_id", limit: 4
+ t.string "identifiable_type", limit: 255
+ t.datetime "created_at"
+ t.datetime "updated_at"
end
+ add_index "identifiers", ["identifiable_type", "identifiable_id"], name: "index_identifiers_on_identifiable_type_and_identifiable_id", using: :btree
+ add_index "identifiers", ["identifier_scheme_id", "identifiable_id", "identifiable_type"], name: "index_identifiers_on_scheme_and_type_and_id", using: :btree
+ add_index "identifiers", ["identifier_scheme_id", "value"], name: "index_identifiers_on_identifier_scheme_id_and_value", using: :btree
+
create_table "languages", force: :cascade do |t|
t.string "abbreviation", limit: 255
t.string "description", limit: 255
@@ -142,8 +204,9 @@
t.boolean "dismissable"
t.date "starts_at"
t.date "expires_at"
- t.datetime "created_at", null: false
- t.datetime "updated_at", null: false
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ t.boolean "enabled", default: true
end
create_table "org_identifiers", force: :cascade do |t|
@@ -187,6 +250,7 @@
t.string "feedback_email_subject", limit: 255
t.text "feedback_email_msg", limit: 65535
t.string "contact_name", limit: 255
+ t.boolean "managed", default: false, null: false
end
add_index "orgs", ["language_id"], name: "fk_rails_5640112cab", using: :btree
@@ -231,8 +295,15 @@
t.string "principal_investigator_phone", limit: 255
t.boolean "feedback_requested", default: false
t.boolean "complete", default: false
+ t.integer "org_id", limit: 4
+ t.integer "funder_id", limit: 4
+ t.integer "grant_id", limit: 4
+ t.datetime "start_date"
+ t.datetime "end_date"
+ t.integer "api_client_id", limit: 4
end
+ add_index "plans", ["org_id"], name: "fk_rails_eda8ce4bca", using: :btree
add_index "plans", ["template_id"], name: "index_plans_on_template_id", using: :btree
create_table "plans_guidance_groups", force: :cascade do |t|
@@ -268,15 +339,17 @@
end
create_table "question_options", force: :cascade do |t|
- t.integer "question_id", limit: 4
- t.string "text", limit: 255
- t.integer "number", limit: 4
+ t.integer "question_id", limit: 4
+ t.string "text", limit: 255
+ t.integer "number", limit: 4
t.boolean "is_default"
t.datetime "created_at"
t.datetime "updated_at"
+ t.string "versionable_id", limit: 36
end
add_index "question_options", ["question_id"], name: "index_question_options_on_question_id", using: :btree
+ add_index "question_options", ["versionable_id"], name: "index_question_options_on_versionable_id", using: :btree
create_table "questions", force: :cascade do |t|
t.text "text", limit: 65535
@@ -336,8 +409,8 @@
add_index "sections", ["versionable_id"], name: "index_sections_on_versionable_id", using: :btree
create_table "sessions", force: :cascade do |t|
- t.string "session_id", limit: 64, null: false
- t.text "data"
+ t.string "session_id", limit: 64, null: false
+ t.text "data", limit: 65535
t.datetime "created_at"
t.datetime "updated_at"
end
@@ -355,13 +428,14 @@
end
create_table "stats", force: :cascade do |t|
- t.integer "count", limit: 8, default: 0
- t.date "date", null: false
- t.string "type", null: false
- t.integer "org_id"
- t.datetime "created_at", null: false
- t.datetime "updated_at", null: false
- t.text "details"
+ t.integer "count", limit: 8, default: 0
+ t.date "date", null: false
+ t.string "type", limit: 255, null: false
+ t.integer "org_id", limit: 4
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ t.text "details", limit: 65535
+ t.boolean "filtered", default: false
end
create_table "templates", force: :cascade do |t|
@@ -409,6 +483,15 @@
t.datetime "updated_at"
end
+ create_table "trackers", force: :cascade do |t|
+ t.integer "org_id", limit: 4
+ t.string "code", limit: 255
+ t.datetime "created_at", null: false
+ t.datetime "updated_at", null: false
+ end
+
+ add_index "trackers", ["org_id"], name: "index_trackers_on_org_id", using: :btree
+
create_table "user_identifiers", force: :cascade do |t|
t.string "identifier", limit: 255
t.datetime "created_at"
@@ -454,9 +537,12 @@
t.string "ldap_username", limit: 255
t.boolean "active", default: true
t.integer "department_id", limit: 4
+ t.datetime "last_api_access"
end
+ add_index "users", ["department_id"], name: "fk_rails_f29bf9cdf2", using: :btree
add_index "users", ["email"], name: "index_users_on_email", using: :btree
+ add_index "users", ["language_id"], name: "fk_rails_45f4f12508", using: :btree
add_index "users", ["org_id"], name: "index_users_on_org_id", using: :btree
create_table "users_perms", id: false, force: :cascade do |t|
@@ -467,11 +553,10 @@
add_index "users_perms", ["perm_id"], name: "fk_rails_457217c31c", using: :btree
add_index "users_perms", ["user_id"], name: "index_users_perms_on_user_id", using: :btree
- add_foreign_key "annotations", "orgs"
- add_foreign_key "annotations", "questions"
add_foreign_key "answers", "plans"
add_foreign_key "answers", "questions"
add_foreign_key "answers", "users"
+ add_foreign_key "conditions", "questions"
add_foreign_key "guidance_groups", "orgs"
add_foreign_key "guidances", "guidance_groups"
add_foreign_key "notes", "answers"
@@ -485,6 +570,7 @@
add_foreign_key "orgs", "languages"
add_foreign_key "orgs", "regions"
add_foreign_key "phases", "templates"
+ add_foreign_key "plans", "orgs"
add_foreign_key "plans", "templates"
add_foreign_key "plans_guidance_groups", "guidance_groups"
add_foreign_key "plans_guidance_groups", "plans"
@@ -497,6 +583,7 @@
add_foreign_key "templates", "orgs"
add_foreign_key "themes_in_guidance", "guidances"
add_foreign_key "themes_in_guidance", "themes"
+ add_foreign_key "trackers", "orgs"
add_foreign_key "user_identifiers", "identifier_schemes"
add_foreign_key "user_identifiers", "users"
add_foreign_key "users", "departments"
diff --git a/db/seeds.rb b/db/seeds.rb
index cebe1248a1..c7722231dc 100755
--- a/db/seeds.rb
+++ b/db/seeds.rb
@@ -30,14 +30,14 @@
description: 'ORCID',
active: true,
logo_url:'http://orcid.org/sites/default/files/images/orcid_16x16.png',
- user_landing_url:'https://orcid.org'
+ identifier_prefix:'https://orcid.org'
},
{
name: 'shibboleth',
description: 'Your institutional credentials',
active: true,
logo_url: 'http://newsite.shibboleth.net/wp-content/uploads/2017/01/Shibboleth-logo_2000x1200-1.png',
- user_landing_url: "https://example.com"
+ identifier_prefix: "https://example.com"
},
]
identifier_schemes.map { |is| create(:identifier_scheme, is) }
diff --git a/lib/dmptool/controller/home.rb b/lib/dmptool/controller/home.rb
deleted file mode 100644
index 42080ffba9..0000000000
--- a/lib/dmptool/controller/home.rb
+++ /dev/null
@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'rss'
-
-module Dmptool
-
- module Controller
-
- module Home
-
- protected
-
- def render_home_page
- # Usage stats
- @stats = Rails.cache.read("stats") || {}
- if @stats.empty?
- @stats = statistics
- end
-
- # Top 5 templates
- @top_5 = Rails.cache.read("top_5")
- if @top_5.nil?
- @top_5 = top_templates
- end
-
- # Retrieve/cache the DMPTool blog's latest posts
- @rss = Rails.cache.read("rss")
- if @rss.nil?
- @rss = feed
- end
-
- render "home/index"
- end
-
- private
-
- # Collect general statistics about the application
- def statistics
- stats = {
- user_count: User.select(:id).count,
- completed_plan_count: Plan.select(:id).count,
- institution_count: Org.participating.select(:id).count
- }
- cache_content("stats", stats)
- stats
- end
-
- # Collect the list of the top 5 most used templates for the past 90 days
- def top_templates
- end_date = Date.today
- start_date = (end_date - 90)
- ids = Plan.group(:template_id)
- .where(created_at: start_date..end_date)
- .order("count_id DESC")
- .count(:id).keys
-
- top_5 = Template.where(id: ids[0..4])
- .pluck(:title)
- cache_content("top_5", top_5)
- top_5
- end
-
- # Get the last 5 blog posts
- def feed
- begin
- xml = open(Rails.application.config.rss).read
- rss = RSS::Parser.parse(xml, false).items.first(5)
- cache_content("rss", rss)
-
- rescue Exception
- # If we were unable to connect to the blog rss
- rss = [] if rss.nil?
- logger.error("Caught exception RSS parse: #{e}.")
- end
- rss
- end
-
- # Store information in the cache
- def cache_content(type, data)
- begin
- Rails.cache.write(type, data, expires_in: 60.minutes)
- rescue Exception => e
- logger.error("Unable to add #{type} to the Rails cache: #{e}.")
- end
- end
-
- end
-
- end
-
-end
diff --git a/lib/dmptool/controller/omniauth_callbacks.rb b/lib/dmptool/controller/omniauth_callbacks.rb
deleted file mode 100644
index 53bc019af7..0000000000
--- a/lib/dmptool/controller/omniauth_callbacks.rb
+++ /dev/null
@@ -1,155 +0,0 @@
-# frozen_string_literal: true
-
-module Dmptool
-
- module Controller
-
- module OmniauthCallbacks
-
- protected
-
- def process_omniauth_callback(scheme)
- # There is occassionally a disconnect between the id of the Scheme
- # when the base controller's dynamic methods were defined and the
- # time this method is called, so reload the scheme
- scheme = IdentifierScheme.find_by(name: scheme.name)
-
- if request.env.present?
- omniauth = request.env["omniauth.auth"] || request.env
- else
- omniauth = {}
- end
-
- if scheme.name == "shibboleth"
- provider = _("your institutional credentials")
- else
- provider = scheme.description
- end
-
- # if the user is already signed in then we are attempting to attach
- # omniauth credentials to an existing account
- if current_user.present? && omniauth.fetch(:uid, "").present?
- if attach_omniauth_credentials(current_user, scheme, omniauth)
- # rubocop:disable LineLength
- flash[:notice] = _("Your account has been successfully linked to %{scheme}.") % {
- scheme: provider
- }
- # rubocop:enable LineLength
- else
- flash[:alert] = _("Unable to link your account to %{scheme}") % {
- scheme: provider
- }
- end
- redirect_to edit_user_registration_path
-
- else
- # Attempt to locate the user via the credentials returned by omniauth
- @user = User.from_omniauth(OpenStruct.new(omniauth))
-
- # If we found the user by their omniauth creds then sign them in
- if @user.present?
- flash[:notice] = _("Successfully signed in")
- sign_in_and_redirect @user, event: :authentication
-
- else
- # Otherwise attempt to locate the user via the email provided in
- # the omniauth creds
- new_user = omniauth_hash_to_new_user(omniauth)
- @user = User.where_case_insensitive("email", new_user.email).first
-
- # If we found the user by email
- if @user.present?
- # sign them in and attach their omniauth credentials to the account
- if attach_omniauth_credentials(@user, scheme, omniauth)
- flash[:notice] = _("Successfully signed in with %{scheme}.") % {
- scheme: provider
- }
- sign_in_and_redirect @user, event: :authentication
-
- else
- # Unable to attach the omniauth creds to the user
- flash[:alert] = _("Unable to sign in with %{scheme}") % {
- scheme: provider
- }
- session["devise.#{scheme.name.downcase}_data"] = omniauth
- flash[:notice] = _('It looks like this is your first time logging in. Please verify and complete the information below to finish creating an account.')
- render 'devise/registrations/new', locals: {
- user: @user,
- orgs: Org.participating
- }
- end
-
- # If we could not find a match take them to the account setup page
- else
- session["devise.#{scheme.name.downcase}_data"] = omniauth
- flash[:notice] = _('It looks like this is your first time logging in. Please verify and complete the information below to finish creating an account.')
- render 'devise/registrations/new', locals: {
- user: new_user,
- orgs: Org.participating
- }
- end
- end
- end
- end
-
- private
-
- def attach_omniauth_credentials(user, scheme, omniauth)
- # Attempt to find or attach the omniauth creds
- ui = UserIdentifier.where(identifier_scheme: scheme, user: user).first
- if ui.present?
- if ui.identifier != omniauth[:uid]
- ui.update(identifier: omniauth[:uid])
- end
- true
- else
- UserIdentifier.create(identifier_scheme: scheme, user: user,
- identifier: omniauth[:uid])
- end
- end
-
- def omniauth_hash_to_new_user(omniauth)
- omniauth_info = omniauth.fetch(:info, {})
- names = extract_omniauth_names(omniauth_info)
- User.new(
- email: extract_omniauth_email(omniauth_info),
- firstname: names.fetch(:firstname, ""),
- surname: names.fetch(:surname, ""),
- org: extract_omniauth_org(omniauth_info)
- )
- end
-
- def extract_omniauth_email(hash)
- hash.fetch(:email, "").split(";")[0]
- end
-
- def extract_omniauth_names(hash)
- firstname = hash.fetch(:givenname, hash.fetch(:firstname, ""))
- surname = hash.fetch(:sn, hash.fetch(:surname, hash.fetch(:lastname, "")))
-
- if hash[:name].present? && (!firstname.present? || !surname.present?)
- names = hash[:name].split(" ")
- firstname = names[0]
- if names.length > 1
- surname = names[names.length - 1]
- end
- end
- { firstname: firstname, surname: surname }
- end
-
- def extract_omniauth_org(hash)
- idp_name = hash.fetch(:identity_provider, "").downcase
- if idp_name.present?
- idp = OrgIdentifier.where("LOWER(identifier) = ?", idp_name).first
- if idp.present?
- org = Org.find_by(id: idp.org_id)
- end
- end
- (org.present? ? org : Org.find_by(is_other: true))
- end
-
- end
-
- end
-
-end
diff --git a/lib/dmptool/controller/orgs.rb b/lib/dmptool/controller/orgs.rb
deleted file mode 100644
index 9bc939c3e1..0000000000
--- a/lib/dmptool/controller/orgs.rb
+++ /dev/null
@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Dmptool
-
- module Controller
-
- module Orgs
-
- # GET /org_logos/:id (format: :json)
- def logos
- skip_authorization
- org = Org.find(params[:id])
- @user = User.new(org: org)
- render json: {
- "org" => {
- "id" => params[:id],
- "html" => render_to_string(partial: "shared/org_branding",
- formats: [:html])
- }
- }.to_json
- end
-
- end
-
- end
-
-end
diff --git a/lib/dmptool/controller/users.rb b/lib/dmptool/controller/users.rb
deleted file mode 100644
index 6acfc5e382..0000000000
--- a/lib/dmptool/controller/users.rb
+++ /dev/null
@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Dmptool
-
- module Controller
-
- module Users
-
- # GET /users/:id/ldap_username
- def ldap_username
- skip_authorization
- end
-
- def ldap_account
- skip_authorization
- @user = User.where(ldap_username: params[:username]).first
- if @user.present?
- # rubocop:disable LineLength
- render(
- json: {
- code: 1,
- email: @user.email,
- msg: _("The DMPTool Account email associated with this username is #{@user.email}")
- }
- )
- # rubocop:enable LineLength
- else
- # rubocop:disable LineLength
- render(
- json: {
- code: 0,
- email: "",
- msg: _("We do not recognize the username %{username}. Please try again or contact us if you have forgotten the username and email for your existing DMPTool account.") % {
- username: params[:username]
- }
- }
- )
- # rubocop:enable LineLength
- end
- end
-
- end
-
- end
-
-end
diff --git a/lib/dmptool/controllers/home_controller.rb b/lib/dmptool/controllers/home_controller.rb
new file mode 100644
index 0000000000..1addfd68bd
--- /dev/null
+++ b/lib/dmptool/controllers/home_controller.rb
@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "rss"
+
+module Dmptool
+
+ module Controllers
+
+ module HomeController
+
+ def render_home_page
+ # Usage stats
+ @stats = statistics
+
+ # Top 5 templates
+ @top_five = top_templates
+
+ # Retrieve/cache the DMPTool blog's latest posts
+ @rss = feed
+
+ render "home/index"
+ end
+
+ private
+
+ # Collect general statistics about the application
+ def statistics
+ cached = Rails.cache.read("stats")
+ return cached unless cached.nil?
+
+ stats = {
+ user_count: User.select(:id).count,
+ completed_plan_count: Plan.select(:id).count,
+ institution_count: Org.participating.select(:id).count
+ }
+ cache_content("stats", stats)
+ stats
+ end
+
+ # Collect the list of the top 5 most used templates for the past 90 days
+ # rubocop:disable Metrics/MethodLength
+ def top_templates
+ cached = Rails.cache.read("top_five")
+ return cached unless cached.nil?
+
+ end_date = Date.today
+ start_date = (end_date - 90)
+ ids = Plan.group(:template_id)
+ .where(created_at: start_date..end_date)
+ .order("count_id DESC")
+ .count(:id).keys
+
+ top_five = Template.where(id: ids[0..4])
+ .pluck(:title)
+ cache_content("top_five", top_five)
+ top_five
+ end
+ # rubocop:enable Metrics/MethodLength
+
+ # Get the last 5 blog posts
+ # rubocop:disable Metrics/AbcSize
+ def feed
+ cached = Rails.cache.read("rss")
+ return cached unless cached.nil?
+
+ resp = HTTParty.get(Rails.application.config.rss)
+ return [] unless resp.code == 200
+
+ rss = RSS::Parser.parse(resp.body, false).items.first(5)
+ cache_content("rss", rss)
+ rss
+ rescue StandardError => e
+ # If we were unable to connect to the blog rss
+ logger.error("Caught exception RSS parse: #{e}.")
+ []
+ end
+ # rubocop:enable Metrics/AbcSize
+
+ # Store information in the cache
+ def cache_content(type, data)
+ return nil unless type.present?
+
+ Rails.cache.write(type, data, expires_in: 60.minutes)
+ rescue StandardError => e
+ logger.error("Unable to add #{type} to the Rails cache: #{e}.")
+ end
+
+ end
+
+ end
+
+end
diff --git a/lib/dmptool/controllers/orgs_controller.rb b/lib/dmptool/controllers/orgs_controller.rb
new file mode 100644
index 0000000000..37ec3aec3e
--- /dev/null
+++ b/lib/dmptool/controllers/orgs_controller.rb
@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Dmptool
+
+ module Controllers
+
+ module OrgsController
+
+ # GET /org_logos/:id (format: :json)
+ def logos
+ skip_authorization
+ org = Org.find(params[:id])
+ @user = User.new(org: org)
+ render json: {
+ "org" => {
+ "id" => params[:id],
+ "html" => render_to_string(template: "shared/org_branding",
+ formats: [:html])
+ }
+ }.to_json
+ end
+
+ # GET /orgs/shibboleth_ds/:id
+ # POST /orgs/shibboleth_ds/:id
+ # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+ def shibboleth_ds_passthru
+ skip_authorization
+ org = Org.find_by(id: params[:id])
+
+ if org.present?
+ entity_id = org.identifier_for_scheme(scheme: "shibboleth")
+ if entity_id.present?
+ shib_login = Rails.application.config.shibboleth_login
+ url = "#{request.base_url.gsub('http:', 'https:')}#{shib_login}"
+ target = user_shibboleth_omniauth_callback_url.gsub("http:", "https:")
+ # initiate shibboleth login sequence
+ redirect_to "#{url}?target=#{target}&entityID=#{entity_id.value}"
+ else
+ @user = User.new(org: org)
+ # render new signin showing org logo
+ render "shared/org_branding"
+ end
+ else
+ redirect_to shibboleth_ds_path,
+ notice: _("Please choose an organisation from the list.")
+ end
+ end
+ # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+ private
+
+ def sign_in_params
+ params.require(:org).permit(:org_name, :org_sources, :org_crosswalk, :id)
+ end
+
+ def convert_params
+ # expecting incoming params to look like:
+ # /orgs/shibboleth/173?org[id=173]
+ # /orgs/shibboleth/173?shib-ds[org_name=173]&shib-ds[org_id=173]]
+ args = sign_in_params
+
+ # POST params need to be converted over to a JSON object
+ if args.is_a?(String)
+ JSON.parse(args).with_indifferent_access
+ else
+ # For some reason when this comes through as a GET with query_params
+ # it includes the closing bracket :/
+ args = args.with_indifferent_access
+ args[:id] = args[:id].gsub(/\]$/, "")
+ args
+ end
+ end
+
+ end
+
+ end
+
+end
diff --git a/lib/dmptool/controller/paginable.rb b/lib/dmptool/controllers/paginable/orgs_controller.rb
similarity index 90%
rename from lib/dmptool/controller/paginable.rb
rename to lib/dmptool/controllers/paginable/orgs_controller.rb
index 8cab04b0ec..4f194308ac 100644
--- a/lib/dmptool/controller/paginable.rb
+++ b/lib/dmptool/controllers/paginable/orgs_controller.rb
@@ -2,11 +2,11 @@
module Dmptool
- module Controller
+ module Controllers
module Paginable
- module Orgs
+ module OrgsController
# /paginable/orgs/public/:page
def public
diff --git a/lib/dmptool/controller/public_pages.rb b/lib/dmptool/controllers/public_pages_controller.rb
similarity index 66%
rename from lib/dmptool/controller/public_pages.rb
rename to lib/dmptool/controllers/public_pages_controller.rb
index 360740baab..27084af66d 100644
--- a/lib/dmptool/controller/public_pages.rb
+++ b/lib/dmptool/controllers/public_pages_controller.rb
@@ -2,9 +2,9 @@
module Dmptool
- module Controller
+ module Controllers
- module PublicPages
+ module PublicPagesController
# The publicly accessible list of participating institutions
def orgs
@@ -15,22 +15,22 @@ def orgs
# The sign in/account creation options page accessed via the 'Get Started' button
# on the home page
+ # rubocop:disable Naming/AccessorMethodName
def get_started
skip_authorization
render "/shared/_get_started"
end
+ # rubocop:enable Naming/AccessorMethodName
protected
# Clean up the file name to make it OS friendly (removing newlines, and punctuation)
def file_name(title)
- file_name = title.gsub(/[\r\n]/, " ")
- .gsub(/[^a-zA-Z\d\s]/, "")
- .gsub(/ /, "_")
- if file_name.length > 31
- file_name = file_name[0..30]
- end
- file_name
+ name = title.gsub(/[\r\n]/, " ")
+ .gsub(/[^a-zA-Z\d\s]/, "")
+ .gsub(/ /, "_")
+
+ name.length > 31 ? name[0..30] : name
end
end
diff --git a/lib/dmptool/controller/static_pages.rb b/lib/dmptool/controllers/static_pages_controller.rb
similarity index 78%
rename from lib/dmptool/controller/static_pages.rb
rename to lib/dmptool/controllers/static_pages_controller.rb
index 06ab39daf1..cd6862e645 100644
--- a/lib/dmptool/controller/static_pages.rb
+++ b/lib/dmptool/controllers/static_pages_controller.rb
@@ -2,9 +2,9 @@
module Dmptool
- module Controller
+ module Controllers
- module StaticPages
+ module StaticPagesController
def promote
end
diff --git a/lib/dmptool/controllers/users/omniauth_callbacks_controller.rb b/lib/dmptool/controllers/users/omniauth_callbacks_controller.rb
new file mode 100644
index 0000000000..27ddf3fad0
--- /dev/null
+++ b/lib/dmptool/controllers/users/omniauth_callbacks_controller.rb
@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+module Dmptool
+
+ module Controllers
+
+ module Users
+
+ module OmniauthCallbacksController
+
+ # rubocop:disable Layout/FormatStringToken
+ # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+ # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+ def process_omniauth_callback(scheme:)
+ # There is occassionally a disconnect between the id of the Scheme
+ # when the base controller's dynamic methods were defined and the
+ # time this method is called, so reload the scheme
+ scheme = IdentifierScheme.find_by(name: scheme.name)
+
+ @provider = provider(scheme: scheme)
+ @omniauth = omniauth.with_indifferent_access
+
+ # if the user is already signed in then we are attempting to attach
+ # omniauth credentials to an existing account
+ if current_user.present? && @omniauth[:uid].present?
+ identifier = attach_omniauth_credentials(
+ user: current_user, scheme: scheme, omniauth: @omniauth
+ )
+
+ if identifier.present?
+ msg = format(_("Your account has been successfully linked to %{scheme}."),
+ scheme: @provider)
+ redirect_to edit_user_registration_path, notice: msg
+ else
+ msg = format(_("Unable to link your account to %{scheme}"),
+ scheme: @provider)
+ redirect_to edit_user_registration_path, alert: msg
+ end
+
+ else
+ # Attempt to locate the user via the credentials returned by omniauth
+ @user = User.from_omniauth(OpenStruct.new(@omniauth))
+
+ # If we found the user by their omniauth creds then sign them in
+ if @user.present?
+ flash[:notice] = _("Successfully signed in")
+ sign_in_and_redirect @user, event: :authentication
+
+ else
+ # Otherwise attempt to locate the user via the email provided in
+ # the omniauth creds
+ new_user = omniauth_hash_to_new_user(scheme: scheme, omniauth: @omniauth)
+ @user = User.where_case_insensitive("email", new_user.email).first
+
+ # If we found the user by email
+ if @user.present?
+ # sign them in and attach their omniauth credentials to the account
+ identifier = attach_omniauth_credentials(
+ user: @user, scheme: scheme, omniauth: @omniauth
+ )
+
+ # rubocop:disable Metrics/BlockNesting
+ if identifier.present?
+ flash[:notice] = format(_("Successfully signed in with %{scheme}."),
+ scheme: @provider)
+ sign_in_and_redirect @user, event: :authentication
+ end
+ # rubocop:enable Metrics/BlockNesting
+
+ else
+ # If we could not find a match take them to the account setup page
+ redirect_to_registration(scheme: scheme, data: @omniauth)
+ end
+ end
+ end
+ end
+ # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+ # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+ # rubocop:enable Layout/FormatStringToken
+
+ private
+
+ # Return the visual name of the scheme
+ def provider(scheme:)
+ return _("your institutional credentials") if scheme.name == "shibboleth"
+
+ scheme.description
+ end
+
+ # Extract the omniauth info from the request
+ def omniauth
+ return {} unless request.env.present?
+
+ hash = request.env["omniauth.auth"]
+ hash = request.env[:"omniauth.auth"] unless hash.present?
+ hash.present? ? hash : request.env
+ end
+
+ # rubocop:disable Layout/LineLength
+ def redirect_to_registration(scheme:, data:)
+ session["devise.#{scheme.name.downcase}_data"] = data
+ redirect_to Rails.application.routes.url_helpers.new_user_registration_path,
+ notice: _("It looks like this is your first time logging in. Please verify and complete the information below to finish creating an account.")
+ end
+ # rubocop:enable Layout/LineLength
+
+ # Attach the omniauth uid to the User
+ # rubocop:disable Metrics/CyclomaticComplexity
+ def attach_omniauth_credentials(user:, scheme:, omniauth:)
+ return false unless user.present? && scheme.present? && omniauth.present?
+
+ ui = Identifier.where(identifier_scheme: scheme, identifiable: user).first
+ # If the User exists and the uid is different update it
+ ui.update(value: omniauth[:uid]) if ui.present? && ui.value != omniauth[:uid]
+ return ui.reload if ui.present?
+
+ Identifier.create(identifier_scheme: scheme, identifiable: user,
+ value: omniauth[:uid])
+ end
+ # rubocop:enable Metrics/CyclomaticComplexity
+
+ # Convert the incoming omniauth info into a User
+ def omniauth_hash_to_new_user(scheme:, omniauth:)
+ return nil unless scheme.present? && omniauth.present?
+
+ omniauth_info = omniauth.fetch(:info, {})
+ names = extract_omniauth_names(hash: omniauth_info)
+ User.new(
+ email: extract_omniauth_email(hash: omniauth_info),
+ firstname: names.fetch(:firstname, ""),
+ surname: names.fetch(:surname, ""),
+ org: extract_omniauth_org(scheme: scheme, hash: omniauth_info)
+ )
+ end
+
+ # Extract the 1st email
+ def extract_omniauth_email(hash:)
+ hash.present? ? hash.fetch(:email, "").split(";")[0] : nil
+ end
+
+ # Find the User names from the omniauth info
+ # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+ def extract_omniauth_names(hash:)
+ return {} unless hash.present?
+
+ out = {
+ firstname: hash.fetch(:givenname, hash.fetch(:firstname, "")),
+ surname: hash.fetch(:sn, hash.fetch(:surname, hash.fetch(:lastname, "")))
+ }
+ return out if out[:firstname].present? || out[:surname].present?
+
+ names = hash[:name].split(" ")
+ {
+ firstname: names[0],
+ surname: names.length > 1 ? names[names.length - 1] : nil
+ }
+ end
+ # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+ # Find the Org associated with the omniauth provider
+ def extract_omniauth_org(scheme:, hash:)
+ return nil unless scheme.present? &&
+ hash.present? &&
+ hash[:identity_provider].present?
+
+ uid = hash[:identity_provider].downcase
+ idp = Identifier.where(identifier_scheme: scheme)
+ .where("LOWER(value) = ?", uid).first
+ idp.present? ? idp.identifiable : nil
+ end
+
+ end
+
+ end
+
+ end
+
+end
diff --git a/lib/dmptool/mailers/user_mailer.rb b/lib/dmptool/mailers/user_mailer.rb
index c0f1f3e7c0..cc1aa48390 100644
--- a/lib/dmptool/mailers/user_mailer.rb
+++ b/lib/dmptool/mailers/user_mailer.rb
@@ -6,21 +6,24 @@ module Mailers
module UserMailer
- # AWS SES does not allow the sender to be be from a different domain so
- # we remove the `from:` that was being used to pretendd it is coming from
- # the Org's contact_email
- def feedback_complete(recipient, plan, requestor)
- @requestor = requestor
- @user = recipient
- @plan = plan
- @phase = plan.phases.first
- if recipient.active?
- FastGettext.with_locale FastGettext.default_locale do
- mail(to: recipient.email,
- subject: _("%{application_name}: Expert feedback has been provided for %{plan_title}") % {application_name: Rails.configuration.branding[:application][:name], plan_title: @plan.title})
- end
+ # rubocop:disable Metrics/MethodLength
+ def api_plan_creation(plan, contributor)
+ return false unless contributor.present? && plan.present?
+
+ @contributor = contributor
+ @plan = plan
+ to_addr = @plan.api_client.contact_email
+ to_addr = "brian.riley@ucop.edu" unless to_addr.present?
+
+ FastGettext.with_locale FastGettext.default_locale do
+ mail(
+ to: to_addr,
+ cc: "brian.riley@ucop.edu; xsrust@gmail.com", # manuel.minwary@ucr.edu",
+ subject: _("New DMP created")
+ )
end
end
+ # rubocop:enable Metrics/MethodLength
end
diff --git a/lib/dmptool/model/user.rb b/lib/dmptool/model/user.rb
deleted file mode 100644
index 60e5a44ca1..0000000000
--- a/lib/dmptool/model/user.rb
+++ /dev/null
@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Dmptool
-
- module Model
-
- module User
-
- extend ActiveSupport::Concern
-
- included do
- # LDap Users password reset
- def valid_password?(password)
- if !has_devise_password? && ldap_password?
- if verify_legacy_password(ldap_password, password)
- convert_password_to_devise(password)
- else
- return false
- end
- end
- super
- end
-
- def ldap_password?
- ldap_password.present?
- end
- end
-
- private
-
- def has_devise_password?
- encrypted_password.present?
- end
-
- def verify_legacy_password(ldap_password, password)
- # LDAP encoding, a 20-byte binary SHA-1 hash and an 8-byte binary
- # salt are concatenated, Base64-encoded, and prepended with "{SSHA}".
- # Base64Encode(SHA1(password+salt)+salt)
- str = ldap_password.sub("{SSHA}", "")
- base64_decoded_hash = Base64.decode64(str)
- if base64_decoded_hash.length == 28
- # SHA1(password+salt)
- sha1_hash = base64_decoded_hash[0, base64_decoded_hash.length - 8]
- salt = base64_decoded_hash.split(//).last(8).join
- end
- # Generate the Ldap hash using user entered password and above salt for
- # password verification
- digest = Digest::SHA1.digest(password + salt)
- hash_to_verify = "{SSHA}" + Base64.encode64(digest + salt).chomp!
- return true if hash_to_verify.strip == ldap_password.strip
- false
- end
-
- def convert_password_to_devise(password)
- self.password = password
- self.ldap_password = nil
- self.save!
- end
-
- end
-
- end
-
-end
diff --git a/lib/dmptool/model/org.rb b/lib/dmptool/models/org.rb
similarity index 57%
rename from lib/dmptool/model/org.rb
rename to lib/dmptool/models/org.rb
index 5c2b4b8c64..df814b07ce 100644
--- a/lib/dmptool/model/org.rb
+++ b/lib/dmptool/models/org.rb
@@ -2,7 +2,7 @@
module Dmptool
- module Model
+ module Models
module Org
@@ -11,15 +11,13 @@ module Org
class_methods do
# DMPTool participating institution helpers
def participating
- self.includes(:identifier_schemes)
- .where(is_other: false)
+ includes(identifiers: :identifier_scheme).where(managed: true).order(:name)
end
end
included do
def shibbolized?
- shib = IdentifierScheme.find_by(name: "shibboleth")
- org_identifiers.where(identifier_scheme: shib).present?
+ managed? && identifier_for_scheme(scheme: "shibboleth").present?
end
end
diff --git a/lib/dmptool/presenters/org_presenter.rb b/lib/dmptool/presenters/org_presenter.rb
new file mode 100644
index 0000000000..dd10f7a5d7
--- /dev/null
+++ b/lib/dmptool/presenters/org_presenter.rb
@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Dmptool
+
+ module Presenters
+
+ class OrgPresenter
+
+ include Rails.application.routes.url_helpers
+
+ def initialize
+ @shib = IdentifierScheme.by_name("shibboleth").first
+ end
+
+ def participating_orgs
+ Org.participating.order(:name)
+ end
+
+ def sign_in_url(org:)
+ return nil unless org.present? && @shib.present?
+
+ "#{shibboleth_ds_path}/#{org.id}"
+ end
+
+ end
+
+ end
+
+end
diff --git a/lib/open_aire_request.rb b/lib/open_aire_request.rb
deleted file mode 100644
index 5cefeab0e7..0000000000
--- a/lib/open_aire_request.rb
+++ /dev/null
@@ -1,33 +0,0 @@
-# frozen_string_literal
-
-require "open-uri"
-require "nokogiri"
-
-class OpenAireRequest
-
- API_URL = "https://api.openaire.eu/projects/dspace/%s/ALL/ALL"
-
- attr_reader :funder_type
-
- def initialize(funder_type)
- @funder_type = funder_type
- end
-
- def get!
- Rails.logger.info("Fetching fresh data from #{API_URL % funder_type}")
- data = open(API_URL % funder_type)
- Rails.logger.info("Fetched fresh data from #{API_URL % funder_type}")
- @results = Nokogiri::XML(data).xpath("//pair/displayed-value").map do |node|
- parts = node.content.split("-")
- grant_id = parts.shift.to_s.strip
- description = parts.join(" - ").strip
- ResearchProject.new(grant_id, description)
- end
- return self
- end
-
- def results
- Array(@results)
- end
-
-end
diff --git a/lib/org_date_rangeable.rb b/lib/org_date_rangeable.rb
index 08739e117d..918e0eb83a 100644
--- a/lib/org_date_rangeable.rb
+++ b/lib/org_date_rangeable.rb
@@ -2,9 +2,11 @@
module OrgDateRangeable
- def monthly_range(org:, start_date: nil, end_date: Date.today.end_of_month)
- query_string = "org_id = :org_id"
- query_hash = { org_id: org.id }
+ # rubocop:disable Metrics/MethodLength, Metrics/LineLength
+ def monthly_range(org:, start_date: nil, end_date: Date.today.end_of_month, filtered: false)
+ # rubocop:enable Metrics/LineLength
+ query_string = "org_id = :org_id and filtered = :filtered"
+ query_hash = { org_id: org.id, filtered: filtered }
unless start_date.nil?
query_string += " and date >= :start_date"
@@ -17,9 +19,11 @@ def monthly_range(org:, start_date: nil, end_date: Date.today.end_of_month)
end
where(query_string, query_hash)
end
+ # rubocop:enable Metrics/MethodLength
class << self
+ # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
def split_months_from_creation(org, &block)
starts_at = org.created_at
ends_at = starts_at.end_of_month
@@ -37,6 +41,7 @@ def split_months_from_creation(org, &block)
enumerable
end
+ # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
end
diff --git a/lib/tasks/upgrade.rake b/lib/tasks/upgrade.rake
index c0644d9df9..bfee65f41d 100644
--- a/lib/tasks/upgrade.rake
+++ b/lib/tasks/upgrade.rake
@@ -1,6 +1,32 @@
require 'set'
namespace :upgrade do
+ desc "Upgrade to v2.2.0 Part 1"
+ task v2_2_0_part1: :environment do
+ p "Upgrading to v2.2.0 (part 1) ... A summary report will be generated when complete"
+ p "------------------------------------------------------------------------"
+ Rake::Task["upgrade:upgrade_2_2_0_identifier_schemes"].execute
+ Rake::Task["upgrade:upgrade_2_2_0_identifiers"].execute
+ Rake::Task["upgrade:upgrade_2_2_0_orgs"].execute
+ Rake::Task["upgrade:results_2_2_0_part1"].execute
+ end
+
+ desc "Upgrade to v2.2.0 Part 2"
+ task v2_2_0_part2: :environment do
+ p "Upgrading to v2.2.0 (part 2) ... A summary report will be generated when complete"
+ p "------------------------------------------------------------------------"
+ Rake::Task["upgrade:migrate_other_organisation_to_org"].execute
+ Rake::Task["upgrade:migrate_contributors"].execute
+ Rake::Task["upgrade:migrate_plan_org_and_funder"].execute
+ Rake::Task["upgrade:migrate_plan_grants"].execute
+ Rake::Task["upgrade:results_2_2_0_part2"].execute
+ end
+
+ desc "Upgrade to v2.1.6"
+ task v2_1_6: :environment do
+ Rake::Task['upgrade:add_versionable_id_to_question_options'].execute
+ end
+
desc "Upgrade to v2.1.3"
task v2_1_3: :environment do
Rake::Task['upgrade:fill_blank_plan_identifiers'].execute
@@ -701,6 +727,541 @@ namespace :upgrade do
Role.reviewer.destroy_all
end
+ desc "generate versionable_ids for "
+ task add_versionable_id_to_question_options: :environment do
+
+ QuestionOption.attr_readonly.delete('versionable_id')
+
+ Template.latest_version.where(customization_of: nil)
+ .includes(phases: { sections: { questions: :question_options }})
+ .each do |uncustomized|
+
+ # update the versionable_id for the canonical and all customized templates
+ uncustomized.question_options.each do |qo|
+ vers_id = loop do
+ rand = SecureRandom.uuid
+ break rand unless QuestionOption.exists?(versionable_id: rand)
+ end
+ qo.update! versionable_id: vers_id
+ text_a = "#{qo.number} - #{qo.text}"
+
+ Question.joins(:question_options)
+ .where(questions: {versionable_id: qo.question.versionable_id})
+ .where.not(questions: {id: qo.question_id}) # ensure we exclude the current question
+ .includes(:question_options)
+ .each do |q_cust|
+ q_cust.question_options.each do |qo_cust|
+ text_b = "#{qo_cust.number} - #{qo_cust.text}"
+
+ if fuzzy_match?(text_a, text_b)
+ qo_cust.update! versionable_id: qo.versionable_id
+ break
+ end
+ end
+ end
+ end
+
+ end
+
+ end
+
+ # -------------------------------------------------
+ # TASKS FOR 2.2.0
+ desc "run all of the identifier_scheme changes"
+ task upgrade_2_2_0_identifier_schemes: :environment do
+ Rake::Task["upgrade:add_new_identifier_schemes"].execute
+ Rake::Task["upgrade:update_shibboleth_description"].execute
+ Rake::Task["upgrade:contextualize_identifier_schemes"].execute
+ end
+ desc "run all of the identifier changes"
+ task upgrade_2_2_0_identifiers: :environment do
+ Rake::Task["upgrade:convert_org_identifiers"].execute
+ p "--------------------------"
+ Rake::Task["upgrade:convert_user_identifiers"].execute
+ end
+ desc "run all of the org changes"
+ task upgrade_2_2_0_orgs: :environment do
+ Rake::Task["upgrade:default_orgs_to_managed"].execute
+ p "--------------------------"
+ Rake::Task["upgrade:retrieve_ror_fundref_ids"].execute
+ end
+
+ desc "add the ROR and Fundref identifier schemes"
+ task add_new_identifier_schemes: :environment do
+ unless IdentifierScheme.where(name: "fundref").any?
+ IdentifierScheme.create(
+ name: "fundref",
+ description: "Crossref Funder Registry (FundRef)",
+ active: true
+ )
+ end
+ unless IdentifierScheme.where(name: "ror").any?
+ IdentifierScheme.create(
+ name: "ror",
+ description: "Research Organization Registry (ROR)",
+ active: true
+ )
+ end
+ end
+
+ desc "update the Shibboleth scheme description"
+ task update_shibboleth_description: :environment do
+ scheme = IdentifierScheme.where(name: "shibboleth")
+ if scheme.any?
+ scheme.first.update(description: "Institutional Sign In (Shibboleth)")
+ end
+ end
+
+ desc "Contextualize the Identifier Schemes (e.g. which ones are for orgs, etc."
+ task contextualize_identifier_schemes: :environment do
+ # Identifier schemes for multiple uses
+ shib = IdentifierScheme.find_or_initialize_by(name: "shibboleth")
+ shib.for_users = true
+ shib.for_orgs = true
+ shib.for_authentication = true
+ shib.save
+
+ orcid = IdentifierScheme.find_or_initialize_by(name: "orcid")
+ orcid.for_users = true
+ orcid.for_contributors = true
+ orcid.for_authentication = true
+ orcid.identifier_prefix = "https://orcid.org/"
+ orcid.save
+
+ # Org identifier schemes
+ ror = IdentifierScheme.find_or_initialize_by(name: "ror")
+ ror.for_orgs = true
+ ror.identifier_prefix = "https://ror.org/"
+ ror.save
+
+ fundref = IdentifierScheme.find_or_initialize_by(name: "fundref")
+ fundref.for_orgs = true
+ fundref.identifier_prefix = "https://api.crossref.org/funders/"
+ fundref.save
+ end
+
+ desc "migrate the old user_identifiers over to the polymorphic identifiers table"
+ task convert_user_identifiers: :environment do
+ p "Transferring existing user_identifiers over to the identifiers table"
+ p "this may take in excess of 10 minutes depending on the size of your users table ..."
+ identifiers = UserIdentifier.joins(:user, :identifier_scheme)
+ .includes(:user, :identifier_scheme)
+ .where.not(identifier: nil)
+ .where.not(identifier: '')
+
+ Parallel.map(identifiers, in_threads: 8) do |ui|
+ # Parallel has trouble with ActiveRecord lazy loading
+ require "org" unless Object.const_defined?("Org")
+ require "identifier" unless Object.const_defined?("Identifier")
+ require "identifier_scheme" unless Object.const_defined?("IdentifierScheme")
+ @reconnected ||= Identifier.connection.reconnect! || true
+
+ lookup = Identifier.where(identifiable_id: ui.user_id,
+ identifiable_type: "User",
+ identifier_scheme: ui.identifier_scheme)
+ next if lookup.present?
+
+ Identifier.create(identifier_scheme: ui.identifier_scheme, attrs: {}.to_json,
+ identifiable: ui.user, value: ui.identifier)
+ end
+
+ count = Identifier.where(identifiable_type: "User").length
+ p "Transfer complete. Orginal user_identifier count #{identifiers.length}, new identifiers count #{count}"
+ if identifiers.length > count
+ p ""
+ p "#{identifiers.length - count} records could not be transferred."
+ p "This is typically due to the fact that the new identifiers table will automatically"
+ p "prepend the identifier_scheme.identifier_prefix to the value For example: "
+ p " '0000-0000-0000-0001' would become 'https://orcid.org/0000-0000-0000-0001'"
+ p "and your old user_identifiers table may have an entry for both versions"
+ end
+ end
+
+ desc "migrate the old org_identifiers over to the polymorphic identifiers table"
+ task convert_org_identifiers: :environment do
+ p "Transferring existing org_identifiers over to the identifiers table"
+ p "please wait ..."
+ identifiers = OrgIdentifier.joins(:org, :identifier_scheme)
+ .includes(:org, :identifier_scheme)
+ .where.not(identifier: nil)
+ .where.not(identifier: '')
+ .order(id: :desc)
+
+ Parallel.map(identifiers, in_threads: 8) do |oi|
+ # Parallel has trouble with ActiveRecord lazy loading
+ require "org" unless Object.const_defined?("Org")
+ require "identifier" unless Object.const_defined?("Identifier")
+ require "identifier_scheme" unless Object.const_defined?("IdentifierScheme")
+ @reconnected ||= Identifier.connection.reconnect! || true
+
+ lookup = Identifier.where(identifiable_id: oi.org_id,
+ identifiable_type: "Org",
+ identifier_scheme: oi.identifier_scheme)
+ next if lookup.present?
+
+ Identifier.create(identifier_scheme: oi.identifier_scheme, attrs: oi.attrs,
+ identifiable: oi.org, value: oi.identifier)
+ end
+ count = Identifier.where(identifiable_type: "Org").length
+ p "Transfer complete. Orginal org_identifier count #{identifiers.length}, new identifiers count #{count}"
+ if identifiers.length > count
+ p ""
+ p "#{identifiers.length - count} records could not be transferred. Run the following query manually to identify them:"
+ p " SELECT * FROM org_identifiers WHERE org_id NOT IN ("
+ p " SELECT identifiers.identifiable_id FROM identifiers "
+ p " WHERE identifiers.identifier_scheme_id = org_identifiers.identifier_scheme_id AND identifiable_type = 'Org'"
+ p " );"
+ p "Then transfer them manually."
+ end
+ end
+
+ desc "Sets the new managed flag for all existing Orgs to managed = true"
+ task default_orgs_to_managed: :environment do
+ Org.all.update_all(managed: true)
+ end
+
+ desc "retrieves ROR ids for each of the Orgs defined in the database"
+ task retrieve_ror_fundref_ids: :environment do
+ ror = IdentifierScheme.find_by(name: "ror")
+ fundref = IdentifierScheme.find_by(name: "fundref")
+
+ out = CSV.generate do |csv|
+ csv << %w[org_id org_name ror_name ror_id fundref_id]
+
+ if ExternalApis::RorService.ping
+ p "Scanning ROR for each of your existing Orgs"
+ p "The results will be written to tmp/ror_fundref_ids.csv to facilitate review and any corrections that may need to be made."
+ p "The CSV file contains the Org name stored in your DB next to the ROR org name that was matched. Use these 2 values to determine if the match was valid."
+ p "You can use the ROR search page to find the correct match for any organizations that need to be corrected: https://ror.org/search"
+ p ""
+ orgs = Org.includes(identifiers: :identifier_scheme)
+ .where(is_other: false).order(:name)
+
+ orgs.each do |org|
+ # If the Org already has a ROR identifier skip it
+ next if org.identifiers.select { |id| id.identifier_scheme_id == ror.id }.any?
+
+ # The abbreviation sometimes causes weird results so strip it off
+ # in this instance
+ org_name = org.name.gsub(" (#{org.abbreviation})", "")
+ rslts = OrgSelection::SearchService.search_externally(search_term: org_name)
+ next unless rslts.any?
+
+ # Just use the first match that contains the search term
+ rslt = rslts.select { |rslt| rslt[:weight] <= 1 }.first
+ next unless rslt.present?
+
+ ror_id = rslt[:ror]
+ fundref_id = rslt[:fundref]
+
+ if ror_id.present?
+ ror_ident = Identifier.find_or_initialize_by(identifiable: org,
+ identifier_scheme: ror)
+ ror_ident.value = "#{ror.identifier_prefix}#{ror_id}"
+ ror_ident.save
+ p " #{org.name} -> ROR: #{ror_ident.value}, #{rslt[:name]}"
+ end
+ if fundref_id.present?
+ fr_ident = Identifier.find_or_initialize_by(identifiable: org,
+ identifier_scheme: fundref)
+ fr_ident.value = "#{fundref.identifier_prefix}#{fundref_id}"
+ fr_ident.save
+ p " #{org.name} -> FUNDRF: #{fr_ident.value}, #{rslt[:name]}"
+ end
+
+ if ror_id.present? || fundref_id.present?
+ csv << [org.id, org.name, rslt[:name], ror_ident&.value, fr_ident&.value]
+ end
+ end
+ else
+ p "ROR appears to be offline or your configuration is invalid. Heartbeat check failed. Refer to the log for more information."
+ end
+ end
+
+ if out.present?
+ file = File.open("tmp/ror_fundref_ids.csv", "w")
+ file.puts out
+ file.close
+ end
+ end
+
+ desc "Attempts to migrate other_organisation entries to Orgs"
+ task migrate_other_organisation_to_org: :environment do
+ is_other = Org.find_by(is_other: true)
+ p "No is_other Org defined, so no orgs need to be created!" unless is_other.present?
+ return false unless is_other.present?
+
+ users = User.where(org: is_other)
+ p "Processing #{users.length} users attached to '#{is_other.name}' #{is_other.id}"
+ p "this may take more than 15 minutes depending on how many users are in your database"
+ # Unfortunately can't use the Parallel gem here because we can have collisions
+ # when creating Orgs
+ users.each do |user|
+ # First lookup by email domain
+ term = user.email.split("@").last
+
+ unless %w[gmail.com yahoo.com msn.com 126.com 163.com].include?(term)
+ # Search the local Org table by its URL
+ matches = Org.where("orgs.target_url LIKE ?", "%#{term}%")
+ org = matches.first if matches.any?
+
+ # by RorService if not already in the DB
+ unless org.present?
+ # Just use the host (e.g. 'rutgers' instead of 'rutgers.edu')
+ host = term.split('.').first
+ next unless host.length > 2
+
+ matches = OrgSelection::SearchService.search_externally(search_term: host)
+ # Only allow results that INCLUDE the search term in parenthesis
+ matches = matches.select do |result|
+ result[:weight] <= 1 && result[:name].include?("(#{term})")
+ end
+
+ org = OrgSelection::HashToOrgService.to_org(hash: matches.first, allow_create: true) if matches.any?
+ org = create_org(org, matches.first) if org.present?
+ end
+ end
+
+ # Otherwise lookup by other_organisation name
+ if !org.present? && user.other_organisation.present?
+ term = user.other_organisation
+ matches = OrgSelection::SearchService.search_externally(search_term: term)
+ # Only allow results that START WITH the search term
+ matches = matches.select { |result| result[:weight] == 0 }
+ org = OrgSelection::HashToOrgService.to_org(hash: matches.first, allow_create: true) if matches.any?
+ org = create_org(org, matches.first) if org.present? && org.valid?
+ end
+
+ # Otherwise create the Org
+ if org.nil? && user.other_organisation.present?
+ name = user.other_organisation
+ abbrev = OrgSelection::SearchService.name_without_alias(name: name)
+ .split(" ").map(&:first).join.upcase
+ org = Org.new(name: name, managed: false, is_other: false,
+ abbreviation: abbrev, language: Language.default)
+ org.save if org.present? && org.valid?
+ end
+
+ if org.present? && org.valid?
+ # Attach the user to the Org
+ p " User id: #{user.id} - #{user.email} attaching to org_id: #{org.id} - #{org.name}"
+ user.update(org_id: org.id)
+ end
+ end
+
+ final = User.where(org: is_other).length
+ p "Complete: #{users.length - final} users could not be processed. Left them attached to '#{is_other.name}'"
+ end
+
+ desc "migrates any data_contact/principal_investigator information from plans table to contributors"
+ task migrate_contributors: :environment do
+ orcid = IdentifierScheme.find_by(name: "orcid")
+
+ # Loop through the plans and convert the Data Contact, owners and PI
+ # into Contributors
+ plans = Plan.includes(:contributors, roles: :user).joins(roles: :user)
+
+ Parallel.map(plans, in_threads: 8) do |plan|
+ next if plan.contributors.any?
+ owner = plan.owner
+
+ # Either use the Data Contact specified on the plan
+ if plan.data_contact_email.present? || plan.data_contact.present?
+ contact, contact_id = to_contributor(plan, plan.data_contact,
+ plan.data_contact_email,
+ plan.data_contact_phone, nil, nil)
+
+ elsif owner.present?
+ contact, contact_id = to_contributor(plan, owner.name(false),
+ owner.email, nil, owner.identifier_for(orcid)&.first&.value, owner.org_id)
+ end
+ # Add the DMP Data Contact
+ if contact.present?
+ contact.save
+ contact.data_curation = true
+ contact.investigation = true if owner.present?
+ contact.save
+ contact_id.save if contact_id.present?
+ end
+
+ # Get the PI
+ pi, pi_id = to_contributor(plan, plan.principal_investigator,
+ plan.principal_investigator_email,
+ plan.principal_investigator_phone,
+ plan.principal_investigator_identifier, nil)
+ # Add the Principal Investigator
+ if pi.present?
+ pi.save
+ pi.investigation = true
+ pi.save
+ pi_id.save if pi_id.present?
+ end
+
+ # Add the authors
+ if owner.present? && owner == contact
+ user, id = to_contributor(plan, owner.name(false),
+ owner.email, nil, owner.identifier_for(orcid)&.first&.value, owner.org_id)
+
+ if user.present?
+ user.save
+ user.data_curation = true
+ user.save
+ id.save if id.present?
+ end
+ end
+
+ plan.reload
+ if plan.contributors.length > 0
+ p "Processed Plan #{plan.id} - which now has #{plan.contributors.length} contributor(s)"
+ end
+ end
+ end
+
+ desc "Attach Plans to their owner's Org and then back fill the Funder"
+ task migrate_plan_org_and_funder: :environment do
+ plans = Plan.includes(template: :org, roles: :user)
+ .joins(template: :org, roles: :user)
+
+ p "Attaching Plans to Orgs ... this can take in excess of 5 minutes depending on how many plans you have."
+ Parallel.map(plans, in_threads: 8) do |plan|
+ next if plan.org_id.present?
+
+ # Parallel has trouble with ActiveRecord lazy loading
+ require "plan" unless Object.const_defined?("Plan")
+ require "role" unless Object.const_defined?("Role")
+ require "perm" unless Object.const_defined?("Perm")
+ require "user" unless Object.const_defined?("User")
+ @reconnected ||= Plan.connection.reconnect! || true
+
+ next unless plan.owner.present? && plan.owner.org.present?
+
+ plan.update(org_id: plan.owner.org.id)
+ end
+
+ p "Attaching Plans to Funders"
+ Parallel.map(plans, in_threads: 8) do |plan|
+ next if plan.funder_id.present?
+
+ # Parallel has trouble with ActiveRecord lazy loading
+ require "plan" unless Object.const_defined?("Plan")
+ require "template" unless Object.const_defined?("Template")
+ require "org" unless Object.const_defined?("Org")
+ @reconnected ||= Plan.connection.reconnect! || true
+
+ next unless plan.funder_name.present? || plan.template.org.funder?
+
+ funder_id = plan.template.org.id if plan.template.org.funder?
+
+ if plan.funder_name.present? && !funder_id.present?
+ matches = OrgSelection::SearchService.search_externally(search_term: plan.funder_name)
+ # Only allow results that INCLUDE the search term in parenthesis
+ matches = matches.select do |result|
+ result[:weight] <= 1 && result[:name].include?("(#{plan.funder_name})")
+ end
+
+ org = OrgSelection::HashToOrgService.to_org(hash: matches.first, allow_create: true) if matches.any?
+ org = create_org(org, matches.first) if org.present? && org.valid?
+ funder_id = org.id if org.present?
+ end
+
+ plan.update(funder_id: funder_id) if funder_id.present?
+ end
+ p "Complete"
+ end
+
+ desc "Migrate the Plans grant_number to an Identifier"
+ task migrate_plan_grants: :environment do
+ plans = Plan.where.not(grant_number: nil).where.not(grant_number: "")
+
+ p "Converting Plan.grant_number into Identifiers"
+ #Parallel.map(plans, in_threads: 8) do |plan|
+ plans.each do |plan|
+ # Parallel has trouble with ActiveRecord lazy loading
+ require "plan" unless Object.const_defined?("Plan")
+ @reconnected ||= Plan.connection.reconnect! || true
+
+ identifier = Identifier.find_or_create_by(
+ identifier_scheme_id: nil, identifiable: plan, value: plan.grant_number
+ )
+ plan.update(grant_id: identifier.id)
+ end
+ p "Complete"
+ end
+
+ desc "Generate stats for all of the 2.2.0 upgrade scripts"
+ task results_2_2_0_part1: :environment do
+ ror = IdentifierScheme.find_by(name: "ror")
+ fundref = IdentifierScheme.find_by(name: "fundref")
+ org_identifiers_migrated = Identifier.where(identifiable_type: 'Org')
+ .where.not(identifier_scheme: [ror, fundref])
+ .count
+ user_identifiers_migrated = Identifier.where(identifiable_type: 'User')
+ .where.not(identifier_scheme: [ror, fundref])
+ .count
+ rors_added = Identifier.where(identifiable_type: 'Org', identifier_scheme: ror).count
+ fundrefs_added = Identifier.where(identifiable_type: 'Org', identifier_scheme: fundref).count
+
+ p "---------------------------------------------------------------"
+ p "Results of v2.2.0 part 1 upgrade:"
+ p " Added new IdentifierScheme: #{ror.id}, '#{ror.name}', '#{ror.description}'"
+ p " Added new IdentifierScheme: #{fundref.id}, '#{fundref.name}', '#{fundref.description}'"
+ p ""
+ p " Migrated #{number_with_delimiter(org_identifiers_migrated)} from org_identifiers to identifiers table."
+ p " Migrated #{number_with_delimiter(user_identifiers_migrated)} from user_identifiers to identifiers table."
+ p " NOTE: org_identifier and user_identifiers tables are being deprecated and will be dropped in a future release."
+ p ""
+ p " Assigned #{number_with_delimiter(rors_added)} ROR identifiers to your Orgs"
+ p " Assigned #{number_with_delimiter(fundrefs_added)} Crossref Funder identifiers to your Orgs"
+ p " NOTE: Please refer to the tmp/ror_fundref_ids.csv file to see how the assigment worked."
+ p " You should make any adjustments BEFORE running part 2 of the upgrade scripts!"
+ p " For example ROR sometimes incorrectly matches Orgs. For example:"
+ p " 'University of Somewhere' may match to 'Univerity of Somewhere - Medical Center'"
+ p " To correct any issues, please delete/insert/update the corresponding Identifier:"
+ p " delete from identifiers where identifiable_type = 'Org' and identifiable_id = [orgs.id];"
+ p " insert into identifiers (identifiable_type, identifier_scheme_id, attrs, identifiable_id, value) values ('Org', [identifier_scheme_id], '{}', [orgs.id], 'https://api.crossref.org/funders/0000000000');"
+ p " update identifiers set `value` = 'https://ror.org/123456789' where identifiable_id = [orgs.id] and identifier_scheme_id = [identifier_scheme_id] and identifiable_type= 'Org';"
+ p "---------------------------------------------------------------"
+ end
+
+ desc "Generate stats for all of the 2.2.0 upgrade scripts"
+ task results_2_2_0_part2: :environment do
+ ror = IdentifierScheme.find_by(name: "ror")
+ fundref = IdentifierScheme.find_by(name: "fundref")
+ is_other = Org.find_by(is_other: true)
+ unaffiliated = User.where(org_id: is_other.id).count
+ unmanaged_orgs = Org.where(managed: false).count
+ managed_orgs = Org.where(managed: true).count
+ contributors_converted = Contributor.all.count
+ orgs_converted = Plan.where.not(org_id: nil).count
+ funders_converted = Plan.where.not(funder_id: nil).count
+ grants_converted = Plan.where.not(grant_id: nil).count
+
+ p "---------------------------------------------------------------"
+ p "Results of v2.2.0 part 2 upgrade:"
+ p " Set #{number_with_delimiter(managed_orgs)} Orgs to 'managed: true' (all of your existing Orgs)"
+ p " The is_other Org is deprecated. Users will not be added to this old default Org in the future."
+ p " you should try to move any remaining users over to actual Orgs, this may require you to create "
+ p " a new Org and attach the user to it."
+ p " `SELECT id, email, other_organisation FROM users WHERE org_id = (SELECT orgs.id FROM orgs WHERE is_other = true);"
+ p " NOTE: all code that checks for `is_other` will instead check `managed` in future releases."
+ p ""
+ p " Added #{number_with_delimiter(unmanaged_orgs)} Orgs"
+ p " NOTE: These Orgs were created from the Funders listed in plans.funder_name and also by examining"
+ p " all of the users attached to the is_other Org (first checking the domain of the user's email"
+ p " address and then the text value stored in other_organisation)."
+ p " In the case of a User, the user was associated with that new Org"
+ p " Added #{number_with_delimiter(contributors_converted)} Contributor based on the old DataContact, PrincipalInvestigator and Plan Owner"
+ p " NOTE: the old data_contact and principal_investigator fields on the plans table are deprecated and will be removed in a future release."
+ p ""
+ p " Attached #{number_with_delimiter(orgs_converted)} Plans to an Org based on the Owner's Org"
+ p " Attached #{number_with_delimiter(funders_converted)} Plans to a Funder based on either the Template's Org (if it was a funder) or the name in funder_name field."
+ p " Migrate #{number_with_delimiter(grants_converted)} Plan grant_numbers to Identifiers"
+ p " NOTE: funder_name and grant_number fields on the plans table are deprecated and will be dropped in a future release"
+ p ""
+ p " #{number_with_delimiter(unaffiliated)} users are still associated with '#{is_other.name}' (is_other Org)."
+ p "---------------------------------------------------------------"
+ end
+
private
def fuzzy_match?(text_a, text_b, min = 3)
@@ -717,4 +1278,58 @@ namespace :upgrade do
end
end
+ # Converts the names, email and phone into a Contributor and an
+ # Identifier model
+ def to_contributor(plan, name, email, phone, identifier, org)
+ return nil, nil unless name.present? || email.present?
+
+ # If the name is not an array already split it up
+ orcid = IdentifierScheme.find_by(name: "orcid")
+
+ # If no Org and/or identifier were nil try to look them up in the User table
+ user = User.includes(:identifiers).where(email: email).first
+ if user.present?
+ org = user.org_id unless org.present?
+
+ unless identifier.present?
+ ident = user.identifiers.select { |i| i.identifier_scheme == orcid }.first
+ identifier = ident.value if ident.present?
+ end
+ end
+
+ contributor = Contributor.where("plan_id = ? AND (LOWER(email) = LOWER(?) OR LOWER(name) = LOWER(?))", plan.id, email, name).first
+ unless contributor.present?
+ contributor = Contributor.new(email: email, plan: plan)
+ contributor.name = name
+ contributor.phone = phone
+ contributor.org_id = org
+ end
+ return contributor, nil if identifier.nil?
+
+ # Get the ORCID id from the string
+ matched = identifier.match(/([0-9]{4}-?){4}/)
+ orcid_id = matched[0] if matched.present?
+ return contributor, nil unless orcid_id.present?
+
+ id = Identifier.find_or_initialize_by(identifiable: contributor,
+ identifier_scheme: orcid)
+ id.value = orcid_id
+ return contributor, id
+ end
+
+ def create_org(org, match)
+ org.save
+ OrgSelection::HashToOrgService.to_identifiers(hash: match).each do |identifier|
+ next unless identifier.value.present?
+
+ identifier.identifiable = org
+ identifier.save
+ end
+ org.reload
+ end
+
+ def number_with_delimiter(number)
+ number.to_s.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
+ end
+
end
diff --git a/package.json b/package.json
index b0e6f39257..7dcc7409d0 100644
--- a/package.json
+++ b/package.json
@@ -28,6 +28,7 @@
"bootstrap": "^4.1.3",
"bootstrap-3-typeahead": "^4.0.2",
"bootstrap-sass": "^3.3.7",
+ "bootstrap-select": "^1.13.10",
"chart.js": "^2.7.2",
"eslint": "^5.8.0",
"eslint-config-airbnb-base": "^13.1.0",
@@ -43,7 +44,7 @@
"number-to-text": "^0.3.5",
"rails-erb-loader": "^5.5.2",
"timeago.js": "4.0.0-beta.1",
- "tinymce": "^4.9.7",
+ "tinymce": "^4.9.10",
"webpack": "^3.12.0",
"webpack-manifest-plugin": "^2.0.4",
"webpack-merge": "3"
diff --git a/spec/controllers/concerns/org_selectable_spec.rb b/spec/controllers/concerns/org_selectable_spec.rb
new file mode 100644
index 0000000000..8577e27b5d
--- /dev/null
+++ b/spec/controllers/concerns/org_selectable_spec.rb
@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe OrgSelectable do
+
+ before(:each) do
+ class StubController < ApplicationController
+ include OrgSelectable
+ end
+
+ @controller = StubController.new
+
+ OrgSelection::HashToOrgService.stubs(:to_org).returns(build(:org))
+ OrgSelection::HashToOrgService.stubs(:to_identifiers)
+ .returns([build(:identifier)])
+
+ @params = ActionController::Parameters.new({
+ other_param: Faker::Company.name,
+ org_id: { id: Faker::Number.number, name: Faker::Company.name }.to_json,
+ org_name: Faker::Company.name,
+ org_sources: [Faker::Company.name],
+ org_crosswalk: [{ id: Faker::Number.number }]
+ })
+ end
+
+ after(:each) do
+ Object.send :remove_const, :StubController
+ end
+
+ context "private methods" do
+
+ describe "#org_from_params(params:)" do
+ it "returns nil if params[:org_id] is not present" do
+ expect(@controller.send(:org_from_params, params_in: {})).to eql(nil)
+ end
+ it "returns nil if the params[:org_id] could not be converted" do
+ @controller.stubs(:org_hash_from_params).returns({})
+ expect(@controller.send(:org_from_params, params_in: {})).to eql(nil)
+ end
+ it "returns an Org" do
+ rslt = @controller.send(:org_from_params, params_in: @params)
+ expect(rslt.is_a?(Org)).to eql(true)
+ end
+ end
+
+ describe "#identifiers_from_params(params:)" do
+ it "returns an empty array if params[:org_id] is not present" do
+ rslt = @controller.send(:identifiers_from_params, params_in: {})
+ expect(rslt).to eql([])
+ end
+ it "returns an empty array if params[:org_id] could not be converted" do
+ @controller.stubs(:org_hash_from_params).returns({})
+ rslt = @controller.send(:identifiers_from_params, params_in: {})
+ expect(rslt).to eql([])
+ end
+ it "returns an Array of identifiers" do
+ rslt = @controller.send(:identifiers_from_params, params_in: @params)
+ expect(rslt.is_a?(Array)).to eql(true)
+ expect(rslt.first.is_a?(Identifier)).to eql(true)
+ end
+ end
+
+ describe "#org_hash_from_params(params:)" do
+ it "returns an empty hash is there is a JSON parse error" do
+ JSON.expects(:parse).raises(JSON::ParserError)
+ rslt = @controller.send(:org_hash_from_params, params_in: @params)
+ expect(rslt).to eql({})
+ end
+ it "logs JSON parse error" do
+ JSON.expects(:parse).raises(JSON::ParserError)
+ Rails.logger.expects(:error).at_least(2)
+ @controller.send(:org_hash_from_params, params_in: @params)
+ end
+ it "returns the hash" do
+ rslt = @controller.send(:org_hash_from_params, params_in: @params)
+ expect(rslt).to eql(JSON.parse(@params[:org_id]))
+ end
+ end
+
+ describe "#remove_org_selection_params(params:)" do
+ before(:each) do
+ @rslt = @controller.send(:remove_org_selection_params,
+ params_in: @params)
+ end
+ it "removes the org_selector params" do
+ expect(@rslt[:org_id].present?).to eql(false)
+ expect(@rslt[:org_name].present?).to eql(false)
+ expect(@rslt[:org_sources].present?).to eql(false)
+ expect(@rslt[:org_crosswalk].present?).to eql(false)
+ end
+ it "does not remove other params" do
+ expect(@rslt[:other_param].present?).to eql(true)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/controllers/contributors_controller_spec.rb b/spec/controllers/contributors_controller_spec.rb
new file mode 100644
index 0000000000..9e37fe2b4a
--- /dev/null
+++ b/spec/controllers/contributors_controller_spec.rb
@@ -0,0 +1,207 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe ContributorsController, type: :controller do
+
+ before(:each) do
+ @scheme = create(:identifier_scheme, name: "orcid")
+ @org = create(:org, managed: true)
+ @plan = create(:plan, :creator, org: @org)
+ @user = @plan.owner
+ @contributor = create(:contributor, plan: @plan)
+
+ @params_hash = {
+ contributor: {
+ name: Faker::TvShows::Simpsons.character,
+ email: Faker::Internet.email,
+ phone: Faker::Number.number,
+ org_id: {
+ id: @org.id,
+ name: @org.name,
+ ror: Faker::Lorem.word
+ }.to_json,
+ identifiers_attributes: { "0": {
+ identifier_scheme_id: @scheme.id,
+ value: SecureRandom.uuid
+ }}
+ }
+ }
+ @roles = Contributor.new.all_roles
+ @roles.each { |role| @params_hash[:contributor][role.to_sym] = %w[0 1].sample }
+
+ @controller = described_class.new
+ end
+
+ context "actions" do
+ before(:each) do
+ sign_in(@user)
+ end
+
+ it "GET plans/:plan_id/contributors (:index)" do
+ get :index, plan_id: @plan.id
+ expect(response).to render_template(:index)
+ expect(assigns(:plan)).to eql(@plan)
+ expect(assigns(:contributors).length).to eql(1)
+ expect(assigns(:contributors).first).to eql(@contributor)
+ end
+
+ it "GET plans/:plan_id/contributors/new (:new)" do
+ get :new, plan_id: @plan.id
+ expect(response).to render_template(:new)
+ expect(assigns(:plan)).to eql(@plan)
+ expect(assigns(:contributor).new_record?).to eql(true)
+ expect(assigns(:contributor).plan).to eql(@plan)
+ end
+
+ it "GET plans/:plan_id/contributors/:id/edit (:edit)" do
+ get :edit, plan_id: @plan.id, id: @contributor.id
+ expect(response).to render_template(:edit)
+ expect(assigns(:plan)).to eql(@plan)
+ expect(assigns(:contributor)).to eql(@contributor)
+ end
+
+ it "POST plans/:plan_id/contributors (:create)" do
+ post :create, @params_hash.merge({ plan_id: @plan.id })
+ expect(response).to redirect_to(plan_contributors_url(@plan))
+ contrib = Contributor.last
+ params = @params_hash[:contributor]
+
+ # Verify that the plan was attached
+ expect(contrib.plan).to eql(@plan)
+
+ # Verify that the contributor fields were all saved
+ expect(contrib.name).to eql(params[:name])
+ expect(contrib.email).to eql(params[:email])
+ expect(contrib.phone).to eql(params[:phone].to_s)
+
+ # Verify that the corrrect roles were assigned
+ contrib.all_roles.each do |role|
+ expect(contrib.send(:"#{role}?")).to eql(params[:"#{role}"] == "1")
+ end
+
+ # Verify that the Org was attached
+ expect(contrib.org).to eql(@org)
+
+ # Verify that the ORCID was saved
+ expected = params[:identifiers_attributes][:"0"][:value]
+ expect(contrib.identifiers.first.identifier_scheme).to eql(@scheme)
+ expect(contrib.identifiers.first.value.ends_with?(expected)).to eql(true)
+ end
+
+ it "PUT plans/:plan_id/contributors/:id (:update)" do
+ put :update, @params_hash.merge({ plan_id: @plan.id, id: @contributor.id })
+ @contributor.reload
+ params = @params_hash[:contributor]
+
+ expect(response).to redirect_to(edit_plan_contributor_url(@plan, @contributor))
+
+ # Verify that the contributor fields were all saved
+ expect(@contributor.name).to eql(params[:name])
+ expect(@contributor.email).to eql(params[:email])
+ expect(@contributor.phone).to eql(params[:phone].to_s)
+
+ # Verify that the corrrect roles were assigned
+ @contributor.all_roles.each do |role|
+ expect(@contributor.send(:"#{role}?")).to eql(params[:"#{role}"] == "1")
+ end
+
+ # Verify that the Org was attached
+ expect(@contributor.org).to eql(@org)
+
+ # Verify that the ORCID was saved
+ expected = params[:identifiers_attributes][:"0"][:value]
+ expect(@contributor.identifiers.first.identifier_scheme).to eql(@scheme)
+ expect(@contributor.identifiers.first.value.ends_with?(expected)).to eql(true)
+ end
+
+ it "DELETE plans/:plan_id/contributors/:id (:destroy)" do
+ id = @contributor.id
+ delete :destroy, @params_hash.merge({ plan_id: @plan.id, id: @contributor.id })
+ expect(Contributor.where(id: id).any?).to eql(false)
+ end
+
+ end
+
+ context "private methods(hash:)" do
+
+ describe "#translate_roles" do
+ it "converts integer to boolean" do
+ roles = @controller.send(:translate_roles, hash: @params_hash[:contributor])
+ expect([true, false].include?(roles[@roles.first])).to eql(true)
+ end
+ it "leaves non-role integers alone" do
+ @params_hash[:contributor][:non_role] = "1"
+ roles = @controller.send(:translate_roles, hash: @params_hash[:contributor])
+ expect(roles[:non_role]).to eql("1")
+ end
+ end
+
+ describe "#process_org(hash:)" do
+ it "returns the hash as is if no :org_id is present" do
+ @params_hash[:contributor].delete(:org_id)
+ hash = @controller.send(:process_org, hash: @params_hash[:contributor])
+ expect(hash).to eql(@params_hash[:contributor])
+ end
+ it "returns the hash as is if the org could not be converted" do
+ @controller.stubs(:org_from_params).returns(nil)
+ hash = @controller.send(:process_org, hash: @params_hash[:contributor])
+ expect(hash).to eql(@params_hash[:contributor])
+ end
+ it "sets the org_id to the idea of the org" do
+ new_org = create(:org)
+ @controller.stubs(:org_from_params).returns(new_org)
+ hash = @controller.send(:process_org, hash: @params_hash[:contributor])
+ expect(hash[:org_id]).to eql(new_org.id)
+ end
+ end
+
+ context "callbacks" do
+
+ describe "#fetch_plan" do
+ it "assigns the plan instance variable" do
+ get :index, plan_id: @plan.id
+ expect(assigns(:plan)).to eql(@plan)
+ end
+ it "redirects to :root if no plan found" do
+ get :index, plan_id: 99999
+ expect(response).to have_http_status(:redirect)
+ expect(response).to redirect_to(root_url)
+ end
+ end
+
+ describe "#fetch_contributor" do
+ it "is not triggered on POST :create" do
+ described_class.any_instance.expects(:fetch_contributor).at_most(0)
+ post :create, @params_hash.merge({ plan_id: @plan.id })
+ end
+ it "is not triggered on GET :index" do
+ described_class.any_instance.expects(:fetch_contributor).at_most(0)
+ get :index, plan_id: @plan.id
+ end
+ it "is not triggered on GET :new" do
+ described_class.any_instance.expects(:fetch_contributor).at_most(0)
+ get :new, plan_id: @plan.id
+ end
+ it "assigns the contributor instance variable" do
+ get :edit, plan_id: @plan.id, id: @contributor.id
+ expect(assigns(:contributor)).to eql(@contributor)
+ end
+ it "redirects to :index if no contributor found" do
+ get :edit, plan_id: @plan.id, id: 99999
+ expect(response).to have_http_status(:redirect)
+ expect(response).to redirect_to(plan_contributors_url(@plan))
+ end
+ it "redirects to :index if contributor does not belong to the plan" do
+ contrib = create(:contributor, plan: create(:plan))
+ get :edit, plan_id: @plan.id, id: contrib.id
+ expect(response).to have_http_status(:redirect)
+ expect(response).to redirect_to(plan_contributors_url(@plan))
+ end
+ end
+
+ end
+
+ end
+
+end
diff --git a/spec/controllers/orgs_controller_spec.rb b/spec/controllers/orgs_controller_spec.rb
new file mode 100644
index 0000000000..79b4426ca0
--- /dev/null
+++ b/spec/controllers/orgs_controller_spec.rb
@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe OrgsController, type: :controller do
+
+ before(:each) do
+ uri = URI.parse(Faker::Internet.url)
+ @name = Faker::Company.name
+
+ hash = {
+ id: uri.to_s,
+ name: "#{@name} (#{uri.host})",
+ sort_name: @name,
+ score: 0,
+ weight: 1
+ }
+ OrgSelection::SearchService.stubs(:search_locally).returns([hash])
+ OrgSelection::SearchService.stubs(:search_externally).returns([hash])
+ OrgSelection::SearchService.stubs(:search_combined).returns([hash])
+ end
+
+ describe "POST /search" do
+
+ it "returns an empty array if the search term is blank" do
+ post :search, org: { name: "" }, format: :js
+ expect(JSON.parse(response.body)).to eql([])
+ end
+
+ it "returns an empty array if the search term is less than 3 characters" do
+ post :search, org: { name: "Fo" }, format: :js
+ expect(JSON.parse(response.body)).to eql([])
+ end
+
+ it 'assigns the orgs variable' do
+ post :search, org: { name: Faker::Lorem.sentence }, format: :js
+ json = JSON.parse(response.body)
+ expect(json.length).to eql(1)
+ expect(json.first["sort_name"]).to eql(@name)
+ end
+
+ it "calls search_locally by default" do
+ OrgSelection::SearchService.expects(:search_locally).at_least(1)
+ post :search, org: { name: Faker::Lorem.sentence }, format: :js
+ end
+
+ it "calls search_externally when query string contains type=external" do
+ OrgSelection::SearchService.expects(:search_externally).at_least(1)
+ post :search, org: { name: Faker::Lorem.sentence }, type: "external",
+ format: :js
+ end
+
+ it "calls search_combined when query string contains type=combined" do
+ OrgSelection::SearchService.expects(:search_combined).at_least(1)
+ post :search, org: { name: Faker::Lorem.sentence }, type: "combined",
+ format: :js
+ end
+ end
+
+end
diff --git a/spec/controllers/registrations_controller_spec.rb b/spec/controllers/registrations_controller_spec.rb
new file mode 100644
index 0000000000..bf2a6f9a3f
--- /dev/null
+++ b/spec/controllers/registrations_controller_spec.rb
@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe RegistrationsController, type: :controller do
+
+ before(:each) do
+ @org = create(:org, is_other: false)
+ @user = create(:user, org: @org)
+ end
+
+ context "private methods" do
+
+ before(:each) do
+ @controller = described_class.new
+ end
+
+ describe "#handle_org(attrs:)" do
+
+ before(:each) do
+ @params = ActionController::Parameters.new({
+ org_id: {
+ id: @org.id.to_s,
+ name: Faker::Lorem.word,
+ ror: Faker::Lorem.word
+ }
+ })
+ @user = build(:user)
+
+ @controller.stubs(:org_from_params).returns(build(:org))
+ end
+
+ it "returns nil if the params are not present" do
+ rslt = @controller.send(:handle_org, attrs: nil)
+ expect(rslt).to eql(nil)
+ end
+ it "returns the params if the params[:org_id] is not present" do
+ rslt = @controller.send(:handle_org, attrs: {})
+ expect(rslt).to eql({})
+ end
+ it "saved the org if it was a new record" do
+ count = Org.all.length
+ @controller.stubs(:org_from_params).returns(create(:org))
+ @controller.send(:handle_org, attrs: @params)
+ expect(Org.all.length).to eql(count + 1)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/controllers/usage_controller_spec.rb b/spec/controllers/usage_controller_spec.rb
index a9ac495d60..7b87713b42 100644
--- a/spec/controllers/usage_controller_spec.rb
+++ b/spec/controllers/usage_controller_spec.rb
@@ -73,46 +73,6 @@
end
end
- describe "POST /usage_filter" do
- before(:each) do
- @date2 = Date.today.months_ago(3).end_of_month.strftime("%Y-%m-%d")
- @user_stat2 = create(:stat_joined_user, date: @date2, org: @org)
- @plan_stat2 = create(:stat_created_plan, date: @date2, org: @org, details: @details)
- end
-
- context "date range specified" do
- before(:each) do
- @args = {
- start_date: Date.today.months_ago(3).strftime("%Y-%m-%d"),
- end_date: @date2
- }
- end
- it "returns the correct values for users" do
- post :filter, usage: @args.merge({ topic: "users" }), format: :js
- expect(assigns(:ranged)).to eql(@user_stat2.count)
- expect(assigns(:total)).to eql(@user_stat2.count + @user_stat.count)
- end
- it "returns the correct values for plans" do
- post :filter, usage: @args.merge({ topic: "plans" }), format: :js
- expect(assigns(:ranged)).to eql(@plan_stat2.count)
- expect(assigns(:total)).to eql(@plan_stat2.count + @plan_stat.count)
- end
- end
-
- context "no date range specified" do
- it "returns the correct values for users" do
- post :filter, usage: { topic: "users" }, format: :js
- expect(assigns(:ranged)).to eql(@user_stat2.count + @user_stat.count)
- expect(assigns(:total)).to eql(@user_stat2.count + @user_stat.count)
- end
- it "returns the correct values for plans" do
- post :filter, usage: { topic: "plans" }, format: :js
- expect(assigns(:ranged)).to eql(@plan_stat2.count + @plan_stat.count)
- expect(assigns(:total)).to eql(@plan_stat2.count + @plan_stat.count)
- end
- end
- end
-
describe "GET /usage_yearly_users" do
before(:each) do
get :yearly_users
diff --git a/spec/factories/annotations.rb b/spec/factories/annotations.rb
index 37fce14fe6..519ac954ad 100644
--- a/spec/factories/annotations.rb
+++ b/spec/factories/annotations.rb
@@ -13,6 +13,7 @@
#
# Indexes
#
+# fk_rails_aca7521f72 (org_id)
# index_annotations_on_question_id (question_id)
# index_annotations_on_versionable_id (versionable_id)
#
diff --git a/spec/factories/answers.rb b/spec/factories/answers.rb
index fafe4822dd..4dacb9de97 100644
--- a/spec/factories/answers.rb
+++ b/spec/factories/answers.rb
@@ -7,13 +7,16 @@
# text :text
# created_at :datetime
# updated_at :datetime
-# label_id :string
+# label_id :string(255)
# plan_id :integer
# question_id :integer
# user_id :integer
#
# Indexes
#
+# fk_rails_3d5ed4418f (question_id)
+# fk_rails_584be190c2 (user_id)
+# fk_rails_84a6005a3e (plan_id)
# index_answers_on_plan_id (plan_id)
# index_answers_on_question_id (question_id)
#
diff --git a/spec/factories/api_clients.rb b/spec/factories/api_clients.rb
new file mode 100644
index 0000000000..1d1d30d696
--- /dev/null
+++ b/spec/factories/api_clients.rb
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: api_clients
+#
+# id :integer not null, primary key
+# name :string, not null
+# homepage :string
+# contact_name :string
+# contact_email :string, not null
+# client_id :string, not null
+# client_secret :string, not null
+# last_access :datetime
+# created_at :datetime
+# updated_at :datetime
+#
+# Indexes
+#
+# index_api_clients_on_name (name)
+#
+
+FactoryBot.define do
+ factory :api_client do
+ name { Faker::Lorem.unique.word }
+ homepage { Faker::Internet.url }
+ contact_name { Faker::Movies::StarWars.character }
+ contact_email { Faker::Internet.email }
+ client_id { SecureRandom.uuid }
+ client_secret { SecureRandom.uuid }
+ end
+end
diff --git a/spec/factories/conditions.rb b/spec/factories/conditions.rb
new file mode 100644
index 0000000000..06f0ffcc4c
--- /dev/null
+++ b/spec/factories/conditions.rb
@@ -0,0 +1,30 @@
+# == Schema Information
+#
+# Table name: conditions
+#
+# id :integer not null, primary key
+# question_id :integer
+# number :integer
+# action_type :integer
+# option_list :text
+# remove_data :text
+# webhook_data :text
+# created_at :datetime not null
+# updated_at :datetime not null
+#
+# Indexes
+#
+# index_conditions_on_question_id (question_id)
+#
+# Foreign Keys
+#
+# fk_rails_... (question_id => question.id)
+#
+#
+
+FactoryBot.define do
+ factory :condition do
+ option_list { nil }
+ remove_data { nil }
+ end
+end
diff --git a/spec/factories/contributors.rb b/spec/factories/contributors.rb
new file mode 100644
index 0000000000..7af1a6b0de
--- /dev/null
+++ b/spec/factories/contributors.rb
@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: contributors
+#
+# id :integer not null, primary key
+# name :string
+# email :string
+# phone :string
+# roles :integer
+# org_id :integer
+# plan_id :integer
+# created_at :datetime
+# updated_at :datetime
+#
+# Indexes
+#
+# index_contributors_on_id (id)
+# index_contributors_on_email (email)
+# index_contributors_on_org_id (org_id)
+#
+# Foreign Keys
+#
+# fk_rails_... (org_id => orgs.id)
+# fk_rails_... (plan_id => plans.id)
+
+FactoryBot.define do
+ factory :contributor do
+ org
+ name { Faker::Movies::StarWars.character }
+ email { Faker::Internet.email }
+ phone { Faker::PhoneNumber.phone_number_with_country_code }
+
+ transient do
+ roles_count { 1 }
+ end
+
+ before(:create) do |contributor, evaluator|
+ (0..evaluator.roles_count - 1).each do |idx|
+ contributor.send(:"#{contributor.all_roles[idx]}=", true)
+ end
+ end
+ end
+end
diff --git a/spec/factories/exported_plans.rb b/spec/factories/exported_plans.rb
index d1a1c22955..4e5163f9f6 100644
--- a/spec/factories/exported_plans.rb
+++ b/spec/factories/exported_plans.rb
@@ -13,9 +13,6 @@
FactoryBot.define do
factory :exported_plan do
- user
- plan
- phase_id { create(:phase).id }
- format { ExportedPlan::VALID_FORMATS.sample }
+ format { %w[csv txt docx pdf xml].sample }
end
end
diff --git a/spec/factories/identifier_schemes.rb b/spec/factories/identifier_schemes.rb
index b6e7e3285a..c308c155d7 100644
--- a/spec/factories/identifier_schemes.rb
+++ b/spec/factories/identifier_schemes.rb
@@ -2,14 +2,15 @@
#
# Table name: identifier_schemes
#
-# id :integer not null, primary key
-# active :boolean
-# description :string
-# logo_url :string
-# name :string
-# user_landing_url :string
-# created_at :datetime
-# updated_at :datetime
+# id :integer not null, primary key
+# active :boolean
+# description :string
+# context :integer
+# logo_url :text
+# name :string
+# identifier_prefix :string
+# created_at :datetime
+# updated_at :datetime
#
FactoryBot.define do
@@ -17,7 +18,17 @@
name { Faker::Company.unique.name[0..29] }
description { Faker::Movies::StarWars.quote }
logo_url { Faker::Internet.url }
- user_landing_url { Faker::Internet.url }
+ identifier_prefix { "#{Faker::Internet.url}/" }
active { true }
+
+ transient do
+ context_count { 1 }
+ end
+
+ after(:create) do |identifier_scheme, evaluator|
+ (0..evaluator.context_count - 1).each do |idx|
+ identifier_scheme.update("#{identifier_scheme.all_context[idx]}": true)
+ end
+ end
end
end
diff --git a/spec/factories/identifiers.rb b/spec/factories/identifiers.rb
new file mode 100644
index 0000000000..49d4a1b832
--- /dev/null
+++ b/spec/factories/identifiers.rb
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: identifiers
+#
+# id :integer not null, primary key
+# attrs :text
+# identifiable_type :string
+# value :string not null
+# created_at :datetime
+# updated_at :datetime
+# identifiable_id :integer
+# identifier_scheme_id :integer not null
+#
+# Indexes
+#
+# index_identifiers_on_identifiable_type_and_identifiable_id (identifiable_type,identifiable_id)
+#
+
+FactoryBot.define do
+ factory :identifier do
+ identifier_scheme
+ for_user
+
+ value { Faker::Lorem.word }
+ attrs { {} }
+
+ trait :for_plan do
+ association :identifiable, factory: :plan
+ end
+ trait :for_org do
+ association :identifiable, factory: :org
+ end
+ trait :for_user do
+ association :identifiable, factory: :user
+ end
+ end
+end
diff --git a/spec/factories/languages.rb b/spec/factories/languages.rb
index 6776c23eb6..99f477d6c5 100644
--- a/spec/factories/languages.rb
+++ b/spec/factories/languages.rb
@@ -11,9 +11,9 @@
FactoryBot.define do
factory :language do
- name { Faker::Language.name }
+ name { Faker::Language.unique.name }
description { "Language for #{name}" }
- abbreviation { Faker::Language.abbreviation }
+ abbreviation { Faker::Language.unique.abbreviation }
default_language { false }
trait :with_dialect do
abbreviation {
diff --git a/spec/factories/notes.rb b/spec/factories/notes.rb
index 5336a3dfd8..0318411976 100644
--- a/spec/factories/notes.rb
+++ b/spec/factories/notes.rb
@@ -13,6 +13,7 @@
#
# Indexes
#
+# fk_rails_7f2323ad43 (user_id)
# index_notes_on_answer_id (answer_id)
#
# Foreign Keys
diff --git a/spec/factories/notifications.rb b/spec/factories/notifications.rb
index 1cacc6ebbd..c50df7fae8 100644
--- a/spec/factories/notifications.rb
+++ b/spec/factories/notifications.rb
@@ -10,6 +10,7 @@
# notification_type :integer
# starts_at :date
# title :string
+# enable :boolean
# created_at :datetime not null
# updated_at :datetime not null
#
@@ -22,10 +23,12 @@
body { Faker::Lorem.paragraph }
dismissable { false }
starts_at { Time.current }
+ enabled { false }
expires_at { starts_at + 2.days }
trait :active do
starts_at { Date.today }
+ enabled { true }
end
trait :dismissable do
dismissable { true }
diff --git a/spec/factories/org_identifiers.rb b/spec/factories/org_identifiers.rb
deleted file mode 100644
index dbfafef825..0000000000
--- a/spec/factories/org_identifiers.rb
+++ /dev/null
@@ -1,26 +0,0 @@
-# == Schema Information
-#
-# Table name: org_identifiers
-#
-# id :integer not null, primary key
-# attrs :string
-# identifier :string
-# created_at :datetime
-# updated_at :datetime
-# identifier_scheme_id :integer
-# org_id :integer
-#
-# Foreign Keys
-#
-# fk_rails_... (identifier_scheme_id => identifier_schemes.id)
-# fk_rails_... (org_id => orgs.id)
-#
-
-FactoryBot.define do
- factory :org_identifier do
- identifier { Faker::Lorem.word }
- attrs { Hash.new }
- org
- identifier_scheme
- end
-end
diff --git a/spec/factories/orgs.rb b/spec/factories/orgs.rb
index 4f164583ab..ad20015270 100644
--- a/spec/factories/orgs.rb
+++ b/spec/factories/orgs.rb
@@ -13,6 +13,7 @@
# links :text
# logo_name :string
# logo_uid :string
+# managed :boolean default(FALSE), not null
# name :string
# org_type :integer default(0), not null
# sort_name :string
@@ -20,12 +21,14 @@
# created_at :datetime not null
# updated_at :datetime not null
# language_id :integer
-# region_id :integer
+#
+# Indexes
+#
+# fk_rails_5640112cab (language_id)
#
# Foreign Keys
#
# fk_rails_... (language_id => languages.id)
-# fk_rails_... (region_id => regions.id)
#
FactoryBot.define do
@@ -42,6 +45,7 @@
is_other { false }
contact_email { Faker::Internet.safe_email }
contact_name { Faker::Name.name }
+ managed { true }
trait :institution do
institution { true }
end
@@ -63,10 +67,12 @@
transient do
templates { 0 }
+ plans { 0 }
end
after :create do |org, evaluator|
create_list(:template, evaluator.templates, :published, org: org)
+ create_list(:plan, evaluator.plans)
end
# ----------------------------------------------------
@@ -75,8 +81,8 @@
trait :shibbolized do
after :create do |org, evaluator|
scheme = IdentifierScheme.find_or_create_by(name: "shibboleth")
- create(:org_identifier, org_id: org.id, identifier_scheme: scheme,
- identifier: SecureRandom.hex(4))
+ create(:identifier, identifiable: org, identifier_scheme: scheme,
+ value: SecureRandom.hex(4))
end
end
# ----------------------------------------------------
@@ -84,5 +90,3 @@
# ----------------------------------------------------
end
end
-
-
diff --git a/spec/factories/plans.rb b/spec/factories/plans.rb
index ca51a56a69..a41be4838a 100644
--- a/spec/factories/plans.rb
+++ b/spec/factories/plans.rb
@@ -21,29 +21,45 @@
# created_at :datetime
# updated_at :datetime
# template_id :integer
+# org_id :integer
+# funder_id :integer
+# grant_id :integer
+# api_client_id :integer
#
# Indexes
#
-# index_plans_on_template_id (template_id)
+# index_plans_on_template_id (template_id)
+# index_plans_on_funder_id (funder_id)
+# index_plans_on_grant_id (grant_id)
+# index_plans_on_api_client_id (api_client_id)
#
# Foreign Keys
#
# fk_rails_... (template_id => templates.id)
+# fk_rails_... (org_id => orgs.id)
#
FactoryBot.define do
factory :plan do
title { Faker::Company.bs }
template
+ org
+ # TODO: Drop this column once the funder_id has been back filled
+ # and we're removing the is_other org stuff
grant_number { SecureRandom.rand(1_000) }
identifier { SecureRandom.hex }
description { Faker::Lorem.paragraph }
principal_investigator { Faker::Name.name }
+ # TODO: Drop this column once the funder_id has been back filled
+ # and we're removing the is_other org stuff
funder_name { Faker::Company.name }
data_contact_email { Faker::Internet.safe_email }
principal_investigator_email { Faker::Internet.safe_email }
feedback_requested { false }
complete { false }
+ start_date { Time.now }
+ end_date { start_date + 2.years }
+
transient do
phases { 0 }
answers { 0 }
diff --git a/spec/factories/questions.rb b/spec/factories/questions.rb
index 074de3cced..c846f0f44a 100644
--- a/spec/factories/questions.rb
+++ b/spec/factories/questions.rb
@@ -16,6 +16,7 @@
#
# Indexes
#
+# fk_rails_4fbc38c8c7 (question_format_id)
# index_questions_on_section_id (section_id)
# index_questions_on_versionable_id (versionable_id)
#
diff --git a/spec/factories/regions.rb b/spec/factories/regions.rb
index 99a62996e4..ae3740b08b 100644
--- a/spec/factories/regions.rb
+++ b/spec/factories/regions.rb
@@ -2,11 +2,12 @@
#
# Table name: regions
#
-# id :integer not null, primary key
-# abbreviation :string
-# description :string
-# name :string
-# super_region_id :integer
+# id :integer not null, primary key
+# abbreviation :string
+# description :string
+# name :string not null
+# created_at :datetime not null
+# updated_at :datetime not null
#
FactoryBot.define do
diff --git a/spec/factories/splash_logs.rb b/spec/factories/splash_logs.rb
deleted file mode 100644
index 816a8543aa..0000000000
--- a/spec/factories/splash_logs.rb
+++ /dev/null
@@ -1,15 +0,0 @@
-# == Schema Information
-#
-# Table name: splash_logs
-#
-# id :integer not null, primary key
-# destination :string
-# created_at :datetime not null
-# updated_at :datetime not null
-#
-
-FactoryBot.define do
- factory :splash_log do
-
- end
-end
diff --git a/spec/factories/stat_created_plan.rb b/spec/factories/stat_created_plan.rb
index 831f9a0c59..e57e2103b1 100644
--- a/spec/factories/stat_created_plan.rb
+++ b/spec/factories/stat_created_plan.rb
@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: stats
+#
+# id :integer not null, primary key
+# count :integer default(0)
+# date :date not null
+# details :text
+# type :string not null
+# created_at :datetime not null
+# updated_at :datetime not null
+# org_id :integer
+#
+
FactoryBot.define do
factory :stat_created_plan do
date { Date.today }
diff --git a/spec/factories/stat_joined_user.rb b/spec/factories/stat_joined_user.rb
index f53cb948d5..f645ad862d 100644
--- a/spec/factories/stat_joined_user.rb
+++ b/spec/factories/stat_joined_user.rb
@@ -1,3 +1,19 @@
+# frozen_string_literal: true
+
+# == Schema Information
+#
+# Table name: stats
+#
+# id :integer not null, primary key
+# count :integer default(0)
+# date :date not null
+# details :text
+# type :string not null
+# created_at :datetime not null
+# updated_at :datetime not null
+# org_id :integer
+#
+
FactoryBot.define do
factory :stat_joined_user do
date { Date.today }
diff --git a/spec/factories/trackers.rb b/spec/factories/trackers.rb
new file mode 100644
index 0000000000..9897d59ab1
--- /dev/null
+++ b/spec/factories/trackers.rb
@@ -0,0 +1,6 @@
+FactoryBot.define do
+ factory :tracker do
+ org { nil }
+ code { "MyString" }
+ end
+end
diff --git a/spec/factories/user_identifiers.rb b/spec/factories/user_identifiers.rb
deleted file mode 100644
index d338189aac..0000000000
--- a/spec/factories/user_identifiers.rb
+++ /dev/null
@@ -1,28 +0,0 @@
-# == Schema Information
-#
-# Table name: user_identifiers
-#
-# id :integer not null, primary key
-# identifier :string
-# created_at :datetime
-# updated_at :datetime
-# identifier_scheme_id :integer
-# user_id :integer
-#
-# Indexes
-#
-# index_user_identifiers_on_user_id (user_id)
-#
-# Foreign Keys
-#
-# fk_rails_... (identifier_scheme_id => identifier_schemes.id)
-# fk_rails_... (user_id => users.id)
-#
-
-FactoryBot.define do
- factory :user_identifier do
- identifier { SecureRandom.hex }
- user
- identifier_scheme
- end
-end
diff --git a/spec/factories/users.rb b/spec/factories/users.rb
index 995add1a72..1cdc603bc9 100644
--- a/spec/factories/users.rb
+++ b/spec/factories/users.rb
@@ -41,7 +41,9 @@
#
# Indexes
#
-# index_users_on_email (email) UNIQUE
+# fk_rails_45f4f12508 (language_id)
+# fk_rails_f29bf9cdf2 (department_id)
+# index_users_on_email (email)
# index_users_on_org_id (org_id)
#
# Foreign Keys
@@ -81,6 +83,7 @@
after(:create) do |user, evaluator|
%w[modify_templates modify_guidance
change_org_details
+ use_api
grant_permissions].each do |perm_name|
user.perms << Perm.find_or_create_by(name: perm_name)
end
diff --git a/spec/features/feedback_requests_spec.rb b/spec/features/feedback_requests_spec.rb
index 69b0ed7f1c..4c70523d0e 100644
--- a/spec/features/feedback_requests_spec.rb
+++ b/spec/features/feedback_requests_spec.rb
@@ -2,6 +2,8 @@
RSpec.describe "FeedbackRequests", type: :feature do
+ include Webmocks
+
let!(:plan) { create(:plan, :organisationally_visible) }
let!(:org) do
@@ -15,6 +17,7 @@
plan.roles << create(:role, :commenter, :creator, :editor, :administrator, user: user)
sign_in(user)
ActionMailer::Base.deliveries = []
+ stub_openaire
end
after do
diff --git a/spec/features/plans_spec.rb b/spec/features/plans_spec.rb
index eaf307472d..3b5ea84eda 100644
--- a/spec/features/plans_spec.rb
+++ b/spec/features/plans_spec.rb
@@ -12,6 +12,7 @@
@user = create(:user, org: @org)
sign_in(@user)
+=begin
OpenURI.expects(:open_uri).returns(<<~XML
@@ -25,26 +26,22 @@
XML
)
-
+=end
end
scenario "User creates a new Plan", :js do
+# TODO: Revisit this after we start refactoring/building out or tests for
+# the new create plan workflow. For some reason the plans/new.js isn't
+# firing here but works fine in the UI with manual testing
+=begin
# Action
click_link "Create plan"
fill_in :plan_title, with: "My test plan"
- fill_in :plan_org_name, with: @research_org.name
+ fill_in :org_org_name, with: @research_org.name
+ choose_suggestion(@research_org.name)
- # --------------------------------------------------------
- # Start DMPTool Customization
- # --------------------------------------------------------
- #find('#suggestion-2-0').click
- #fill_in :plan_funder_name, with: @funding_org.name
- #find('#suggestion-3-0').click
- find('#suggestion-1-0').click
- fill_in :plan_funder_name, with: @funding_org.name
- # --------------------------------------------------------
- # End DMPTool Customization
- # --------------------------------------------------------
+ fill_in :funder_org_name, with: @funding_org.name
+ choose_suggestion(@funding_org.name)
click_button "Create plan"
# Expectations
@@ -82,7 +79,8 @@
expect(current_path).to eql(overview_plan_path(@plan))
expect(@plan.title).to eql("My test plan")
- expect(@plan.funder_name).to eql(@funding_org.name)
+ expect(@plan.org_id).to eql(@research_org.id)
+ expect(@plan.funder_id).to eql(@funding_org.id)
expect(@plan.grant_number).to eql("115797")
expect(@plan.description).to eql("Plan abstract...")
expect(@plan.identifier).to eql("ABCDEF")
@@ -101,6 +99,7 @@
# --------------------------------------------------------
expect(@plan.principal_investigator_email).to eql(@user.email)
expect(@plan.principal_investigator_phone).to eql("07787 000 0000")
+=end
end
end
diff --git a/spec/features/registrations_spec.rb b/spec/features/registrations_spec.rb
index 0cbdfe944b..0e8ec60ee0 100644
--- a/spec/features/registrations_spec.rb
+++ b/spec/features/registrations_spec.rb
@@ -25,6 +25,10 @@
password: "testing123",
email: "john.doe@testing-dmproadmap.org"
} }
+
+ before(:each) do
+ mock_blog
+ end
# -------------------------------------------------------------
# end DMPTool customization
# -------------------------------------------------------------
@@ -51,20 +55,7 @@
fill_in "First Name", with: user_attributes[:firstname]
fill_in "Last Name", with: user_attributes[:surname]
fill_in "Email", with: user_attributes[:email]
-
- # -------------------------------------------------------------
- # start DMPTool customization
- # We do not allow users to select an org
- # For some reason Chrome headless is triggering a:
- # 'Please include a '@' character' message sometimes
- # -------------------------------------------------------------
- #fill_in "Organisation", with: org.name
- ## Click from the dropdown autocomplete
- #find("#suggestion-1-0").click
- # -------------------------------------------------------------
- # end DMPTool customization
- # -------------------------------------------------------------
-
+ select_an_org("#new_user_org_name", org)
fill_in "Password", with: user_attributes[:password]
check "Show password"
check "I accept the terms and conditions"
@@ -103,18 +94,7 @@
fill_in "First Name", with: user_attributes[:firstname]
fill_in "Last Name", with: user_attributes[:surname]
fill_in "Email", with: "invalid-email"
-
- # -------------------------------------------------------------
- # start DMPTool customization
- # We do not allow users to select an org
- # -------------------------------------------------------------
- #fill_in "Organisation", with: org.name
- ## Click from the dropdown autocomplete
- #find("#suggestion-1-0").click
- # -------------------------------------------------------------
- # end DMPTool customization
- # -------------------------------------------------------------
-
+ select_an_org("#new_user_org_name", org)
fill_in "Password", with: user_attributes[:password]
check "Show password"
check "I accept the terms and conditions"
@@ -126,4 +106,4 @@
expect(User.count).to be_zero
end
-end
\ No newline at end of file
+end
diff --git a/spec/features/sessions_spec.rb b/spec/features/sessions_spec.rb
index 11d569a6d1..a08f70f43a 100644
--- a/spec/features/sessions_spec.rb
+++ b/spec/features/sessions_spec.rb
@@ -7,6 +7,10 @@
# Initialize the is_other org
# -------------------------------------------------------------
include DmptoolHelper
+
+ before(:each) do
+ mock_blog
+ end
# -------------------------------------------------------------
# end DMPTool customization
# -------------------------------------------------------------
@@ -62,46 +66,4 @@
expect(page).to have_text("Error")
end
- # -------------------------------------------------------------
- # start DMPTool customization
- # Shibboleth sign in
- # -------------------------------------------------------------
- scenario "User is redirected to Shibboleth Login for a shibbolized org", :js do
- generate_shibbolized_orgs(12)
- org = Org.participating.first
-
- # Setup
- visit root_path
- access_shib_ds_modal
- find("#shib-ds_org_name").set(org.name)
- sleep(0.2)
- ## Click from the dropdown autocomplete
- find("#suggestion-1-0").click
- #click_button "Go"
- click_link "See the full list of participating institutions"
- first("a[href^=\"/orgs/shibboleth/\"]").click
- expect(current_path).to eql("/Shibboleth.sso/Login")
- end
-
- scenario "User is shown the Org's custom sign in page for non-shibbolized Orgs", :js do
- org = create(:org, is_other: false)
- generate_shibbolized_orgs(10)
-
- # Setup
- visit root_path
- access_shib_ds_modal
- find("#shib-ds_org_name").set(org.name)
- sleep(0.2)
- ## Click from the dropdown autocomplete
- find("#suggestion-1-0").click
- #click_button "Go"
- click_link "See the full list of participating institutions"
- first("a[href^=\"/org_logos/\"]").click
-
- expect(find(".branding-name").present?).to eql(true)
- end
- # -------------------------------------------------------------
- # end DMPTool customization
- # -------------------------------------------------------------
-
end
diff --git a/spec/features/super_admins/org_swaps_spec.rb b/spec/features/super_admins/org_swaps_spec.rb
index 20c13c4a0b..9c33600fbc 100644
--- a/spec/features/super_admins/org_swaps_spec.rb
+++ b/spec/features/super_admins/org_swaps_spec.rb
@@ -19,7 +19,7 @@
sign_in(@user)
click_link "Admin"
click_link "Templates"
- find('[aria-describedby="label-id-superadmin_user_org_name"]').click
+ find("#superadmin_user_org_name").click
fill_in(:superadmin_user_org_name, with: @org2.name[0..4])
choose_suggestion(@org2.name)
click_button "Change affiliation"
diff --git a/spec/mixins/dmptool/controller/home_spec.rb b/spec/mixins/dmptool/controller/home_spec.rb
deleted file mode 100644
index bfefe2373f..0000000000
--- a/spec/mixins/dmptool/controller/home_spec.rb
+++ /dev/null
@@ -1,67 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe 'DMPTool custom home page', type: :request do
-
- describe '#render_home_page' do
-
- context 'statistics' do
-
- let!(:other_org) { create(:org, is_other: true) }
-
- it 'has the correct number of users' do
- (0..4).each { create(:user, org: other_org) }
- get root_path
- expect(assigns(:stats)[:user_count]).to eql(5)
- end
-
- it 'has the correct number of plans' do
- (0..4).each { create(:plan) }
- get root_path
- expect(assigns(:stats)[:completed_plan_count]).to eql(5)
- end
-
- it 'has the correct number of orgs' do
- (0..4).each { create(:org, is_other: false) }
- get root_path
- expect(assigns(:stats)[:institution_count]).to eql(5)
- end
-
- end
-
- context 'top_templates' do
-
- let!(:org) { create(:org, is_other: false) }
- let!(:templates) { (0..12).map { create(:template, :published, phases: 1, org: org) } }
-
- before do
- templates.each_with_index do |tmplt, i|
- i.times do
- create(:plan, :publicly_visible, :creator, template: tmplt,
- created_at: Date.today-1, complete: i.odd?)
- end
- end
- end
-
- it 'has the correct number of templates' do
- get root_path
- expect(assigns(:top_5).length).to eql(5)
- end
-
- it 'includes the correct templates' do
- get root_path
- # The Top 5 template count should be based on the number of plans
- ids = Plan.group(:template_id).order("count_id DESC").count(:id).keys
- ids[0..4].each do |id|
- expect(assigns(:top_5).include?(Template.find(id).title)).to eql(true)
- end
- end
-
- end
-
- context 'rss' do
- # Skipping this test since it relies on an external WP blog. We could stub
- end
-
- end
-
-end
diff --git a/spec/mixins/dmptool/controller/omniauth_callbacks_spec.rb b/spec/mixins/dmptool/controller/omniauth_callbacks_spec.rb
deleted file mode 100644
index d4a8da54dd..0000000000
--- a/spec/mixins/dmptool/controller/omniauth_callbacks_spec.rb
+++ /dev/null
@@ -1,131 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe 'DMPTool custom handler for Omniauth callbacks', type: :controller do
-
- include Devise::Test::ControllerHelpers
-
- describe '#process_omniauth_callback' do
-
- let!(:org) { create(:org, is_other: false) }
- let!(:shibboleth) { create(:identifier_scheme, name: "shibboleth") }
- let!(:orcid) { create(:identifier_scheme, name: "orcid") }
-
- before do
- OrgIdentifier.create( org: org, identifier_scheme: shibboleth, identifier: "test-org")
- @controller = Users::OmniauthCallbacksController.new
- request.env["devise.mapping"] = Devise.mappings[:user]
- end
-
- context "user is already signed in" do
-
- let!(:user) { create(:user, org: org) }
-
- before do
- sign_in(user)
- end
-
- context "linking account to shibboleth" do
-
- before do
- request.env["omniauth.auth"] = mock_omniauth_call("shibboleth", user)
- end
-
- it "should create the identifier and display success message" do
- get :shibboleth
- expect(flash[:notice]).to eql("Your account has been successfully linked to your institutional credentials.")
- expect(response).to redirect_to("/users/edit")
- end
-
- it "should update the identifier and display success message" do
- UserIdentifier.create(identifier_scheme: shibboleth, user: user, identifier: "foo")
- get :shibboleth
- expect(flash[:notice]).to eql("Your account has been successfully linked to your institutional credentials.")
- expect(response).to redirect_to("/users/edit")
- expect(user.reload.user_identifiers.first.identifier).not_to eql("foo")
- end
- end
-
- context "linking account to orcid" do
-
- before do
- request.env["omniauth.auth"] = mock_omniauth_call("orcid", user)
- end
-
- it "should create the identifier and display success message" do
- get :orcid
- expect(flash[:notice]).to eql("Your account has been successfully linked to #{orcid.description}.")
- expect(response).to redirect_to("/users/edit")
- end
-
- it "should update the identifier and display success message" do
- UserIdentifier.create(identifier_scheme: orcid, user: user, identifier: "foo")
- get :orcid
- expect(flash[:notice]).to eql("Your account has been successfully linked to #{orcid.description}.")
- expect(response).to redirect_to("/users/edit")
- expect(user.reload.user_identifiers.first.identifier).not_to eql("foo")
- end
-
- end
-
- end
-
- context "user is NOT signed in but omniauth uid is already registered" do
-
- let!(:existing_user) { create(:user, org: org) }
- let!(:existing_uid) { create(:user_identifier, user: existing_user,
- identifier_scheme: shibboleth, identifier: "123ABC") }
- before do
- request.env["omniauth.auth"] = mock_omniauth_call("shibboleth", existing_user)
- end
-
- it "should display a success message and sign in" do
- get :shibboleth
- expect(flash[:notice]).to eql("Successfully signed in")
- expect(response).to redirect_to("/")
- end
-
- end
-
- context "user is NOT signed in and omniauth uid not recognized" do
-
- context "user's email was recognized" do
-
- let!(:existing_user) { create(:user, org: org) }
-
- context "was able to associate their account with the omniauth uid via their email address" do
-
- before do
- request.env["omniauth.auth"] = mock_omniauth_call("shibboleth", existing_user)
- end
-
- it "should display success message and login" do
- get :shibboleth
- expect(flash[:notice]).to eql("Successfully signed in with your institutional credentials.")
- expect(response).to redirect_to("/")
- expect(existing_user.user_identifiers.first.identifier).to eql("123ABC")
- end
-
- end
-
- context "was NOT able to associate their account with the omniauth uid or email address" do
- before do
- request.env["omniauth.auth"] = mock_omniauth_call("shibboleth", existing_user)
- existing_user.update_attributes(email: Faker::Internet.unique.safe_email)
- end
-
- it "should display a warning message and load the finish account creation page" do
- get :shibboleth
- expect(flash[:notice]).to eql("It looks like this is your first time logging in. Please verify and complete the information below to finish creating an account.")
- expect(response).to render_template(:new) #"/users/sign_up")
- expect(existing_user.user_identifiers.length).to eql(0)
- end
-
- end
-
- end
-
- end
-
- end
-
-end
diff --git a/spec/mixins/dmptool/controller/orgs_spec.rb b/spec/mixins/dmptool/controller/orgs_spec.rb
deleted file mode 100644
index c4480fbab8..0000000000
--- a/spec/mixins/dmptool/controller/orgs_spec.rb
+++ /dev/null
@@ -1,35 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe 'DMPTool custom endpoint to retrieve Org logo/name', type: :request do
-
- describe '#logos' do
-
- let!(:org) { create(:org) }
-
- it "should be accessible when not logged in" do
- get org_logo_path(org.id)
- expect(response).to have_http_status(:success)
- end
-
- it "should throw a RecordNotFound exception" do
- expect{ get org_logo_path(99999) }.to raise_error(ActiveRecord::RecordNotFound)
- end
-
- it 'returns json that includes the org name if the org exists but has no logo' do
- get org_logo_path(org.id)
- json = JSON.parse(response.body)
- expect(assigns(:user).org).to eql(org)
- expect(json["org"]["html"].include?("branding-name")).to eql(true)
- end
-
- it 'returns json that includes the logo if the org has a logo' do
- org.update_attributes(logo: File.read(Rails.root.join("app", "assets", "images", "logo.png")))
- get org_logo_path(org.id)
- json = JSON.parse(response.body)
- expect(assigns(:user).org).to eql(org)
- expect(json["org"]["html"].include?("org-logo")).to eql(true)
- end
-
- end
-
-end
diff --git a/spec/mixins/dmptool/controller/paginable_spec.rb b/spec/mixins/dmptool/controller/paginable_spec.rb
deleted file mode 100644
index ae6984999c..0000000000
--- a/spec/mixins/dmptool/controller/paginable_spec.rb
+++ /dev/null
@@ -1,35 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe 'DMPTool custom endpoint to public Orgs paginated page', type: :request do
-
- describe '#public' do
-
- let!(:funder) { create(:org, :funder) }
- let!(:institution) { create(:org, :institution) }
- let!(:organisation) { create(:org, :organisation) }
- let!(:research_institute) { create(:org, :research_institute) }
- let!(:project) { create(:org, :project) }
- let!(:school) { create(:org, :school) }
-
- it "should be accessible when not logged in" do
- get public_paginable_orgs_path(1)
- expect(response).to have_http_status(:success)
- end
-
- it "should not include funder Org" do
- get public_paginable_orgs_path(1)
- expect(response.body.include?(funder.name)).to eql(false)
- end
-
- it 'should include any non-funder Orgs' do
- get public_paginable_orgs_path(1)
- expect(response.body.include?(institution.name)).to eql(true)
- expect(response.body.include?(organisation.name)).to eql(true)
- expect(response.body.include?(research_institute.name)).to eql(true)
- expect(response.body.include?(project.name)).to eql(true)
- expect(response.body.include?(school.name)).to eql(true)
- end
-
- end
-
-end
diff --git a/spec/mixins/dmptool/controller/public_pages_spec.rb b/spec/mixins/dmptool/controller/public_pages_spec.rb
deleted file mode 100644
index d4ddf51d75..0000000000
--- a/spec/mixins/dmptool/controller/public_pages_spec.rb
+++ /dev/null
@@ -1,68 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe 'DMPTool custom endpoints for public pages', type: :request do
-
- describe '#orgs' do
-
- let!(:funder) { create(:org, :funder, name: Faker::Name.unique.name) }
- let!(:institution) { create(:org, :institution, name: Faker::Name.unique.name) }
- let!(:organisation) { create(:org, :organisation, name: Faker::Name.unique.name) }
-
- it "should be accessible when not logged in" do
- get public_orgs_path
- expect(response).to have_http_status(:success)
- end
-
- it 'should not include a funder Org' do
- get public_orgs_path
- expect(response.body.include?("
#{funder.name}")).to eql(false)
- end
-
- it 'returns json that includes the org names if the org is an institution or organisation' do
- get public_orgs_path
- expect(response.body.include?("
#{organisation.name}")).to eql(true)
- end
-
- end
-
- describe "#get_started" do
-
- it "should be accessible when not logged in" do
- get get_started_path
- expect(response).to have_http_status(:success)
- end
-
- end
-
- describe "strip newline and punctuation characters from file_name for PDF/DOCX" do
- class TestPublicPagesController < PublicPagesController
- def test_file_name(name)
- file_name(name)
- end
- end
-
- let!(:ctrl) { TestPublicPagesController.new }
-
- it "replaces spaces, periods, commas, and colons with underscores" do
- expect(ctrl.test_file_name("A title with spaces")).to eql("A_title_with_spaces")
- expect(ctrl.test_file_name("A title with, comma")).to eql("A_title_with_comma")
- expect(ctrl.test_file_name("A title with. period")).to eql("A_title_with_period")
- expect(ctrl.test_file_name("A title with: colon")).to eql("A_title_with_colon")
- expect(ctrl.test_file_name("A title with; semicolon")).to eql("A_title_with_semicolon")
- end
-
- it "removes newlines and carriage returns" do
- expect(ctrl.test_file_name("A title with\nnewline")).to eql("A_title_with_newline")
- expect(ctrl.test_file_name("A title with\rcarriage return")).to eql("A_title_with_carriage_return")
- expect(ctrl.test_file_name("A title with\r\nboth")).to eql("A_title_with__both")
- expect(ctrl.test_file_name("A title with
-newline")).to eql("A_title_with_newline")
- end
-
- it "only uses the first 30 characters" do
- expect(ctrl.test_file_name("0123456789012345678901234567890B")).to eql("0123456789012345678901234567890")
- end
- end
-
-end
diff --git a/spec/mixins/dmptool/controller/users_spec.rb b/spec/mixins/dmptool/controller/users_spec.rb
deleted file mode 100644
index e8c6e7e6a9..0000000000
--- a/spec/mixins/dmptool/controller/users_spec.rb
+++ /dev/null
@@ -1,26 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe 'DMPTool custom endpoints to static pages', type: :request do
-
- it "#ldap_username should be accessible when not logged in" do
- get users_ldap_username_path
- expect(response).to have_http_status(:success)
- expect(response.body.include?("
Forgot email?")).to eql(true)
- end
-
- context "#ldap_account" do
-
- it "email/username is not found" do
- post users_ldap_account_path(username: "invalid")
- expect(response.body.include?("We do not recognize the username")).to eql(true)
- end
-
- it "email/username was found" do
- create(:user, ldap_username: "tester")
- post users_ldap_account_path(username: "tester")
- expect(response.body.include?("The DMPTool Account email associated")).to eql(true)
- end
-
- end
-
-end
diff --git a/spec/mixins/dmptool/controllers/home_controller_spec.rb b/spec/mixins/dmptool/controllers/home_controller_spec.rb
new file mode 100644
index 0000000000..da72d6ae41
--- /dev/null
+++ b/spec/mixins/dmptool/controllers/home_controller_spec.rb
@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Dmptool::Controllers::HomeController, type: :request do
+
+ before(:each) do
+ @controller = ::HomeController.new
+ mock_blog
+ end
+
+ it "HomeController includes our customizations" do
+ expect(@controller.respond_to?(:render_home_page)).to eql(true)
+ end
+
+ describe "#render_home_page" do
+ it "#page is accessible when not logged in" do
+ create(:plan, template: create(:template), created_at: Time.now.yesterday)
+ get root_path
+ # Request specs are expensive so just check everything in this one test
+ expect(response).to have_http_status(:success), "should have received a 200"
+ expect(assigns(:rss).present?).to eql(true), "should have set @rss"
+ expect(assigns(:stats).present?).to eql(true), "should have set @stats"
+ expect(assigns(:top_five).present?).to eql(true), "should have set @top_five"
+ expect(response.body.include?("
Welcome to the DMPTool")).to eql(true)
+ end
+ end
+
+ context "private methods" do
+
+ describe "#statistics" do
+ it "returns the contents of the Rails.cache if available" do
+ val = [Faker::Lorem.paragraph]
+ Rails.cache.stubs(:read).returns(val)
+ expect(@controller.send(:statistics)).to eql(val)
+ end
+ it "returns 0 for :user_count if no Users" do
+ expect(@controller.send(:statistics)[:user_count]).to eql(0)
+ end
+ it "returns 0 for :completed_plan_count if no Plans" do
+ expect(@controller.send(:statistics)[:completed_plan_count]).to eql(0)
+ end
+ it "returns 0 for :institution_count if no participating Orgs" do
+ Org.destroy_all
+ expect(@controller.send(:statistics)[:institution_count]).to eql(0)
+ end
+ it "returns the total number of Users" do
+ create(:user)
+ expect(@controller.send(:statistics)[:user_count]).to eql(1)
+ end
+ it "returns the total number of Plans" do
+ create(:plan)
+ expect(@controller.send(:statistics)[:completed_plan_count]).to eql(1)
+ end
+ it "returns the total number of participating Orgs" do
+ # The default org is being generated by the rails_helper!
+ Org.destroy_all
+ create(:org, managed: false)
+ create(:org, managed: true)
+ expect(@controller.send(:statistics)[:institution_count]).to eql(1)
+ end
+ end
+
+ describe "#top_templates" do
+ before(:each) do
+ @older = create(:plan, template: create(:template),
+ created_at: Time.now - 120.days)
+ 6.times { create(:plan, template: create(:template), created_at: Date.yesterday) }
+ end
+ it "returns the contents of the Rails.cache if available" do
+ val = [Faker::Lorem.paragraph]
+ Rails.cache.stubs(:read).returns(val)
+ expect(@controller.send(:top_templates)).to eql(val)
+ end
+ it "returns an empty array if no plans were created in last 90 days" do
+ Plan.destroy_all
+ expect(@controller.send(:top_templates)).to eql([])
+ end
+ it "returns the top 5 templates" do
+ expect(@controller.send(:top_templates).length).to eql(5)
+ end
+ it "does not include plans that are older than 90 days" do
+ expect(@controller.send(:top_templates).include?(@older.template)).to eql(false)
+ end
+ end
+
+ describe "#feed" do
+ it "returns the contents of the Rails.cache if available" do
+ val = [Faker::Lorem.paragraph]
+ Rails.cache.stubs(:read).returns(val)
+ expect(@controller.send(:feed)).to eql(val)
+ end
+ it "returns an empty array if the Blog feed does not return a 200 code" do
+ HTTParty.stubs(:get).returns(OpenStruct.new(code: 404, body: nil))
+ expect(@controller.send(:feed)).to eql([])
+ end
+ it "returns writes to log if an Error is thrown" do
+ Rails.logger.expects(:error).at_least(1)
+ RSS::Parser.stubs(:parse).raises(StandardError.new(Faker::Lorem.word))
+ expect(@controller.send(:feed)).to eql([])
+ end
+ it "returns the xml" do
+ expect(@controller.send(:feed).length).to eql(2)
+ end
+ end
+
+ describe "#cache_content" do
+ before(:each) do
+ # Rails cache is a NULL_STORE by default unless running in production
+ # Enable the cache for these tests
+ memory_store = ActiveSupport::Cache.lookup_store(:memory_store)
+ Rails.stubs(:cache).returns(memory_store)
+
+ @type = Faker::Lorem.word
+ @val = Faker::Lorem.sentence
+ end
+ after(:each) do
+ Rails.cache.clear
+ end
+
+ it "Does not add the item to the Rails cache if :type is not present" do
+ Rails.cache.expects(:write).at_most(0)
+ @controller.send(:cache_content, nil, @val)
+ end
+ it "Logs errors" do
+ err = StandardError.new(Faker::Lorem.word)
+ Rails.logger.expects(:error).at_least(1)
+ Rails.cache.stubs(:write).raises(err)
+ @controller.send(:cache_content, @type, @val)
+ end
+ it "Adds the item to the Rails cache" do
+ @controller.send(:cache_content, @type, @val)
+ expect(Rails.cache.read(@type)).to eql(@val)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/mixins/dmptool/controllers/orgs_controller_spec.rb b/spec/mixins/dmptool/controllers/orgs_controller_spec.rb
new file mode 100644
index 0000000000..27386d0bf1
--- /dev/null
+++ b/spec/mixins/dmptool/controllers/orgs_controller_spec.rb
@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Dmptool::Controllers::OrgsController, type: :request do
+
+ before(:each) do
+ @controller = ::OrgsController.new
+ @controller.prepend_view_path "app/views/branded"
+ mock_blog
+ end
+
+ it "OrgController includes our customizations" do
+ expect(@controller.respond_to?(:logos)).to eql(true)
+ end
+
+ describe "GET logos" do
+ it "page is accessible when not logged in" do
+ org = create(:org, managed: true)
+ # stub the logo method
+ logo = OpenStruct.new({ present?: true })
+ logo.stubs(:thumb).returns(OpenStruct.new({ url: Faker::Internet.url }))
+ Org.any_instance.stubs(:logo).returns(logo)
+ get org_logo_path(org)
+ # Request specs are expensive so just check everything in this one test
+ expect(response).to have_http_status(:success), "should have received a 200"
+ expect(assigns(:user).present?).to eql(true), "should have set @user"
+ expect(assigns(:user).org).to eql(org), "should have set @user.org"
+ json = JSON.parse(response.body)
+ expect(json["org"].present?).to eql(true)
+ expect(json["org"]["id"]).to eql(org.id.to_s)
+ expect(json["org"]["html"].include?("
Participating Institutions")).to eql(true)
+ end
+ end
+
+ describe "#get_started" do
+ it "should be accessible when not logged in" do
+ get get_started_path
+ expect(response).to have_http_status(:success)
+ expect(response.body.include?("
Sign in options")).to eql(true)
+ end
+
+ end
+
+ # rubocop:disable Metrics/LineLength
+ describe "#file_name" do
+ it "replaces spaces, periods, commas, and colons with underscores" do
+ expect(@controller.send(:file_name, "A title with spaces")).to eql("A_title_with_spaces")
+ expect(@controller.send(:file_name, "A title with, comma")).to eql("A_title_with_comma")
+ expect(@controller.send(:file_name, "A title with. period")).to eql("A_title_with_period")
+ expect(@controller.send(:file_name, "A title with: colon")).to eql("A_title_with_colon")
+ expect(@controller.send(:file_name, "A title with; semicolon")).to eql("A_title_with_semicolon")
+ end
+
+ it "removes newlines and carriage returns" do
+ expect(@controller.send(:file_name, "A title with\nnewline")).to eql("A_title_with_newline")
+ expect(@controller.send(:file_name, "A title with\rcarriage return")).to eql("A_title_with_carriage_return")
+ expect(@controller.send(:file_name, "A title with\r\nboth")).to eql("A_title_with__both")
+ expect(@controller.send(:file_name, "A title with
+newline")).to eql("A_title_with_newline")
+ end
+
+ it "only uses the first 30 characters" do
+ expect(@controller.send(:file_name, "0123456789012345678901234567890B")).to eql("0123456789012345678901234567890")
+ end
+ end
+ # rubocop:enable Metrics/LineLength
+
+end
diff --git a/spec/mixins/dmptool/controller/static_pages_spec.rb b/spec/mixins/dmptool/controllers/static_pages_controller_spec.rb
similarity index 61%
rename from spec/mixins/dmptool/controller/static_pages_spec.rb
rename to spec/mixins/dmptool/controllers/static_pages_controller_spec.rb
index c6ab978bb9..bd69fb0761 100644
--- a/spec/mixins/dmptool/controller/static_pages_spec.rb
+++ b/spec/mixins/dmptool/controllers/static_pages_controller_spec.rb
@@ -1,8 +1,18 @@
-require 'rails_helper'
+# frozen_string_literal: true
-RSpec.describe 'DMPTool custom endpoints to static pages', type: :request do
+require "rails_helper"
- it "#promote should be accessible when not logged in" do
+RSpec.describe Dmptool::Controllers::StaticPagesController, type: :request do
+
+ before(:each) do
+ @controller = ::StaticPagesController.new
+ end
+
+ it "StaticPagesController includes our customizations" do
+ expect(@controller.respond_to?(:faq)).to eql(true)
+ end
+
+ it "#pages are accessible when not logged in" do
get promote_path
expect(response).to have_http_status(:success)
expect(response.body.include?("
Promote the DMPTool")).to eql(true)
diff --git a/spec/mixins/dmptool/controllers/users/omniauth_callbacks_controller_spec.rb b/spec/mixins/dmptool/controllers/users/omniauth_callbacks_controller_spec.rb
new file mode 100644
index 0000000000..3e35466412
--- /dev/null
+++ b/spec/mixins/dmptool/controllers/users/omniauth_callbacks_controller_spec.rb
@@ -0,0 +1,306 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Dmptool::Controllers::Users::OmniauthCallbacksController,
+ type: :controller do
+
+ include Devise::Test::ControllerHelpers
+
+ before(:each) do
+ @scheme = create(:identifier_scheme, identifier_prefix: nil, name: "shibboleth",
+ for_authentication: true)
+ @org = create(:org, managed: true)
+ @entity_id = create(:identifier, identifiable: @org, identifier_scheme: @scheme,
+ value: SecureRandom.uuid)
+ @user = create(:user, org: @org)
+
+ @omniauth_hash = {
+ "omniauth.auth": mock_omniauth_call(@scheme.name, @user)
+ }.with_indifferent_access
+ @controller = Users::OmniauthCallbacksController.new
+ end
+
+ it "OmniauthCallbacksController includes our customizations" do
+ expect(@controller.respond_to?(:process_omniauth_callback)).to eql(true)
+ end
+
+ it "Has a path for every "
+
+ describe "#process_omniauth_callback" do
+ before(:each) do
+ request.env["devise.mapping"] = Devise.mappings[:user]
+ end
+
+ context "user is already signed in" do
+ before do
+ sign_in(@user)
+ end
+
+ describe "linking account to shibboleth" do
+ before do
+ request.env["omniauth.auth"] = @omniauth_hash["omniauth.auth"]
+ # rubocop:disable Metrics/LineLength
+ @msg = "Your account has been successfully linked to your institutional credentials."
+ # rubocop:enable Metrics/LineLength
+ @uid = @omniauth_hash["omniauth.auth"]["uid"]
+ end
+
+ it "should create the identifier and display success message" do
+ get :shibboleth
+ expect(flash[:notice]).to eql(@msg)
+ expect(response).to redirect_to("/users/edit")
+ expect(@user.reload.identifiers.last.value).to eql(@uid)
+ end
+
+ it "should update the identifier and display success message" do
+ id = create(:identifier, identifier_scheme: @scheme, identifiable: @user,
+ value: SecureRandom.uuid)
+ get :shibboleth
+ expect(flash[:notice]).to eql(@msg)
+ expect(response).to redirect_to("/users/edit")
+ expect(id.reload.value).to eql(@uid)
+ end
+ end
+ end
+
+ describe "user is NOT signed in but omniauth uid is already registered" do
+ before do
+ @id = create(:identifier, identifier_scheme: @scheme, identifiable: @user,
+ value: @omniauth_hash["omniauth.auth"]["uid"])
+ request.env["omniauth.auth"] = @omniauth_hash["omniauth.auth"]
+ end
+
+ it "should display a success message and sign in" do
+ get :shibboleth
+ expect(flash[:notice].starts_with?("Successfully signed in")).to eql(true)
+ expect(response).to redirect_to("/")
+ expect(@user.reload.identifiers.last).to eql(@id)
+ end
+ end
+
+ describe "user is NOT signed in and omniauth uid not recognized" do
+ before(:each) do
+ request.env["omniauth.auth"] = @omniauth_hash["omniauth.auth"]
+ @uid = @omniauth_hash["omniauth.auth"]["uid"]
+ end
+
+ context "user's email was recognized" do
+ it "should display success message and login" do
+ @user.identifiers.destroy_all
+ get :shibboleth
+ # rubocop:disable Metrics/LineLength
+ expect(flash[:notice]).to eql("Successfully signed in with your institutional credentials.")
+ # rubocop:enable Metrics/LineLength
+ expect(response).to redirect_to("/")
+ expect(@user.reload.identifiers.last.value).to eql(@uid)
+ end
+ end
+
+ context "user's email is not recognized" do
+ it "should display a warning message and load the finish account creation page" do
+ @user.update(email: Faker::Internet.unique.email)
+ get :shibboleth
+ # rubocop:disable Metrics/LineLength
+ expect(flash[:notice]).to eql("It looks like this is your first time logging in. Please verify and complete the information below to finish creating an account.")
+ expect(response).to redirect_to("/users/sign_up")
+ expect(@user.identifiers.length).to eql(0)
+ expect(session["devise.shibboleth_data"]).to eql(@omniauth_hash["omniauth.auth"])
+ # rubocop:enable Metrics/LineLength
+ end
+ end
+
+ end
+
+ end
+
+ context "private methods" do
+
+ describe "#provider(scheme:)" do
+ it "returns 'institutional credentials' if the scheme name is 'shibboleth'" do
+ expected = "your institutional credentials"
+ expect(@controller.send(:provider, scheme: @scheme)).to eql(expected)
+ end
+ it "returns the scheme name" do
+ @scheme.name = Faker::Lorem.word
+ expect(@controller.send(:provider, scheme: @scheme)).to eql(@scheme.description)
+ end
+ end
+
+ describe "#omniauth" do
+ it "returns an empty hash if the Request has no ENV info" do
+ @controller.stubs(:request).returns(OpenStruct.new({ env: nil }))
+ expect(@controller.send(:omniauth)).to eql({})
+ end
+ it "finds the 'omniauth.auth' hash in the Request ENV" do
+ @controller.stubs(:request).returns(OpenStruct.new({ env: @omniauth_hash }))
+ expect(@controller.send(:omniauth)).to eql(@omniauth_hash["omniauth.auth"])
+ end
+ it "returns the Request ENV if no 'omniauth.auth' is present" do
+ hash = { uid: SecureRandom.uuid }
+ @controller.stubs(:request).returns(OpenStruct.new({ env: hash }))
+ expect(@controller.send(:omniauth)).to eql(hash)
+ end
+ end
+
+ describe "#redirect_to_registration(data:)" do
+ # Tested above because we need the full HTTP Request object to be available
+ # to access the session and process a redirect
+ end
+
+ describe "#attach_omniauth_credentials(user:, scheme:, omniauth:)" do
+ before(:each) do
+ @user = create(:user)
+ end
+
+ it "returns nil if no :user is present" do
+ rslt = @controller.send(:attach_omniauth_credentials, user: nil,
+ scheme: @scheme,
+ omniauth: @hash)
+ expect(rslt).to eql(false)
+ end
+ it "returns nil if no :scheme is present" do
+ rslt = @controller.send(:attach_omniauth_credentials, user: @user,
+ scheme: nil,
+ omniauth: @hash)
+ expect(rslt).to eql(false)
+ end
+ it "returns nil if no :omniauth hash is present" do
+ rslt = @controller.send(:attach_omniauth_credentials, user: @user,
+ scheme: @scheme,
+ omniauth: nil)
+ expect(rslt).to eql(false)
+ end
+ it "updates the User's Identifier :value" do
+ id = create(:identifier, identifiable: @user, identifier_scheme: @scheme)
+ hash = { uid: SecureRandom.uuid }
+ rslt = @controller.send(:attach_omniauth_credentials, user: @user,
+ scheme: @scheme,
+ omniauth: hash)
+ expect(rslt).to eql(id.reload)
+ expect(rslt.value).to eql(hash[:uid])
+ end
+ it "creates an Identifier for the User" do
+ hash = { uid: SecureRandom.uuid }
+ rslt = @controller.send(:attach_omniauth_credentials, user: @user,
+ scheme: @scheme,
+ omniauth: hash)
+ expect(rslt.value).to eql(hash[:uid])
+ end
+ end
+
+ describe "#omniauth_hash_to_new_user(scheme:, omniauth:)" do
+ before(:each) do
+ @hash = {
+ info: {
+ name: Faker::Movies::StarWars.character,
+ email: Faker::Internet.email,
+ identity_provider: @entity_id.value
+ }
+ }
+ end
+
+ it "returns nil if no :scheme is present" do
+ rslt = @controller.send(:omniauth_hash_to_new_user, scheme: nil,
+ omniauth: @hash)
+ expect(rslt).to eql(nil)
+ end
+ it "returns nil if no :omniauth hash is present" do
+ rslt = @controller.send(:omniauth_hash_to_new_user, scheme: @scheme,
+ omniauth: nil)
+ expect(rslt).to eql(nil)
+ end
+ it "initializes a new User" do
+ rslt = @controller.send(:omniauth_hash_to_new_user, scheme: @scheme,
+ omniauth: @hash)
+ expect(rslt.new_record?).to eql(true)
+ expect(rslt.org).to eql(@org)
+ expect(rslt.email).to eql(@hash[:info][:email])
+ names = @hash[:info][:name].split
+ first = names.length > 1 ? names.first : nil
+ expect(rslt.firstname).to eql(first)
+ last = names.length > 1 ? names.last : names.first
+ expect(rslt.surname).to eql(last)
+ end
+ end
+
+ describe "#extract_omniauth_email(hash:)" do
+ it "returns nil if no email is present in the hash" do
+ expect(@controller.send(:extract_omniauth_email, hash: nil)).to eql(nil)
+ end
+ it "return the email" do
+ hash = { email: Faker::Internet.email }
+ result = @controller.send(:extract_omniauth_email, hash: hash)
+ expect(result).to eql(hash[:email])
+ end
+ it "returns the 1st email if there are multiples" do
+ hash = { email: "#{Faker::Internet.email};#{Faker::Internet.email}" }
+ result = @controller.send(:extract_omniauth_email, hash: hash)
+ expect(result).to eql(hash[:email].split(";").first)
+ end
+ end
+
+ describe "#extract_omniauth_names(hash:)" do
+ it "returns an empty hash if :hash is not present" do
+ expect(@controller.send(:extract_omniauth_names, hash: nil)).to eql({})
+ end
+ it "handles :givenname" do
+ hash = { givenname: Faker::Movies::StarWars.character.split.first }
+ result = @controller.send(:extract_omniauth_names, hash: hash)
+ expect(result[:firstname]).to eql(hash[:givenname])
+ end
+ it "handles :firstname" do
+ hash = { firstname: Faker::Movies::StarWars.character.split.first }
+ result = @controller.send(:extract_omniauth_names, hash: hash)
+ expect(result[:firstname]).to eql(hash[:firstname])
+ end
+ it "handles :lastname" do
+ hash = { lastname: Faker::Movies::StarWars.character.split.first }
+ result = @controller.send(:extract_omniauth_names, hash: hash)
+ expect(result[:surname]).to eql(hash[:lastname])
+ end
+ it "handles :surname" do
+ hash = { surname: Faker::Movies::StarWars.character.split.first }
+ result = @controller.send(:extract_omniauth_names, hash: hash)
+ expect(result[:surname]).to eql(hash[:surname])
+ end
+ it "correctly splits :name into first and last" do
+ hash = { name: Faker::Movies::StarWars.character }
+ result = @controller.send(:extract_omniauth_names, hash: hash)
+ names = hash[:name].split
+ expect(result[:firstname]).to eql(names.length > 1 ? names.first : nil)
+ expect(result[:surname]).to eql(names.last)
+ end
+ end
+
+ describe "#extract_omniauth_org(scheme:, hash:)" do
+ before(:each) do
+ @hash = { identity_provider: @entity_id.value_without_scheme_prefix }
+ end
+
+ it "returns nil if the :scheme is not present" do
+ rslt = @controller.send(:extract_omniauth_org, scheme: nil, hash: @hash)
+ expect(rslt).to eql(nil)
+ end
+ it "returns nil if the :hash is not present" do
+ rslt = @controller.send(:extract_omniauth_org, scheme: @scheme, hash: nil)
+ expect(rslt).to eql(nil)
+ end
+ it "returns nil if the :hash has no :identity_provider" do
+ rslt = @controller.send(:extract_omniauth_org, scheme: @scheme, hash: {})
+ expect(rslt).to eql(nil)
+ end
+ it "returns nil if there is no matching Org" do
+ @hash[:identity_provider] = Faker::Lorem.word
+ rslt = @controller.send(:extract_omniauth_org, scheme: @scheme, hash: @hash)
+ expect(rslt).to eql(nil)
+ end
+ it "returns the Org" do
+ rslt = @controller.send(:extract_omniauth_org, scheme: @scheme, hash: @hash)
+ expect(rslt).to eql(@org)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/mixins/dmptool/mailers/user_mailer_spec.rb b/spec/mixins/dmptool/mailers/user_mailer_spec.rb
new file mode 100644
index 0000000000..e227bc6f3a
--- /dev/null
+++ b/spec/mixins/dmptool/mailers/user_mailer_spec.rb
@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Dmptool::Mailers::UserMailer, type: :mailer do
+
+ describe "DMPTool mixin for the UserMailer" do
+
+ before do
+ @plan = build(:plan)
+ @contributor = build(:contributor, plan: @plan)
+ end
+
+ # TODO: Enable these tests once the contributor code is in place
+
+ xit "UserMailer includes our cusotmizations" do
+ expect(UserMailer.respond_to?(:api_plan_creation)).to eql(true)
+ end
+
+ context "#api_plan_creation(plan, contributor)" do
+
+ xit "does not send an email if :plan is not present" do
+ UserMailer.api_plan_creation(nil, @contributor)
+ expect(ActionMailer::Base.deliveries.size).to eql(0)
+ end
+ xit "does not send an email if :contributor is not present" do
+ UserMailer.api_plan_creation(@plan, nil)
+ expect(ActionMailer::Base.deliveries.size).to eql(0)
+ end
+
+ context "success" do
+ before(:each) do
+ @mail = UserMailer.api_plan_creation(@plan, @contributor)
+ end
+
+ xit "Has the correct :subject" do
+ expect(@mail.subject).to eql(_("New DMP created"))
+ end
+ xit "Has the correct :to recipients" do
+ expect(@mail.to.include?("brian.riley@ucop.edu")).to eql(true)
+ end
+ xit "renders the correct template" do
+ expected = "a new DMP was created via the API"
+ expect(@mail.body.encoded.include?(expected)).to eql(true)
+ end
+ end
+
+ end
+
+ end
+
+end
diff --git a/spec/mixins/dmptool/model/org_spec.rb b/spec/mixins/dmptool/model/org_spec.rb
deleted file mode 100644
index 342299fd26..0000000000
--- a/spec/mixins/dmptool/model/org_spec.rb
+++ /dev/null
@@ -1,40 +0,0 @@
-require 'rails_helper'
-
-
-RSpec.describe Org, type: :model do
-
- describe "DMPTool customizations to Org model" do
-
- before do
- generate_shibbolized_orgs(10)
- end
-
- context ".participating" do
-
- it "is_other org is not included in list of participating" do
- org = create(:org, is_other: true)
- expect(Org.participating.include?(org)).to eql(false)
- end
-
- it ".participating includes correct orgs" do
- expect(Org.participating.size).to eql(10)
- end
-
- end
-
- context ".shibbolized?" do
-
- it "when Org does not have an identifier for Shibboleth" do
- org = create(:org, is_other: false)
- expect(org.shibbolized?).to eql(false)
- end
-
- it "when the Org has a shibboleth identifier" do
- org = Org.participating.first
- expect(org.shibbolized?).to eql(true)
- end
- end
-
- end
-
-end
\ No newline at end of file
diff --git a/spec/mixins/dmptool/model/user_spec.rb b/spec/mixins/dmptool/model/user_spec.rb
deleted file mode 100644
index c769e389e6..0000000000
--- a/spec/mixins/dmptool/model/user_spec.rb
+++ /dev/null
@@ -1,70 +0,0 @@
-require 'rails_helper'
-
-
-RSpec.describe User, type: :model do
-
- describe "DMPTool customizations to User model" do
-
- before do
- generate_shibbolized_orgs(1)
- end
-
- let!(:org) { Org.participating.first }
-
- context ".ldap_password?" do
-
- it "correctly determines if the user has an ldap password" do
- user = create(:user, ldap_password: "ABCD123")
- expect(user.ldap_password?).to eql(true)
- end
-
- end
-
- context ".valid_password?" do
-
- let(:password) { "Testing*12!" }
- let(:salt) { "saltyTst" }
-
- it "converts a user's LDAP password to Devise password" do
- # Create a user and then remove their Devise passwords to simulate
- # a record migrated from the old DMPTool v2 LDAP security model
- encoded = Base64.encode64(Digest::SHA1.digest(password+salt)+salt).chomp!
- user = create(:user, ldap_password: "{SSHA}"+encoded)
- user.password = ""
- user.encrypted_password = ""
- user.save(validate: false)
- expect(user.valid_password?(password)).to eql(true)
- # Make sure the old LDAP password was deleted and that the new Devise
- # password was properly converted
- user.reload
- expect(user.encrypted_password.present?).to eql(true)
- expect(user.ldap_password.present?).to eql(false)
- expect(user.valid_password?(password)).to eql(true)
- end
-
- it "does not change the user's password if they already have a Devise password" do
- encoded = Base64.encode64(Digest::SHA1.digest(password+salt)+salt).chomp!
- user = create(:user, ldap_password: "{SSHA}"+encoded)
- expect(user.valid_password?(password)).to eql(false)
- expect(user.ldap_password.present?).to eql(true)
- expect(user.encrypted_password.present?).to eql(true)
- end
-
- it "does not change the user's password if the provided password is invalid" do
- # Create a user and then remove their Devise passwords to simulate
- # a record migrated from the old DMPTool v2 LDAP security model
- encoded = Base64.encode64(Digest::SHA1.digest(password+salt)+salt).chomp!
- user = create(:user, ldap_password: "{SSHA}"+encoded)
- user.password = ""
- user.encrypted_password = ""
- user.save(validate: false)
- expect(user.valid_password?("INVALID_Passwd12")).to eql(false)
- expect(user.ldap_password.present?).to eql(true)
- expect(user.encrypted_password.present?).to eql(false)
- end
-
- end
-
- end
-
-end
\ No newline at end of file
diff --git a/spec/mixins/dmptool/models/org_spec.rb b/spec/mixins/dmptool/models/org_spec.rb
new file mode 100644
index 0000000000..55178bc509
--- /dev/null
+++ b/spec/mixins/dmptool/models/org_spec.rb
@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Dmptool::Models::Org, type: :model do
+
+ describe "DMPTool customizations to Org model" do
+
+ before do
+ generate_shibbolized_orgs(2)
+ @unmanaged = create(:org, managed: false)
+ end
+
+ it "Org includes our cusotmizations" do
+ expect(::Org.respond_to?(:participating)).to eql(true)
+ end
+
+ context "#participating" do
+ it "does not return unmanaged orgs" do
+ expect(Org.participating.include?(@unmanaged)).to eql(false)
+ end
+ it "includes managed orgs" do
+ expect(Org.participating.size).to eql(3)
+ end
+ end
+
+ context "#shibbolized?" do
+ it "returns false when the Org is not :managed" do
+ org = Org.participating.first
+ org.update(managed: false)
+ expect(org.shibbolized?).to eql(false)
+ end
+ it "returns false if Org does not have an identifier for Shibboleth" do
+ expect(@unmanaged.shibbolized?).to eql(false)
+ end
+ it "returns true" do
+ org = Org.participating.first
+ expect(org.shibbolized?).to eql(true)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/mixins/dmptool/presenters/org_presenter_spec.rb b/spec/mixins/dmptool/presenters/org_presenter_spec.rb
new file mode 100644
index 0000000000..7b88d2b4f5
--- /dev/null
+++ b/spec/mixins/dmptool/presenters/org_presenter_spec.rb
@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Dmptool::Presenters::OrgPresenter do
+
+ describe "DMPTool OrgPresenter" do
+ before do
+ @managed = create(:org, managed: true)
+ @unmanaged = create(:org, managed: false)
+ @scheme = create(:identifier_scheme, name: "shibboleth")
+ @presenter = described_class.new
+ end
+
+ describe "#initialize" do
+ it "initializes if a shibboleth scheme is available" do
+ expect(@presenter.is_a?(Dmptool::Presenters::OrgPresenter)).to eql(true)
+ end
+ it "initializes if a shibboleth scheme is NOT available" do
+ @scheme.destroy
+ presenter = described_class.new
+ expect(presenter.is_a?(Dmptool::Presenters::OrgPresenter)).to eql(true)
+ end
+ end
+
+ describe "#participating_orgs" do
+ it "returns 'managed' Orgs" do
+ expect(@presenter.participating_orgs.include?(@managed)).to eql(true)
+ end
+ it "does not return 'unmanaged' Orgs" do
+ expect(@presenter.participating_orgs.include?(@unmanaged)).to eql(false)
+ end
+ end
+
+ describe "#sign_in_url(org:)" do
+ it "returns nil if the :org is not present" do
+ expect(@presenter.sign_in_url(org: nil)).to eql(nil)
+ end
+ it "returns nil if there is no shibboleth scheme" do
+ @scheme.destroy
+ @presenter = described_class.new
+ expect(@presenter.sign_in_url(org: @managed)).to eql(nil)
+ end
+ it "returns the correct URL/path" do
+ result = @presenter.sign_in_url(org: @unmanaged)
+ path = Rails.application.routes.url_helpers.shibboleth_ds_path
+ expect(result.starts_with?(path)).to eql(true)
+ expect(result.ends_with?(@unmanaged.id.to_s)).to eql(true)
+ end
+ end
+ end
+
+end
diff --git a/spec/models/api_client_spec.rb b/spec/models/api_client_spec.rb
new file mode 100644
index 0000000000..98d55fc4a5
--- /dev/null
+++ b/spec/models/api_client_spec.rb
@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe ApiClient, type: :model do
+
+ context "validations" do
+
+ it { is_expected.to validate_presence_of(:name) }
+ it { is_expected.to validate_presence_of(:contact_email) }
+
+ # Uniqueness validation
+ it {
+ subject.name = Faker::Lorem.word
+ subject.contact_email = Faker::Internet.email
+ subject.client_id = Faker::Lorem.word
+ subject.client_secret = Faker::Lorem.word
+ is_expected.to validate_uniqueness_of(:name)
+ .case_insensitive
+ .with_message("must be unique")
+ }
+
+ # Email format validation
+ it {
+ is_expected.to allow_values("one@example.com", "foo-bar@ed.ac.uk")
+ .for(:contact_email)
+ }
+ it {
+ is_expected.not_to allow_values("example.com", "foo bar@ed.ac.uk")
+ .for(:contact_email)
+ }
+
+ end
+
+ context "Instance Methods" do
+ before(:each) do
+ @client = build(:api_client)
+ end
+
+ describe "#to_s" do
+ it "should return the name" do
+ expect(@client.to_s).to eql(@client.name)
+ end
+
+ it "should return the name through interpolation" do
+ expect("#{@client}").to eql(@client.name)
+ end
+ end
+
+ describe "#authenticate" do
+ it "returns false if no secret is specified" do
+ expect(@client.authenticate(secret: nil)).to eql(false)
+ end
+
+ it "returns false if the secrets do not match" do
+ expect(@client.authenticate(secret: SecureRandom.uuid)).to eql(false)
+ end
+
+ it "returns true if the secrets match" do
+ expect(@client.authenticate(secret: @client.client_secret)).to eql(true)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/models/concerns/date_rangeable_spec.rb b/spec/models/concerns/date_rangeable_spec.rb
new file mode 100644
index 0000000000..9059b06ce9
--- /dev/null
+++ b/spec/models/concerns/date_rangeable_spec.rb
@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe DateRangeable do
+
+ # Using the Plan model for testing this Concern
+ before(:each) do
+ @plans_in_range = [
+ create(:plan, created_at: Date.today - 31.days, updated_at: Date.today - 31.days),
+ create(:plan, created_at: Date.today - 31.days, updated_at: Date.today - 31.days)
+ ]
+ @plan_prior = create(:plan, created_at: Date.today - 90.days,
+ updated_at: Date.today - 90.days)
+ @plan_after = create(:plan, created_at: Date.today, updated_at: Date.today)
+ end
+
+ context "class methods" do
+
+ describe "#date_range?(term:)" do
+ it "returns true the 'Oct 2019' format" do
+ expect(Plan.date_range?(term: "Jan 19")).to eql(true)
+ expect(Plan.date_range?(term: "Jan 2019")).to eql(true)
+ expect(Plan.date_range?(term: "January 2019")).to eql(true)
+ expect(Plan.date_range?(term: Date.today.strftime("%b %Y"))).to eql(true)
+ end
+ it "returns false for others" do
+ expect(Plan.date_range?(term: "01 19")).to eql(false)
+ expect(Plan.date_range?(term: "01 2019")).to eql(false)
+ expect(Plan.date_range?(term: "1st Jan 2019")).to eql(false)
+ expect(Plan.date_range?(term: "01-01-2019")).to eql(false)
+ expect(Plan.date_range?(term: "01/01/2019")).to eql(false)
+ expect(Plan.date_range?(term: "2019-01-01")).to eql(false)
+ expect(Plan.date_range?(term: "2019-01-01 00:00:01")).to eql(false)
+ end
+ end
+
+ describe "#by_date_range(field, term)" do
+ before(:each) do
+ @term = (Date.today - 31.days).strftime("%b %Y")
+ end
+
+ it "searches by the specified field" do
+ expect(Plan.by_date_range(:created_at, @term).length).to eql(2)
+ expect(Plan.by_date_range(:updated_at, @term).length).to eql(2)
+ end
+ it "returns the expected records" do
+ results = Plan.by_date_range(:created_at, @term)
+ results.each { |r| expect(@plans_in_range.include?(r)).to eql(true) }
+ end
+ it "does not return records from a prior month" do
+ results = Plan.by_date_range(:created_at, @term)
+ expect(results.include?(@plan_prior)).to eql(false)
+ end
+ it "does not return records from a later month" do
+ results = Plan.by_date_range(:created_at, @term)
+ expect(results.include?(@plan_after)).to eql(false)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/models/concerns/identifiable_spec.rb b/spec/models/concerns/identifiable_spec.rb
new file mode 100644
index 0000000000..60869bcdbf
--- /dev/null
+++ b/spec/models/concerns/identifiable_spec.rb
@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Identifiable do
+
+ # Using the Org model for testing this Concern
+ before(:each) do
+ @org = create(:org)
+ @scheme1 = create(:identifier_scheme)
+ @scheme2 = create(:identifier_scheme)
+ @id1 = create(:identifier, identifier_scheme: @scheme1, identifiable: @org)
+ @id2 = create(:identifier, identifier_scheme: @scheme2, identifiable: @org)
+ end
+
+ context "class methods" do
+
+ describe "#from_identifiers(array:)" do
+ it "returns nil if array is not present" do
+ expect(Org.from_identifiers(array: nil)).to eql(nil)
+ end
+ it "returns nil if array is empty" do
+ expect(Org.from_identifiers(array: [])).to eql(nil)
+ end
+ it "returns nil if the identifier scheme does not exist" do
+ array = [{ name: SecureRandom.uuid, value: Faker::Lorem.word }]
+ expect(Org.from_identifiers(array: array)).to eql(nil)
+ end
+ it "returns nil if no matches were found" do
+ array = [{ name: @scheme1.name, value: SecureRandom.uuid }]
+ expect(Org.from_identifiers(array: array)).to eql(nil)
+ end
+ it "returns the identifiable object" do
+ array = [{ name: @scheme1.name, value: @id1.value }]
+ expect(Org.from_identifiers(array: array)).to eql(@org)
+ end
+ it "does not return matching identifiable from another object" do
+ array = [{ name: @scheme1.name, value: @id1.value }]
+ expect(User.from_identifiers(array: array)).to eql(nil)
+ end
+ it "returns the first identifiable object if multiple matches" do
+ array = [
+ { name: @scheme2.name, value: @id2.value },
+ { name: @scheme1.name, value: @id1.value }
+ ]
+ expect(Org.from_identifiers(array: array)).to eql(@org)
+ end
+ end
+
+ end
+
+ context "instance methods" do
+
+ describe "#identifier_for_scheme(scheme:)" do
+ it "returns nil if no identifier was found" do
+ scheme3 = create(:identifier_scheme)
+ expect(@org.identifier_for_scheme(scheme: scheme3)).to eql(nil)
+ end
+ it "returns nil if identifier scheme does not exist" do
+ expect(@org.identifier_for_scheme(scheme: SecureRandom.uuid)).to eql(nil)
+ end
+ it "returns the identifier if passed the scheme name" do
+ expect(@org.identifier_for_scheme(scheme: @scheme1.name)).to eql(@id1)
+ end
+ it "returns the identifier if passed the identifier scheme" do
+ expect(@org.identifier_for_scheme(scheme: @scheme1)).to eql(@id1)
+ end
+ end
+
+ describe "#consolidate_identifiers!(array:)" do
+ it "returns the existing identifiers if array is not present" do
+ expect(@org.consolidate_identifiers!(array: nil)).to eql(false)
+ end
+ it "returns the existing identifiers if array is empty" do
+ expect(@org.consolidate_identifiers!(array: [])).to eql(false)
+ end
+ it "ignores items in array if they are not identifiers" do
+ array = [build(:org)]
+ original = @org.identifiers
+ @org.consolidate_identifiers!(array: array)
+ expect(@org.identifiers).to eql(original)
+ end
+ it "does not replace an existing identifier" do
+ array = [build(:identifier, identifier_scheme: @scheme1, value: "Foo")]
+ @org.consolidate_identifiers!(array: array)
+ expect(@org.identifier_for_scheme(scheme: @scheme1).value).to eql(@id1.value)
+ end
+ it "adds the new identifier" do
+ scheme3 = create(:identifier_scheme)
+ array = [build(:identifier, identifier_scheme: scheme3, value: "Foo")]
+ @org.consolidate_identifiers!(array: array)
+ expected = @org.identifier_for_scheme(scheme: scheme3).value
+ expect(expected.ends_with?("Foo")).to eql(true)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/models/condition_spec.rb b/spec/models/condition_spec.rb
new file mode 100644
index 0000000000..bcf85ec6b9
--- /dev/null
+++ b/spec/models/condition_spec.rb
@@ -0,0 +1,5 @@
+require 'rails_helper'
+
+RSpec.describe Condition, type: :model do
+ pending "add some examples to (or delete) #{__FILE__}"
+end
diff --git a/spec/models/contributor_spec.rb b/spec/models/contributor_spec.rb
new file mode 100644
index 0000000000..88f4089013
--- /dev/null
+++ b/spec/models/contributor_spec.rb
@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Contributor, type: :model do
+
+ context "validations" do
+
+ it { is_expected.to validate_presence_of(:roles) }
+
+ it "should validate that roles is greater than zero" do
+ subject.name = Faker::Books::Dune.character
+ subject.email = Faker::Internet.email
+ is_expected.to validate_numericality_of(:roles)
+ .with_message("You must specify at least one role.")
+ end
+
+ describe "#name_or_email_presence" do
+ before(:each) do
+ @contributor = build(:contributor, plan: create(:plan), investigation: true)
+ end
+
+ it "is invalid if both the name and email are blank" do
+ @contributor.name = nil
+ @contributor.email = nil
+ expect(@contributor.valid?).to eql(false)
+ expect(@contributor.errors[:name].present?).to eql(true)
+ expect(@contributor.errors[:email].present?).to eql(true)
+ end
+ it "is valid if a name is present" do
+ @contributor.email = nil
+ expect(@contributor.valid?).to eql(true)
+ end
+ it "is valid if an email is present" do
+ @contributor.name = nil
+ expect(@contributor.valid?).to eql(true)
+ end
+ end
+
+ end
+
+ context "associations" do
+ it { is_expected.to belong_to(:org) }
+ it { is_expected.to belong_to(:plan) }
+ it { is_expected.to have_many(:identifiers) }
+ end
+
+end
diff --git a/spec/models/exported_plan_spec.rb b/spec/models/exported_plan_spec.rb
new file mode 100644
index 0000000000..6c7dd8e5b0
--- /dev/null
+++ b/spec/models/exported_plan_spec.rb
@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Org, type: :model do
+
+ context "instance methods" do
+ before(:each) do
+ plan = create(:plan)
+ @owner = create(:user)
+ plan.roles << create(:role, :creator, user: @owner)
+ @exported = build(:exported_plan, plan: plan)
+ end
+
+ describe "#orcid" do
+ it "returns an empty string if the owner is nil" do
+ @exported.user = nil
+ expect(@exported.orcid).to eql("")
+ end
+ it "returns an empty string if the owner has no ORCID identifier" do
+
+ expect(@exported.orcid).to eql("")
+ end
+ it "returns the ORCID identifier" do
+ scheme = build(:identifier_scheme, name: "orcid")
+ identifier = build(:identifier, :for_user, identifier_scheme: scheme)
+ @exported.owner.identifiers << identifier
+ expect(@exported.orcid).to eql(identifier.value)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/models/guidance_group_spec.rb b/spec/models/guidance_group_spec.rb
index f57957b34d..c9861b1f3f 100644
--- a/spec/models/guidance_group_spec.rb
+++ b/spec/models/guidance_group_spec.rb
@@ -2,6 +2,11 @@
RSpec.describe GuidanceGroup, type: :model do
+ before(:each) do
+ # Ensure that the default managing org abbreviation is available
+ Rails.configuration.branding.fetch(:organisation, {})[:abbreviation] = "CC"
+ end
+
context "validations" do
it { is_expected.to validate_presence_of(:name) }
diff --git a/spec/models/guidance_spec.rb b/spec/models/guidance_spec.rb
index 9762897c36..7be4df9b2e 100644
--- a/spec/models/guidance_spec.rb
+++ b/spec/models/guidance_spec.rb
@@ -2,6 +2,11 @@
RSpec.describe Guidance, type: :model do
+ before(:each) do
+ # Ensure that the default managing org abbreviation is available
+ Rails.configuration.branding.fetch(:organisation, {})[:abbreviation] = "CC"
+ end
+
context "validations" do
it { is_expected.to validate_presence_of(:text) }
diff --git a/spec/models/identifier_scheme_spec.rb b/spec/models/identifier_scheme_spec.rb
index 27d02628c6..65272a166e 100644
--- a/spec/models/identifier_scheme_spec.rb
+++ b/spec/models/identifier_scheme_spec.rb
@@ -3,24 +3,73 @@
RSpec.describe IdentifierScheme, type: :model do
context "validations" do
-
it { is_expected.to validate_presence_of(:name) }
it { is_expected.to validate_length_of(:name).is_at_most(30) }
- it { is_expected.to allow_value(true).for(:name) }
+ it { is_expected.to allow_value("foo").for(:name) }
- it { is_expected.to allow_value(false).for(:name) }
+ it { is_expected.not_to allow_value("012").for(:name) }
it { is_expected.to_not allow_value(nil).for(:name) }
-
end
context "associations" do
+ it { is_expected.to have_many :identifiers }
+ end
+
+ context "scopes" do
+ before(:each) do
+ @scheme = create(:identifier_scheme, for_users: true, active: true)
+ end
+
+ describe "#active" do
+ it "returns active identifier schemes" do
+ expect(described_class.active.first).to eql(@scheme)
+ end
+ it "does not return inactive identifier schemes" do
+ @scheme.update(active: false)
+ expect(described_class.active.first).to eql(nil)
+ end
+ end
+
+ describe "#by_name scope" do
+ it "is case insensitive" do
+ rslt = described_class.by_name(@scheme.name.upcase).first
+ expect(rslt).to eql(@scheme)
+ end
+
+ it "returns the IdentifierScheme" do
+ rslt = described_class.by_name(@scheme.name).first
+ expect(rslt).to eql(@scheme)
+ end
+
+ it "returns empty ActiveRecord results if nothing is found" do
+ rslts = described_class.by_name(Faker::Lorem.sentence)
+ expect(rslts.empty?).to eql(true)
+ end
+ end
+ end
- it { is_expected.to have_many :user_identifiers }
+ context "instance methods" do
+ before(:each) do
+ @scheme = build(:identifier_scheme)
+ end
- it { is_expected.to have_many(:users).through(:user_identifiers) }
+ describe "#name=(value)" do
+ it "allows single word names" do
+ @scheme.name = "foo"
+ expect(@scheme.name).to eql("foo")
+ end
+ it "removes no alpha characters" do
+ @scheme.name = " foo bar- "
+ expect(@scheme.name).to eql("foobar")
+ end
+ it "sets everything to lower case" do
+ @scheme.name = "FoO"
+ expect(@scheme.name).to eql("foo")
+ end
+ end
end
diff --git a/spec/models/identifier_spec.rb b/spec/models/identifier_spec.rb
new file mode 100644
index 0000000000..5a8f79cb7e
--- /dev/null
+++ b/spec/models/identifier_spec.rb
@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Identifier, type: :model do
+
+ context "validations" do
+ it { is_expected.to validate_presence_of(:value) }
+
+ it { is_expected.to validate_presence_of(:identifiable) }
+
+ describe "uniqueness" do
+ before(:each) do
+ @org = create(:org)
+ end
+
+ it "prevents duplicate value when identifier_scheme is nil" do
+ scheme = create(:identifier_scheme)
+ create(:identifier, identifiable: @org, identifier_scheme: nil,
+ value: "foo")
+ id = build(:identifier, identifiable: @org, identifier_scheme: nil,
+ value: "foo")
+ expect(id.valid?).to eql(false)
+ expect(id.errors[:value].present?).to eql(true)
+ end
+ it "allows a duplicate value for the identifier_scheme" do
+ scheme = create(:identifier_scheme)
+ create(:identifier, identifiable: @org, identifier_scheme: scheme,
+ value: "foo")
+ id = build(:identifier, identifiable: create(:org),
+ identifier_scheme: scheme, value: "foo")
+ expect(id.valid?).to eql(true)
+ end
+ it "prevents multiple identifiers per identifier_scheme" do
+ scheme = create(:identifier_scheme)
+ create(:identifier, identifiable: @org, identifier_scheme: scheme,
+ value: Faker::Lorem.word)
+ id = build(:identifier, identifiable: @org, identifier_scheme: scheme,
+ value: Faker::Number.number.to_s)
+ expect(id.valid?).to eql(false)
+ expect(id.errors[:identifier_scheme].present?).to eql(true)
+ end
+ it "does not apply if the value is unique and identifier_scheme is nil" do
+ create(:identifier, identifiable: @org, identifier_scheme: nil,
+ value: Faker::Lorem.word)
+ id = build(:identifier, identifiable: @org, identifier_scheme: nil,
+ value: Faker::Number.number.to_s)
+ expect(id.valid?).to eql(true)
+ end
+ it "does not prevent identifiers for same scheme but different identifiables" do
+ scheme = create(:identifier_scheme)
+ create(:identifier, identifiable: @org, identifier_scheme: scheme,
+ value: Faker::Lorem.word)
+ id = build(:identifier, identifiable: create(:org),
+ identifier_scheme: scheme,
+ value: Faker::Number.number.to_s)
+ expect(id.valid?).to eql(true)
+ end
+ it "does not prevent same value for different schemes and identifiables" do
+ scheme = create(:identifier_scheme)
+ create(:identifier, identifiable: @org, identifier_scheme: scheme,
+ value: "foo")
+ id = build(:identifier, identifiable: create(:org),
+ identifier_scheme: create(:identifier_scheme),
+ value: "foo")
+ expect(id.valid?).to eql(true)
+ end
+ end
+ end
+
+ context "associations" do
+ it { is_expected.to belong_to(:identifiable) }
+
+ it { is_expected.to belong_to(:identifier_scheme) }
+ end
+
+ context "scopes" do
+ describe "#by_scheme_name" do
+ before(:each) do
+ @scheme = create(:identifier_scheme)
+ @scheme2 = create(:identifier_scheme)
+ @id = create(:identifier, :for_plan, identifier_scheme: @scheme)
+ @id2 = create(:identifier, :for_plan, identifier_scheme: @scheme2)
+
+ @rslts = described_class.by_scheme_name(@scheme.name, "Plan")
+ end
+
+ it "returns the correct identifier" do
+ expect(@rslts.include?(@id)).to eql(true)
+ end
+ it "does not return the identifier for the other scheme" do
+ expect(@rslts.include?(@id2)).to eql(false)
+ end
+ end
+ end
+
+ describe "#attrs=" do
+ let!(:identifier) { create(:identifier) }
+
+ it "when hash is a Hash sets attrs to a String of JSON" do
+ identifier.attrs = { foo: "bar" }
+ expect(identifier.attrs).to eql({ "foo": "bar" }.to_json)
+ end
+
+ it "when hash is nil sets attrs to empty JSON object" do
+ identifier.attrs = nil
+ expect(identifier.attrs).to eql({}.to_json)
+ end
+
+ it "when hash is a String sets attrs to empty JSON object" do
+ identifier.attrs = ""
+ expect(identifier.attrs).to eql({}.to_json)
+ end
+ end
+
+ describe "#identifier_format" do
+ it "returns 'orcid' for identifiers associated with the orcid identifier_scheme" do
+ scheme = build(:identifier_scheme, name: "orcid")
+ id = build(:identifier, identifier_scheme: scheme)
+ expect(id.identifier_format).to eql("orcid")
+ end
+ it "returns 'ror' for identifiers associated with the ror identifier_scheme" do
+ scheme = build(:identifier_scheme, name: "ror")
+ id = build(:identifier, identifier_scheme: scheme)
+ expect(id.identifier_format).to eql("ror")
+ end
+ it "returns 'fundref' for identifiers associated with the fundref identifier_scheme" do
+ scheme = build(:identifier_scheme, name: "fundref")
+ id = build(:identifier, identifier_scheme: scheme)
+ expect(id.identifier_format).to eql("fundref")
+ end
+ it "returns 'ark' for identifiers whose value contains 'ark:'" do
+ scheme = build(:identifier_scheme, name: "ror")
+ val = "#{scheme.identifier_prefix}ark:#{Faker::Lorem.word}"
+ id = create(:identifier, value: val)
+ expect(id.identifier_format).to eql("ark")
+ end
+ it "returns 'doi' for identifiers whose value matches the doi format" do
+ scheme = build(:identifier_scheme, name: "ror")
+ val = "#{scheme.identifier_prefix}doi:10.1234/123abc98"
+ id = create(:identifier, value: val)
+ expect(id.identifier_format).to eql("doi"), "expected url containing 'doi:' to be a doi"
+
+ val = "#{scheme.identifier_prefix}10.1234/123abc98"
+ id = create(:identifier, value: val)
+ expect(id.identifier_format).to eql("doi"), "expected url not containing 'doi:' to be a doi"
+ end
+ it "returns 'url' for identifiers whose value matches a URL format" do
+ scheme = build(:identifier_scheme, name: "ror")
+ id = create(:identifier, value: "#{scheme.identifier_prefix}#{Faker::Lorem.word}")
+ expect(id.identifier_format).to eql("url")
+
+ id = create(:identifier, value: "#{scheme.identifier_prefix}#{Faker::Lorem.word}")
+ expect(id.identifier_format).to eql("url")
+ end
+ it "returns 'other' for all other identifier values" do
+ scheme = build(:identifier_scheme, identifier_prefix: nil)
+ id = create(:identifier, value: Faker::Lorem.word, identifier_scheme: scheme)
+ expect(id.identifier_format).to eql("other"), "expected alpha characters to return 'other'"
+
+ id = create(:identifier, value: Faker::Number.number, identifier_scheme: scheme)
+ expect(id.identifier_format).to eql("other"), "expected numeric characters to return 'other'"
+
+ id = create(:identifier, value: SecureRandom.uuid, identifier_scheme: scheme)
+ expect(id.identifier_format).to eql("other"), "expected UUID to return 'other'"
+ end
+ end
+
+ describe "#value_without_scheme_prefix" do
+ before(:each) do
+ @scheme = create(:identifier_scheme, identifier_prefix: Faker::Internet.url)
+ @without = Faker::Lorem.word
+ @val = "#{@scheme.identifier_prefix}/#{@without}"
+ end
+
+ it "returns the value as is if no identifier scheme is present" do
+ id = create(:identifier, value: @val, identifier_scheme: nil)
+ expect(id.value_without_scheme_prefix).to eql(@val)
+ end
+ it "returns the value as is if no identifier scheme has no prefix" do
+ @scheme.identifier_prefix = nil
+ id = create(:identifier, value: @val, identifier_scheme: @scheme)
+ expect(id.value_without_scheme_prefix).to eql(@val)
+ end
+ it "returns the value without the identifier scheme prefix" do
+ id = create(:identifier, value: @val, identifier_scheme: @scheme)
+ expect(id.value_without_scheme_prefix).to eql(@without)
+ end
+ end
+
+ describe "#value=(val)" do
+ before(:each) do
+ @scheme = create(:identifier_scheme, identifier_prefix: Faker::Internet.url)
+ end
+
+ it "returns the value if the identifier_scheme is not present" do
+ val = Faker::Lorem.word
+ id = build(:identifier, value: val, identifier_scheme: nil)
+ expect(id.value).to eql(val)
+ end
+ it "returns the value if the identifier_scheme has no prefix" do
+ val = Faker::Lorem.word
+ @scheme.identifier_prefix = nil
+ id = build(:identifier, value: val, identifier_scheme: @scheme)
+ expect(id.value).to eql(val)
+ end
+ it "returns the value if the value is already a URL" do
+ val = "#{@scheme.identifier_prefix}/#{Faker::Lorem.word}"
+ id = build(:identifier, value: val, identifier_scheme: @scheme)
+ expect(id.value).to eql(val)
+ end
+ it "appends the identifier scheme prefix to the value" do
+ val = Faker::Lorem.word
+ id = build(:identifier, value: val, identifier_scheme: @scheme)
+ expected = @scheme.identifier_prefix
+ expect(id.value.starts_with?(expected)).to eql(true)
+ end
+ it "appends the identifier scheme prefix to the value even if its a URL" do
+ val = Faker::Internet.url
+ id = build(:identifier, value: val, identifier_scheme: @scheme)
+ expected = @scheme.identifier_prefix
+ expect(id.value.starts_with?(expected)).to eql(true)
+ end
+ end
+
+end
diff --git a/spec/models/notification_spec.rb b/spec/models/notification_spec.rb
index 99fc17620c..c63338f69f 100644
--- a/spec/models/notification_spec.rb
+++ b/spec/models/notification_spec.rb
@@ -16,6 +16,10 @@
it { is_expected.not_to allow_value(nil).for(:dismissable) }
+ it { is_expected.to allow_values(true, false).for(:enabled) }
+
+ it { is_expected.not_to allow_value(nil).for(:enabled) }
+
it { is_expected.to validate_presence_of(:starts_at) }
it { is_expected.to validate_presence_of(:expires_at) }
@@ -34,19 +38,21 @@
subject { Notification.active }
- context "when now is before starts_at" do
+ context "when enabled and now is before starts_at" do
- let!(:notification) { create(:notification, starts_at: 1.week.from_now) }
+ let!(:notification) { create(:notification, starts_at: 1.week.from_now,
+ enabled: true) }
it { is_expected.not_to include(notification) }
end
- context "when now lies between starts_at and expires_at" do
+ context "when enabled and now lies between starts_at and expires_at" do
let!(:notification) do
record = build(:notification, starts_at: 1.day.ago,
- expires_at: 1.day.from_now)
+ expires_at: 1.day.from_now,
+ enabled: true)
record.save(validate: false)
record
end
@@ -55,15 +61,29 @@
end
- context "when now is after expires_at" do
+ context "when enabled and now is after expires_at" do
let!(:notification) do
- create(:notification, starts_at: 1.week.from_now)
+ create(:notification, starts_at: 1.week.from_now, enabled: true)
end
it { is_expected.not_to include(notification) }
end
+
+ context "when disabled and now lies between starts_at and expires_at" do
+
+ let!(:notification) do
+ record = build(:notification, starts_at: 1.day.ago,
+ expires_at: 1.day.from_now)
+ record.save(validate: false)
+ record
+ end
+
+ it { is_expected.not_to include(notification) }
+
+ end
+
end
describe ".active_per_user" do
@@ -119,6 +139,30 @@
it { is_expected.to include(notification) }
end
+
+ context "when User is present and Notification is disabled" do
+
+ let!(:notification) { create(:notification, :active, enabled: false) }
+
+ let!(:user) { create(:user) }
+
+ subject { Notification.active_per_user(user) }
+
+ it { is_expected.not_to include(notification) }
+
+ end
+
+ context "when User is nil and Notification is not dismissable or enabled" do
+
+ let!(:user) { nil }
+
+ let!(:notification) { create(:notification) }
+
+ subject { Notification.active_per_user(user) }
+
+ it { is_expected.not_to include(notification) }
+
+ end
end
describe "#acknowledged?" do
diff --git a/spec/models/org_identifier_spec.rb b/spec/models/org_identifier_spec.rb
deleted file mode 100644
index ede69b184a..0000000000
--- a/spec/models/org_identifier_spec.rb
+++ /dev/null
@@ -1,68 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe OrgIdentifier, type: :model do
-
- context "validations" do
-
- it do
- # https://github.com/thoughtbot/shoulda-matchers/issues/682
- subject.identifier_scheme = create(:identifier_scheme)
- is_expected.to validate_uniqueness_of(:identifier_scheme_id)
- .scoped_to(:org_id)
- .with_message("must be unique")
- end
-
- it { is_expected.to validate_presence_of(:identifier) }
-
- it { is_expected.to validate_presence_of(:org) }
-
- it { is_expected.to validate_presence_of(:identifier_scheme) }
-
- end
-
- context "associations" do
-
- it { is_expected.to belong_to(:org) }
-
- it { is_expected.to belong_to(:identifier_scheme) }
-
- end
-
- describe "#attrs=" do
-
- context "when hash is a Hash" do
-
- let!(:org_identifier) { create(:org_identifier) }
-
- it "sets attrs to a String of JSON" do
- org_identifier.attrs = { foo: "bar" }
- expect(org_identifier.attrs).to eql({"foo" => "bar"}.to_json)
- end
-
- end
-
- context "when hash is nil" do
-
- let!(:org_identifier) { create(:org_identifier) }
-
- it "sets attrs to empty JSON object" do
- org_identifier.attrs = nil
- expect(org_identifier.attrs).to eql({}.to_json)
- end
-
- end
-
- context "when hash is a String" do
-
- let!(:org_identifier) { create(:org_identifier) }
-
- it "sets attrs to empty JSON object" do
- org_identifier.attrs = ''
- expect(org_identifier.attrs).to eql({}.to_json)
- end
-
- end
-
- end
-
-end
diff --git a/spec/models/org_spec.rb b/spec/models/org_spec.rb
index bbe7841e12..c8a17a0148 100644
--- a/spec/models/org_spec.rb
+++ b/spec/models/org_spec.rb
@@ -20,6 +20,8 @@
it { is_expected.to validate_presence_of(:language) }
+ it { is_expected.to allow_values(0, 1).for(:managed) }
+
it "validates presence of contact_email if feedback_enabled" do
subject.feedback_enabled = true
is_expected.to validate_presence_of(:contact_email)
@@ -62,35 +64,57 @@
it { should have_and_belong_to_many(:token_permission_types).join_table("org_token_permissions") }
- it { should have_many(:org_identifiers) }
+ it { should have_many(:identifiers) }
- it { should have_many(:identifier_schemes).through(:org_identifiers) }
+ it { should have_many(:plans) }
+ it { should have_many(:funded_plans) }
end
- describe ".managing_orgs" do
+ context "scopes" do
+ before(:each) do
+ @managed = create(:org, managed: true)
+ @unmanaged = create(:org, managed: false)
+ end
- subject { Org.managing_orgs }
+ describe ".default_orgs" do
+ subject { Org.default_orgs }
- context "when Org has same abbr as branding" do
+ context "when Org has same abbr as branding" do
- let!(:org) do
- create(:org,
- abbreviation: Rails.configuration
- .branding.dig(:organisation, :abbreviation))
+ let!(:org) do
+ abbrev = Rails.configuration.branding.dig(:organisation,
+ :abbreviation)
+ create(:org, abbreviation: abbrev)
- end
+ end
- it { is_expected.to include(org) }
+ it { is_expected.to include(org) }
- end
+ end
- context "when Org doesn't have same abbr as branding" do
+ context "when Org doesn't have same abbr as branding" do
- let!(:org) { create(:org, abbreviation: 'foo-bar') }
+ let!(:org) { create(:org, abbreviation: "foo-bar") }
- it { is_expected.not_to include(org) }
+ it { is_expected.not_to include(org) }
+ end
+ end
+
+ describe "#managed" do
+ it "returns only the managed orgs" do
+ rslts = described_class.managed
+ expect(rslts.include?(@managed)).to eql(true)
+ expect(rslts.include?(@unmanaged)).to eql(false)
+ end
+ end
+ describe "#unmanaged" do
+ it "returns only the un-managed orgs" do
+ rslts = described_class.unmanaged
+ expect(rslts.include?(@managed)).to eql(false)
+ expect(rslts.include?(@unmanaged)).to eql(true)
+ end
end
end
@@ -434,8 +458,21 @@
end
-
end
+ describe "#links" do
+ it "returns the contents of the field" do
+ links = { "org": [{
+ "link": Faker::Internet.url,
+ "text": Faker::Lorem.word
+ }] }
+ org = build(:org, links: links)
+ expect(org.links).to eql(JSON.parse(links.to_json))
+ end
+ it "defaults to {'org': }" do
+ org = build(:org)
+ expect(org.links).to eql(JSON.parse({ "org": [] }.to_json))
+ end
+ end
end
diff --git a/spec/models/phase_spec.rb b/spec/models/phase_spec.rb
index 530e443908..949d9d7b43 100644
--- a/spec/models/phase_spec.rb
+++ b/spec/models/phase_spec.rb
@@ -79,6 +79,10 @@
create_list(:section, 2, phase: phase)
end
+ it "checks number of sections" do
+ expect(subject.sections.size).to eql(phase.sections.size)
+ end
+
it "doesn't persist the record" do
expect(subject).to be_a_new_record
end
diff --git a/spec/models/plan_spec.rb b/spec/models/plan_spec.rb
index 4b35384129..505de16ec2 100644
--- a/spec/models/plan_spec.rb
+++ b/spec/models/plan_spec.rb
@@ -17,12 +17,38 @@
it { is_expected.to allow_values(true, false).for(:complete) }
it { is_expected.not_to allow_value(nil).for(:complete) }
+
+ describe "dates" do
+ before(:each) do
+ @plan = build(:plan)
+ end
+
+ it "allows start_date to be nil" do
+ @plan.start_date = nil
+ @plan.end_date = Time.now + 3.days
+ expect(@plan.valid?).to eql(true)
+ end
+ it "allows end_date to be nil" do
+ @plan.start_date = Time.now + 3.days
+ @plan.end_date = nil
+ expect(@plan.valid?).to eql(true)
+ end
+ it "does not allow end_date to come before start_date" do
+ @plan.start_date = Time.now + 3.days
+ @plan.end_date = Time.now
+ expect(@plan.valid?).to eql(false)
+ end
+ end
+
end
context "associations" do
it { is_expected.to belong_to :template }
+ it { is_expected.to belong_to :org }
+
+ it { is_expected.to belong_to :funder }
it { is_expected.to have_many :phases }
@@ -44,6 +70,10 @@
it { is_expected.to have_many :setting_objects }
+ it { is_expected.to have_many(:identifiers) }
+
+ it { is_expected.to have_many(:contributors) }
+
end
describe ".publicly_visible" do
@@ -457,7 +487,7 @@
context "when Plan title matches term" do
- let!(:plan) { create(:plan, title: "foolike title") }
+ let!(:plan) { create(:plan, :creator, title: "foolike title") }
it { is_expected.to include(plan) }
@@ -467,18 +497,69 @@
let!(:template) { create(:template, title: "foolike title") }
- let!(:plan) { create(:plan, template: template) }
+ let!(:plan) { create(:plan, :creator, template: template) }
it { is_expected.to include(plan) }
end
+ context "when Organisation name matches term" do
+
+ let!(:plan) { create(:plan, :creator, description: "foolike desc") }
+
+ let!(:org) { create(:org, name: 'foolike name') }
+
+ before do
+ user = plan.owner
+ user.org = org
+ user.save
+ end
+
+ it "returns organisation name" do
+ expect(subject).to include(plan)
+ end
+
+ end
+
+ # TODO: Add this one in once we are able to easily do LEFT JOINs in Rails 5
+ context "when Contributor name matches term" do
+ let!(:plan) { create(:plan, :creator, description: "foolike desc") }
+ let!(:contributor) { create(:contributor, plan: plan, name: "Dr. Foo Bar") }
+
+ xit "returns contributor name" do
+ expect(subject).to include(plan)
+ end
+ end
+
context "when neither title matches term" do
- let!(:plan) { create(:plan, description: "foolike desc") }
+ let!(:plan) { create(:plan, :creator, description: "foolike desc") }
+
+ it { is_expected.not_to include(plan) }
+
+ end
+
+
+ end
+
+ describe ".stats_filter" do
+
+ subject { Plan.all.stats_filter }
+
+ context "when plan visibility is test" do
+ let!(:plan) { create(:plan, :creator, :is_test) }
it { is_expected.not_to include(plan) }
+ end
+
+ context "when plan visibility is not test" do
+ let!(:p1) { create(:plan, :creator, :publicly_visible) }
+ let!(:p2) { create(:plan, :creator, :privately_visible) }
+ let!(:p3) { create(:plan, :creator, :organisationally_visible) }
+ it { is_expected.to include(p1) }
+ it { is_expected.to include(p2) }
+ it { is_expected.to include(p3) }
end
end
@@ -755,6 +836,12 @@
context "config does not allow admin viewing" do
+ before(:each) do
+ Branding.expects(:fetch)
+ .with(:service_configuration, :plans, :org_admins_read_all)
+ .returns(false)
+ end
+
it "super admins" do
Branding.expects(:fetch)
.with(:service_configuration, :plans, :super_admins_read_all)
@@ -765,10 +852,6 @@
end
it "org admins" do
- Branding.expects(:fetch)
- .with(:service_configuration, :plans, :org_admins_read_all)
- .returns(false)
-
user.perms << create(:perm, name: "modify_guidance")
expect(subject.readable_by?(user.id)).to eql(false)
end
@@ -1417,4 +1500,62 @@
end
end
+ describe "#landing_page" do
+ let!(:plan) { create(:plan, :creator) }
+
+ it "returns nil if no DOI or ARK is available" do
+ expect(plan.landing_page).to eql(nil)
+ end
+ it "returns the DOI if available" do
+ id = create(:identifier, identifiable: plan, value: "10.9999/123erge/45f")
+ plan.reload
+ expect(plan.landing_page).to eql(id)
+ end
+ it "returns the ARK if available" do
+ id = create(:identifier, identifiable: plan, value: "ark:10.9999/123")
+ plan.reload
+ expect(plan.landing_page).to eql(id)
+ end
+ end
+
+ describe "#grant association sanity checks" do
+ let!(:plan) { create(:plan, :creator) }
+
+ it "allows a grant identifier to be associated" do
+ plan.grant = build(:identifier, identifier_scheme: nil)
+ plan.save
+ expect(plan.grant.new_record?).to eql(false)
+ end
+ it "allows a grant identifier to be deleted" do
+ plan.grant = build(:identifier, identifier_scheme: nil)
+ plan.save
+ plan.grant = nil
+ plan.save
+ expect(plan.grant).to eql(nil)
+ expect(Identifier.last).to eql(nil)
+ end
+ it "does not allow multiple grants on a single plan" do
+ plan.grant = build(:identifier, identifier_scheme: nil)
+ plan.save
+ val = SecureRandom.uuid
+ plan.grant = build(:identifier, identifier_scheme: nil, value: val)
+ plan.save
+ expect(plan.grant.new_record?).to eql(false)
+ expect(plan.grant.value).to eql(val)
+ expect(Identifier.all.length).to eql(1)
+ end
+ it "allows the same grant to be associated with different plans" do
+ val = SecureRandom.uuid
+ id = build(:identifier, identifier_scheme: nil, value: val)
+ plan.grant = id
+ plan.save
+ plan2 = create(:plan, grant: id)
+ expect(plan2.grant).to eql(plan.grant)
+ expect(plan2.grant.value).to eql(plan.grant.value)
+ # Make sure that deleting the plan does not delete the shared grant!
+ plan.destroy
+ expect(plan2.grant).not_to eql(nil)
+ end
+ end
+
end
diff --git a/spec/models/question_spec.rb b/spec/models/question_spec.rb
index 7147288346..1bd55fc62f 100644
--- a/spec/models/question_spec.rb
+++ b/spec/models/question_spec.rb
@@ -124,6 +124,14 @@
context "when no options are provided" do
+ before do
+ create_list(:question_option, 4, question: question)
+ end
+
+ it "checks number of question options" do
+ expect(subject.question_options.size).to eql(question.question_options.size)
+ end
+
it "doesn't persist the record" do
expect(subject).to be_new_record
end
diff --git a/spec/models/section_spec.rb b/spec/models/section_spec.rb
index 904c9aefeb..c5872d4527 100644
--- a/spec/models/section_spec.rb
+++ b/spec/models/section_spec.rb
@@ -34,6 +34,28 @@
end
+ describe "#deep_copy" do
+
+ let!(:options) { Hash.new }
+
+ let!(:section) { create(:section) }
+
+ subject { section.deep_copy(options) }
+
+ context "when no options provided" do
+
+ before do
+ create_list(:question, 3, section: section)
+ end
+
+ it "checks number of questions" do
+ expect(section.questions.size).to eql(section.questions.size)
+ end
+
+ end
+
+ end
+
describe "#num_answered_questions" do
let!(:phase) { create(:phase, template: template) }
diff --git a/spec/models/template_spec.rb b/spec/models/template_spec.rb
index 800d405220..e4a353b5eb 100644
--- a/spec/models/template_spec.rb
+++ b/spec/models/template_spec.rb
@@ -46,6 +46,10 @@
it { is_expected.to have_many :questions }
+ it { is_expected.to have_many :question_options }
+
+ it { is_expected.to have_many :conditions }
+
it { is_expected.to have_many :annotations }
end
diff --git a/spec/models/tracker_spec.rb b/spec/models/tracker_spec.rb
new file mode 100644
index 0000000000..41ddb2aa28
--- /dev/null
+++ b/spec/models/tracker_spec.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+#
+require 'rails_helper'
+
+RSpec.describe Tracker, type: :model do
+ describe "creation" do
+ it "can be created from an org" do
+ org = build(:org)
+ tracker = org.build_tracker
+ expect(tracker).to be_valid
+ end
+
+ it "can be created with an empty code" do
+ org = build(:org)
+ tracker = org.build_tracker(code: "")
+ expect(tracker).to be_valid
+ end
+
+ it "fails with a badly formatted code" do
+ org = build(:org)
+ tracker = org.build_tracker(code: "XXXXXXXXXX")
+ expect(tracker).to_not be_valid
+ end
+
+ it "works with a valid code" do
+ org = build(:org)
+ tracker = org.build_tracker(code: "UA-12345678-12")
+ expect(tracker).to be_valid
+ end
+
+ it "fails with a null org" do
+ org = build(:org)
+ tracker = org.build_tracker(code: "XXXXXXXXXX")
+ tracker.org = nil
+ expect(tracker).to_not be_valid
+ end
+ end
+end
diff --git a/spec/models/user_identifier_spec.rb b/spec/models/user_identifier_spec.rb
deleted file mode 100644
index d82de6ba2a..0000000000
--- a/spec/models/user_identifier_spec.rb
+++ /dev/null
@@ -1,23 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe UserIdentifier, type: :model do
-
- context "validations" do
-
- it { is_expected.to validate_presence_of(:identifier) }
-
- it { is_expected.to validate_presence_of(:user) }
-
- it { is_expected.to validate_presence_of(:identifier_scheme) }
-
- end
-
- context "associations" do
-
- it { is_expected.to belong_to :user }
-
- it { is_expected.to belong_to :identifier_scheme }
-
- end
-
-end
diff --git a/spec/models/user_spec.rb b/spec/models/user_spec.rb
index 4529958ca9..397aa57c50 100644
--- a/spec/models/user_spec.rb
+++ b/spec/models/user_spec.rb
@@ -57,11 +57,7 @@
it { is_expected.to have_many(:plans).through(:roles) }
- it { is_expected.to have_many(:user_identifiers) }
-
- it {
- is_expected.to have_many(:identifier_schemes).through(:user_identifiers)
- }
+ it { should have_many(:identifiers) }
it {
is_expected.to have_and_belong_to_many(:notifications).dependent(:destroy)
@@ -283,30 +279,22 @@
end
describe "#identifier_for" do
-
let!(:user) { create(:user) }
+ let!(:scheme) { create(:identifier_scheme) }
- let!(:identifier_scheme) { create(:identifier_scheme) }
-
- subject { user.identifier_for(identifier_scheme) }
-
- context "when user has an user_identifier present" do
+ subject { user.identifier_for(scheme.name) }
- let!(:user_identifier) do
- create(:user_identifier, identifier_scheme: identifier_scheme,
- user: user)
+ context "when user has an identifier present" do
+ let!(:identifier) do
+ create(:identifier, :for_user, identifier_scheme: scheme,
+ identifiable: user)
end
- it { is_expected.to eql(user_identifier) }
-
+ it { is_expected.to eql(identifier) }
end
context "when user has no user_identifier present" do
-
- let!(:user_identifier) { create(:user_identifier, user: user) }
-
- it { is_expected.not_to eql(user_identifier) }
-
+ it { is_expected.not_to eql("") }
end
end
@@ -347,7 +335,6 @@
end
describe "#can_org_admin?" do
-
subject { user.can_org_admin? }
context "when user includes Perm with name 'grant_permissions'" do
@@ -550,45 +537,34 @@
end
end
+ # Test creationg a User from an omniauth callback like Shibboleth
describe ".from_omniauth" do
-
let!(:user) { create(:user) }
-
- let!(:auth) { stub(provider: "auth-provider", uid: "1234abcd") }
+ let!(:auth) do
+ OpenStruct.new(provider: Faker::Lorem.unique.word, uid: Faker::Lorem.word)
+ end
+ let!(:scheme) { create(:identifier_scheme, name: auth[:provider], identifier_prefix: nil) }
subject { User.from_omniauth(auth) }
-
- context "when User has UserIdentifier, with different ID" do
-
- let!(:identifier_scheme) do
- create(:identifier_scheme, name: "auth-provider")
- end
-
- let!(:user_identifier) do
- create(:user_identifier, user: user,
- identifier_scheme: identifier_scheme,
- identifier: "another-auth-uid")
+ context "when User has Identifier, with different ID" do
+ let!(:identifier) do
+ create(:identifier, :for_user, identifiable: user,
+ identifier_scheme: scheme,
+ value: Faker::Movies::StarWars.character)
end
it { is_expected.to be_nil }
-
end
context "when user Identifier and auth Provider are the same string" do
-
- let!(:identifier_scheme) do
- create(:identifier_scheme, name: "auth-provider")
- end
-
- let!(:user_identifier) do
- create(:user_identifier, user: user,
- identifier_scheme: identifier_scheme,
- identifier: "1234abcd")
+ let!(:identifier) do
+ create(:identifier, :for_user, identifiable: user,
+ identifier_scheme: scheme,
+ value: auth[:uid])
end
it { is_expected.to eql(user) }
-
end
end
diff --git a/spec/presenters/api/v1/contributor_presenter_spec.rb b/spec/presenters/api/v1/contributor_presenter_spec.rb
new file mode 100644
index 0000000000..30604ca332
--- /dev/null
+++ b/spec/presenters/api/v1/contributor_presenter_spec.rb
@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::ContributorPresenter do
+
+ describe "#role_as_uri" do
+ it "returns nil if the plans_contributor role is nil" do
+ uri = described_class.role_as_uri(role: nil)
+ expect(uri).to eql(nil)
+ end
+ it "returns the correct URI" do
+ uri = described_class.role_as_uri(role: "data_curation")
+ expect(uri.start_with?("http")).to eql(true)
+ expect(uri.end_with?("Data_curation")).to eql(true)
+ end
+ end
+
+ describe "#contributor_id" do
+ before(:each) do
+ @contributor = create(:contributor, investigation: true, plan: create(:plan))
+ create(:identifier, identifiable: @contributor)
+ @contributor.reload
+ end
+
+ it "returns nil if no ORCID exists" do
+ rslt = described_class.contributor_id(identifiers: @contributor.identifiers)
+ expect(rslt).to eql(nil)
+ end
+ it "returns the ORCID" do
+ scheme = create(:identifier_scheme, name: "orcid")
+ orcid = create(:identifier, identifier_scheme: scheme, identifiable: @contributor)
+ @contributor.reload
+ rslt = described_class.contributor_id(identifiers: @contributor.identifiers)
+ expect(rslt).to eql(orcid)
+ end
+ end
+
+end
diff --git a/spec/presenters/api/v1/funding_presenter_spec.rb b/spec/presenters/api/v1/funding_presenter_spec.rb
new file mode 100644
index 0000000000..feb6dde3d6
--- /dev/null
+++ b/spec/presenters/api/v1/funding_presenter_spec.rb
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::FundingPresenter do
+
+ describe "#status(plan:)" do
+ it "returns `planned` if the plan is nil" do
+ expect(described_class.status(plan: nil)).to eql("planned")
+ end
+ it "returns `planned` if the plan's grant_number is nil" do
+ plan = build(:plan, grant_number: nil)
+ expect(described_class.status(plan: plan)).to eql("planned")
+ end
+ it "returns `granted` if the plan has a grant_number" do
+ plan = build(:plan, grant_number: Faker::Lorem.word)
+ expect(described_class.status(plan: plan)).to eql("granted")
+ end
+ end
+
+end
diff --git a/spec/presenters/api/v1/language_presenter_spec.rb b/spec/presenters/api/v1/language_presenter_spec.rb
new file mode 100644
index 0000000000..1997820e84
--- /dev/null
+++ b/spec/presenters/api/v1/language_presenter_spec.rb
@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::LanguagePresenter do
+
+ describe "#three_char_code(lang:)" do
+ it "returns nil if the specified lang (as string) has no match" do
+ expect(described_class.three_char_code(lang: "foo")).to eql(nil)
+ end
+ it "returns nil if the specified lang (as symbol) has no match" do
+ expect(described_class.three_char_code(lang: :foo)).to eql(nil)
+ end
+ it "returns the 3 char code for the specified lang (as string)" do
+ expect(described_class.three_char_code(lang: "en")).to eql("eng")
+ end
+ it "returns the 3 char code for the specified lang (as symbol)" do
+ expect(described_class.three_char_code(lang: :en)).to eql("eng")
+ end
+ it "returns the 3 char code for the specified lang with region designation" do
+ expect(described_class.three_char_code(lang: "en-UK")).to eql("eng")
+ end
+ end
+
+end
diff --git a/spec/presenters/api/v1/org_presenter_spec.rb b/spec/presenters/api/v1/org_presenter_spec.rb
new file mode 100644
index 0000000000..dea4a61a61
--- /dev/null
+++ b/spec/presenters/api/v1/org_presenter_spec.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::OrgPresenter do
+
+ describe "#affiliation_id" do
+ before(:each) do
+ @ror_scheme = create(:identifier_scheme, name: "ror")
+ @fundref_scheme = create(:identifier_scheme, name: "fundref")
+ @org = create(:org)
+ create(:identifier, identifiable: @org)
+ @org.reload
+ end
+
+ it "returns nil if no ORCID exists" do
+ rslt = described_class.affiliation_id(identifiers: @org.identifiers)
+ expect(rslt).to eql(nil)
+ end
+ it "returns the ROR" do
+ ror = create(:identifier, identifier_scheme: @ror_scheme, identifiable: @org)
+ create(:identifier, identifier_scheme: @fundref_scheme, identifiable: @org)
+ @org.reload
+ rslt = described_class.affiliation_id(identifiers: @org.identifiers)
+ expect(rslt).to eql(ror)
+ end
+ it "returns the FUNDREF if no ROR is present" do
+ fundref = create(:identifier, identifier_scheme: @fundref_scheme,
+ identifiable: @org)
+ @org.reload
+ rslt = described_class.affiliation_id(identifiers: @org.identifiers)
+ expect(rslt).to eql(fundref)
+ end
+ end
+
+end
diff --git a/spec/presenters/api/v1/pagination_presenter_spec.rb b/spec/presenters/api/v1/pagination_presenter_spec.rb
new file mode 100644
index 0000000000..5d9ace05f5
--- /dev/null
+++ b/spec/presenters/api/v1/pagination_presenter_spec.rb
@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::PaginationPresenter do
+
+ describe "#url_without_pagination" do
+ before(:each) do
+ @url = Faker::Internet.url
+ end
+
+ it "returns nil if no url was specified" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 1, current_page: 1)
+ expect(presenter.url_without_pagination).to eql(nil)
+ end
+ it "removes per_page from the query string" do
+ target = "#{@url}?per_page=2"
+ presenter = described_class.new(current_url: target, per_page: 2,
+ total_items: 1, current_page: 1)
+ rslt = presenter.url_without_pagination.include?("per_page=2")
+ expect(rslt).to eql(false)
+ end
+ it "removes page from the query string" do
+ target = "#{@url}?page=2"
+ presenter = described_class.new(current_url: target, per_page: 2,
+ total_items: 1, current_page: 1)
+ rslt = presenter.url_without_pagination.include?("page=2")
+ expect(rslt).to eql(false)
+ end
+ it "retains other query string items if there were no pagination ones" do
+ target = "#{@url}?other=true"
+ presenter = described_class.new(current_url: target, per_page: 2,
+ total_items: 1, current_page: 1)
+ rslt = presenter.url_without_pagination.include?("other=true")
+ expect(rslt).to eql(true)
+ end
+ it "retains other query string items if it removed pagination ones" do
+ target = "#{@url}?per_page=2&other=true"
+ presenter = described_class.new(current_url: target, per_page: 2,
+ total_items: 1, current_page: 1)
+ rslt = presenter.url_without_pagination.include?("other=true")
+ expect(rslt).to eql(true)
+ end
+ it "ends with a '&' if there were query string items" do
+ target = "#{@url}?per_page=2&other=true"
+ presenter = described_class.new(current_url: target, per_page: 2,
+ total_items: 1, current_page: 1)
+ rslt = presenter.url_without_pagination.end_with?("&")
+ expect(rslt).to eql(true)
+ end
+ it "ends with a '?' if there were no query string items" do
+ presenter = described_class.new(current_url: @url, per_page: 2,
+ total_items: 1, current_page: 1)
+ rslt = presenter.url_without_pagination.end_with?("?")
+ expect(rslt).to eql(true)
+ end
+ it "ends with a '?' if there were only pagination items in query string" do
+ target = "#{@url}?page=2"
+ presenter = described_class.new(current_url: target, per_page: 2,
+ total_items: 1, current_page: 1)
+ rslt = presenter.url_without_pagination.end_with?("?")
+ expect(rslt).to eql(true)
+ end
+ end
+
+ describe "#prev_page?" do
+ it "returns false if we are on page 1" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 4, current_page: 1)
+ expect(presenter.prev_page?).to eql(false)
+ end
+ it "returns false if there is only 1 page" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 2, current_page: 2)
+ expect(presenter.prev_page?).to eql(false)
+ end
+ it "returns true if more than 1 page and we are not on page 1" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 4, current_page: 2)
+ expect(presenter.prev_page?).to eql(true)
+ end
+ end
+
+ describe "#next_page?" do
+ it "returns false if we are on the last page" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 4, current_page: 2)
+ expect(presenter.next_page?).to eql(false)
+ end
+ it "returns false if there is only 1 page" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 2, current_page: 1)
+ expect(presenter.next_page?).to eql(false)
+ end
+ it "returns true if more than 1 page and we are not on last page" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 4, current_page: 1)
+ expect(presenter.next_page?).to eql(true)
+ end
+ end
+
+ describe "#prev_page_link" do
+ before(:each) do
+ url = "#{Faker::Internet.url}?other=true"
+ @presenter = described_class.new(current_url: url, per_page: 2,
+ total_items: 4, current_page: 2)
+ end
+
+ it "includes per_page in the query string" do
+ expect(@presenter.prev_page_link.include?("per_page=2")).to eql(true)
+ end
+ it "includes shows the correct page number" do
+ expect(@presenter.prev_page_link.include?("page=1")).to eql(true)
+ end
+ it "retains other query params" do
+ expect(@presenter.prev_page_link.include?("other=true")).to eql(true)
+ end
+ end
+
+ describe "#next_page_link" do
+ before(:each) do
+ url = "#{Faker::Internet.url}?other=true"
+ @presenter = described_class.new(current_url: url, per_page: 2,
+ total_items: 4, current_page: 1)
+ end
+
+ it "includes per_page in the query string" do
+ expect(@presenter.next_page_link.include?("per_page=2")).to eql(true)
+ end
+ it "includes shows the correct page number" do
+ expect(@presenter.next_page_link.include?("page=2")).to eql(true)
+ end
+ it "retains other query params" do
+ expect(@presenter.next_page_link.include?("other=true")).to eql(true)
+ end
+ end
+
+ context "private methods" do
+
+ describe "#total_pages" do
+ it "returns 1 if total_items is missing" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: nil)
+ expect(presenter.send(:total_pages)).to eql(1)
+ end
+ it "returns 1 if per_page is missing" do
+ presenter = described_class.new(current_url: nil, per_page: nil,
+ total_items: 4)
+ expect(presenter.send(:total_pages)).to eql(1)
+ end
+ it "returns 1 if total_items is <= 0" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 0)
+ expect(presenter.send(:total_pages)).to eql(1)
+ end
+ it "returns 1 if per_page is <= 0" do
+ presenter = described_class.new(current_url: nil, per_page: 0,
+ total_items: 4)
+ expect(presenter.send(:total_pages)).to eql(1)
+ end
+ it "returns the total_items / per_page" do
+ presenter = described_class.new(current_url: nil, per_page: 2,
+ total_items: 4)
+ expect(presenter.send(:total_pages)).to eql(2)
+ end
+ it "rounds up" do
+ presenter = described_class.new(current_url: nil, per_page: 3,
+ total_items: 4)
+ expect(presenter.send(:total_pages)).to eql(2)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/presenters/api/v1/plan_presenter_spec.rb b/spec/presenters/api/v1/plan_presenter_spec.rb
new file mode 100644
index 0000000000..ea5fb9071e
--- /dev/null
+++ b/spec/presenters/api/v1/plan_presenter_spec.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::PlanPresenter do
+
+ describe "#initialize(plan:)" do
+ before(:each) do
+ plan = build(:plan)
+ @data_contact = build(:contributor, data_curation: true)
+ @pi = build(:contributor, investigation: true)
+ plan.contributors = [@data_contact, @pi]
+ @presenter = described_class.new(plan: plan)
+ end
+
+ it "sets contributors to empty array if no plan was specified" do
+ presenter = described_class.new(plan: nil)
+ expect(presenter.data_contact).to eql(nil)
+ expect(presenter.contributors).to eql([])
+ end
+ it "sets contributors to empty array if plan has no contributors" do
+ plan = build(:plan)
+ plan.contributors = []
+ presenter = described_class.new(plan: plan)
+ expect(presenter.data_contact).to eql(nil)
+ expect(presenter.contributors).to eql([])
+ end
+ it "sets data_contact" do
+ expect(@presenter.data_contact).to eql(@data_contact)
+ end
+ it "sets other contributors (including the data_contact)" do
+ expect(@presenter.contributors.length).to eql(2)
+ expect(@presenter.contributors.include?(@data_contact)).to eql(true)
+ expect(@presenter.contributors.include?(@pi)).to eql(true)
+ end
+ end
+
+end
diff --git a/spec/presenters/api/v1/template_presenter_spec.rb b/spec/presenters/api/v1/template_presenter_spec.rb
new file mode 100644
index 0000000000..82966749aa
--- /dev/null
+++ b/spec/presenters/api/v1/template_presenter_spec.rb
@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::TemplatePresenter do
+
+ describe "#title" do
+ before(:each) do
+ @org = create(:org)
+ @template = build(:template, customization_of: nil, org: @org)
+ end
+
+ it "returns the template title if its not a customization" do
+ presenter = described_class.new(template: @template)
+ expect(presenter.title).to eql(@template.title)
+ end
+ it "returns the template title and Org name if it is a customization" do
+ @template.customization_of = Faker::Number.number
+ presenter = described_class.new(template: @template)
+ expect(presenter.title.start_with?(@template.title)).to eql(true)
+ expect(presenter.title.end_with?(@org.name)).to eql(true)
+ end
+ end
+
+end
diff --git a/spec/presenters/identifier_presenter_spec.rb b/spec/presenters/identifier_presenter_spec.rb
new file mode 100644
index 0000000000..4a97ba7112
--- /dev/null
+++ b/spec/presenters/identifier_presenter_spec.rb
@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe IdentifierPresenter do
+
+ before(:each) do
+ @user = create(:user)
+ @user_scheme = create(:identifier_scheme, for_users: true)
+ @plan_scheme = create(:identifier_scheme, for_plans: true, for_users: false)
+ @org_scheme = create(:identifier_scheme, for_orgs: true, for_users: false)
+ end
+
+ describe "#identifiers" do
+ it "returns the identiable object's identifiers" do
+ id = build(:identifier)
+ @user.identifiers << id
+ @user.org.identifiers << build(:identifier)
+ presenter = described_class.new(identifiable: @user)
+ expect(presenter.identifiers.length).to eql(1)
+ expect(presenter.identifiers.first).to eql(id)
+ end
+ end
+
+ describe "#id_for_scheme(scheme:)" do
+ before(:each) do
+ @user_id = build(:identifier, identifier_scheme: @user_scheme)
+ @user_id2 = build(:identifier, identifier_scheme: @org_scheme)
+ @user.identifiers = [@user_id, @user_id2]
+ @presenter = described_class.new(identifiable: @user)
+ end
+
+ it "initializes a new identifier if no matching identifiers exist" do
+ rslt = @presenter.id_for_scheme(scheme: @plan_scheme)
+ expect(rslt.new_record?).to eql(true)
+ end
+
+ it "returns the correct identifier" do
+ rslt = @presenter.id_for_scheme(scheme: @user_scheme)
+ expect(rslt).to eql(@user_id)
+ end
+ end
+
+ describe "#scheme_by_name(name:)" do
+ it "returns the correct scheme" do
+ presenter = described_class.new(identifiable: @user)
+ rslt = presenter.scheme_by_name(name: @user_scheme.name)
+ expect(rslt.first).to eql(@user_scheme)
+ end
+ end
+
+ describe "#id_for_display(id:, with_scheme_name)" do
+ before(:each) do
+ @none = _("None defined")
+ @presenter = described_class.new(identifiable: @user)
+
+ url = Faker::Internet.url
+ @user_scheme.identifier_prefix = url
+ val = "#{url}/#{Faker::Lorem.word}"
+ @identifier = create(:identifier, identifier_scheme: @user_scheme,
+ value: val)
+ end
+
+ it "defaults to showing the scheme name" do
+ rslt = @presenter.id_for_display(id: @identifier)
+ expect(rslt.include?(@user_scheme.identifier_prefix)).to eql(true)
+ end
+ it "does not display the scheme name if flag is set" do
+ rslt = @presenter.id_for_display(id: @identifier, with_scheme_name: false)
+ expect(rslt.include?(@user_scheme.name)).to eql(false)
+ end
+ it "returns the correct text when the identifier is new" do
+ id = build(:identifier)
+ rslt = @presenter.id_for_display(id: id)
+ expect(rslt).to eql(@none)
+ end
+ it "returns the correct text when the identifier is blank" do
+ @identifier.value = ""
+ rslt = @presenter.id_for_display(id: @identifier)
+ expect(rslt).to eql(@none)
+ end
+ it "returns the value when the scheme has no identifier_prefix" do
+ val = Faker::Lorem.word
+ @user_scheme.identifier_prefix = nil
+ @identifier.value = val
+ rslt = @presenter.id_for_display(id: @identifier)
+ expect(rslt).to eql(val)
+ end
+ it "returns the value as a link when the scheme has a identifier_prefix" do
+ rslt = @presenter.id_for_display(id: @identifier)
+ expect(rslt.include?(@identifier.value)).to eql(true)
+ end
+ end
+
+ context "#schemes" do
+ describe "when the identifiable object is an Org" do
+ before(:each) do
+ @presenter = described_class.new(identifiable: build(:org))
+ end
+
+ it "returns schemes appropriate to the Org context" do
+ expect(@presenter.schemes.include?(@org_scheme)).to eql(true)
+ end
+ it "does not return schemes for other contexts" do
+ expect(@presenter.schemes.include?(@user_scheme)).not_to eql(true)
+ expect(@presenter.schemes.include?(@plan_scheme)).not_to eql(true)
+ end
+ end
+
+ describe "when the identifiable object is an Plan" do
+ before(:each) do
+ @presenter = described_class.new(identifiable: build(:plan))
+ end
+
+ it "returns schemes appropriate to the Plan context" do
+ expect(@presenter.schemes.include?(@plan_scheme)).to eql(true)
+ end
+ it "does not return schemes for other contexts" do
+ expect(@presenter.schemes.include?(@user_scheme)).not_to eql(true)
+ expect(@presenter.schemes.include?(@org_scheme)).not_to eql(true)
+ end
+ end
+
+ describe "when the identifiable object is an User" do
+ before(:each) do
+ @presenter = described_class.new(identifiable: build(:user))
+ end
+
+ it "returns schemes appropriate to the User context" do
+ expect(@presenter.schemes.include?(@user_scheme)).to eql(true)
+ end
+ it "does not return schemes for other contexts" do
+ expect(@presenter.schemes.include?(@org_scheme)).not_to eql(true)
+ expect(@presenter.schemes.include?(@plan_scheme)).not_to eql(true)
+ end
+ end
+ end
+
+end
diff --git a/spec/presenters/org_selection_presenter_spec.rb b/spec/presenters/org_selection_presenter_spec.rb
new file mode 100644
index 0000000000..d5a7191080
--- /dev/null
+++ b/spec/presenters/org_selection_presenter_spec.rb
@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe OrgSelectionPresenter do
+
+ before(:each) do
+ @org = create(:org)
+ @orgs = [@org, build(:org)]
+ @presenter = described_class.new(orgs: @orgs, selection: @org)
+ end
+
+ describe "#name" do
+ it "returns blank if no selection is defined" do
+ presenter = described_class.new(orgs: @orgs, selection: nil)
+ expect(presenter.name).to eql("")
+ end
+ it "#name returns blank" do
+ expect(@presenter.name).to eql(@org.name)
+ end
+ end
+
+ it "#crosswalk returns an array containing the Orgs as hashes" do
+ rslt = JSON.parse(@presenter.crosswalk)
+ @orgs.each do |org|
+ expected = OrgSelection::OrgToHashService.to_hash(org: org).to_json
+ expect(rslt.include?(JSON.parse(expected))).to eql(true)
+ end
+ end
+
+ it "#select_list returns an array of the Org names" do
+ expect(@presenter.select_list.include?(@org.name)).to eql(true)
+ end
+
+ describe "#crosswalk_entry_from_org_id(value:)" do
+ it "return an empty hash if the value is blank" do
+ expect(@presenter.crosswalk_entry_from_org_id(value: nil)).to eql("{}")
+ end
+ it "return an empty hash if the value is not an integer" do
+ expect(@presenter.crosswalk_entry_from_org_id(value: "a123")).to eql("{}")
+ end
+ it "return an empty hash if the value does not have a match in crosswalk" do
+ expect(@presenter.crosswalk_entry_from_org_id(value: "999")).to eql("{}")
+ end
+ it "return ther correct crosswalk entry" do
+ rslt = @presenter.crosswalk_entry_from_org_id(value: @org.id.to_s)
+ expected = OrgSelection::OrgToHashService.to_hash(org: @org).to_json
+ expect(rslt).to eql(expected)
+ end
+ end
+
+end
diff --git a/spec/presenters/plan_presenter.rb b/spec/presenters/plan_presenter.rb
new file mode 100644
index 0000000000..f316e93fde
--- /dev/null
+++ b/spec/presenters/plan_presenter.rb
@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe PlanPresenter do
+
+ before(:each) do
+ @plan = build(:plan, start_date: nil, end_date: nil)
+ @presenter = described_class.new(@plan)
+ end
+
+ describe "#project_dates_to_readonly_display" do
+ it "returns blank if no start_date or end_date" do
+ expect(@presenter.project_dates_to_readonly_display).to eql("")
+ end
+ it "returns 'Starts on [:date]' if end_date is nil" do
+ @plan.start_date = Time.now
+ expected = @presenter.project_dates_to_readonly_display
+ expect(expected.start_with?("Starts on")).to eql(true)
+ end
+ it "returns 'Ends on [:date]' if start_date is nil" do
+ @plan.end_date = Time.now
+ expected = @presenter.project_dates_to_readonly_display
+ expect(expected.start_with?("Ends on")).to eql(true)
+ end
+ it "returns '[:date] to [:date]' start_date end_date are present" do
+ @plan.start_date = Time.now
+ @plan.end_date = Time.now + 2.months
+ expected = @presenter.project_dates_to_readonly_display
+ expect(expected.include?(" to ")).to eql(true)
+ end
+ end
+
+end
diff --git a/spec/rails_helper.rb b/spec/rails_helper.rb
index dab15ab9fc..3fa3598b4b 100644
--- a/spec/rails_helper.rb
+++ b/spec/rails_helper.rb
@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
# This file is copied to spec/ when you run 'rails generate rspec:install'
-require 'spec_helper'
-ENV['RAILS_ENV'] ||= 'test'
-require File.expand_path('../../config/environment', __FILE__)
+require "spec_helper"
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../config/environment", __dir__)
# Prevent database truncation if the environment is production
abort("The Rails environment is running in production mode!") if Rails.env.production?
-require 'rspec/rails'
-require 'capybara-screenshot/rspec'
+require "rspec/rails"
+# require "capybara-screenshot/rspec"
+require "webmock/rspec"
# Clear all of the screenshots from old tests
Dir[Rails.root.join('tmp/capybara/*')].each { |f| File.delete(f) }
@@ -24,9 +27,9 @@
# directory. Alternatively, in the individual `*_spec.rb` files, manually
# require only the support files necessary.
#
-Dir[Rails.root.join('spec/support/**/*.rb')].each { |f| require f }
+Dir[Rails.root.join("spec/support/**/*.rb")].sort.each { |f| require f }
-Dir[Rails.root.join('spec/mixins/*.rb')].each { |f| require f }
+Dir[Rails.root.join("spec/mixins/*.rb")].sort.each { |f| require f }
# Checks for pending migrations and applies them before tests are run.
# If you are not using ActiveRecord, you can remove this line.
@@ -59,6 +62,7 @@
# config.filter_gems_from_backtrace("gem name")
config.include Devise::Test::IntegrationHelpers, type: :request
config.include Devise::Test::ControllerHelpers, type: :controller
+ config.include Devise::Test::ControllerHelpers, type: :view
config.include Pundit::Matchers, type: :policy
# ------------------------------------------------------
diff --git a/spec/requests/api/v1/authentication_controller_spec.rb b/spec/requests/api/v1/authentication_controller_spec.rb
new file mode 100644
index 0000000000..c6176a566d
--- /dev/null
+++ b/spec/requests/api/v1/authentication_controller_spec.rb
@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::AuthenticationController, type: :request do
+
+ before(:each) do
+ @client = create(:api_client)
+ end
+
+ context "actions" do
+
+ describe "POST /api/v1/authenticate" do
+ before(:each) do
+ @client = create(:api_client)
+ @payload = {
+ grant_type: "client_credentials",
+ client_id: @client.client_id,
+ client_secret: @client.client_secret
+ }
+ end
+
+ it "calls the Api::Jwt::AuthenticationService" do
+ Api::V1::Auth::Jwt::AuthenticationService.expects(:call).at_most(1)
+ post api_v1_authenticate_path, @payload.to_json
+ end
+ it "renders /api/v1/error template if authentication fails" do
+ errs = [Faker::Lorem.sentence]
+ Api::V1::Auth::Jwt::AuthenticationService.any_instance
+ .stubs(:call).returns(nil)
+ .stubs(:errors).returns(errs)
+ post api_v1_authenticate_path, @payload.to_json
+ expect(response.code).to eql("401")
+ expect(response).to render_template("api/v1/error")
+ end
+ it "returns a JSON Web Token" do
+ token = Api::V1::Auth::Jwt::JsonWebToken.encode(payload: @payload)
+ Api::V1::Auth::Jwt::AuthenticationService.any_instance.stubs(:call)
+ .returns(token)
+ post api_v1_authenticate_path, @payload.to_json
+ expect(response.code).to eql("200")
+ expect(response).to render_template("api/v1/token")
+ end
+ end
+
+ end
+
+end
diff --git a/spec/requests/api/v1/base_api_controller_spec.rb b/spec/requests/api/v1/base_api_controller_spec.rb
new file mode 100644
index 0000000000..eaeff0569c
--- /dev/null
+++ b/spec/requests/api/v1/base_api_controller_spec.rb
@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::BaseApiController, type: :request do
+
+ before(:each) do
+ @client = create(:api_client)
+ end
+
+ context "actions" do
+
+ describe "heartbeat (GET api/v1/heartbeat)" do
+ it "skips the authorize_request callback" do
+ described_class.new.expects(:authorize_request).at_most(0)
+ get api_v1_heartbeat_path
+ end
+ it "returns a 200 status" do
+ get api_v1_heartbeat_path
+ expect(response.code).to eql("200")
+ end
+ it "renders the standard response template" do
+ get api_v1_heartbeat_path
+ expect(response).to render_template(partial: "api/v1/_standard_response")
+ end
+ end
+
+ end
+
+ context "private methods" do
+ include Mocks::ApiJsonSamples
+
+ before(:each) do
+ @controller = described_class.new
+ end
+
+ # See the plans_controller_spec.rb for tests of most of this method's
+ # callbacks since this controller's only endpoint, :heartbeat, skips them
+
+ describe "#authorize_request" do
+ before(:each) do
+ @client = create(:api_client)
+ struct = OpenStruct.new(headers: {})
+ @controller.expects(:request).returns(struct)
+ end
+
+ it "calls log_access if the authorization succeeds" do
+ auth_svc = OpenStruct.new(call: @client)
+ Api::V1::Auth::Jwt::AuthorizationService.expects(:new).returns(auth_svc)
+ @controller.expects(:log_access).at_least(1)
+ @controller.send(:authorize_request)
+ end
+
+ it "sets the client if the authorization succeeds" do
+ auth_svc = OpenStruct.new(call: @client)
+ Api::V1::Auth::Jwt::AuthorizationService.expects(:new).returns(auth_svc)
+ @controller.send(:authorize_request)
+ expect(@controller.client).to eql(@client)
+ end
+
+ it "renders an UNAUTHORIZED error if the client is not authorized" do
+ auth_svc = OpenStruct.new(call: nil)
+ Api::V1::Auth::Jwt::AuthorizationService.expects(:new).returns(auth_svc)
+ @controller.expects(:render_error).at_least(1)
+ @controller.send(:authorize_request)
+ end
+ end
+
+ describe "#log_access" do
+ it "returns false if the client is not set" do
+ @controller.expects(:client).returns(nil)
+ expect(@controller.send(:log_access)).to eql(false)
+ end
+ it "returns true if the client is set" do
+ @client = create(:api_client)
+ @controller.expects(:client).returns(@client)
+ expect(@controller.send(:log_access)).to eql(true)
+ end
+ it "updates the api_client.last_access if client is an ApiClient" do
+ @client = create(:api_client)
+ time = @client.last_access
+ @controller.expects(:client).returns(@client)
+ @controller.send(:log_access)
+ expect(time).not_to eql(@client.reload.last_access)
+ end
+ it "updates the users.last_api_access if client is a User" do
+ @user = create(:user)
+ time = @user.last_api_access
+ @controller.expects(:client).returns(@user)
+ @controller.send(:log_access)
+ expect(time).not_to eql(@user.reload.last_api_access)
+ end
+ end
+
+ describe "#caller_name" do
+ it "returns the caller's IP if the client is nil" do
+ ip = Faker::Internet.ip_v4_address
+ @controller.expects(:client).returns(nil)
+ @controller.expects(:request).returns(OpenStruct.new(remote_ip: ip))
+ expect(@controller.send(:caller_name)).to eql(ip)
+ end
+ it "returns the user name if the client is a User" do
+ @user = create(:user)
+ @controller.expects(:client).returns(@user)
+ expect(@controller.send(:caller_name)).to eql(@user.name(false))
+ end
+ it "returns the client name if the client is a ApiClient" do
+ @client = create(:api_client)
+ @controller.expects(:client).returns(@client)
+ expect(@controller.send(:caller_name)).to eql(@client.name)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/requests/api/v1/plans_controller.rb b/spec/requests/api/v1/plans_controller.rb
new file mode 100644
index 0000000000..81019de433
--- /dev/null
+++ b/spec/requests/api/v1/plans_controller.rb
@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::PlansController, type: :request do
+
+ include ApiHelper
+
+ context "ApiClient" do
+
+ before(:each) do
+ mock_authorization_for_api_client
+
+ # Org model requires a language so make sure the default is set
+ create(:language, default_language: true)
+ end
+
+ describe "GET /api/v1/plan/:id - show" do
+ it "returns the plan" do
+ plan = create(:plan, api_client_id: ApiClient.first&.id)
+ get api_v1_plan_path(plan)
+ expect(response.code).to eql("200")
+ expect(response).to render_template("api/v1/plans/index")
+ expect(assigns(:items).length).to eql(1)
+ end
+ it "returns a 404 if the ApiClient did not create the plan" do
+ plan = create(:plan, api_client_id: create(:api_client))
+ get api_v1_plan_path(plan)
+ expect(response.code).to eql("404")
+ expect(response).to render_template("api/v1/error")
+ end
+ it "returns a 404 if not found" do
+ get api_v1_plan_path(9999)
+ expect(response.code).to eql("404")
+ expect(response).to render_template("api/v1/error")
+ end
+ end
+
+ describe "POST /api/v1/plans - create" do
+ include Webmocks
+ include Mocks::ApiJsonSamples
+
+ before(:each) do
+ stub_ror_service
+ mock_identifier_schemes
+ create(:template, :publicly_visible, is_default: true, published: true)
+ end
+
+ context "minimal JSON" do
+ before(:each) do
+ @json = JSON.parse(minimal_create_json).with_indifferent_access
+ end
+
+ it "returns a 400 if the incoming JSON is invalid" do
+ post api_v1_plans_path, Faker::Lorem.word
+ expect(response.code).to eql("400")
+ expect(response).to render_template("api/v1/error")
+ end
+ it "returns a 400 if the incoming DMP is invalid" do
+ create(:plan, api_client_id: ApiClient.first.id)
+ @json[:items].first[:dmp][:title] = ""
+ post api_v1_plans_path, @json.to_json
+ expect(response.code).to eql("400")
+ expect(response).to render_template("api/v1/error")
+ end
+ it "returns a 400 if the plan already exists" do
+ plan = create(:plan, created_at: (Time.now - 3.days),
+ api_client_id: ApiClient.first.id)
+ @json[:items].first[:dmp][:dmp_id] = {
+ type: "url",
+ identifier: Rails.application.routes.url_helpers.api_v1_plan_url(plan)
+ }
+ post api_v1_plans_path, @json.to_json
+ expect(response.code).to eql("400")
+ expect(response).to render_template("api/v1/error")
+ expect(response.body.include?("already exists")).to eql(true)
+ end
+ it "returns a 201 if the incoming JSON is valid" do
+ post api_v1_plans_path, @json.to_json
+ expect(response.code).to eql("201")
+ expect(response).to render_template("api/v1/plans/index")
+ end
+
+ context "plan inspection" do
+ before(:each) do
+ post api_v1_plans_path, @json.to_json
+ @original = @json.with_indifferent_access[:items].first[:dmp]
+ @plan = Plan.last
+ end
+
+ it "set the Plan title" do
+ expect(@plan.title).to eql(@original[:title])
+ end
+ it "attached the contact to the Plan" do
+ expect(@plan.contributors.length).to eql(1)
+ end
+ it "set the Contact email" do
+ expected = @plan.contributors.first.email
+ expect(expected).to eql(@original[:contact][:mbox])
+ end
+ it "set the Contact roles" do
+ expected = @plan.contributors.first
+ expect(expected.data_curation?).to eql(true)
+ end
+ it "set the Template id" do
+ app = ApplicationService.application_name.split("-").first
+ tmplt = @original[:extension].select { |i| i[app].present? }.first
+ expected = tmplt[app][:template][:id]
+ expect(@plan.template_id).to eql(expected)
+ end
+ end
+ end
+
+ context "complete JSON" do
+ before(:each) do
+ @json = JSON.parse(complete_create_json).with_indifferent_access
+ end
+
+ it "returns a 201 if the incoming JSON is valid" do
+ post api_v1_plans_path, @json.to_json
+ expect(response.code).to eql("201")
+ expect(response).to render_template("api/v1/plans/index")
+ end
+
+ context "plan inspection" do
+ before(:each) do
+ post api_v1_plans_path, @json.to_json
+ @original = @json.with_indifferent_access[:items].first[:dmp]
+ @plan = Plan.last
+ end
+
+ it "set the Plan title" do
+ expect(@plan.title).to eql(@original[:title])
+ end
+
+ it "set the Plan description" do
+ expect(@plan.title).to eql(@original[:title])
+ end
+ it "set the Plan start_date" do
+ expect(@plan.title).to eql(@original[:title])
+ end
+ it "set the Plan end_date" do
+ expect(@plan.title).to eql(@original[:title])
+ end
+ it "Plan identifiers includes the grant id" do
+ expect(@plan.identifiers.length).to eql(1)
+ expected = @original[:project].first[:funding].first[:grant_id][:type]
+ expect("other").to eql(expected)
+
+ expected = @original[:project].first[:funding].first[:grant_id][:identifier]
+ expect(@plan.identifiers.first.value).to eql(expected)
+ end
+
+ context "contact inspection" do
+ before(:each) do
+ @original = @original[:contact]
+ contacts = @plan.contributors.select do |pc|
+ pc.email == @original[:mbox]
+ end
+ @contact = contacts.first
+ end
+
+ it "attached the Contact to the Plan" do
+ expect(@contact.present?).to eql(true)
+ end
+ it "set the Contact name" do
+ expect(@contact.name).to eql(@original[:name])
+ end
+ it "set the Contact email" do
+ expect(@contact.email).to eql(@original[:mbox])
+ end
+ it "set the Contact roles" do
+ expect(@contact.data_curation?).to eql(true)
+ end
+ it "Contact identifiers includes the orcid" do
+ expect(@contact.identifiers.length).to eql(1)
+ expected = @original[:contact_id][:type]
+ expect(@contact.identifiers.first.identifier_scheme.name).to eql(expected)
+
+ expected = @original[:contact_id][:identifier]
+ rslt = @contact.identifiers.first.value
+ expect(rslt.ends_with?(expected)).to eql(true)
+ end
+ it "ignored the unknown identifier type" do
+ results = @contact.identifiers.select do |i|
+ i.value == @original[:contact_id]
+ end
+ expect(results.any?).to eql(false)
+ end
+
+ context "contact org inspection" do
+ before(:each) do
+ @original = @original[:affiliation]
+ end
+
+ it "attached the Org to the Contact" do
+ expect(@contact.org.present?).to eql(true)
+ end
+ it "sets the name" do
+ expect(@contact.org.name).to eql(@original[:name])
+ end
+ it "sets the abbreviation" do
+ expect(@contact.org.abbreviation).to eql(@original[:abbreviation])
+ end
+ it "Org identifiers includes the affiation id" do
+ expect(@contact.org.identifiers.length).to eql(1)
+ expected = @original[:affiliation_id][:type]
+ result = @contact.org.identifiers.first.identifier_scheme.name
+ expect(result).to eql(expected)
+
+ expected = @original[:affiliation_id][:identifier]
+ rslt = @contact.org.identifiers.first.value
+ expect(rslt.ends_with?(expected)).to eql(true)
+ end
+ it "is the same as the Plan's org" do
+ expect(@plan.org).to eql(@contact.org)
+ end
+ end
+ end
+
+ context "contributor inspection" do
+ before(:each) do
+ @original = @original[:contributor].first
+ contributors = @plan.contributors.select do |contrib|
+ contrib.email == @original[:mbox]
+ end
+ @subject = contributors.first
+ end
+
+ it "attached the Contributor to the Plan" do
+ expect(@subject.present?).to eql(true)
+ end
+ it "set the Contributor name" do
+ expect(@subject.name).to eql(@original[:name])
+ end
+ it "set the Contributor email" do
+ expect(@subject.email).to eql(@original[:mbox])
+ end
+ it "set the Contributor roles" do
+ expected = @original[:role].map do |role|
+ role.gsub("#{Contributor::ONTOLOGY_BASE_URL}/", "")
+ end
+ expect(@subject.send(:"#{expected.first.downcase}?")).to eql(true)
+ end
+ it "Contributor identifiers includes the orcid" do
+ expect(@subject.identifiers.length).to eql(1)
+ expected = @original[:contributor_id][:type]
+ expect(@subject.identifiers.first.identifier_scheme.name).to eql(expected)
+
+ expected = @original[:contributor_id][:identifier]
+ rslt = @subject.identifiers.first.value
+ expect(rslt.ends_with?(expected)).to eql(true)
+ end
+
+ context "contributor org inspection" do
+ before(:each) do
+ @original = @original[:affiliation]
+ end
+
+ it "attached the Org to the Contributor" do
+ expect(@subject.org.present?).to eql(true)
+ end
+ it "sets the name" do
+ expect(@subject.org.name).to eql(@original[:name])
+ end
+ it "sets the abbreviation" do
+ expect(@subject.org.abbreviation).to eql(@original[:abbreviation])
+ end
+ it "Org identifiers includes the affiation id" do
+ expect(@subject.org.identifiers.length).to eql(1)
+ expected = @original[:affiliation_id][:type]
+ expect("ror").to eql(expected)
+
+ expected = @original[:affiliation_id][:identifier]
+ rslt = @subject.org.identifiers.first.value
+ expect(rslt.ends_with?(expected)).to eql(true)
+ end
+ end
+ end
+
+ context "funder inspection" do
+ before(:each) do
+ @original = @original[:project].first[:funding].first
+ @funder = @plan.funder
+ end
+
+ it "attached the Funder to the Plan" do
+ expect(@funder.present?).to eql(true)
+ end
+ it "sets the name" do
+ expect(@funder.name).to eql(@original[:name])
+ end
+ it "Funder identifiers includes the funder_id id" do
+ expect(@funder.identifiers.length).to eql(1)
+ expected = @original[:funder_id][:type]
+ expect(@funder.identifiers.first.identifier_scheme.name).to eql(expected)
+
+ expected = @original[:funder_id][:identifier].to_s
+ rslt = @funder.identifiers.first.value
+ expect(rslt.ends_with?(expected)).to eql(true)
+ end
+ end
+
+ it "set the Template id" do
+ app = ApplicationService.application_name.split("-").first
+ tmplt = @original[:extension].select { |i| i[app].present? }.first
+ expected = tmplt[app][:template][:id]
+ expect(@plan.template_id).to eql(expected)
+ end
+ end
+
+ end
+
+ end
+ end
+
+ context "User" do
+
+ before(:each) do
+ mock_authorization_for_user
+ end
+
+ describe "GET /api/v1/plan/:id - show" do
+ it "returns the plan" do
+ plan = create(:plan, :creator, :organisationally_visible, org: Org.last)
+ get api_v1_plan_path(plan)
+ expect(response.code).to eql("200")
+ expect(response).to render_template("api/v1/plans/index")
+ expect(assigns(:items).length).to eql(1)
+ end
+ it "returns a 404 if not found" do
+ get api_v1_plan_path(9999)
+ expect(response.code).to eql("404")
+ expect(response).to render_template("api/v1/error")
+ end
+ it "returns a 404 if the user does not have access" do
+ org2 = create(:org)
+ plan = create(:plan, :creator, :organisationally_visible, org: org2)
+ get api_v1_plan_path(plan)
+ expect(response.code).to eql("404")
+ expect(response).to render_template("api/v1/error")
+ end
+ end
+
+ end
+
+end
diff --git a/spec/requests/api/v1/templates_controller_spec.rb b/spec/requests/api/v1/templates_controller_spec.rb
new file mode 100644
index 0000000000..f5fcfecd72
--- /dev/null
+++ b/spec/requests/api/v1/templates_controller_spec.rb
@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::TemplatesController, type: :request do
+
+ include ApiHelper
+
+ context "ApiClient" do
+
+ before(:each) do
+ mock_authorization_for_api_client
+ end
+
+ describe "GET /api/v1/templates - index" do
+ it "returns a even if there are no public templates" do
+ get api_v1_templates_path
+ expect(response.code).to eql("200")
+ expect(response).to render_template("api/v1/templates/index")
+ expect(assigns(:items).empty?).to eql(true)
+ end
+
+ it "returns a public published template" do
+ create(:template, :publicly_visible, published: true, customization_of: nil)
+ get api_v1_templates_path
+ expect(assigns(:items).length).to eql(1)
+ end
+
+ it "does not return an unpublished template" do
+ create(:template, :publicly_visible, published: false, customization_of: nil)
+ get api_v1_templates_path
+ expect(assigns(:items).length).to eql(0)
+ end
+
+ it "does not return an organizational template" do
+ get api_v1_templates_path
+ create(:template, :organisationally_visible, :published, customization_of: nil)
+ get api_v1_templates_path
+ expect(assigns(:items).length).to eql(0)
+ end
+ end
+
+ end
+
+ context "User" do
+
+ before(:each) do
+ mock_authorization_for_user
+ end
+
+ describe "GET /api/v1/templates - index" do
+ it "returns a even if there are no public templates" do
+ get api_v1_templates_path
+ expect(response.code).to eql("200")
+ expect(response).to render_template("api/v1/templates/index")
+ expect(assigns(:items).empty?).to eql(true)
+ end
+
+ it "returns a public published template" do
+ create(:template, :publicly_visible, :published, customization_of: nil)
+ get api_v1_templates_path
+ expect(assigns(:items).length).to eql(1)
+ end
+
+ it "returns a organizational published template (for user's org)" do
+ create(:template, :organisationally_visible, :published, org: Org.last,
+ customization_of: nil)
+ get api_v1_templates_path
+ expect(assigns(:items).length).to eql(1)
+ end
+
+ it "does not return an unpublished template" do
+ create(:template, :organisationally_visible, published: false,
+ org: Org.last, customization_of: nil)
+ get api_v1_templates_path
+ expect(assigns(:items).length).to eql(0)
+ end
+
+ it "does not return another Org's organizational template" do
+ org2 = create(:org)
+ get api_v1_templates_path
+ create(:template, :organisationally_visible, published: true, org: org2,
+ customization_of: nil)
+ get api_v1_templates_path
+ expect(assigns(:items).length).to eql(0)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/api/v1/auth/jwt/authentication_service_spec.rb b/spec/services/api/v1/auth/jwt/authentication_service_spec.rb
new file mode 100644
index 0000000000..53e5251799
--- /dev/null
+++ b/spec/services/api/v1/auth/jwt/authentication_service_spec.rb
@@ -0,0 +1,328 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Auth::Jwt::AuthenticationService do
+
+ before(:each) do
+ @jwt = SecureRandom.uuid
+ Api::V1::Auth::Jwt::JsonWebToken.stubs(:encode).returns(@jwt)
+ end
+
+ context "instance methods" do
+
+ describe "#initialize(json:)" do
+ it "sets errors to empty hash" do
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: Faker::Lorem.word, client_secret: Faker::Lorem.word
+ }
+ )
+ expect(svc.errors).to eql({})
+ end
+ it "defaults :grant_type to client_credentials" do
+ id = Faker::Lorem.word
+ svc = described_class.new(
+ json: {
+ client_id: id,
+ client_secret: Faker::Lorem.word
+ }
+ )
+ expect(svc.send(:client_id)).to eql(id)
+ end
+ it "does not accept invalid :grant_type" do
+ svc = described_class.new(
+ json: {
+ grant_type: Faker::Lorem.word,
+ client_id: Faker::Lorem.word,
+ client_secret: Faker::Lorem.word
+ }
+ )
+ expect(svc.send(:client_id)).to eql(nil)
+ end
+ it "accepts client_credentials :grant_type" do
+ id = Faker::Lorem.word
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: id,
+ client_secret: Faker::Lorem.word
+ }
+ )
+ expect(svc.send(:client_id)).to eql(id)
+ end
+ it "accepts authorization_code :grant_type" do
+ email = Faker::Internet.email
+ svc = described_class.new(
+ json: {
+ grant_type: "authorization_code",
+ email: email,
+ code: Faker::Lorem.word
+ }
+ )
+ expect(svc.send(:client_id)).to eql(email)
+ end
+ end
+
+ describe "#call" do
+ it "returns null if the client_id is empty" do
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: nil,
+ client_secret: Faker::Lorem.word
+ }
+ )
+ expect(svc.call).to eql(nil)
+ end
+
+ it "returns null if the client_secret is empty" do
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: Faker::Lorem.word,
+ client_secret: nil
+ }
+ )
+ expect(svc.call).to eql(nil)
+ end
+
+ it "defers to the private #client method" do
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: Faker::Lorem.word,
+ client_secret: Faker::Lorem.word
+ }
+ )
+ svc.expects(:client).at_least(1)
+ svc.call
+ end
+
+ it "returns nil if the #client method returned nil" do
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: Faker::Lorem.word,
+ client_secret: Faker::Lorem.word
+ }
+ )
+ svc.stubs(:client).returns(nil)
+ expect(svc.call).to eql(nil)
+ end
+
+ it "returns nil if the Client is not an ApiClient or User" do
+ org = build(:org)
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: org.name,
+ client_secret: org.abbreviation
+ }
+ )
+ svc.stubs(:client).returns(org)
+ expect(svc.call).to eql(nil)
+ end
+
+ it "returns a JSON Web Token and Expiration Time for ApiClient" do
+ client = create(:api_client)
+ svc = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: client.client_id,
+ client_secret: client.client_secret
+ }
+ )
+ svc.stubs(:client).returns(client)
+ expect(svc.call).to eql(@jwt)
+ end
+
+ it "returns a JSON Web Token and Expiration Time for User" do
+ user = create(:user, api_token: SecureRandom.uuid)
+ svc = described_class.new(
+ json: {
+ grant_type: "authorization_code",
+ email: user.email,
+ code: user.api_token
+ }
+ )
+ svc.stubs(:client).returns(user)
+ expect(svc.call).to eql(@jwt)
+ end
+ end
+
+ end
+
+ context "private methods" do
+
+ describe "#client" do
+ before(:each) do
+ @service = described_class.new
+ end
+
+ it "is a singleton method" do
+ client = create(:api_client)
+ @service.expects(:authenticate_client).at_most(1).returns(client)
+ rslt = @service.send(:client)
+ expect(@service.send(:client)).to eql(rslt)
+ end
+ it "returns nil if no User or ApiClient was authenticated" do
+ @service.stubs(:authenticate_user).returns(nil)
+ @service.stubs(:authenticate_client).returns(nil)
+ rslt = @service.send(:client)
+ expect(@service.send(:client)).to eql(rslt)
+ end
+ it "returns the api_client if a ApiClient was authenticated" do
+ client = create(:api_client)
+ @service.stubs(:authenticate_client).returns(client)
+ expect(@service.send(:client)).to eql(client)
+ end
+ it "returns the user if a User was authenticated" do
+ user = create(:user)
+ svc = described_class.new(
+ json: {
+ grant_type: "authorization_code",
+ email: user.email, code: Faker::Lorem.word
+ }
+ )
+ svc.stubs(:authenticate_user).returns(user)
+ expect(svc.send(:client)).to eql(user)
+ end
+ it "adds 'invalid credentials' to errors if nothing authenticated" do
+ @service.stubs(:authenticate_user).returns(nil)
+ @service.stubs(:authenticate_client).returns(nil)
+ @service.send(:client)
+ msg = "Invalid credentials"
+ expect(@service.errors[:client_authentication]).to eql(msg)
+ end
+ end
+
+ describe "#authenticate_client" do
+ before(:each) do
+ @client = create(:api_client)
+ @service = described_class.new(
+ json: {
+ grant_type: "client_credentials",
+ client_id: @client.client_id,
+ client_secret: @client.client_secret
+ }
+ )
+ end
+
+ it "returns nil if no ApiClient is matched" do
+ @client.destroy
+ expect(@service.send(:authenticate_client)).to eql(nil)
+ end
+ it "returns nil if the matching ApiClient did not auth" do
+ @client.update(client_secret: SecureRandom.uuid)
+ expect(@service.send(:authenticate_client)).to eql(nil)
+ end
+ it "returns the ApiClient" do
+ expect(@service.send(:authenticate_client)).to eql(@client)
+ end
+ end
+
+ describe "#authenticate_user" do
+ before(:each) do
+ @user = create(:user, :org_admin, api_token: SecureRandom.uuid)
+ @service = described_class.new(
+ json: {
+ grant_type: "authorization_code",
+ email: @user.email,
+ code: @user.api_token
+ }
+ )
+ end
+
+ it "returns nil if no User is matched" do
+ @user.destroy
+ expect(@service.send(:authenticate_user)).to eql(nil)
+ end
+ it "returns nil if the matching User is inactive" do
+ @user.update(active: false)
+ expect(@service.send(:authenticate_user)).to eql(nil)
+ end
+ it "returns nil if the matching User does not have permission" do
+ @user.perms.each(&:destroy)
+ expect(@service.send(:authenticate_user)).to eql(nil)
+ end
+ it "returns nil if the client_secret does not match the api_token" do
+ @user.update(api_token: SecureRandom.uuid)
+ expect(@service.send(:authenticate_user)).to eql(nil)
+ end
+ it "returns the User" do
+ expect(@service.send(:authenticate_user)).to eql(@user)
+ end
+ end
+
+ describe "#parse_client" do
+ before(:each) do
+ @service = described_class.new
+ @client_id = SecureRandom.uuid
+ @client_secret = SecureRandom.uuid
+ end
+
+ it "sets the client_id to nil if its is not in JSON" do
+ @service.send(
+ :parse_client,
+ json: {
+ client_secret: @client_secret
+ }
+ )
+ expect(@service.send(:client_id)).to eql(nil)
+ end
+ it "sets the client_secret to nil if its is not in JSON" do
+ @service.send(:parse_client, json: { client_id: @client_id })
+ expect(@service.send(:client_secret)).to eql(nil)
+ end
+ it "sets the client_id" do
+ @service.send(
+ :parse_client,
+ json: {
+ client_id: @client_id,
+ client_secret: @client_secret
+ }
+ )
+ expect(@service.send(:client_id)).to eql(@client_id)
+ end
+ it "sets the client_secret" do
+ @service.send(
+ :parse_client,
+ json: {
+ client_id: @client_id,
+ client_secret: @client_secret
+ }
+ )
+ expect(@service.send(:client_secret)).to eql(@client_secret)
+ end
+ end
+
+ describe "#parse_code" do
+ before(:each) do
+ @service = described_class.new
+ @email = Faker::Internet.email
+ @code = SecureRandom.uuid
+ end
+
+ it "sets the client_id to nil if :email is not in JSON" do
+ @service.send(:parse_code, json: { code: @code })
+ expect(@service.send(:client_id)).to eql(nil)
+ end
+ it "sets the client_secret to nil if :code is not in JSON" do
+ @service.send(:parse_code, json: { email: @email })
+ expect(@service.send(:client_secret)).to eql(nil)
+ end
+ it "sets the client_id" do
+ @service.send(:parse_code, json: { email: @email, code: @code })
+ expect(@service.send(:client_id)).to eql(@email)
+ end
+ it "sets the client_secret" do
+ @service.send(:parse_code, json: { email: @email, code: @code })
+ expect(@service.send(:client_secret)).to eql(@code)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/api/v1/auth/jwt/authorization_service_spec.rb b/spec/services/api/v1/auth/jwt/authorization_service_spec.rb
new file mode 100644
index 0000000000..06f26f94ba
--- /dev/null
+++ b/spec/services/api/v1/auth/jwt/authorization_service_spec.rb
@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Auth::Jwt::AuthorizationService do
+
+ before(:each) do
+ @token = SecureRandom.uuid
+ Api::V1::Auth::Jwt::JsonWebToken.stubs(:decode).returns({ client_id: @token })
+ @headers = { "Authorization": "Bearer #{@token}" }
+ @service = described_class.new(headers: @headers)
+ end
+
+ context "instance methods" do
+
+ it "#initialize(:headers) sets the errors to an empty hash" do
+ expect(@service.errors).to eql({})
+ end
+
+ it "#call defers to the private #client method" do
+ @service.expects(:client).at_least(1)
+ @service.call
+ end
+
+ end
+
+ context "private methods" do
+
+ before(:each) do
+ @client = create(:api_client, client_id: @token)
+ end
+
+ describe "#client" do
+ it "returns the client if its already set (singleton)" do
+ ApiClient.expects(:find_by).at_most(1)
+ rslt = @service.send(:client)
+ expect(@service.send(:client)).to eql(rslt)
+ end
+ it "sets client to the one found with the JWT" do
+ expect(@service.send(:client)).to eql(@client)
+ end
+ it "adds 'invalid token' to errors if no client matches the JWT" do
+ @service.expects(:decoded_auth_token).returns(nil)
+ @service.send(:client)
+ expect(@service.errors[:token]).to eql("Invalid token")
+ end
+ end
+
+ describe "#decoded_auth_token" do
+ it "returns the decoded token if its already set (singleton)" do
+ rslt = @service.send(:decoded_auth_token)
+ expect(@service.send(:decoded_auth_token)).to eql(rslt)
+ end
+ it "sets the decoded token" do
+ expect(@service.send(:decoded_auth_token)[:client_id]).to eql(@token)
+ end
+ it "adds 'token expired' to errors when a JWT has expired" do
+ Api::V1::Auth::Jwt::JsonWebToken.stubs(:decode).raises(JWT::ExpiredSignature)
+ expect(@service.send(:decoded_auth_token)).to eql(nil)
+ expect(@service.errors[:token]).to eql("Token expired")
+ end
+ end
+
+ describe "#http_auth_header" do
+ it "returns nil if no 'Authorization' header" do
+ svc = described_class.new(headers: {})
+ expect(svc.send(:http_auth_header)).to eql(nil)
+ end
+ it "adds 'missing token' to errors if no 'Authorization' header" do
+ svc = described_class.new(headers: {})
+ svc.send(:http_auth_header)
+ expect(svc.errors[:token]).to eql("Missing token")
+ end
+ it "returns the token portion of the 'Authorization' header" do
+ expect(@service.send(:http_auth_header)).to eql(@token)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/api/v1/auth/jwt/json_web_token_spec.rb b/spec/services/api/v1/auth/jwt/json_web_token_spec.rb
new file mode 100644
index 0000000000..5a5e0db28d
--- /dev/null
+++ b/spec/services/api/v1/auth/jwt/json_web_token_spec.rb
@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Auth::Jwt::JsonWebToken do
+
+ before(:each) do
+ @payload = {
+ "foo": Faker::Lorem.sentence,
+ "bar": Faker::Number.number
+ }
+ end
+
+ context "#encode(payload:, exp:)" do
+ it "encodes the payload into a JWT" do
+ token = described_class.encode(payload: @payload,
+ exp: 2.hours.from_now)
+ expect(token.is_a?(String)).to eql(true)
+ expect(token.length > 1).to eql(true)
+ end
+ it "allows for a default expiration time" do
+ token = described_class.encode(payload: @payload)
+ expect(token.is_a?(String)).to eql(true)
+ expect(token.length > 1).to eql(true)
+ end
+ end
+
+ context "#decode(token:)" do
+ before(:each) do
+ @token = described_class.encode(payload: @payload)
+ end
+
+ it "decodes the token and returns the payload" do
+ hash = described_class.decode(token: @token)
+ expect(hash[:foo]).to eql(@payload[:foo])
+ expect(hash[:bar]).to eql(@payload[:bar])
+ end
+ it "includes the expiration time" do
+ hash = described_class.decode(token: @token)
+ expect(hash[:exp]).to eql(@payload[:exp])
+ end
+ it "throws JWT::ExpiredSignature when a token has expired" do
+ err = JWT::ExpiredSignature
+ JWT.stubs(:decode).raises(err)
+ expect { described_class.decode(token: @token) }.to raise_error(err)
+ end
+ it "returns nil when other JWT::DecodeError happens" do
+ JWT.stubs(:decode).raises(JWT::VerificationError)
+ expect(described_class.decode(token: @token)).to eql(nil)
+ end
+ end
+
+end
diff --git a/spec/services/api/v1/conversion_service_spec.rb b/spec/services/api/v1/conversion_service_spec.rb
new file mode 100644
index 0000000000..fe404443f2
--- /dev/null
+++ b/spec/services/api/v1/conversion_service_spec.rb
@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::ConversionService do
+
+ describe "boolean_to_yes_no_unknown" do
+ it "returns `yes` when true" do
+ expect(described_class.boolean_to_yes_no_unknown(true)).to eql("yes")
+ end
+ it "returns `yes` when 1" do
+ expect(described_class.boolean_to_yes_no_unknown(1)).to eql("yes")
+ end
+ it "returns `no` when false" do
+ expect(described_class.boolean_to_yes_no_unknown(false)).to eql("no")
+ end
+ it "returns `no` when 0" do
+ expect(described_class.boolean_to_yes_no_unknown(0)).to eql("no")
+ end
+ it "returns `unknown` when nil" do
+ expect(described_class.boolean_to_yes_no_unknown(nil)).to eql("unknown")
+ end
+ end
+
+ describe "yes_no_unknown_to_boolean" do
+ it "returns true when `yes`" do
+ expect(described_class.yes_no_unknown_to_boolean("yes")).to eql(true)
+ end
+ it "returns false when `no`" do
+ expect(described_class.yes_no_unknown_to_boolean("no")).to eql(false)
+ end
+ it "returns nil when `unknown`" do
+ expect(described_class.yes_no_unknown_to_boolean("unknown")).to eql(nil)
+ end
+ end
+
+ describe "#to_identifier(context:, value:)" do
+ it "returns nil if the context is not present" do
+ expected = described_class.to_identifier(context: nil,
+ value: Faker::Lorem.word)
+ expect(expected).to eql(nil)
+ end
+ it "returns nil if the value is not present" do
+ expected = described_class.to_identifier(context: Faker::Lorem.word,
+ value: nil)
+ expect(expected).to eql(nil)
+ end
+ it "returns an Identifier with a IdentifierScheme matching the context" do
+ context = Faker::Lorem.word
+ expected = described_class.to_identifier(context: context,
+ value: Faker::Lorem.word)
+ expect(expected.identifier_scheme.name).to eql(context)
+ end
+ it "returns an Identifier asssociated with the 'grant' scheme" do
+ value = Faker::Lorem.word
+ expected = described_class.to_identifier(context: Faker::Lorem.word,
+ value: value)
+ expect(expected.value).to eql(value)
+ end
+ end
+
+end
diff --git a/spec/services/api/v1/deserialization/contributor_spec.rb b/spec/services/api/v1/deserialization/contributor_spec.rb
new file mode 100644
index 0000000000..01db8f4583
--- /dev/null
+++ b/spec/services/api/v1/deserialization/contributor_spec.rb
@@ -0,0 +1,321 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Deserialization::Contributor do
+
+ before(:each) do
+ # Org requires a language, so make sure a default is available!
+ create(:language, default_language: true) unless Language.default
+ @org = create(:org)
+ @plan = create(:plan, template: create(:template), org: @org)
+
+ @name = Faker::Movies::StarWars.character
+ @email = Faker::Internet.email
+
+ @contributor = create(:contributor, org: @org, plan: @plan,
+ name: @name, email: @email)
+ @role = "#{Contributor::ONTOLOGY_BASE_URL}/#{@contributor.selected_roles.first}"
+
+ @scheme = create(:identifier_scheme)
+ @identifier = create(:identifier, identifiable: @contributor,
+ identifier_scheme: @scheme,
+ value: SecureRandom.uuid)
+ @contributor.reload
+ @json = { name: @name, mbox: @email, role: [@role] }
+ end
+
+ describe "#deserialize!(json: {})" do
+ before(:each) do
+ described_class.stubs(:marshal_contributor).returns(@contributor)
+ end
+
+ it "returns nil if json is not valid" do
+ expect(described_class.deserialize!(plan_id: @plan.id, json: nil)).to eql(nil)
+ end
+ it "returns nil if the Contributor is not valid" do
+ Contributor.any_instance.stubs(:valid?).returns(false)
+ expect(described_class.deserialize!(plan_id: @plan.id, json: @json)).to eql(nil)
+ end
+ it "calls attach_identifier!" do
+ described_class.expects(:attach_identifier!).at_least(1)
+ id = SecureRandom.uuid
+ scheme = create(:identifier_scheme, identifier_prefix: nil)
+ json = @json.merge(
+ { contributor_id: { type: scheme.name.downcase, identifier: id } }
+ )
+ described_class.deserialize!(plan_id: @plan.id, json: json)
+ end
+ it "returns the Contributor" do
+ result = described_class.deserialize!(plan_id: @plan.id, json: @json)
+ expect(result).to eql(@contributor)
+ end
+ end
+
+ context "private methods" do
+
+ describe "#valid?(is_contact:, json:)" do
+ it "returns false if json is not present" do
+ result = described_class.send(:valid?, is_contact: true, json: nil)
+ expect(result).to eql(false)
+ end
+ it "returns false if :name and :mbox are not present" do
+ json = { role: [@role] }
+ result = described_class.send(:valid?, is_contact: true, json: json)
+ expect(result).to eql(false)
+ end
+ context "Contact" do
+ it "returns true without :role" do
+ json = { name: @name, mbox: @email }
+ result = described_class.send(:valid?, is_contact: true, json: json)
+ expect(result).to eql(true)
+ end
+ it "returns true with :role" do
+ result = described_class.send(:valid?, is_contact: true, json: @json)
+ expect(result).to eql(true)
+ end
+ end
+ context "Contributor" do
+ it "returns false without :role" do
+ json = { name: @name, mbox: @email }
+ result = described_class.send(:valid?, is_contact: false, json: json)
+ expect(result).to eql(false)
+ end
+ it "returns true with :role" do
+ result = described_class.send(:valid?, is_contact: false, json: @json)
+ expect(result).to eql(true)
+ end
+ end
+ end
+
+ describe "#marshal_contributor(plan_id:, is_contact:, json:)" do
+ it "returns nil if the plan_id is not present" do
+ result = described_class.send(:marshal_contributor, plan_id: nil,
+ is_contact: true,
+ json: @json)
+ expect(result).to eql(nil)
+ end
+ it "returns nil if the json is not present" do
+ result = described_class.send(:marshal_contributor, plan_id: @plan.id,
+ is_contact: true,
+ json: nil)
+ expect(result).to eql(nil)
+ end
+ it "attaches the Org to the Contributor" do
+ result = described_class.send(:marshal_contributor, plan_id: @plan.id,
+ is_contact: true,
+ json: @json)
+ expect(result.org).to eql(@org)
+ end
+ it "assigns the contact role" do
+ json = { name: Faker::TvShows::Simpsons.character }
+ result = described_class.send(:marshal_contributor, plan_id: @plan.id,
+ is_contact: true,
+ json: json)
+ expect(result.data_curation?).to eql(true)
+ end
+ it "assigns the contributor role" do
+ role = @contributor.all_roles[1].to_s
+ json = { name: Faker::TvShows::Simpsons.character, role: [role] }
+ result = described_class.send(:marshal_contributor, plan_id: @plan.id,
+ is_contact: false,
+ json: json)
+ expect(result.send(:"#{role}?")).to eql(true)
+ end
+ end
+
+ describe "#find_by_identifier(json:)" do
+ it "returns nil if json is not present" do
+ expect(described_class.send(:find_by_identifier, json: nil)).to eql(nil)
+ end
+ it "returns nil if :contact_id and :contributor_id are not present" do
+ expect(described_class.send(:find_by_identifier, json: @json)).to eql(nil)
+ end
+ it "finds the Contributor by :contact_id" do
+ json = @json.merge(
+ { contact_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:find_by_identifier, json: json)
+ expect(result).to eql(@contributor)
+ end
+ it "finds the Contributor by :contributor_id" do
+ json = @json.merge(
+ { contributor_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:find_by_identifier, json: json)
+ expect(result).to eql(@contributor)
+ end
+ it "returns nil if no Contributor was found" do
+ json = @json.merge(
+ { contributor_id: { type: @scheme.name, identifier: SecureRandom.uuid } }
+ )
+ expect(described_class.send(:find_by_identifier, json: json)).to eql(nil)
+ end
+ end
+
+ describe "#find_or_initialize_by(plan_id:, json:)" do
+ it "returns nil if json is not present" do
+ result = described_class.send(:find_or_initialize_by, plan_id: @plan.id,
+ json: nil)
+ expect(result).to eql(nil)
+ end
+ it "returns nil if plan_id is not present" do
+ result = described_class.send(:find_or_initialize_by, plan_id: nil,
+ json: @json)
+ expect(result).to eql(nil)
+ end
+ it "finds the matching Contributor" do
+ result = described_class.send(:find_or_initialize_by, plan_id: @plan.id,
+ json: @json)
+ expect(result).to eql(@contributor)
+ end
+ it "initializes the Contributor if there were no viable matches" do
+ json = {
+ name: Faker::TvShows::Simpsons.character,
+ mbox: Faker::Internet.unique.email
+ }
+ result = described_class.send(:find_or_initialize_by, plan_id: @plan.id,
+ json: json)
+ expect(result.new_record?).to eql(true)
+ expect(result.name).to eql(json[:name])
+ expect(result.email).to eql(json[:mbox])
+ end
+ end
+
+ describe "#deserialize_org(json:)" do
+ it "returns nil if json is not present" do
+ expect(described_class.send(:deserialize_org, json: nil)).to eql(nil)
+ end
+ it "returns nil if json :affiliation is not present" do
+ expect(described_class.send(:deserialize_org, json: @json)).to eql(nil)
+ end
+ it "calls the Org.deserialize! method" do
+ Api::V1::Deserialization::Org.expects(:deserialize!).at_least(1)
+ json = @json.merge({ affiliation: { name: Faker::Company.name } })
+ described_class.send(:deserialize_org, json: json)
+ end
+ end
+
+ describe "#assign_contact_roles(contributor:)" do
+ it "returns nil if the contributor is not present" do
+ result = described_class.send(:assign_contact_roles, contributor: nil)
+ expect(result).to eql(nil)
+ end
+ it "assigns the :data_curation role" do
+ result = described_class.send(:assign_contact_roles, contributor: @contributor)
+ expect(result.data_curation?).to eql(true)
+ end
+ end
+
+ describe "#assign_roles(contributor:, json:)" do
+ it "returns nil if the contributor is not present" do
+ result = described_class.send(:assign_roles, contributor: nil, json: @json)
+ expect(result).to eql(nil)
+ end
+ it "returns the Contributor as-is if json is not present" do
+ result = described_class.send(:assign_roles, contributor: @contributor,
+ json: nil)
+ expect(result).to eql(@contributor)
+ end
+ it "returns the Contributor as-is if json :role is not present" do
+ json = { name: @name }
+ result = described_class.send(:assign_roles, contributor: @contributor,
+ json: json)
+ expect(result).to eql(@contributor)
+ end
+ it "ignores unknown/undefined roles" do
+ @json[:role] << Faker::Lorem.word
+ result = described_class.send(:assign_roles, contributor: @contributor,
+ json: @json)
+ expect(result.selected_roles).to eql(@contributor.selected_roles)
+ end
+ it "calls the translate_role" do
+ described_class.expects(:translate_role).at_least(1)
+ described_class.send(:assign_roles, contributor: @contributor, json: @json)
+ end
+ it "assigns the roles" do
+ result = described_class.send(:assign_roles, contributor: @contributor,
+ json: @json)
+ expect(result.selected_roles).to eql(@contributor.selected_roles)
+ end
+
+ end
+
+ describe "#attach_identifier!(contributor:, json:)" do
+ it "returns the Contributor as-is if json is not present" do
+ result = described_class.send(:attach_identifier!, contributor: @contributor,
+ json: nil)
+ expect(result.identifiers).to eql(@contributor.identifiers)
+ end
+ it "returns the Contributor as-is if the json has no identifier" do
+ result = described_class.send(:attach_identifier!, contributor: @contributor,
+ json: @json)
+ expect(result.identifiers).to eql(@contributor.identifiers)
+ end
+ it "returns the Contributor as-is if it already has a :contributor_id" do
+ json = @json.merge(
+ { contributor_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, contributor: @contributor,
+ json: json)
+ expect(result.identifiers).to eql(@contributor.identifiers)
+ end
+ it "returns the Contributor as-is if it already has the :contact_id" do
+ json = @json.merge(
+ { contact_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, contributor: @contributor,
+ json: json)
+ expect(result.identifiers).to eql(@contributor.identifiers)
+ end
+ it "adds the :contributor_id to the Contributor" do
+ scheme = create(:identifier_scheme, name: "foo")
+ json = @json.merge(
+ { contributor_id: { type: scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, contributor: @contributor,
+ json: json)
+ expect(result.identifiers.length > @contributor.identifiers.length).to eql(false)
+ expect(result.identifiers.last.identifier_scheme).to eql(scheme)
+ id = result.identifiers.last.value
+ expect(id.end_with?(@identifier.value)).to eql(true)
+ end
+ it "adds the :contact_id to the Contributor" do
+ scheme = create(:identifier_scheme, name: "foo")
+ json = @json.merge(
+ { contact_id: { type: scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, contributor: @contributor,
+ json: json)
+ expect(result.identifiers.length > @contributor.identifiers.length).to eql(false)
+ expect(result.identifiers.last.identifier_scheme).to eql(scheme)
+ id = result.identifiers.last.value
+ expect(id.end_with?(@identifier.value)).to eql(true)
+ end
+ end
+
+ describe "#translate_role(role:)" do
+ before(:each) do
+ @default = Contributor.default_role
+ end
+
+ it "returns the default role if role is not present?" do
+ expect(described_class.send(:translate_role, role: nil)).to eql(@default)
+ end
+ it "returns the default role if role is not a valid/defined role" do
+ result = described_class.send(:translate_role, role: Faker::Lorem.word)
+ expect(result).to eql(@default)
+ end
+ it "returns the role (when it includes the ONTOLOGY_BASE_URL)" do
+ expected = @role.split("/").last
+ expect(described_class.send(:translate_role, role: @role)).to eql(expected)
+ end
+ it "returns the role (when it does not include the ONTOLOGY_BASE_URL)" do
+ role = Contributor.new.all_roles.last.to_s
+ expect(described_class.send(:translate_role, role: role)).to eql(role)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/api/v1/deserialization/funding_spec.rb b/spec/services/api/v1/deserialization/funding_spec.rb
new file mode 100644
index 0000000000..e66aed93f0
--- /dev/null
+++ b/spec/services/api/v1/deserialization/funding_spec.rb
@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Deserialization::Funding do
+
+ before(:each) do
+ # Org requires a language, so make sure a default is available!
+ create(:language, default_language: true) unless Language.default
+
+ @funder = create(:org, :funder, name: Faker::Company.name)
+ @plan = create(:plan)
+ @grant = create(:identifier, identifier_scheme: nil, value: SecureRandom.uuid,
+ identifiable: @plan)
+
+ Api::V1::Deserialization::Org.stubs(:deserialize!).returns(@funder)
+ Api::V1::Deserialization::Identifier.stubs(:deserialize!).returns(@grant)
+
+ @json = {
+ name: @funder.name,
+ funding_status: %w[planned granted rejected].sample
+ }
+ end
+
+ describe "#deserialize!(plan:, json: {})" do
+ it "returns nil if plan is not present" do
+ expect(described_class.deserialize!(plan: nil, json: @json)).to eql(nil)
+ end
+ it "returns the Plan as-is if json is present" do
+ expect(described_class.deserialize!(plan: @plan, json: nil)).to eql(@plan)
+ end
+ it "returns the Plan as-is if json is not valid" do
+ json = { funding_status: "planned" }
+ expect(described_class.deserialize!(plan: @plan, json: json)).to eql(@plan)
+ end
+ it "assigns the funder" do
+ result = described_class.deserialize!(plan: @plan, json: @json)
+ expect(result.funder).to eql(@funder)
+ end
+ it "assigns the grant" do
+ json = @json.merge({ grant_id: { type: "url", identifier: Faker::Lorem.word } })
+ result = described_class.deserialize!(plan: @plan, json: json)
+ expect(result.grant_id).to eql(@grant.id)
+ end
+ it "returns the Plan" do
+ expect(described_class.deserialize!(plan: @plan, json: @json)).to eql(@plan)
+ end
+ end
+
+ context "private methods" do
+
+ describe "#valid?(json:)" do
+ it "returns false if json is not present" do
+ expect(described_class.send(:valid?, json: nil)).to eql(false)
+ end
+ it "returns false if :name and :funder_id and :grant_id are not present" do
+ json = { funding_status: %w[] }
+ expect(described_class.send(:valid?, json: json)).to eql(false)
+ end
+ it "returns true if :name is present" do
+ expect(described_class.send(:valid?, json: @json)).to eql(true)
+ end
+ it "returns true if :funder_id is present" do
+ json = {
+ funder_id: { type: Faker::Lorem.word, identifier: SecureRandom.uuid }
+ }
+ expect(described_class.send(:valid?, json: json)).to eql(true)
+ end
+ it "returns true if :grant_id is present" do
+ json = { grant_id: { type: Faker::Lorem.word, identifier: @grant.value } }
+ expect(described_class.send(:valid?, json: json)).to eql(true)
+ end
+ end
+
+ describe "#deserialize_grant(plan:, json:)" do
+ it "returns the Plan as-is if no json is present" do
+ result = described_class.send(:deserialize_grant, plan: @plan, json: nil)
+ expect(result).to eql(@plan)
+ end
+ it "returns the Plan as-is if no :grant_id is present" do
+ result = described_class.send(:deserialize_grant, plan: @plan, json: @json)
+ expect(result).to eql(@plan)
+ end
+ it "attaches the the grant to the plan" do
+ json = @json.merge(
+ { grant_id: { type: "url", identifier: @grant.value } }
+ )
+ result = described_class.send(:deserialize_grant, plan: @plan, json: json)
+ expect(result.grant_id.present?).to eql(true)
+ expect(result.grant.identifier_scheme).to eql(nil)
+ expect(result.grant.value).to eql(json[:grant_id][:identifier])
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/api/v1/deserialization/identifier_spec.rb b/spec/services/api/v1/deserialization/identifier_spec.rb
new file mode 100644
index 0000000000..4d1715f99c
--- /dev/null
+++ b/spec/services/api/v1/deserialization/identifier_spec.rb
@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Deserialization::Identifier do
+
+ before(:each) do
+ @scheme = create(:identifier_scheme)
+ @value = SecureRandom.uuid
+ @identifiable = build(:org)
+ @json = { type: @scheme.name, identifier: @value }
+ end
+
+ describe "#deserialize!(identifiable:, json: {})" do
+ it "returns nil if json is not valid" do
+ result = described_class.deserialize!(identifiable: @identifiable,
+ json: nil)
+ expect(result).to eql(nil)
+ end
+
+ context "when :type does not match an IdentifierScheme" do
+
+ it "marshalls an Identifier" do
+ json = { type: "other", identifier: @value }
+ rslt = described_class.deserialize!(identifiable: @identifiable, json: json)
+ validate_identifier(result: rslt, scheme: nil, value: @value)
+ end
+ it "marshalls an existing Identifier" do
+ id = create(:identifier, identifier_scheme: nil,
+ identifiable: @identifiable, value: @value)
+ json = { type: "other", identifier: @value }
+ rslt = described_class.deserialize!(identifiable: @identifiable, json: json)
+ validate_identifier(result: rslt, scheme: nil, value: @value)
+ expect(rslt.id).to eql id.id
+ end
+
+ end
+
+ context "when :type matches an IdentifierScheme" do
+ it "calls #identifier_for_scheme" do
+ described_class.expects(:identifier_for_scheme).at_least(1)
+ described_class.deserialize!(identifiable: @identifiable, json: @json)
+ end
+ it "returns an Identifier for that IdentifierScheme" do
+ result = described_class.deserialize!(identifiable: @identifiable,
+ json: @json)
+ expect(result.identifier_scheme).to eql(@scheme)
+ end
+
+ end
+
+ end
+
+ context "private methods" do
+
+ describe "#valid?(json:)" do
+ it "returns nil if json is not valid" do
+ expect(described_class.send(:valid?, json: nil)).to eql(false)
+ end
+ it "returns nil if :identifier is not present" do
+ json = { type: @scheme.name }
+ expect(described_class.send(:valid?, json: json)).to eql(false)
+ end
+ it "returns nil if :type is not present" do
+ json = { identifier: @value }
+ expect(described_class.send(:valid?, json: json)).to eql(false)
+ end
+ it "returns true" do
+ expect(described_class.send(:valid?, json: @json)).to eql(true)
+ end
+ end
+
+ describe "#identifier_for_scheme(scheme:, identifiable:, json:)" do
+ it "returns nil if scheme is nil" do
+ result = described_class.send(:identifier_for_scheme,
+ scheme: nil, identifiable: @identifiable,
+ json: @json)
+ expect(result).to eql(nil)
+ end
+ it "returns nil if identifiable is nil" do
+ result = described_class.send(:identifier_for_scheme,
+ scheme: @scheme, identifiable: nil,
+ json: @json)
+ expect(result).to eql(nil)
+ end
+ it "returns nil if json is nil" do
+ result = described_class.send(:identifier_for_scheme,
+ scheme: @scheme, identifiable: @identifiable,
+ json: nil)
+ expect(result).to eql(nil)
+ end
+ it "returns nil if :type does not match an IdentifierScheme" do
+ json = { type: Faker::Lorem.word, identifier: @value }
+ result = described_class.send(:identifier_for_scheme,
+ scheme: @scheme,
+ identifiable: @identifiable, json: json)
+ expect(result).to eql(nil)
+ end
+ it "updates the existing Identifier for the IdentifierScheme" do
+ identifier = create(:identifier, identifier_scheme: @scheme,
+ identifiable: @identifiable,
+ value: Faker::Number.number)
+ result = described_class.send(:identifier_for_scheme,
+ scheme: @scheme,
+ identifiable: @identifiable, json: @json)
+ expect(result.id).to eql(identifier.id)
+ expect(result.value.ends_with?(@json[:identifier])).to eql(true)
+ end
+ end
+
+ end
+
+ private
+
+ def validate_identifier(result:, scheme:, value:)
+ expect(result.is_a?(Identifier)).to eql(true), "expected it to be an Identifier"
+ expect(result.identifier_scheme).to eql(scheme), "expected schemes to match"
+ expect(result.value).to eql(value), "expected values to match"
+ end
+
+end
diff --git a/spec/services/api/v1/deserialization/org_spec.rb b/spec/services/api/v1/deserialization/org_spec.rb
new file mode 100644
index 0000000000..c152cdfd6e
--- /dev/null
+++ b/spec/services/api/v1/deserialization/org_spec.rb
@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Deserialization::Org do
+
+ before(:each) do
+ # Org requires a language, so make sure a default is available!
+ create(:language, default_language: true) unless Language.default
+
+ @name = Faker::Company.name
+ @abbrev = Faker::Lorem.word.upcase
+ @org = create(:org, name: @name, abbreviation: @abbrev)
+ @scheme = create(:identifier_scheme)
+ @identifier = create(:identifier, identifiable: @org,
+ identifier_scheme: @scheme,
+ value: SecureRandom.uuid)
+ @org.reload
+ @json = { name: @name, abbreviation: @abbrev }
+ end
+
+ describe "#deserialize!(json: {})" do
+ before(:each) do
+ described_class.stubs(:find_by_identifier).returns(nil)
+ described_class.stubs(:find_by_name).returns(@org)
+ end
+
+ it "returns nil if json is not valid" do
+ expect(described_class.deserialize!(json: nil)).to eql(nil)
+ end
+ it "calls find_by_identifier" do
+ described_class.expects(:find_by_identifier).at_least(1)
+ described_class.deserialize!(json: @json)
+ end
+ it "calls find_by_name if find_by_identifier finds none" do
+ result = described_class.deserialize!(json: @json)
+ expect(result).to eql(@org)
+ end
+ it "sets the language to the default" do
+ default = Language.default || create(:language)
+ result = described_class.deserialize!(json: @json)
+ expect(result.language).to eql(default)
+ end
+ it "sets the abbreviation" do
+ result = described_class.deserialize!(json: @json)
+ expect(result.abbreviation).to eql(@abbrev)
+ end
+ it "returns nil if the Org is not valid" do
+ Org.any_instance.stubs(:valid?).returns(false)
+ expect(described_class.deserialize!(json: @json)).to eql(nil)
+ end
+ it "attaches the identifier to the Org" do
+ id = SecureRandom.uuid
+ scheme = create(:identifier_scheme, identifier_prefix: nil, name: "foo")
+ json = @json.merge(
+ { affiliation_id: { type: scheme.name, identifier: id } }
+ )
+ result = described_class.deserialize!(json: json)
+ expect(result.identifiers.length).to eql(2)
+ expect(result.identifiers.last.value).to eql(id)
+ end
+ it "is able to create a new Org" do
+ described_class.stubs(:find_by_name)
+ .returns(build(:org, name: Faker::Company.name))
+ result = described_class.deserialize!(json: @json)
+ expect(result.new_record?).to eql(false)
+ expect(result.abbreviation).to eql(@json[:abbreviation])
+ end
+ end
+
+ context "private methods" do
+
+ describe "#valid?(json:)" do
+ it "returns false if json is not present" do
+ expect(described_class.send(:valid?, json: nil)).to eql(false)
+ end
+ it "returns false if :name is not present" do
+ json = { abbreviation: @abbrev }
+ expect(described_class.send(:valid?, json: json)).to eql(false)
+ end
+ it "returns true" do
+ expect(described_class.send(:valid?, json: @json)).to eql(true)
+ end
+ end
+
+ describe "#find_by_identifier(json:)" do
+ it "returns nil if json is not present" do
+ expect(described_class.send(:find_by_identifier, json: nil)).to eql(nil)
+ end
+ it "returns nil if :affiliation_id and :funder_id are not present" do
+ expect(described_class.send(:find_by_identifier, json: @json)).to eql(nil)
+ end
+ it "finds the Org by :affiliation_id" do
+ json = @json.merge(
+ { affiliation_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ expect(described_class.send(:find_by_identifier, json: json)).to eql(@org)
+ end
+ it "finds the Org by :funder_id" do
+ json = @json.merge(
+ { funder_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ expect(described_class.send(:find_by_identifier, json: json)).to eql(@org)
+ end
+ it "returns nil if no Org was found" do
+ json = @json.merge(
+ { affiliation_id: { type: @scheme.name, identifier: SecureRandom.uuid } }
+ )
+ expect(described_class.send(:find_by_identifier, json: json)).to eql(nil)
+ end
+ end
+
+ describe "#find_by_name(json:)" do
+ it "returns nil if json is not present" do
+ expect(described_class.send(:find_by_name, json: nil)).to eql(nil)
+ end
+ it "returns nil if :name is not present" do
+ json = { abbreviation: @abbrev }
+ expect(described_class.send(:find_by_name, json: json)).to eql(nil)
+ end
+ it "finds the matching Org by name" do
+ expect(described_class.send(:find_by_name, json: @json)).to eql(@org)
+ end
+ it "finds the Org from the OrgSelection::SearchService" do
+ json = { name: Faker::Company.unique.name }
+ array = [{ name: @org.name, weight: 0 }]
+ OrgSelection::SearchService.stubs(:search_externally).returns(array)
+ OrgSelection::HashToOrgService.stubs(:to_org).returns(@org)
+ expect(described_class.send(:find_by_name, json: json)).to eql(@org)
+ end
+ it "initializes the Org if there were no viable matches" do
+ json = { name: Faker::Company.unique.name }
+ OrgSelection::SearchService.stubs(:search_externally).returns([])
+ org = build(:org, name: json[:name])
+ OrgSelection::HashToOrgService.stubs(:to_org).returns(org)
+ expect(described_class.send(:find_by_name, json: json)).to eql(org)
+ end
+ end
+
+ describe "#attach_identifier!(org:, json:)" do
+ it "returns the Org as-is if json is not present" do
+ result = described_class.send(:attach_identifier!, org: @org, json: nil)
+ expect(result.identifiers).to eql(@org.identifiers)
+ end
+ it "returns the Org as-is if the json has no identifier" do
+ result = described_class.send(:attach_identifier!, org: @org, json: @json)
+ expect(result.identifiers).to eql(@org.identifiers)
+ end
+ it "returns the Org as-is if the Org already has the :affiliation_id" do
+ json = @json.merge(
+ { affiliation_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, org: @org, json: json)
+ expect(result.identifiers).to eql(@org.identifiers)
+ end
+ it "returns the Org as-is if the Org already has the :funder_id" do
+ json = @json.merge(
+ { funder_id: { type: @scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, org: @org, json: json)
+ expect(result.identifiers).to eql(@org.identifiers)
+ end
+ it "adds the :affiliation_id to the Org" do
+ scheme = create(:identifier_scheme)
+ json = @json.merge(
+ { affiliation_id: { type: scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, org: @org, json: json)
+ expect(result.identifiers.length > @org.identifiers.length).not_to eql(true)
+ expect(result.identifiers.last.identifier_scheme).to eql(scheme)
+ id = result.identifiers.last.value
+ expect(id.end_with?(@identifier.value)).to eql(true)
+ end
+ it "adds the :funder_id to the Org" do
+ scheme = create(:identifier_scheme)
+ json = @json.merge(
+ { funder_id: { type: scheme.name, identifier: @identifier.value } }
+ )
+ result = described_class.send(:attach_identifier!, org: @org, json: json)
+ expect(result.identifiers.length > @org.identifiers.length).not_to eql(true)
+ expect(result.identifiers.last.identifier_scheme).to eql(scheme)
+ id = result.identifiers.last.value
+ expect(id.end_with?(@identifier.value)).to eql(true)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/api/v1/deserialization/plan_spec.rb b/spec/services/api/v1/deserialization/plan_spec.rb
new file mode 100644
index 0000000000..ada83fab03
--- /dev/null
+++ b/spec/services/api/v1/deserialization/plan_spec.rb
@@ -0,0 +1,358 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe Api::V1::Deserialization::Plan do
+
+ before(:each) do
+ # Org requires a language, so make sure a default is available!
+ create(:language, default_language: true) unless Language.default
+
+ @template = create(:template)
+ @plan = create(:plan, template: @template)
+ @scheme = create(:identifier_scheme, name: "doi",
+ identifier_prefix: Faker::Internet.url)
+ @doi = "10.9999/45ty5t.345/34t"
+ @identifier = create(:identifier, identifier_scheme: @scheme,
+ identifiable: @plan, value: @doi)
+
+ @app_name = ApplicationService.application_name.split("-").first&.downcase
+ @app_name = "tester" unless @app_name.present?
+
+ contrib = Contributor.new
+ @json = {
+ title: Faker::Lorem.sentence,
+ description: Faker::Lorem.paragraph,
+ ethical_issues_exist: "unknown",
+ contact: {
+ name: Faker::Movies::StarWars.character,
+ mbox: Faker::Internet.email
+ },
+ contributor: [
+ {
+ name: Faker::TvShows::Simpsons.unique.character,
+ role: ["#{Contributor::ONTOLOGY_BASE_URL}/#{contrib.all_roles.first}"]
+ },
+ {
+ name: Faker::TvShows::Simpsons.unique.character,
+ role: [contrib.all_roles.last.to_s]
+ }
+ ],
+ project: [
+ {
+ title: Faker::Lorem.sentence,
+ description: Faker::Lorem.paragraph,
+ start: Time.now.to_formatted_s(:iso8601),
+ end: (Time.now + 2.years).to_formatted_s(:iso8601),
+ funding: [
+ { name: Faker::Movies::StarWars.planet }
+ ]
+ }
+ ],
+ dataset: [
+ { title: Faker::Lorem.sentence }
+ ],
+ dmp_id: { type: "doi", identifier: @identifier.value },
+ extension: [
+ "#{@app_name}": {
+ template: { id: @template.id, title: @template.title }
+ }
+ ]
+ }
+
+ # We need to ensure that the deserializer on Funding is called, but
+ # no need to check that class' subsequent calls
+ Api::V1::Deserialization::Org.stubs(:deserialize!).returns(@org)
+ Api::V1::Deserialization::Identifier.stubs(:deserialize!).returns(@identifier)
+ end
+
+ describe "#deserialize!(json: {})" do
+ before(:each) do
+ described_class.stubs(:marshal_plan).returns(@plan)
+ described_class.stubs(:deserialize_project).returns(@plan)
+ described_class.stubs(:deserialize_contact).returns(@plan)
+ described_class.stubs(:deserialize_contributors).returns(@plan)
+ described_class.stubs(:deserialize_datasets).returns(@plan)
+ end
+
+ it "returns nil if json is not valid" do
+ expect(described_class.deserialize!(json: nil)).to eql(nil)
+ end
+ it "returns nil if no :dmp_id, :template or default template available" do
+ described_class.stubs(:marshal_plan).returns(nil)
+ described_class.deserialize!(json: @json)
+ end
+ it "returns the Plan" do
+ expect(described_class.deserialize!(json: @json)).to eql(@plan)
+ end
+ it "sets the title to the default" do
+ described_class.stubs(:marshal_plan).returns(Plan.new)
+ result = described_class.deserialize!(json: @json)
+ expect(result.title).to eql(@plan.title)
+ end
+ it "sets the description" do
+ described_class.stubs(:marshal_plan).returns(Plan.new)
+ result = described_class.deserialize!(json: @json)
+ expect(result.description).to eql(@plan.description)
+ end
+ end
+
+ context "private methods" do
+
+ describe "#valid?(json:)" do
+ it "returns false if json is not present" do
+ expect(described_class.send(:valid?, json: nil)).to eql(false)
+ end
+ it "returns false if :name is not present" do
+ json = { abbreviation: @abbrev }
+ expect(described_class.send(:valid?, json: json)).to eql(false)
+ end
+ it "returns false if no default template, no :template and no :dmp_id" do
+ Template.find_by(is_default: true)&.destroy
+ @json[:dmp_id] = nil
+ @json[:extension] = []
+ expect(described_class.send(:valid?, json: @json)).to eql(false)
+ end
+ it "returns true" do
+ expect(described_class.send(:valid?, json: @json)).to eql(true)
+ end
+ end
+
+ describe "#marshal_plan(json:)" do
+ it "returns nil if json is not present" do
+ expect(described_class.send(:marshal_plan, json: nil)).to eql(nil)
+ end
+ it "returns nil there is no :dmp_id and no :template" do
+ @json[:dmp_id] = nil
+ @json[:extension] = []
+ expect(described_class.send(:marshal_plan, json: @json)).to eql(nil)
+ end
+ it "returns nil if :dmp_id was not found, no :template, no default template" do
+ @json[:dmp_id][:identifier] = SecureRandom.uuid
+ @json[:extension] = []
+ expect(described_class.send(:marshal_plan, json: @json)).to eql(nil)
+ end
+ it "finds the Plan by :dmp_id" do
+ expect(described_class.send(:marshal_plan, json: @json)).to eql(@plan)
+ end
+ it "creates a new Plan with default template if no :dmp_id and no :template" do
+ @json[:dmp_id] = []
+ @json[:extension] = []
+ default = Template.find_by(is_default: true)
+ default = create(:template, is_default: true) unless default.present?
+ result = described_class.send(:marshal_plan, json: @json)
+ expect(result.new_record?).to eql(true)
+ expect(result.template_id).to eql(default.id)
+ end
+ it "creates a new Plan if :dmp_id was not present" do
+ @json[:dmp_id] = []
+ result = described_class.send(:marshal_plan, json: @json)
+ expect(result.new_record?).to eql(true)
+ expect(result.template_id).to eql(@template.id)
+ end
+ it "creates a new Plan if :dmp_id was not found" do
+ @json[:dmp_id][:identifier] = SecureRandom.uuid
+ result = described_class.send(:marshal_plan, json: @json)
+ expect(result.new_record?).to eql(true)
+ expect(result.template_id).to eql(@template.id)
+ end
+ end
+
+ describe "#deserialize_project(plan:, json:)" do
+ before(:each) do
+ # clear out the dates set in the factory
+ @plan.start_date = nil
+ @plan.end_date = nil
+ end
+
+ it "returns the Plan as-is if the json is not present" do
+ result = described_class.send(:deserialize_project, plan: @plan, json: nil)
+ expect(result).to eql(@plan)
+ expect(result.start_date).to eql(nil)
+ end
+ it "returns the Plan as-is if the json :project is not present" do
+ json = { title: Faker::Lorem.sentence }
+ result = described_class.send(:deserialize_project, plan: @plan, json: json)
+ expect(result).to eql(@plan)
+ expect(result.start_date).to eql(nil)
+ end
+ it "returns the Plan as-is if the json :project is not an array" do
+ json = {
+ title: Faker::Lorem.sentence,
+ project: { start: Time.now.to_formatted_s(:iso8601) }
+ }
+ result = described_class.send(:deserialize_project, plan: @plan, json: json)
+ expect(result).to eql(@plan)
+ expect(result.start_date).to eql(nil)
+ end
+ it "assigns the start_date of the Plan" do
+ result = described_class.send(:deserialize_project, plan: @plan, json: @json)
+ expected = Time.new(@json[:project].first[:start]).utc.to_formatted_s(:iso8601)
+ expect(result.start_date.to_formatted_s(:iso8601)).to eql(expected)
+ end
+ it "assigns the end_date of the Plan" do
+ result = described_class.send(:deserialize_project, plan: @plan, json: @json)
+ expected = Time.new(@json[:project].first[:end]).utc.to_formatted_s(:iso8601)
+ expect(result.end_date.to_formatted_s(:iso8601)).to eql(expected)
+ end
+ it "does not call the deserializer for Funding if :funding is not present" do
+ @json[:project].first[:funding] = nil
+ Api::V1::Deserialization::Funding.expects(:deserialize!).at_most(0)
+ described_class.send(:deserialize_project, plan: @plan, json: @json)
+ end
+ it "calls the deserializer for Funding if :funding present" do
+ Api::V1::Deserialization::Funding.expects(:deserialize!).at_least(1)
+ described_class.send(:deserialize_project, plan: @plan, json: @json)
+ end
+ end
+
+ describe "#deserialize_contact(plan:, json:)" do
+ it "returns the Plan as-is if json is not present" do
+ result = described_class.send(:deserialize_contact, plan: @plan, json: nil)
+ expect(result).to eql(@plan)
+ expect(result.contributors.length).to eql(0)
+ end
+ it "returns the Plan as-is if json :contact is not present" do
+ @json[:contact] = nil
+ result = described_class.send(:deserialize_contact, plan: @plan, json: @json)
+ expect(result).to eql(@plan)
+ expect(result.contributors.length).to eql(0)
+ end
+ it "calls the Contributor.deserialize! for the contact entry" do
+ Api::V1::Deserialization::Contributor.expects(:deserialize!).at_least(1)
+ described_class.send(:deserialize_contact, plan: @plan, json: @json)
+ end
+ it "attaches the Contributors to the Plan" do
+ result = described_class.send(:deserialize_contact, plan: @plan, json: @json)
+ expect(result.contributors.length).to eql(1)
+ expect(result.contributors.first.name).to eql(@json[:contact][:name])
+ end
+ end
+
+ describe "#deserialize_contributors(plan:, json:)" do
+ it "calls the Contributor.deserialize! for each contributor entry" do
+ Api::V1::Deserialization::Contributor.expects(:deserialize!).at_least(2)
+ described_class.send(:deserialize_contributors, plan: @plan, json: @json)
+ end
+ it "attaches the Contributors to the Plan" do
+ result = described_class.send(:deserialize_contributors, plan: @plan,
+ json: @json)
+ expect(result.contributors.length).to eql(2)
+ expect(result.contributors.first.name).to eql(@json[:contributor].first[:name])
+ expect(result.contributors.last.name).to eql(@json[:contributor].last[:name])
+ end
+ end
+
+ describe "#find_by_identifier(json:)" do
+ it "returns nil if json is not present" do
+ expect(described_class.send(:find_by_identifier, json: nil)).to eql(nil)
+ end
+ it "returns nil if json has no :dmp_id" do
+ json = { contact_id: { type: "url", identifier: SecureRandom.uuid } }
+ expect(described_class.send(:find_by_identifier, json: json)).to eql(nil)
+ end
+ it "calls Plan.from_identifiers if the :dmp_id is a DOI/ARK" do
+ described_class.stubs(:doi?).returns(true)
+ Plan.expects(:from_identifiers).at_least(1)
+ described_class.send(:find_by_identifier, json: @json)
+ end
+ it "calls Plan.find_by if the :dmp_id is not a DOI/ARK" do
+ described_class.stubs(:doi?).returns(false)
+ Plan.expects(:find_by).at_least(1)
+ described_class.send(:find_by_identifier, json: @json)
+ end
+ end
+
+ describe "doi?(value:)" do
+ it "returns false if value is not present" do
+ expect(described_class.send(:doi?, value: nil)).to eql(false)
+ end
+ it "returns false if the value does not match ARK or DOI pattern" do
+ url = Faker::Internet.url
+ expect(described_class.send(:doi?, value: url)).to eql(false)
+ end
+ it "returns false if the value does not match a partial ARK/DOI pattern" do
+ val = "23645gy3d"
+ expect(described_class.send(:doi?, value: val)).to eql(false)
+ val = "10.999"
+ expect(described_class.send(:doi?, value: val)).to eql(false)
+ end
+ it "returns false if there is no 'doi' identifier scheme" do
+ val = "10.999/23645gy3d"
+ @scheme.destroy
+ expect(described_class.send(:doi?, value: val)).to eql(false)
+ end
+ it "returns false if 'doi' identifier scheme exists but value is not doi" do
+ expect(described_class.send(:doi?, value: SecureRandom.uuid)).to eql(false)
+ end
+ it "returns true (identifier only)" do
+ val = "10.999/23645gy3d"
+ expect(described_class.send(:doi?, value: val)).to eql(true)
+ end
+ it "returns true (fully qualified ARK/DOI url)" do
+ url = "#{Faker::Internet.url}/10.999/23645gy3d"
+ expect(described_class.send(:doi?, value: url)).to eql(true)
+ end
+ end
+
+ describe "#find_template(json:)" do
+ it "returns nil if the json is not present" do
+ expect(described_class.send(:find_template, json: nil)).to eql(nil)
+ end
+ it "returns default template if no template is found for the :id" do
+ json = { template: { id: 9999, title: Faker::Lorem.sentence } }
+ expect(described_class.send(:find_template, json: json)).to eql(nil)
+ end
+ it "returns the specified template" do
+ expect(described_class.send(:find_template, json: @json)).to eql(@template)
+ end
+ end
+
+ describe "template_id(json:)" do
+ it "returns nil if json not present" do
+ expect(described_class.send(:template_id, json: nil)).to eql(nil)
+ end
+ it "returns nil if extensions for the app were not found" do
+ described_class.stubs(:app_extensions).returns({})
+ expect(described_class.send(:template_id, json: @json)).to eql(nil)
+ end
+ it "returns nil if the extensions have no template info" do
+ expected = { foo: { title: Faker::Lorem.sentence } }
+ described_class.stubs(:app_extensions).returns(expected)
+ expect(described_class.send(:template_id, json: @json)).to eql(nil)
+ end
+ it "returns nil if the extensions have no id for the template info" do
+ expected = { template: { title: Faker::Lorem.sentence } }
+ described_class.stubs(:app_extensions).returns(expected)
+ expect(described_class.send(:template_id, json: @json)).to eql(nil)
+ end
+ it "returns the template id" do
+ expect(described_class.send(:template_id, json: @json)).to eql(@template.id)
+ end
+ end
+
+ describe "#app_extensions(json:)" do
+ it "returns an empty hash is json is not present" do
+ expect(described_class.send(:app_extensions, json: nil)).to eql({})
+ end
+ it "returns an empty hash is json :extended_attributes is not present" do
+ json = { title: Faker::Lorem.sentence }
+ expect(described_class.send(:app_extensions, json: json)).to eql({})
+ end
+ it "returns an empty hash if there is no extension for the current application" do
+ expected = { template: { id: @template.id } }
+ ApplicationService.expects(:application_name).returns("tester")
+ json = { extension: [{ foo: expected }] }
+ expect(described_class.send(:app_extensions, json: json)).to eql({})
+ end
+ it "returns the hash for the current application" do
+ expected = { template: { id: @template.id } }
+ json = { extension: [{ "#{@app_name}": expected }] }
+ result = described_class.send(:app_extensions, json: json)
+ expect(result).to eql(expected)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/application_service_spec.rb b/spec/services/application_service_spec.rb
new file mode 100644
index 0000000000..524f891b4c
--- /dev/null
+++ b/spec/services/application_service_spec.rb
@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe ApplicationService do
+
+ describe "#default_language" do
+ it "returns the default language abbreviation defined in languages table" do
+ lang = create(:language, default_language: true)
+ expect(described_class.default_language).to eql(lang.abbreviation)
+ end
+ it "returns `en` if no default language is defined" do
+ Language.destroy_all
+ expect(described_class.default_language).to eql("en")
+ end
+ end
+
+ describe "#application_name" do
+ it "returns the application name defined in the config/branding.yml" do
+ Rails.application.config.branding[:application][:name] = "foo"
+ expect(described_class.application_name).to eql("foo")
+ end
+ it "returns the Rails application name if no config/branding.yml entry" do
+ Rails.application.config.branding[:application].delete(:name)
+ expected = Rails.application.class.name.split('::').first.downcase
+ expect(described_class.application_name).to eql(expected)
+ end
+ end
+
+end
diff --git a/spec/services/external_apis/base_service_spec.rb b/spec/services/external_apis/base_service_spec.rb
new file mode 100644
index 0000000000..08dc9fdcc6
--- /dev/null
+++ b/spec/services/external_apis/base_service_spec.rb
@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe ExternalApis::BaseService do
+
+ before(:each) do
+ # The base service is meant to abstract, so spoof some config
+ # variables here so that our tests can function
+ described_class.stubs(:landing_page_url).returns(Faker::Internet.url)
+ described_class.stubs(:api_base_url).returns(Faker::Internet.url)
+ end
+
+ describe "#headers" do
+ before(:each) do
+ @headers = described_class.headers
+ end
+ it "sets the Content-Type header for JSON" do
+ expect(@headers[:"Content-Type"]).to eql("application/json")
+ end
+ it "sets the Accept header for JSON" do
+ expect(@headers[:Accept]).to eql("application/json")
+ end
+ it "sets the User-Agent header for the default Application name and contact us url" do
+ expected = "#{described_class.send(:app_name)}" \
+ " (#{described_class.send(:app_email)})"
+ expect(@headers[:"User-Agent"]).to eql(expected)
+ end
+ end
+
+ describe "#log_error" do
+ before(:each) do
+ @err = Exception.new(Faker::Lorem.sentence)
+ end
+ it "does not write to the log if method is undefined" do
+ expect(described_class.log_error(method: nil, error: @err)).to eql(nil)
+ end
+ it "does not write to the log if error is undefined" do
+ expect(described_class.log_error(method: Faker::Lorem.word, error: nil)).to eql(nil)
+ end
+ it "writes to the log" do
+ Rails.logger.expects(:error).at_least(1)
+ described_class.log_error(method: Faker::Lorem.word, error: @err)
+ end
+ end
+
+ context "private methods" do
+ context "#config" do
+ it "returns the branding.yml config" do
+ expected = Rails.application.config.branding
+ expect(described_class.send(:config)).to eql(expected)
+ end
+ end
+ context "#app_name" do
+ it "defaults to the Rails.application.class.name" do
+ Rails.configuration.branding[:application].delete(:name)
+ expected = ApplicationService.application_name
+ expect(described_class.send(:app_name)).to eql(expected)
+ end
+ it "returns the application name defined in branding.yml" do
+ Rails.configuration.branding[:application][:name] = "Foo"
+ expect(described_class.send(:app_name)).to eql("foo")
+ end
+ end
+ context "#app_email" do
+ it "defaults to the contact_us url" do
+ Rails.configuration.branding[:organisation].delete(:helpdesk_email)
+ expected = Rails.application.routes.url_helpers.contact_us_url
+ expect(described_class.send(:app_email)).to eql(expected)
+ end
+ it "returns the help_desk email defined in branding.yml" do
+ Rails.configuration.branding[:organisation][:helpdesk_email] = "Foo"
+ expect(described_class.send(:app_email)).to eql("Foo")
+ end
+ end
+ context "#http_get" do
+ before(:each) do
+ @uri = "http://example.org"
+ end
+ it "returns nil if no URI is specified" do
+ expect(described_class.send(:http_get, uri: nil)).to eql(nil)
+ end
+ it "returns nil if an error occurs" do
+ expect(described_class.send(:http_get, uri: "badurl~^(%")).to eql(nil)
+ end
+ it "logs an error if an error occurs" do
+ Rails.logger.expects(:error).at_least(1)
+ expect(described_class.send(:http_get, uri: "badurl~^(%")).to eql(nil)
+ end
+ it "returns an HTTP response" do
+ stub_request(:get, @uri).with(headers: described_class.headers)
+ .to_return(status: 200, body: "", headers: {})
+ expect(described_class.send(:http_get, uri: @uri).code).to eql(200)
+ end
+ it "follows redirects" do
+ uri2 = "#{@uri}/redirected"
+ stub_redirect(uri: @uri, redirect_to: uri2)
+ stub_request(:get, uri2).with(headers: described_class.headers)
+ .to_return(status: 200, body: "", headers: {})
+
+ resp = described_class.send(:http_get, uri: @uri)
+ expect(resp.code).to eql(200)
+ end
+ end
+
+ context "#options(additional_headers:, debug:)" do
+ before(:each) do
+ described_class.stubs(:headers).returns({ "Accept": "*/*" })
+ end
+ it "headers just include base headers if no :additional_headers" do
+ result = described_class.send(:options)
+ expect(result[:headers][:Accept]).to eql("*/*")
+ end
+ it "merges additonal headers into the :headers option" do
+ result = described_class.send(:options, additional_headers: { foo: "bar" })
+ expect(result[:headers][:Accept]).to eql("*/*")
+ expect(result[:headers][:foo]).to eql("bar")
+ end
+ it "does not include :debug_output if :debug is false" do
+ result = described_class.send(:options)
+ expect(result[:debug_output]).to eql(nil)
+ end
+ it "includes :debug_output if :debug is true" do
+ result = described_class.send(:options, additional_headers: {}, debug: true)
+ expect(result[:debug_output].nil?).to eql(false)
+ end
+ it "includes :follow_redirects option" do
+ result = described_class.send(:options)
+ expect(result[:follow_redirects]).to eql(true)
+ end
+ end
+
+ end
+
+ def stub_redirect(uri:, redirect_to:)
+ stub_request(:get, uri).with(headers: described_class.headers)
+ .to_return(status: 301, body: "",
+ headers: { "Location": redirect_to })
+ end
+end
diff --git a/spec/services/external_apis/ror_service_spec.rb b/spec/services/external_apis/ror_service_spec.rb
new file mode 100644
index 0000000000..193eb28470
--- /dev/null
+++ b/spec/services/external_apis/ror_service_spec.rb
@@ -0,0 +1,371 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe ExternalApis::RorService do
+
+ describe "#ping" do
+ before(:each) do
+ @headers = described_class.headers
+ @heartbeat = URI("#{described_class.api_base_url}#{described_class.heartbeat_path}")
+ end
+ it "returns true if an HTTP 200 is returned" do
+ stub_request(:get, @heartbeat).with(headers: @headers)
+ .to_return(status: 200, body: "", headers: {})
+ expect(described_class.ping).to eql(true)
+ end
+ it "returns false if an HTTP 200 is NOT returned" do
+ stub_request(:get, @heartbeat).with(headers: @headers)
+ .to_return(status: 404, body: "", headers: {})
+ expect(described_class.ping).to eql(false)
+ end
+ end
+
+ describe "#search" do
+ before(:each) do
+ @headers = described_class.headers
+ @search = URI("#{described_class.api_base_url}#{described_class.search_path}")
+ @heartbeat = URI("#{described_class.api_base_url}#{described_class.heartbeat_path}")
+ stub_request(:get, @heartbeat).with(headers: @headers).to_return(status: 200)
+ end
+
+ it "returns an empty array if term is blank" do
+ expect(described_class.search(term: nil)).to eql([])
+ end
+
+ context "ROR did not return a 200 status" do
+ before(:each) do
+ @term = Faker::Lorem.word
+ uri = "#{@search}?page=1&query=#{@term}"
+ stub_request(:get, uri).with(headers: @headers)
+ .to_return(status: 404, body: "", headers: {})
+ end
+ it "returns an empty array" do
+ expect(described_class.search(term: @term)).to eql([])
+ end
+ it "logs the response as an error" do
+ described_class.expects(:handle_http_failure).at_least(1)
+ described_class.search(term: @term)
+ end
+ end
+
+ it "returns an empty string if ROR found no matches" do
+ results = {
+ "number_of_results": 0,
+ "time_taken": 23,
+ "items": [],
+ "meta": { "types": [], "countries" => [] }
+ }
+ term = Faker::Lorem.word
+ uri = "#{@search}?page=1&query=#{term}"
+ stub_request(:get, uri).with(headers: @headers)
+ .to_return(status: 200, body: results.to_json, headers: {})
+ expect(described_class.search(term: term)).to eql([])
+ end
+
+ context "Successful response from API" do
+ before(:each) do
+ results = {
+ "number_of_results": 2,
+ "time_taken": 5,
+ "items": [
+ {
+ "id": "https://ror.org/1234567890",
+ "name": "Example University",
+ "types": ["Education"],
+ "links": ["http://example.edu/"],
+ "aliases": ["Example"],
+ "acronyms": ["EU"],
+ "status": "active",
+ "country": { "country_name": "United States", "country_code": "US" },
+ "external_ids": {
+ "GRID": { "preferred": "grid.12345.1", "all": "grid.12345.1" }
+ }
+ }, {
+ "id": "https://ror.org/0987654321",
+ "name": "Universidade de Example",
+ "types": ["Education"],
+ "links": [],
+ "aliases": ["Example"],
+ "acronyms": ["EU"],
+ "status": "active",
+ "country": { "country_name": "Mexico", "country_code": "MX" },
+ "external_ids": {
+ "GRID": { "preferred": "grid.98765.8", "all": "grid.98765.8" }
+ }
+ }
+ ]
+ }
+ term = Faker::Lorem.word
+ uri = "#{@search}?page=1&query=#{term}"
+ stub_request(:get, uri).with(headers: @headers)
+ .to_return(status: 200, body: results.to_json, headers: {})
+ @orgs = described_class.search(term: term)
+ end
+
+ it "returns both results" do
+ expect(@orgs.length).to eql(2)
+ end
+
+ it "includes the website in the name (if available)" do
+ expected = {
+ id: "https://ror.org/1234567890",
+ name: "Example University (example.edu)"
+ }
+ expect(@orgs.map { |i| i[:name] }.include?(expected[:name])).to eql(true)
+ end
+
+ it "includes the country in the name (if no website is available)" do
+ expected = {
+ id: "https://ror.org/0987654321",
+ name: "Universidade de Example (Mexico)"
+ }
+ expect(@orgs.map { |i| i[:name] }.include?(expected[:name])).to eql(true)
+ end
+ end
+ end
+
+ context "private methods" do
+ describe "#query_ror" do
+ before(:each) do
+ @results = {
+ "number_of_results": 1,
+ "time_taken": 5,
+ "items": [{
+ "id": Faker::Internet.url,
+ "name": Faker::Lorem.word,
+ "country": { "country_name": Faker::Lorem.word }
+ }]
+ }
+ @term = Faker::Lorem.word
+ @headers = described_class.headers
+ search = URI("#{described_class.api_base_url}#{described_class.search_path}")
+ @uri = "#{search}?page=1&query=#{@term}"
+ end
+
+ it "returns an empty array if term is blank" do
+ expect(described_class.send(:query_ror, term: nil)).to eql([])
+ end
+ it "calls the handle_http_failure method if a non 200 response is received" do
+ stub_request(:get, @uri).with(headers: @headers)
+ .to_return(status: 403, body: "", headers: {})
+ described_class.expects(:handle_http_failure).at_least(1)
+ expect(described_class.send(:query_ror, term: @term)).to eql([])
+ end
+ it "returns the response body as JSON" do
+ stub_request(:get, @uri).with(headers: @headers)
+ .to_return(status: 200, body: @results.to_json,
+ headers: {})
+ expect(described_class.send(:query_ror, term: @term)).not_to eql([])
+ end
+ end
+
+ describe "#query_string" do
+ it "assigns the search term to the 'query' argument" do
+ str = described_class.send(:query_string, term: "Foo")
+ expect(str).to eql("query=Foo&page=1")
+ end
+ it "defaults the page number to 1" do
+ str = described_class.send(:query_string, term: "Foo")
+ expect(str).to eql("query=Foo&page=1")
+ end
+ it "assigns the page number to the 'page' argument" do
+ str = described_class.send(:query_string, term: "Foo", page: 3)
+ expect(str).to eql("query=Foo&page=3")
+ end
+ it "ignores empty filter options" do
+ str = described_class.send(:query_string, term: "Foo", filters: [])
+ expect(str).to eql("query=Foo&page=1")
+ end
+ it "assigns a single filter" do
+ str = described_class.send(:query_string, term: "Foo", filters: ["types:A"])
+ expect(str).to eql("query=Foo&page=1&filter=types:A")
+ end
+ it "assigns multiple filters" do
+ str = described_class.send(:query_string, term: "Foo", filters: [
+ "types:A", "country.country_code:GB"
+ ])
+ expect(str).to eql("query=Foo&page=1&filter=types:A,country.country_code:GB")
+ end
+ end
+
+ describe "#process_pages" do
+ before(:each) do
+ described_class.stubs(:max_pages).returns(2)
+ described_class.stubs(:max_results_per_page).returns(5)
+
+ @search = URI("#{described_class.api_base_url}#{described_class.search_path}")
+ @term = Faker::Lorem.word
+ @headers = described_class.headers
+ end
+
+ it "returns an empty array if json is blank" do
+ rslts = described_class.send(:process_pages, term: @term, json: nil)
+ expect(rslts.length).to eql(0)
+ end
+ it "properly manages results with only one page" do
+ items = 4.times.map do
+ {
+ "id": Faker::Internet.unique.url,
+ "name": Faker::Lorem.word,
+ "country": { "country_name": Faker::Lorem.word }
+ }
+ end
+ results1 = { "number_of_results": 4, "items": items }
+
+ stub_request(:get, "#{@search}?page=1&query=#{@term}")
+ .with(headers: @headers)
+ .to_return(status: 200, body: results1.to_json, headers: {})
+
+ json = JSON.parse({ "items": items, "number_of_results": 4 }.to_json)
+ rslts = described_class.send(:process_pages, term: @term, json: json)
+
+ expect(rslts.length).to eql(4)
+ end
+ it "properly manages results with multiple pages" do
+ items = 7.times.map do
+ {
+ "id": Faker::Internet.unique.url,
+ "name": Faker::Lorem.word,
+ "country": { "country_name": Faker::Lorem.word }
+ }
+ end
+ results1 = { "number_of_results": 7, "items": items[0..4] }
+ results2 = { "number_of_results": 7, "items": items[5..6] }
+
+ stub_request(:get, "#{@search}?page=1&query=#{@term}")
+ .with(headers: @headers)
+ .to_return(status: 200, body: results1.to_json, headers: {})
+ stub_request(:get, "#{@search}?page=2&query=#{@term}")
+ .with(headers: @headers)
+ .to_return(status: 200, body: results2.to_json, headers: {})
+
+ json = JSON.parse({ "items": items[0..4], "number_of_results": 7 }.to_json)
+ rslts = described_class.send(:process_pages, term: @term, json: json)
+ expect(rslts.length).to eql(7)
+ end
+ it "does not go beyond the max_pages" do
+ items = 12.times.map do
+ {
+ "id": Faker::Internet.unique.url,
+ "name": Faker::Lorem.word,
+ "country": { "country_name": Faker::Lorem.word }
+ }
+ end
+ results1 = { "number_of_results": 12, "items": items[0..4] }
+ results2 = { "number_of_results": 12, "items": items[5..9] }
+
+ stub_request(:get, "#{@search}?page=1&query=#{@term}")
+ .with(headers: @headers)
+ .to_return(status: 200, body: results1.to_json, headers: {})
+ stub_request(:get, "#{@search}?page=2&query=#{@term}")
+ .with(headers: @headers)
+ .to_return(status: 200, body: results2.to_json, headers: {})
+
+ json = JSON.parse({ "items": items[0..4], "number_of_results": 12 }.to_json)
+ rslts = described_class.send(:process_pages, term: @term, json: json)
+ expect(rslts.length).to eql(10)
+ end
+ end
+
+ describe "#parse_results" do
+ it "returns an empty array if there are no items" do
+ expect(described_class.send(:parse_results, json: nil)).to eql([])
+ end
+ it "ignores items with no name or id" do
+ json = { "items": [
+ { "id": Faker::Internet.url, "name": Faker::Lorem.word },
+ { "id": Faker::Internet.url },
+ { "name": Faker::Lorem.word }
+ ] }.to_json
+ items = described_class.send(:parse_results, json: JSON.parse(json))
+ expect(items.length).to eql(1)
+ end
+ it "returns the correct number of results" do
+ json = { "items": [
+ { "id": Faker::Internet.url, "name": Faker::Lorem.word },
+ { "id": Faker::Internet.url, "name": Faker::Lorem.word }
+ ] }.to_json
+ items = described_class.send(:parse_results, json: JSON.parse(json))
+ expect(items.length).to eql(2)
+ end
+ end
+
+ describe "#org_name" do
+ it "returns nil if there is no name" do
+ json = { "country": { "country_name": "Nowhere" } }.to_json
+ expect(described_class.send(:org_name, item: JSON.parse(json))).to eql("")
+ end
+ it "properly appends the website if available" do
+ json = {
+ "name": "Example College",
+ "links": ["https://example.edu"],
+ "country": { "country_name": "Nowhere" }
+ }.to_json
+ expected = "Example College (example.edu)"
+ expect(described_class.send(:org_name, item: JSON.parse(json))).to eql(expected)
+ end
+ it "properly appends the country if available and no website is available" do
+ json = {
+ "name": "Example College",
+ "country": { "country_name": "Nowhere" }
+ }.to_json
+ expected = "Example College (Nowhere)"
+ expect(described_class.send(:org_name, item: JSON.parse(json))).to eql(expected)
+ end
+ it "properly handles an item with no website or country" do
+ json = {
+ "name": "Example College",
+ "links": [],
+ "country": {}
+ }.to_json
+ expected = "Example College"
+ expect(described_class.send(:org_name, item: JSON.parse(json))).to eql(expected)
+ end
+ end
+
+ describe "#org_website" do
+ it "returns nil if no 'links' are in the json" do
+ item = JSON.parse({ "links": nil }.to_json)
+ expect(described_class.send(:org_website, item: item)).to eql(nil)
+ end
+ it "returns nil if the item is nil" do
+ expect(described_class.send(:org_website, item: nil)).to eql(nil)
+ end
+ it "returns the domain only" do
+ item = JSON.parse({ "links": ["https://example.org/path?a=b"] }.to_json)
+ expect(described_class.send(:org_website, item: item)).to eql("example.org")
+ end
+ it "removes the www prefix" do
+ item = JSON.parse({ "links": ["www.example.org"] }.to_json)
+ expect(described_class.send(:org_website, item: item)).to eql("example.org")
+ end
+ end
+
+ describe "#fundref_id" do
+ before(:each) do
+ @hash = { "external_ids": {} }
+ end
+ it "returns a blank if no external_ids are present" do
+ json = JSON.parse(@hash.to_json)
+ expect(described_class.send(:fundref_id, item: json)).to eql("")
+ end
+ it "returns a blank if no FundRef ids are present" do
+ @hash["external_ids"] = { "FundRef": {} }
+ json = JSON.parse(@hash.to_json)
+ expect(described_class.send(:fundref_id, item: json)).to eql("")
+ end
+ it "returns the preferred id when specified" do
+ @hash["external_ids"] = { "FundRef": { "preferred": "1", "all": %w[2 1] } }
+ json = JSON.parse(@hash.to_json)
+ expect(described_class.send(:fundref_id, item: json)).to eql("1")
+ end
+ it "returns the firstid if no preferred is specified" do
+ @hash["external_ids"] = { "FundRef": { "preferred": nil, "all": %w[2 1] } }
+ json = JSON.parse(@hash.to_json)
+ expect(described_class.send(:fundref_id, item: json)).to eql("2")
+ end
+ end
+
+ end
+end
diff --git a/spec/services/org/create_created_plan_service_spec.rb b/spec/services/org/create_created_plan_service_spec.rb
index 3a5072559f..7a705ae5eb 100644
--- a/spec/services/org/create_created_plan_service_spec.rb
+++ b/spec/services/org/create_created_plan_service_spec.rb
@@ -75,7 +75,7 @@
def find_by_dates(dates:, org_id:)
dates.map do |date|
- StatCreatedPlan.find_by(date: date, org_id: org_id)
+ StatCreatedPlan.find_by(date: date, org_id: org_id, filtered: false)
end
end
@@ -118,7 +118,7 @@ def find_by_dates(dates:, org_id:)
it "monthly records are either created or updated" do
described_class.call(org)
- april = StatCreatedPlan.where(date: "2018-04-30", org: org)
+ april = StatCreatedPlan.where(date: "2018-04-30", org: org, filtered: true)
expect(april).to have(1).items
expect(april.first.count).to eq(2)
@@ -129,7 +129,7 @@ def find_by_dates(dates:, org_id:)
described_class.call(org)
- april = StatCreatedPlan.where(date: "2018-04-30", org: org)
+ april = StatCreatedPlan.where(date: "2018-04-30", org: org, filtered: true)
expect(april).to have(1).items
expect(april.first.count).to eq(3)
end
@@ -181,7 +181,7 @@ def find_by_dates(dates:, org_id:)
described_class.call
- april = StatCreatedPlan.where(date: "2018-04-30", org: org)
+ april = StatCreatedPlan.where(date: "2018-04-30", org: org, filtered: true)
expect(april).to have(1).items
expect(april.first.count).to eq(2)
@@ -192,7 +192,7 @@ def find_by_dates(dates:, org_id:)
described_class.call
- april = StatCreatedPlan.where(date: "2018-04-30", org: org)
+ april = StatCreatedPlan.where(date: "2018-04-30", org: org, filtered: true)
expect(april).to have(1).items
expect(april.first.count).to eq(3)
end
diff --git a/spec/services/org/create_last_month_created_plan_service_spec.rb b/spec/services/org/create_last_month_created_plan_service_spec.rb
index 765243d054..368ff334f1 100644
--- a/spec/services/org/create_last_month_created_plan_service_spec.rb
+++ b/spec/services/org/create_last_month_created_plan_service_spec.rb
@@ -53,7 +53,7 @@
last_month_count = StatCreatedPlan.find_by(
date: Date.today.last_month.end_of_month,
- org_id: org.id).count
+ org_id: org.id, filtered: false).count
expect(last_month_count).to eq(3)
end
@@ -62,7 +62,7 @@
last_month_details = StatCreatedPlan.find_by(
date: Date.today.last_month.end_of_month,
- org_id: org.id).by_template
+ org_id: org.id, filtered: false).by_template
expect(last_month_details).to match_array(
[
@@ -72,12 +72,12 @@
)
end
- it "generates counts by template from today's last month" do
+ it "generates counts using template from today's last month" do
described_class.call(org)
last_month_details = StatCreatedPlan.find_by(
date: Date.today.last_month.end_of_month,
- org_id: org.id).using_template
+ org_id: org.id, filtered: false).using_template
expect(last_month_details).to match_array(
[
@@ -92,7 +92,7 @@
last_month = StatCreatedPlan.where(
date: Date.today.last_month.end_of_month,
- org_id: org.id)
+ org_id: org.id, filtered: false)
expect(last_month).to have(1).items
expect(last_month.first.count).to eq(3)
@@ -106,7 +106,7 @@
last_month = StatCreatedPlan.where(
date: Date.today.last_month.end_of_month,
- org_id: org.id)
+ org_id: org.id, filtered: false)
expect(last_month).to have(1).items
expect(last_month.first.count).to eq(4)
@@ -121,7 +121,7 @@
last_month_count = StatCreatedPlan.find_by(
date: Date.today.last_month.end_of_month,
- org_id: org.id).count
+ org_id: org.id, filtered: false).count
expect(last_month_count).to eq(3)
end
@@ -133,7 +133,7 @@
last_month_details = StatCreatedPlan.find_by(
date: Date.today.last_month.end_of_month,
- org_id: org.id).by_template
+ org_id: org.id, filtered: false).by_template
expect(last_month_details).to match_array(
[
@@ -150,7 +150,7 @@
last_month_details = StatCreatedPlan.find_by(
date: Date.today.last_month.end_of_month,
- org_id: org.id).using_template
+ org_id: org.id, filtered: false).using_template
expect(last_month_details).to match_array(
[
@@ -167,7 +167,7 @@
last_month = StatCreatedPlan.where(
date: Date.today.last_month.end_of_month,
- org: org)
+ org: org, filtered: false)
expect(last_month).to have(1).items
expect(last_month.first.count).to eq(3)
@@ -180,7 +180,7 @@
described_class.call
last_month = StatCreatedPlan.where(date: Date.today.last_month.end_of_month,
- org: org)
+ org: org, filtered: false)
expect(last_month).to have(1).items
expect(last_month.first.count).to eq(4)
end
diff --git a/spec/services/org_selection/hash_to_org_service_spec.rb b/spec/services/org_selection/hash_to_org_service_spec.rb
new file mode 100644
index 0000000000..46092a18d6
--- /dev/null
+++ b/spec/services/org_selection/hash_to_org_service_spec.rb
@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe OrgSelection::HashToOrgService do
+
+ before(:each) do
+ @name = Faker::Company.name
+ @abbrev = Faker::Lorem.word.upcase
+ @lang = create(:language)
+ @url = Faker::Internet.url
+ @attr_key = Faker::Lorem.word
+ @attr_val = Faker::Lorem.word
+ @scheme = create(:identifier_scheme, for_orgs: true)
+
+ @hash = {
+ name: "#{@name} (#{@abbrev})",
+ sort_name: @name,
+ score: Faker::Number.number,
+ weight: Faker::Number.number,
+ language: @lang.abbreviation,
+ abbreviation: @abbrev,
+ url: @url,
+ "#{@scheme.name}": Faker::Lorem.word,
+ "#{@attr_key}": @attr_val
+ }
+ end
+
+ describe "#to_org(hash:)" do
+ it "returns nil if the hash is empty" do
+ expect(described_class.to_org(hash: nil)).to eql(nil)
+ end
+ it "returns the Org if the hash contains an Org id and the names match" do
+ org = create(:org, name: @name)
+ @hash[:id] = org.id
+ expect(described_class.to_org(hash: @hash)).to eql(org)
+ end
+ it "returns the Org by its identifier and the names match" do
+ ident = build(:identifier, identifier_scheme: @scheme,
+ value: @hash[:"#{@scheme.name}"])
+ org = create(:org, name: @name, identifiers: [ident])
+ expect(described_class.to_org(hash: @hash)).to eql(org)
+ end
+ it "returns the Org by name match" do
+ org = create(:org, name: @name)
+ expect(described_class.to_org(hash: @hash)).to eql(org)
+ end
+ it "returns a new Org instance" do
+ expect(described_class.to_org(hash: @hash).new_record?).to eql(true)
+ end
+ end
+
+ describe "#to_identifiers(hash:)" do
+ before(:each) do
+ @rslt = described_class.to_identifiers(hash: @hash)
+ end
+
+ it "returns an empty array if hash is nil" do
+ expect(described_class.to_identifiers(hash: nil)).to eql([])
+ end
+ it "skips non-IdentifierScheme entries" do
+ @hash.delete(:"#{@scheme.name}")
+ expect(described_class.to_identifiers(hash: @hash)).to eql([])
+ end
+ it "returns an array of new Identifiers" do
+ expect(@rslt.is_a?(Array)).to eql(true)
+ expect(@rslt.length).to eql(1)
+ end
+ it "returned Identifiers have an identifier scheme" do
+ expect(@rslt.first.identifier_scheme).to eql(@scheme)
+ end
+ it "returned Identifiers have a value" do
+ expect(@rslt.first.value.ends_with?(@hash[:"#{@scheme.name}"])).to eql(true)
+ end
+ it "returned Identifiers have attrs" do
+ expected = JSON.parse({
+ name: @hash[:name],
+ url: @url,
+ language: @lang.abbreviation,
+ abbreviation: @abbrev,
+ "#{@attr_key}": @attr_val
+ }.to_json)
+ expect(JSON.parse(@rslt.first.attrs)).to eql(expected)
+ end
+ end
+
+ context "private methods" do
+
+ describe "#initialize_org(hash:)" do
+ it "returns nil if the hash is nil" do
+ rslt = described_class.send(:initialize_org, hash: nil)
+ expect(rslt).to eql(nil)
+ end
+ it "returns nil if the hash has no name attribute" do
+ @hash.delete(:name)
+ rslt = described_class.send(:initialize_org, hash: @hash)
+ expect(rslt).to eql(nil)
+ end
+ it "returns a new instance of Org" do
+ rslt = described_class.send(:initialize_org, hash: @hash)
+ nm = "#{@name} (#{@abbrev})"
+ lnks = JSON.parse({ "org": [{ "link": @url, "text": nm }] }.to_json)
+ expect(rslt.is_a?(Org)).to eql(true)
+ expect(rslt.new_record?).to eql(true)
+ expect(rslt.name).to eql(nm)
+ expect(rslt.links).to eql(lnks)
+ expect(rslt.language).to eql(@lang)
+ expect(rslt.target_url).to eql(@url)
+ expect(rslt.institution?).to eql(true)
+ expect(rslt.abbreviation).to eql(@abbrev)
+ end
+ end
+
+ describe "#links_from_hash(name:, website:)" do
+ before(:each) do
+ @dflt = { org: [] }
+ end
+
+ it "returns a default hash if name is blank" do
+ rslt = described_class.send(:links_from_hash, name: nil, website: @url)
+ expect(rslt).to eql(@dflt)
+ end
+ it "returns a default hash if website is blank" do
+ rslt = described_class.send(:links_from_hash, name: @name, website: nil)
+ expect(rslt).to eql(@dflt)
+ end
+ it "returns the links hash" do
+ rslt = described_class.send(:links_from_hash, name: @name,
+ website: @url)
+ expect(rslt).to eql({ org: [{ "link": @url, "text": @name }] })
+ end
+ end
+
+ describe "#abbreviation_from_hash(hash:)" do
+ it "returns nil if the hash is nil" do
+ rslt = described_class.send(:abbreviation_from_hash, hash: nil)
+ expect(rslt).to eql(nil)
+ end
+ it "returns the hash's abbreviation if it exists" do
+ rslt = described_class.send(:abbreviation_from_hash, hash: @hash)
+ expect(rslt).to eql(@abbrev)
+ end
+ it "returns the name as an acronym (first letter of each word)" do
+ @hash.delete(:abbreviation)
+ rslt = described_class.send(:abbreviation_from_hash, hash: @hash)
+ expected = @name.split(" ").map { |i| i[0].upcase }.join
+ expect(rslt).to eql(expected)
+ end
+ end
+
+ describe "#language_from_hash(hash:)" do
+ before(:each) do
+ @dflt = create(:language, default_language: true)
+ end
+
+ it "returns the default language if hash is empty" do
+ rslt = described_class.send(:language_from_hash, hash: nil)
+ expect(rslt).to eql(@dflt)
+ end
+ it "returns the default language if hash does not have a :language" do
+ rslt = described_class.send(:language_from_hash, hash: {})
+ expect(rslt).to eql(@dflt)
+ end
+ it "returns the default language if no matching languages exist" do
+ @lang.destroy
+ rslt = described_class.send(:language_from_hash, hash: @hash)
+ expect(rslt).to eql(@dflt)
+ end
+ it "returns the correct language" do
+ rslt = described_class.send(:language_from_hash, hash: @hash)
+ expect(rslt).to eql(@lang)
+ end
+ end
+
+ describe "#identifier_keys" do
+ before(:each) do
+ @rslt = described_class.send(:identifier_keys)
+ end
+
+ it "returns the identifier key" do
+ expect(@rslt.include?("#{@scheme.name}")).to eql(true)
+ end
+ it "does not return the other keys" do
+ expect(@rslt.include?("name")).to eql(false)
+ expect(@rslt.include?("sort_name")).to eql(false)
+ expect(@rslt.include?("weight")).to eql(false)
+ expect(@rslt.include?("score")).to eql(false)
+ expect(@rslt.include?("language")).to eql(false)
+ expect(@rslt.include?("url")).to eql(false)
+ expect(@rslt.include?("#{@attr_key}")).to eql(false)
+ end
+ end
+
+ describe "#attr_keys(hash:)" do
+ before(:each) do
+ @rslt = described_class.send(:attr_keys, hash: JSON.parse(@hash.to_json))
+ end
+
+ it "returns an empty hash if hash is nil" do
+ expect(described_class.send(:attr_keys, hash: nil)).to eql({})
+ end
+ it "does not include sort_name, weight or score attributes" do
+ expect(@rslt.include?("sort_name")).to eql(false)
+ expect(@rslt.include?("weight")).to eql(false)
+ expect(@rslt.include?("score")).to eql(false)
+ end
+ it "does not include identifier keys" do
+ expect(@rslt.include?("#{@scheme.name}")).to eql(false)
+ end
+ it "returns the other attributes" do
+ expect(@rslt.include?("name")).to eql(true)
+ expect(@rslt.include?("language")).to eql(true)
+ expect(@rslt.include?("url")).to eql(true)
+ expect(@rslt.include?("#{@attr_key}")).to eql(true)
+ end
+ end
+
+ describe "#exact_match?(rec:, name2:)" do
+ it "returns false if no record is present" do
+ rslt = described_class.send(:exact_match?, rec: nil,
+ name2: Faker::Lorem.word)
+ expect(rslt).to eql(false)
+ end
+ it "returns false if the name is blank" do
+ rslt = described_class.send(:exact_match?, rec: build(:org), name2: "")
+ expect(rslt).to eql(false)
+ end
+ it "calls the SearchService" do
+ OrgSelection::SearchService.expects(:exact_match?).at_least(1)
+ described_class.send(:exact_match?, rec: build(:org),
+ name2: Faker::Lorem.word)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/services/org_selection/org_to_hash_service_spec.rb b/spec/services/org_selection/org_to_hash_service_spec.rb
new file mode 100644
index 0000000000..7a4fb8b934
--- /dev/null
+++ b/spec/services/org_selection/org_to_hash_service_spec.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe OrgSelection::OrgToHashService do
+
+ before(:each) do
+ @name = Faker::Lorem.word
+ @scheme = build(:identifier_scheme)
+ @id = build(:identifier, identifier_scheme: @scheme)
+ @org = build(:org, name: "#{@name} (ABC)", identifiers: [@id])
+ end
+
+ describe "#to_hash(org:)" do
+ before(:each) do
+ @rslt = described_class.to_hash(org: @org)
+ end
+
+ it "returns an empty hash if the Org is nil" do
+ expect(described_class.to_hash(org: nil)).to eql({})
+ end
+ it "places the Org.id into the :id parameter" do
+ expect(@rslt[:id]).to eql(@org.id)
+ end
+ it "places the Org.name into the :name parameter" do
+ expect(@rslt[:name]).to eql(@org.name)
+ end
+ it "places the Org.name (without an alias) into the :sort_name parameter" do
+ expect(@rslt[:sort_name]).to eql(@name)
+ end
+ it "places identifiers into the correct `[scheme.name]: [value]` format" do
+ expect(@rslt[:"#{@scheme.name}"]).to eql(@id.value)
+ end
+ end
+
+end
diff --git a/spec/services/org_selection/search_service_spec.rb b/spec/services/org_selection/search_service_spec.rb
new file mode 100644
index 0000000000..ad07516d8e
--- /dev/null
+++ b/spec/services/org_selection/search_service_spec.rb
@@ -0,0 +1,361 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe OrgSelection::SearchService do
+
+ before(:each) do
+ @records = [
+ {
+ id: Faker::Internet.url,
+ name: "Foo College (test.edu)",
+ sort_name: "Foo College"
+ },
+ {
+ id: Faker::Internet.url,
+ name: "Foo College (other.edu)",
+ sort_name: "Foo College"
+ },
+ {
+ id: Faker::Internet.url,
+ name: "Foo University (Ireland)",
+ sort_name: "Foo University"
+ },
+ {
+ id: Faker::Internet.url,
+ name: "University of Foo (Spain)",
+ sort_name: "University of Foo"
+ }
+ ]
+
+ # Mock calls to the RorService
+ ExternalApis::RorService.stubs(:active).returns(true)
+ ExternalApis::RorService.stubs(:search).returns(@records)
+ end
+
+ describe "#search_combined(search_term:)" do
+ it "returns an empty array if the search term is not provided" do
+ expect(described_class.search_combined(search_term: nil)).to eql([])
+ end
+ it "returns an empty array if the search term is less than 2 chars" do
+ expect(described_class.search_combined(search_term: "Ab")).to eql([])
+ end
+ it "only searches locally if an exact match was found" do
+ org = create(:org)
+ described_class.expects(:local_search).returns([org]).at_least(1)
+ described_class.expects(:externals_search).at_least(0)
+ described_class.search_combined(search_term: org.name)
+ end
+ it "calls both search_locally and search_externally" do
+ described_class.expects(:local_search).at_least(1)
+ described_class.expects(:externals_search).at_least(1)
+ described_class.search_combined(search_term: Faker::Company.name)
+ end
+ end
+
+ describe "#search_externally(search_term:)" do
+ it "returns an empty array if the search term is not provided" do
+ expect(described_class.search_externally(search_term: nil)).to eql([])
+ end
+ it "returns an empty array if the search term is less than 2 chars" do
+ expect(described_class.search_externally(search_term: "Ab")).to eql([])
+ end
+ it "calls the private externals_search method" do
+ described_class.expects(:externals_search).at_least(1)
+ described_class.search_externally(search_term: Faker::Company.name)
+ end
+ end
+
+ describe "#search_locally(search_term:)" do
+ it "returns an empty array if the search term is not provided" do
+ expect(described_class.search_locally(search_term: nil)).to eql([])
+ end
+ it "returns an empty array if the search term is less than 2 chars" do
+ expect(described_class.search_locally(search_term: "Ab")).to eql([])
+ end
+ it "calls the private locals_search method" do
+ described_class.expects(:local_search).at_least(1)
+ described_class.search_locally(search_term: Faker::Company.name)
+ end
+ end
+
+ describe "#name_without_alias(name:)" do
+ it "returns an empty string if name is not present" do
+ expect(described_class.name_without_alias(name: nil)).to eql("")
+ end
+ it "returns the name without the abbreviation alias" do
+ name = Faker::Company.name
+ rslt = described_class.name_without_alias(name: "#{name} (ABC)")
+ expect(rslt).to eql(name)
+ end
+ it "returns the name without the domain alias" do
+ name = Faker::Company.name
+ rslt = described_class.name_without_alias(name: "#{name} (example.edu)")
+ expect(rslt).to eql(name)
+ end
+ end
+
+ describe "#exact_match?(name1:, name2:)" do
+ it "returns false if name1 is nil" do
+ rslt = described_class.exact_match?(name1: nil, name2: "Foo")
+ expect(rslt).to eql(false)
+ end
+ it "returns false if name2 is nil" do
+ rslt = described_class.exact_match?(name1: "Foo", name2: nil)
+ expect(rslt).to eql(false)
+ end
+ it "returns false if the names do not match" do
+ rslt = described_class.exact_match?(name1: "Bar", name2: "Foo")
+ expect(rslt).to eql(false)
+ end
+ it "returns true if the names match" do
+ rslt = described_class.exact_match?(name1: "Foo", name2: "Foo")
+ expect(rslt).to eql(true)
+ end
+ it "returns true if the names match but their cases do not" do
+ rslt = described_class.exact_match?(name1: "foo", name2: "Foo")
+ expect(rslt).to eql(true)
+ end
+ end
+
+ context "private methods" do
+
+ describe "#local_search(search_term:)" do
+ it "returns an empty array if the search term is blank" do
+ rslts = described_class.send(:local_search, search_term: nil)
+ expect(rslts).to eql([])
+ end
+ it "returns an empty array if no Orgs were matched" do
+ rslts = described_class.send(:local_search, search_term: "Bar")
+ expect(rslts).to eql([])
+ end
+ it "returns an array of matching Orgs" do
+ create(:org, name: "Foo Bar")
+ rslts = described_class.send(:local_search, search_term: "Foo")
+ expect(rslts.length).to eql(1)
+ expect(rslts.is_a?(Array)).to eql(true)
+ end
+ end
+
+ describe "#externals_search(search_term:)" do
+ before(:each) do
+ ExternalApis::RorService.stubs(:active).returns(true)
+ end
+
+ it "returns an empty array if the search term is blank" do
+ rslts = described_class.send(:externals_search, search_term: nil)
+ expect(rslts).to eql([])
+ end
+ it "returns an empty array if no external apis are active" do
+ ExternalApis::RorService.stubs(:active).returns(false)
+ rslts = described_class.send(:externals_search, search_term: "Foo")
+ expect(rslts).to eql([])
+ end
+ it "returns an empty array if no Orgs were matched" do
+ ExternalApis::RorService.stubs(:search).returns([])
+ rslts = described_class.send(:externals_search, search_term: "Foo")
+ expect(rslts).to eql([])
+ end
+ it "returns an array of matching Orgs" do
+ rslts = described_class.send(:externals_search, search_term: "Foo")
+ expect(rslts.length).to eql(4)
+ expect(rslts.is_a?(Array)).to eql(true)
+ end
+ end
+
+ describe "#prepare(search_term:, records:)" do
+ it "returns an empty array if the search term is blank" do
+ rslts = described_class.send(:prepare, search_term: nil,
+ records: @records)
+ expect(rslts).to eql([])
+ end
+ it "returns an empty array if the records is not an array" do
+ rslts = described_class.send(:prepare, search_term: "Foo",
+ records: nil)
+ expect(rslts).to eql([])
+ end
+ it "handles Org models" do
+ recs = [create(:org, name: "Fooville Community College")]
+ rslts = described_class.send(:prepare, search_term: "Foo",
+ records: recs)
+ expect(rslts.first[:name]).to eql("Fooville Community College")
+ end
+ it "handles non-Org models" do
+ rslts = described_class.send(:prepare, search_term: "Foo",
+ records: @records)
+ rec = rslts.select { |item| item[:name].include?("Ireland") }.first
+ expect(rec[:name]).to eql("Foo University (Ireland)")
+ end
+ end
+
+ describe "#deduplicate(records:)" do
+ it "returns an empty array if the incoming records is not an Array" do
+ expect(described_class.send(:deduplicate, records: nil)).to eql([])
+ end
+ it "includes all of the unique records" do
+ rslts = described_class.send(:deduplicate, records: @records)
+ expect(rslts.length).to eql(3)
+ end
+ it "removes the duplicate" do
+ rslts = described_class.send(:deduplicate, records: @records)
+ dupe = rslts.select { |rec| rec[:name] == "Foo College (other.edu)" }
+ expect(dupe).to eql([])
+ end
+ end
+
+ describe "#sort(array:)" do
+ before(:each) do
+ @sortable = @records.each_with_index.map do |rec, idx|
+ rec.merge(weight: idx, score: idx + 1)
+ end
+ # Mix up the records since we scored them in order
+ @sortable = @sortable.sort { |a, b| b[:name] <=> a[:name] }
+ end
+
+ it "returns an empty array if the incoming array is not an Array" do
+ expect(described_class.send(:sort, array: nil)).to eql([])
+ end
+ it "places the record with the lowest score + weight first" do
+ rslts = described_class.send(:sort, array: @sortable)
+ expect(rslts.first[:score]).to eql(1)
+ expect(rslts.first[:weight]).to eql(0)
+ end
+ it "places the record with the highest score+ weight last" do
+ rslts = described_class.send(:sort, array: @sortable)
+ expect(rslts.last[:score]).to eql(4)
+ expect(rslts.last[:weight]).to eql(3)
+ end
+ it "sorts by name ascending when the score and weight match" do
+ @sortable[1][:score] = 0
+ @sortable[1][:weight] = 0
+ @sortable[2][:score] = 0
+ @sortable[2][:weight] = 0
+
+ rslts = described_class.send(:sort, array: @sortable)
+ expect(rslts[0][:sort_name].include?("College")).to eql(true)
+ expect(rslts[1][:sort_name].include?("University")).to eql(true)
+ end
+ end
+
+ describe "#evaluate(reord:, search_term:)" do
+ before(:each) do
+ described_class.stubs(:score).returns(0)
+ described_class.stubs(:weigh).returns(0)
+ @record = @records.first
+ end
+ it "returns the record if search term is nil" do
+ rslt = described_class.send(:evaluate, record: @record,
+ search_term: nil)
+ expect(rslt).to eql(@record)
+ end
+ it "returns a nil if record is nil" do
+ rslt = described_class.send(:evaluate, record: nil,
+ search_term: "Foo")
+ expect(rslt).to eql(nil)
+ end
+ it "adds a score to each item" do
+ rslt = described_class.send(:evaluate, record: @record,
+ search_term: "Foo")
+ expect(rslt[:score]).to eql(0)
+ end
+ it "adds a weight to each item" do
+ rslt = described_class.send(:evaluate, record: @record,
+ search_term: "Foo")
+ expect(rslt[:weight]).to eql(0)
+ end
+ end
+
+ describe "#score(search_term:, item_name:)" do
+ it "returns a high value '99' if term is nil" do
+ rslt = described_class.send(:score, search_term: nil,
+ item_name: "Foo")
+ expect(rslt).to eql(99)
+ end
+ it "returns a high value '99' if item_name is nil" do
+ rslt = described_class.send(:score, search_term: "Foo",
+ item_name: nil)
+ expect(rslt).to eql(99)
+ end
+ it "calls the base class' natuaral language comparison method" do
+ Text::Levenshtein.stubs(:distance).returns(0)
+ rslt = described_class.send(:score, search_term: "Foo",
+ item_name: "Bar")
+ expect(rslt).to eql(0)
+ end
+ end
+
+ describe "#weigh(search_term:, item_name:)" do
+ before(:each) do
+ @term = "Foo"
+ end
+ it "expects a weight of 3 if the search_term is blank" do
+ rslt = described_class.send(:weigh, search_term: nil,
+ item_name: @term)
+ expect(rslt).to eql(3)
+ end
+ it "expects a weight of 3 if the search_term is blank" do
+ rslt = described_class.send(:weigh, search_term: @term,
+ item_name: nil)
+ expect(rslt).to eql(3)
+ end
+ it "expects a result that starts with the search term to weigh zero" do
+ item = "#{@term.downcase}#{Faker::Lorem.sentence}"
+ rslt = described_class.send(:weigh, search_term: @term,
+ item_name: item)
+ expect(rslt).to eql(0)
+ end
+ it "expects a result that contains the search term to weigh one" do
+ item = "#{Faker::Lorem.sentence}#{@term.downcase}"
+ rslt = described_class.send(:weigh, search_term: @term,
+ item_name: item)
+ expect(rslt).to eql(1)
+ end
+ it "expects a result that does not contain the search term to weigh two" do
+ item = Faker::Lorem.sentence.to_s.gsub(@term, "foo bar")
+ rslt = described_class.send(:weigh, search_term: @term,
+ item_name: item)
+ expect(rslt).to eql(2)
+ end
+ end
+
+ describe "#filter(array:)" do
+ it "returns an empty array if the array in is not an Array" do
+ expect(described_class.send(:filter, array: nil)).to eql([])
+ end
+ it "returns all records if they do not have a 'score' and 'weight'" do
+ recs = [
+ { name: Faker::Lorem.word },
+ { name: Faker::Lorem.word }
+ ]
+ rslts = described_class.send(:filter, array: recs)
+ expect(rslts.length).to eql(2)
+ end
+ it "discards any item whose score is > 25 and weight > 1" do
+ recs = [
+ { name: Faker::Lorem.word },
+ { name: Faker::Lorem.word, score: 26, weight: 2 }
+ ]
+ rslts = described_class.send(:filter, array: recs)
+ expect(rslts.length).to eql(1)
+ end
+ it "does not discard an item whose weight is > 1 but score < 25" do
+ recs = [
+ { name: Faker::Lorem.word },
+ { name: Faker::Lorem.word, score: 20, weight: 2 }
+ ]
+ rslts = described_class.send(:filter, array: recs)
+ expect(rslts.length).to eql(2)
+ end
+ it "does not discard an item whose weight is < 2 but score > 25" do
+ recs = [
+ { name: Faker::Lorem.word },
+ { name: Faker::Lorem.word, score: 26, weight: 1 }
+ ]
+ rslts = described_class.send(:filter, array: recs)
+ expect(rslts.length).to eql(2)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
index a487656802..3dd74bd384 100644
--- a/spec/spec_helper.rb
+++ b/spec/spec_helper.rb
@@ -1,9 +1,11 @@
-require 'simplecov'
-SimpleCov.start 'rails'
+# frozen_string_literal: true
-$LOAD_PATH.unshift(File.expand_path("..", __FILE__))
+require "simplecov"
+SimpleCov.start "rails"
-require 'mocha'
+$LOAD_PATH.unshift(File.expand_path(__dir__))
+
+require "mocha"
# This file was generated by the `rails generate rspec:install` command. Conventionally, all
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -94,4 +96,38 @@
# test failures related to randomization by passing the same `--seed` value
# as the one that triggered the failure.
Kernel.srand config.seed
+
+ config.before(:context) do
+ # Capture the current time so that we can compare against files afterward
+ # to clear out any downloaded/exported plans/templates
+ @start_time = Time.now
+ end
+
+ config.after(:context) do
+ # Clean up any files generated by the Export/Download UI pages
+ path = Rails.root.join("*.{csv,txt,docx,pdf}").to_s
+ Dir.glob(path).each do |file|
+ puts "Deleting test file generated by Download/Export: #{file}"
+ File.delete(file) if File.ctime(file) > @start_time
+ end
+ end
+
+ # Enable Capybara webmocks if we are testing a feature
+ config.before(:each) do |example|
+ if example.metadata[:type] == :feature
+ Capybara::Webmock.start
+
+ # Allow Capybara to make localhost requests and also contact the
+ # google api chromedriver store
+ WebMock.disable_net_connect!(
+ allow_localhost: true,
+ allow: %w[chromedriver.storage.googleapis.com]
+ )
+ end
+ end
+
+ config.after(:suite) do
+ Capybara::Webmock.stop
+ end
+
end
diff --git a/spec/support/capybara.rb b/spec/support/capybara.rb
index 5fb9609abb..ea92923b7a 100644
--- a/spec/support/capybara.rb
+++ b/spec/support/capybara.rb
@@ -4,29 +4,18 @@
require_relative "helpers/capybara_helper"
require_relative "helpers/sessions_helper"
require_relative "helpers/tiny_mce_helper"
-require_relative "helpers/combobox_helper"
-
-SCREEN_SIZE = [2400, 1350]
-DIMENSION = Selenium::WebDriver::Dimension.new(*SCREEN_SIZE)
+require_relative "helpers/autocomplete_helper"
Capybara.default_driver = :rack_test
# Cache for one hour
Webdrivers.cache_time = 3600
-
# This is a customisation of the default :selenium_chrome_headless config in:
# https://github.com/teamcapybara/capybara/blob/master/lib/capybara.rb
#
# This adds the --no-sandbox flag to fix TravisCI as described here:
# https://docs.travis-ci.com/user/chrome#sandboxing
-Capybara.register_driver :selenium_chrome_headless do |app|
- Capybara::Selenium::Driver.load_selenium
- browser_options = ::Selenium::WebDriver::Chrome::Options.new
- browser_options.args << '--headless'
- browser_options.args << '--no-sandbox'
- browser_options.args << '--disable-gpu' if Gem.win_platform?
- Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
-end
+Capybara.javascript_driver = :capybara_webmock_chrome_headless
RSpec.configure do |config|
@@ -35,8 +24,7 @@
end
config.before(:each, type: :feature, js: true) do
- Capybara.current_driver = :selenium_chrome_headless
- Capybara.page.driver.browser.manage.window.size = DIMENSION
+ Capybara.current_driver = :capybara_webmock_chrome_headless
end
end
@@ -51,5 +39,5 @@
config.include(CapybaraHelper, type: :feature)
config.include(SessionsHelper, type: :feature)
config.include(TinyMceHelper, type: :feature)
- config.include(ComboboxHelper, type: :feature)
+ config.include(AutoCompleteHelper, type: :feature)
end
diff --git a/spec/support/helpers/api.rb b/spec/support/helpers/api.rb
new file mode 100644
index 0000000000..22a97bb2ce
--- /dev/null
+++ b/spec/support/helpers/api.rb
@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ApiHelper
+
+ def mock_authorization_for_api_client
+ api_client = ApiClient.first
+ api_client = create(:api_client) unless api_client.present?
+
+ Api::V1::BaseApiController.any_instance.stubs(:authorize_request).returns(true)
+ Api::V1::BaseApiController.any_instance.stubs(:client).returns(api_client)
+ end
+
+ # rubocop:disable Metrics/AbcSize
+ def mock_authorization_for_user
+ create(:org) unless Org.any?
+ user = User.org_admins(Org.last).first
+
+ unless user.present?
+ user = create(:user, :org_admin, api_token: SecureRandom.uuid, org: Org.last)
+ end
+
+ Api::V1::BaseApiController.any_instance.stubs(:authorize_request).returns(true)
+ Api::V1::BaseApiController.any_instance.stubs(:client).returns(user)
+ end
+ # rubocop:enable Metrics/AbcSize
+
+end
diff --git a/spec/support/helpers/autocomplete_helper.rb b/spec/support/helpers/autocomplete_helper.rb
new file mode 100644
index 0000000000..c95ede4eca
--- /dev/null
+++ b/spec/support/helpers/autocomplete_helper.rb
@@ -0,0 +1,33 @@
+module AutoCompleteHelper
+
+ def select_an_org(autocomplete_id, org)
+ # Set the Org Name
+ find(autocomplete_id).set org.name
+ sleep(0.2)
+
+ # The controllers are expecting the org_id though, so lets
+ # populate it
+ hidden_id = autocomplete_id.gsub("_name", "_id").gsub("#", "")
+ hash = { id: org.id, name: org.name }.to_json
+
+ if hidden_id.present?
+ page.execute_script(
+ "document.getElementById('#{hidden_id}').value = '#{hash.to_s}'"
+ );
+ end
+ end
+
+ def choose_suggestion(suggestion_text)
+ matcher = ".ui-autocomplete .ui-menu-item"
+ matching_element = all(:css, matcher).detect do |element|
+ element.text.strip == suggestion_text.strip
+ end
+ unless matching_element.present?
+ raise ArgumentError, "No such suggestion with text '#{suggestion_text}'"
+ end
+ matching_element.click
+ # Wait for the JS to run
+ sleep(0.2)
+ end
+
+end
diff --git a/spec/support/helpers/combobox_helper.rb b/spec/support/helpers/combobox_helper.rb
deleted file mode 100644
index 4a05741ca5..0000000000
--- a/spec/support/helpers/combobox_helper.rb
+++ /dev/null
@@ -1,15 +0,0 @@
-module ComboboxHelper
-
- def choose_suggestion(suggestion_text)
- matching_element = all(:css, '.js-suggestion').detect do |element|
- element.text.strip == suggestion_text.strip
- end
- unless matching_element.present?
- raise ArgumentError, "No such suggestion with text '#{suggestion_text}'"
- end
- matching_element.click
- # Wait for the JS to run
- sleep(0.2)
- end
-
-end
\ No newline at end of file
diff --git a/spec/support/helpers/dmptool_helper.rb b/spec/support/helpers/dmptool_helper.rb
index 1209f53446..16c941900d 100644
--- a/spec/support/helpers/dmptool_helper.rb
+++ b/spec/support/helpers/dmptool_helper.rb
@@ -1,6 +1,4 @@
-# -------------------------------------------------------------
-# start DMPTool customization
-# -------------------------------------------------------------
+# frozen_string_literal: true
module DmptoolHelper
@@ -15,7 +13,7 @@ def access_sign_in_modal
def access_create_account_modal
access_sign_in_options_modal
- click_on "Create account with email address"
+ click_on "Create an account"
end
def access_shib_ds_modal
@@ -24,24 +22,24 @@ def access_shib_ds_modal
end
def generate_shibbolized_orgs(count)
- (1..count).each do |idx|
- create(:org, :organisation, :shibbolized, is_other: false)
+ (1..count).each do
+ create(:org, :organisation, :shibbolized, managed: true)
end
end
+ # rubocop:disable Metrics/MethodLength
def mock_omniauth_call(scheme, user)
-
case scheme
when "shibboleth"
# Mock the OmniAuth payload for Shibboleth
{
provider: scheme,
- uid: "123ABC",
+ uid: SecureRandom.uuid,
info: {
email: user.email,
givenname: user.firstname,
sn: user.surname,
- identity_provider: user.org.org_identifiers.first.identifier
+ identity_provider: user.org.identifiers.first.value
}
}
@@ -49,18 +47,37 @@ def mock_omniauth_call(scheme, user)
# Moch the Omniauth payload for Orcid
{
provider: scheme,
- uid: "ORCID123"
+ uid: 4.times.map { Faker::Number.number(l_digits: 4).to_s }.join("-")
}
else
{
provider: scheme,
- uid: "testing"
+ uid: Faker::Lorem.word
}
end
end
+ # rubocop:enable Metrics/MethodLength
-end
+ # rubocop:disable Metrics/MethodLength
+ def mock_blog
+ xml = <<-XML
+
+
+
+ #{Faker::Lorem.sentence}
+
+ #{Faker::Lorem.sentence}
+
+
+ #{Faker::Lorem.sentence}
+
+
+
+ XML
+ stub_request(:get, "https://blog.dmptool.org/feed").to_return(
+ status: 200, body: xml.to_s, headers: {}
+ )
+ end
+ # rubocop:enable Metrics/MethodLength
-# -------------------------------------------------------------
-# end DMPTool customization
-# -------------------------------------------------------------
+end
diff --git a/spec/support/helpers/roles_helper.rb b/spec/support/helpers/roles_helper.rb
index 1705cc647e..44687734b3 100644
--- a/spec/support/helpers/roles_helper.rb
+++ b/spec/support/helpers/roles_helper.rb
@@ -2,8 +2,8 @@ module RolesHelper
def build_plan(administrator = false, editor = false, commenter = false)
org = create(:org)
+ plan = create(:plan, answers: 2, guidance_groups: 2, org: org)
creator = create(:user, org: org)
- plan = create(:plan, answers: 2, guidance_groups: 2)
create(:role, :creator, :active, plan: plan, user: creator)
if administrator
diff --git a/spec/support/helpers/webmocks.rb b/spec/support/helpers/webmocks.rb
new file mode 100644
index 0000000000..734598f28b
--- /dev/null
+++ b/spec/support/helpers/webmocks.rb
@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Webmocks
+
+ def stub_ror_service
+ url = ExternalApis::RorService.api_base_url
+ headers = ExternalApis::RorService.headers
+
+ # Mock the results of the ping/heartbeat check
+ stub_request(:get, "#{url}#{ExternalApis::RorService.heartbeat_path}")
+ .with(headers: headers).to_return(status: 200, body: "OK", headers: {})
+
+ # Mock the results of a search. We are only returning the elements of the
+ # ROR response that we actually care about here
+ stub_request(:get, /#{url}#{ExternalApis::RorService.search_path}\.*/)
+ .with(headers: headers)
+ .to_return(status: 200, body: mocked_ror_response, headers: {})
+ end
+
+ def stub_openaire
+ url = ExternalApis::OpenAireService.api_base_url
+ url = "#{url}#{ExternalApis::OpenAireService.search_path}"
+ url = url % ExternalApis::OpenAireService.default_funder
+ stub_request(:get, url).to_return(status: 200, body: "", headers: {})
+ end
+
+ # rubocop:disable Metrics/MethodLength
+ def mocked_ror_response
+ body = { number_of_results: 10, time_taken: 10, items: [] }
+ 10.times.each do
+ body[:items] << {
+ id: Faker::Internet.url(host: "ror.org"),
+ name: Faker::Company.unique.name,
+ links: [[Faker::Internet.url, nil].sample],
+ country: { country_name: Faker::Books::Dune.planet },
+ external_ids: {
+ FundRef: { preferred: nil, all: [Faker::Number.number(digits: 6)] }
+ }
+ }
+ end
+ body.to_json
+ end
+ # rubocop:enable Metrics/MethodLength
+
+end
diff --git a/spec/support/mocks/api_json_samples.rb b/spec/support/mocks/api_json_samples.rb
new file mode 100644
index 0000000000..ff57408c32
--- /dev/null
+++ b/spec/support/mocks/api_json_samples.rb
@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+# Mock JSON submissions
+module Mocks
+
+ module ApiJsonSamples
+
+ ROLES = %w[Investigation Project_administration Data_curation].freeze
+
+
+ def mock_identifier_schemes
+ create(:identifier_scheme, name: "ror")
+ create(:identifier_scheme, name: "fundref")
+ create(:identifier_scheme, name: "orcid")
+ create(:identifier_scheme, name: "grant")
+ end
+
+ def minimal_update_json
+ {
+ "total_items": 1,
+ "items": [
+ {
+ "dmp": {
+ "title": Faker::Lorem.sentence,
+ "contact": {
+ "name": Faker::TvShows::Simpsons.character,
+ "mbox": Faker::Internet.email
+ },
+ "dataset": [{
+ "title": Faker::Lorem.sentence
+ }],
+ "dmp_id": {
+ "type": "doi",
+ "identifier": SecureRandom.uuid
+ }
+ }
+ }
+ ]
+ }.to_json
+ end
+
+ def minimal_create_json
+ {
+ "total_items": 1,
+ "items": [
+ {
+ "dmp": {
+ "title": Faker::Lorem.sentence,
+ "contact": {
+ "name": Faker::TvShows::Simpsons.character,
+ "mbox": Faker::Internet.email
+ },
+ "dataset": [{
+ "title": Faker::Lorem.sentence
+ }],
+ "extension": [
+ "#{ApplicationService.application_name.split("-").first}": {
+ "template": {
+ "id": Template.last.id,
+ "title": Faker::Lorem.sentence
+ }
+ }
+ ]
+ }
+ }
+ ]
+ }.to_json
+ end
+
+ def complete_create_json
+ lang = Language.all.pluck(:abbreviation).sample || "en-UK"
+ contact = {
+ name: Faker::TvShows::Simpsons.character,
+ email: Faker::Internet.email,
+ id: SecureRandom.uuid
+ }
+ {
+ "total_items": 1,
+ "items": [
+ {
+ "dmp": {
+ "created": (Time.now - 3.months).to_formatted_s(:iso8601),
+ "title": Faker::Lorem.sentence,
+ "description": Faker::Lorem.paragraph,
+ "language": Api::V1::LanguagePresenter.three_char_code(lang: lang),
+ "ethical_issues_exist": %w[yes no unknown].sample,
+ "ethical_issues_description": Faker::Lorem.paragraph,
+ "ethical_issues_report": Faker::Internet.url,
+ "contact": {
+ "name": contact[:name],
+ "mbox": contact[:email],
+ "affiliation": {
+ "name": Faker::TvShows::Simpsons.location,
+ "abbreviation": Faker::Lorem.word.upcase,
+ "region": Faker::Space.planet,
+ "affiliation_id": {
+ "type": "ror",
+ "identifier": SecureRandom.uuid
+ }
+ },
+ "contact_id": {
+ "type": "orcid",
+ "identifier": contact[:id]
+ }
+ },
+ "contributor": [{
+ "role": [
+ "https://dictionary.casrai.org/Contributor_Roles/Project_administration",
+ "https://dictionary.casrai.org/Contributor_Roles/Investigation"
+ ],
+ "name": Faker::Movies::StarWars.character,
+ "mbox": Faker::Internet.email,
+ "affiliation": {
+ "name": Faker::Movies::StarWars.planet,
+ "abbreviation": Faker::Lorem.word.upcase,
+ "affiliation_id": {
+ "type": "ror",
+ "identifier": SecureRandom.uuid
+ }
+ },
+ "contributor_id": {
+ "type": "orcid",
+ "identifier": SecureRandom.uuid
+ }
+ }, {
+ "role": [
+ "https://dictionary.casrai.org/Contributor_Roles/Investigation"
+ ],
+ "name": contact[:name],
+ "mbox": contact[:email],
+ "affiliation": {
+ "name": Faker::Movies::StarWars.planet,
+ "abbreviation": Faker::Lorem.word.upcase,
+ "affiliation_id": {
+ "type": "ror",
+ "identifier": SecureRandom.uuid
+ }
+ },
+ "contributor_id": {
+ "type": "orcid",
+ "identifier": contact[:id]
+ }
+ }],
+ "project": [{
+ "title": Faker::Lorem.sentence,
+ "description": Faker::Lorem.paragraph,
+ "start": (Time.now + 3.months).to_formatted_s(:iso8601),
+ "end": (Time.now + 2.years).to_formatted_s(:iso8601),
+ "funding": [{
+ "name": Faker::Movies::StarWars.droid,
+ "funder_id": {
+ "type": "fundref",
+ "identifier": Faker::Number.number
+ },
+ "grant_id": {
+ "type": "other",
+ "identifier": SecureRandom.uuid
+ },
+ "funding_status": %w[planned applied granted].sample
+ }]
+ }],
+ "dataset": [{
+ "title": Faker::Lorem.sentence,
+ "personal_data": %w[yes no unknown].sample,
+ "sensitive_data": %w[yes no unknown].sample,
+ "dataset_id": {
+ "type": "url",
+ "identifier": Faker::Internet.url
+ }
+ }],
+ "extension": [{
+ "#{ApplicationService.application_name.split("-").first}": {
+ "template": {
+ "id": Template.last.id,
+ "title": Faker::Lorem.sentence
+ }
+ }
+ }]
+ }
+ }
+ ]
+ }.to_json
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/_standard_response.json_jbuilder_spec.rb b/spec/views/api/v1/_standard_response.json_jbuilder_spec.rb
new file mode 100644
index 0000000000..37b0678f59
--- /dev/null
+++ b/spec/views/api/v1/_standard_response.json_jbuilder_spec.rb
@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/_standard_response.json.jbuilder" do
+
+ before(:each) do
+ @application = Faker::Lorem.word
+ @caller = Faker::Lorem.word
+ @url = Faker::Internet.url
+ @code = [200, 400, 404, 500].sample
+
+ assign :application, @application
+ assign :caller, @caller
+
+ @response = OpenStruct.new(status: @code)
+ @request = Net::HTTPGenericRequest.new("GET", nil, nil, @url)
+ end
+
+ describe "standard response items - Also the same as: GET /heartbeat" do
+
+ before(:each) do
+ render partial: "api/v1/standard_response",
+ locals: { response: @response, request: @request }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "includes the :application" do
+ expect(@json[:application]).to eql(@application)
+ end
+ it "includes the :code" do
+ expect(@json[:code]).to eql(@code)
+ end
+ it "includes the :message" do
+ expect(@json[:message]).to eql(Rack::Utils::HTTP_STATUS_CODES[@code])
+ end
+ it "includes the :time" do
+ expect(@json[:time].present?).to eql(true)
+ end
+ it ":time is in UTC format" do
+ expect(Date.parse(@json[:time]).is_a?(Date)).to eql(true)
+ end
+ it "includes the :caller" do
+ expect(@json[:caller]).to eql(@caller)
+ end
+ it "includes the :source" do
+ expect(@json[:source].include?(@url)).to eql(true)
+ end
+ it "includes the :total_items" do
+ expect(@json[:total_items]).to eql(0)
+ end
+
+ end
+
+ context "responses with pagination" do
+
+ describe "On the 1st page and there is only one page" do
+ before(:each) do
+ assign :page, 1
+ assign :per_page, 3
+
+ render partial: "api/v1/standard_response",
+ locals: { response: @response, request: @request,
+ total_items: 3 }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "shows the correct page number" do
+ expect(@json[:page]).to eql(1)
+ end
+ it "includes the per_page number" do
+ expect(@json[:per_page]).to eql(3)
+ end
+ it "includes the :total_items" do
+ expect(@json[:total_items]).to eql(3)
+ end
+ it "does not show a 'prev' page link" do
+ expect(@json[:prev].present?).to eql(false)
+ end
+ it "does not show a 'next' page link" do
+ expect(@json[:prev].present?).to eql(false)
+ end
+ end
+
+ describe "On the 1st page and there multiple pages" do
+ before(:each) do
+ assign :page, 1
+ assign :per_page, 3
+
+ render partial: "api/v1/standard_response",
+ locals: { response: @response, request: @request,
+ total_items: 4 }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "shows the correct page number" do
+ expect(@json[:page]).to eql(1)
+ end
+ it "includes the per_page number" do
+ expect(@json[:per_page]).to eql(3)
+ end
+ it "includes the :total_items" do
+ expect(@json[:total_items]).to eql(4)
+ end
+ it "does not show a 'prev' page link" do
+ expect(@json[:prev].present?).to eql(false)
+ end
+ it "does not show a 'next' page link" do
+ expect(@json[:next].present?).to eql(true)
+ end
+ end
+
+ describe "On the 2nd page and there more than 2 pages" do
+ before(:each) do
+ assign :page, 2
+ assign :per_page, 3
+
+ render partial: "api/v1/standard_response",
+ locals: { response: @response, request: @request,
+ total_items: 7 }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "shows the correct page number" do
+ expect(@json[:page]).to eql(2)
+ end
+ it "includes the per_page number" do
+ expect(@json[:per_page]).to eql(3)
+ end
+ it "includes the :total_items" do
+ expect(@json[:total_items]).to eql(7)
+ end
+ it "does not show a 'prev' page link" do
+ expect(@json[:prev].present?).to eql(true)
+ end
+ it "does not show a 'next' page link" do
+ expect(@json[:next].present?).to eql(true)
+ end
+ end
+
+ describe "On the last page" do
+ before(:each) do
+ assign :page, 2
+ assign :per_page, 3
+
+ render partial: "api/v1/standard_response",
+ locals: { response: @response, request: @request,
+ total_items: 5 }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "shows the correct page number" do
+ expect(@json[:page]).to eql(2)
+ end
+ it "includes the per_page number" do
+ expect(@json[:per_page]).to eql(3)
+ end
+ it "includes the :total_items" do
+ expect(@json[:total_items]).to eql(5)
+ end
+ it "does not show a 'prev' page link" do
+ expect(@json[:prev].present?).to eql(true)
+ end
+ it "does not show a 'next' page link" do
+ expect(@json[:next].present?).to eql(false)
+ end
+ end
+
+ end
+
+end
diff --git a/spec/views/api/v1/contributors/_show.json.jbuilder_spec.rb b/spec/views/api/v1/contributors/_show.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..5879c9ee8b
--- /dev/null
+++ b/spec/views/api/v1/contributors/_show.json.jbuilder_spec.rb
@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/contributors/_show.json.jbuilder" do
+
+ before(:each) do
+ @plan = create(:plan)
+ scheme = create(:identifier_scheme, name: "orcid")
+ @contact = create(:contributor, org: create(:org), plan: @plan, roles_count: 0,
+ data_curation: true)
+ @ident = create(:identifier, identifiable: @contact, value: Faker::Lorem.word,
+ identifier_scheme: scheme)
+ @contact.reload
+ end
+
+ describe "includes all of the Contributor attributes" do
+ before(:each) do
+ render partial: "api/v1/contributors/show", locals: { contributor: @contact }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "includes the :name" do
+ expect(@json[:name]).to eql(@contact.name)
+ end
+ it "includes the :mbox" do
+ expect(@json[:mbox]).to eql(@contact.email)
+ end
+
+ it "includes the :role" do
+ expect(@json[:role].first.ends_with?("Data_curation")).to eql(true)
+ end
+
+ it "includes :affiliation" do
+ expect(@json[:affiliation][:name]).to eql(@contact.org.name)
+ end
+
+ it "includes :contributor_id" do
+ expect(@json[:contributor_id][:type]).to eql(@ident.identifier_format)
+ expect(@json[:contributor_id][:identifier]).to eql(@ident.value)
+ end
+ it "ignores non-orcid identifiers :contributor_id" do
+ scheme = create(:identifier_scheme, name: "shibboleth")
+ create(:identifier, value: Faker::Lorem.word, identifiable: @contact,
+ identifier_scheme: scheme)
+ @contact.reload
+ expect(@json[:contributor_id][:type]).to eql(@ident.identifier_format)
+ expect(@json[:contributor_id][:identifier]).to eql(@ident.value)
+ end
+ end
+
+ describe "includes all of the Contact attributes" do
+ before(:each) do
+ render partial: "api/v1/contributors/show", locals: { contributor: @contact,
+ is_contact: true }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "includes the :name" do
+ expect(@json[:name]).to eql(@contact.name)
+ end
+ it "includes the :mbox" do
+ expect(@json[:mbox]).to eql(@contact.email)
+ end
+
+ it "does NOT include the :role" do
+ expect(@json[:role]).to eql(nil)
+ end
+
+ it "includes :affiliation" do
+ expect(@json[:affiliation][:name]).to eql(@contact.org.name)
+ end
+
+ it "includes :contact_id" do
+ expect(@json[:contact_id][:type]).to eql(@ident.identifier_format)
+ expect(@json[:contact_id][:identifier]).to eql(@ident.value)
+ end
+ it "ignores non-orcid identifiers :contact_id" do
+ scheme = create(:identifier_scheme, name: "shibboleth")
+ create(:identifier, value: Faker::Lorem.word, identifiable: @contact,
+ identifier_scheme: scheme)
+ @contact.reload
+ expect(@json[:contact_id][:type]).to eql(@ident.identifier_format)
+ expect(@json[:contact_id][:identifier]).to eql(@ident.value)
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/datasets/_show.json.jbuilder_spec.rb b/spec/views/api/v1/datasets/_show.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..5f9bd63a40
--- /dev/null
+++ b/spec/views/api/v1/datasets/_show.json.jbuilder_spec.rb
@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/datasets/_show.json.jbuilder" do
+
+ before(:each) do
+ # TODO: Implement this once the Dataset models are in place
+ @plan = create(:plan)
+ render partial: "api/v1/datasets/show", locals: { plan: @plan }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "includes all of the dataset attributes" do
+ it "includes :title" do
+ expect(@json[:title]).to eql("Generic Dataset")
+ end
+ it "includes :personal_data" do
+ expect(@json[:personal_data]).to eql("unknown")
+ end
+ it "includes :sensitive_data" do
+ expect(@json[:sensitive_data]).to eql("unknown")
+ end
+ it "includes :dataset_id" do
+ expect(@json[:dataset_id][:type]).to eql("url")
+ url = Rails.application.routes.url_helpers.api_v1_plan_url(@plan)
+ expect(@json[:dataset_id][:identifier]).to eql(url)
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/error.json.jbuilder_spec.rb b/spec/views/api/v1/error.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..de74a43ff3
--- /dev/null
+++ b/spec/views/api/v1/error.json.jbuilder_spec.rb
@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/error.json.jbuilder" do
+
+ before(:each) do
+ @url = Faker::Internet.url
+ @code = [200, 400, 404, 500].sample
+ @errors = [Faker::Lorem.sentence, Faker::Lorem.sentence]
+
+ assign :payload, { errors: @errors }
+
+ @resp = OpenStruct.new(status: @code)
+ @req = Net::HTTPGenericRequest.new("GET", nil, nil, @url)
+
+ render template: "api/v1/error", locals: { response: @resp, request: @req }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "error responses from controllers" do
+
+ it "renders the standard_response partial" do
+ expect(response).to render_template(partial: "api/v1/_standard_response")
+ end
+
+ it ":items is an empty array" do
+ expect(@json[:items]).to eql([])
+ end
+
+ it ":errors contains an array of error messages" do
+ expect(@json[:errors]).to eql(@errors)
+ end
+
+ end
+
+end
diff --git a/spec/views/api/v1/identifiers/_show.json.jbuilder_spec.rb b/spec/views/api/v1/identifiers/_show.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..d9116a3b21
--- /dev/null
+++ b/spec/views/api/v1/identifiers/_show.json.jbuilder_spec.rb
@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/identifiers/_show.json.jbuilder" do
+
+ before(:each) do
+ @scheme = create(:identifier_scheme)
+ @identifier = create(:identifier, value: Faker::Lorem.word,
+ identifier_scheme: @scheme)
+ render partial: "api/v1/identifiers/show", locals: { identifier: @identifier }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "includes all of the identifier attributes" do
+ it "includes :type" do
+ expect(@json[:type]).to eql(@identifier.identifier_format)
+ end
+ it "includes :identifier" do
+ expect(@json[:identifier]).to eql(@identifier.value)
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/orgs/_show.json.jbuilder_spec.rb b/spec/views/api/v1/orgs/_show.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..fc77811862
--- /dev/null
+++ b/spec/views/api/v1/orgs/_show.json.jbuilder_spec.rb
@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/orgs/_show.json.jbuilder" do
+
+ before(:each) do
+ scheme = create(:identifier_scheme, name: "ror")
+ @org = create(:org)
+ @ident = create(:identifier, value: Faker::Lorem.word, identifiable: @org,
+ identifier_scheme: scheme)
+ @org.reload
+ render partial: "api/v1/orgs/show", locals: { org: @org }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "includes all of the org attributes" do
+ it "includes :name" do
+ expect(@json[:name]).to eql(@org.name)
+ end
+ it "includes :abbreviation" do
+ expect(@json[:abbreviation]).to eql(@org.abbreviation)
+ end
+ it "includes :region" do
+ expect(@json[:region]).to eql(@org.region.abbreviation)
+ end
+ it "includes :affiliation_id" do
+ expect(@json[:affiliation_id][:type]).to eql(@ident.identifier_format)
+ expect(@json[:affiliation_id][:identifier]).to eql(@ident.value)
+ end
+ it "uses the ROR over the FundRef :affiliation_id" do
+ scheme = create(:identifier_scheme, name: "fundref")
+ create(:identifier, value: Faker::Lorem.word, identifiable: @org,
+ identifier_scheme: scheme)
+ @org.reload
+ expect(@json[:affiliation_id][:type]).to eql(@ident.identifier_format)
+ expect(@json[:affiliation_id][:identifier]).to eql(@ident.value)
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/plans/_cost.json.jbuilder_spec.rb b/spec/views/api/v1/plans/_cost.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..415b8b7df2
--- /dev/null
+++ b/spec/views/api/v1/plans/_cost.json.jbuilder_spec.rb
@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/plans/_cost.json.jbuilder" do
+
+ before(:each) do
+ # TODO: Implement this once the Currency question and Cost theme are in place
+ # and the PlanPresenter is extracting the info
+ @cost = {
+ title: Faker::Lorem.sentence,
+ description: Faker::Lorem.paragraph,
+ currency_code: Faker::Currency.code,
+ value: Faker::Number.decimal(l_digits: 2)
+ }.with_indifferent_access
+
+ render partial: "api/v1/plans/cost", locals: { cost: @cost }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "includes all of the cost attributes" do
+ it "includes :title" do
+ expect(@json[:title]).to eql(@cost[:title])
+ end
+ it "includes :description" do
+ expect(@json[:description]).to eql(@cost[:description])
+ end
+ it "includes :currency_code" do
+ expect(@json[:currency_code]).to eql(@cost[:currency_code])
+ end
+ it "includes :value" do
+ expect(@json[:value]).to eql(@cost[:value])
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/plans/_funding.json.jbuilder_spec.rb b/spec/views/api/v1/plans/_funding.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..3f200f6274
--- /dev/null
+++ b/spec/views/api/v1/plans/_funding.json.jbuilder_spec.rb
@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/plans/_funding.json.jbuilder" do
+
+ before(:each) do
+ @funder = create(:org, :funder)
+ create(:identifier, identifiable: @funder,
+ identifier_scheme: create(:identifier_scheme, name: "fundref"))
+ @funder.reload
+ @plan = create(:plan, funder: @funder)
+ @grant = create(:identifier, identifiable: @plan)
+ @plan.update(grant_id: @grant.id)
+ @plan.reload
+
+ render partial: "api/v1/plans/funding", locals: { plan: @plan }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "includes all of the funding attributes" do
+ it "includes :name" do
+ expect(@json[:name]).to eql(@funder.name)
+ end
+ it "includes :funding_status" do
+ expected = Api::V1::FundingPresenter.status(plan: @plan)
+ expect(@json[:funding_status]).to eql(expected)
+ end
+ it "includes :funder_ids" do
+ id = @funder.identifiers.first
+ expect(@json[:funder_id][:type]).to eql(id.identifier_format)
+ expect(@json[:funder_id][:identifier]).to eql(id.value)
+ end
+ it "includes :grant_ids" do
+ expect(@json[:grant_id][:type]).to eql(@grant.identifier_format)
+ expect(@json[:grant_id][:identifier]).to eql(@grant.value)
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/plans/_project.json.jbuilder_spec.rb b/spec/views/api/v1/plans/_project.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..6e73ff20a7
--- /dev/null
+++ b/spec/views/api/v1/plans/_project.json.jbuilder_spec.rb
@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/plans/_project.json.jbuilder" do
+
+ before(:each) do
+ @plan = build(:plan, funder: build(:org, :funder))
+ render partial: "api/v1/plans/project", locals: { plan: @plan }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "includes all of the project attributes" do
+ it "includes :title" do
+ expect(@json[:title]).to eql(@plan.title)
+ end
+ it "includes :description" do
+ expect(@json[:description]).to eql(@plan.description)
+ end
+ it "includes :start" do
+ expect(@json[:start]).to eql(@plan.start_date.to_formatted_s(:iso8601))
+ end
+ it "includes :end" do
+ expect(@json[:end]).to eql(@plan.end_date.to_formatted_s(:iso8601))
+ end
+
+ it "includes the :funder" do
+ expect(@json[:funding].length).to eql(1)
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/plans/_show.json.jbuilder_spec.rb b/spec/views/api/v1/plans/_show.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..19b75d8aef
--- /dev/null
+++ b/spec/views/api/v1/plans/_show.json.jbuilder_spec.rb
@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/plans/_show.json.jbuilder" do
+
+ before(:each) do
+ @plan = create(:plan)
+ @data_contact = create(:contributor, data_curation: true, plan: @plan)
+ @pi = create(:contributor, investigation: true, plan: @plan)
+ @plan.contributors = [@data_contact, @pi]
+ create(:identifier, identifiable: @plan)
+ @plan.reload
+ end
+
+ describe "includes all of the DMP attributes" do
+
+ before(:each) do
+ render partial: "api/v1/plans/show", locals: { plan: @plan }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "includes the :title" do
+ expect(@json[:title]).to eql(@plan.title)
+ end
+ it "includes the :description" do
+ expect(@json[:description]).to eql(@plan.description)
+ end
+ it "includes the :language" do
+ expected = Api::V1::LanguagePresenter.three_char_code(
+ lang: ApplicationService.default_language
+ )
+ expect(@json[:language]).to eql(expected)
+ end
+ it "includes the :created" do
+ expect(@json[:created]).to eql(@plan.created_at.to_formatted_s(:iso8601))
+ end
+ it "includes the :modified" do
+ expect(@json[:modified]).to eql(@plan.updated_at.to_formatted_s(:iso8601))
+ end
+
+ it "returns the URL of the plan as the :dmp_id if no DOI is defined" do
+ expected = Rails.application.routes.url_helpers.api_v1_plan_url(@plan)
+ expect(@json[:dmp_id][:type]).to eql("url")
+ expect(@json[:dmp_id][:identifier]).to eql(expected)
+ end
+
+ it "includes the :contact" do
+ expect(@json[:contact][:mbox]).to eql(@data_contact.email)
+ end
+ it "includes the :contributors" do
+ emails = @json[:contributor].collect { |c| c[:mbox] }
+ expect(emails.include?(@pi.email)).to eql(true)
+ end
+
+ # TODO: make sure this is working once the new Cost theme and Currency
+ # question type have been implemented
+ it "includes the :cost" do
+ expect(@json[:cost]).to eql(nil)
+ end
+
+ it "includes the :project" do
+ expect(@json[:project].length).to eql(1)
+ end
+ it "includes the :dataset" do
+ expect(@json[:dataset].length).to eql(1)
+ end
+ it "includes the :extension" do
+ expect(@json[:extension].length).to eql(1)
+ end
+ it "includes the :template in :extension" do
+ app = ApplicationService.application_name.split("-").first
+ @section = @json[:extension].select { |hash| hash.keys.first == app }.first
+ expect(@section[app.to_sym].present?).to eql(true)
+ tmplt = @plan.template
+ expect(@section[app.to_sym][:template][:id]).to eql(tmplt.id)
+ expect(@section[app.to_sym][:template][:title]).to eql(tmplt.title)
+ end
+
+ end
+
+ describe "when the system mints DOIs" do
+ before(:each) do
+ @doi = create(:identifier, value: "10.9999/123abc.zy/x23", identifiable: @plan)
+ @plan.reload
+ render partial: "api/v1/plans/show", locals: { plan: @plan }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "returns the DOI for the :dmp_id if one is present" do
+ expect(@json[:dmp_id][:type]).to eql("doi")
+ expect(@json[:dmp_id][:identifier]).to eql(@doi.value)
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/templates/index.json.jbuilder_spec.rb b/spec/views/api/v1/templates/index.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..1fb6f8057a
--- /dev/null
+++ b/spec/views/api/v1/templates/index.json.jbuilder_spec.rb
@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/templates/index.json.jbuilder" do
+
+ before(:each) do
+ @application = Faker::Lorem.word
+ @url = Faker::Internet.url
+ @code = [200, 400, 404, 500].sample
+
+ @template1 = create(:template, :published, org: create(:org))
+ @template2 = create(:template, :published)
+
+ assign :application, @application
+ assign :items, [@template1, @template2]
+
+ @resp = OpenStruct.new(status: @code)
+ @req = Net::HTTPGenericRequest.new("GET", nil, nil, @url)
+
+ render template: "api/v1/templates/index",
+ locals: { response: @resp, request: @req }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ it "includes both templates" do
+ expect(@json[:items].length).to eql(2)
+ end
+
+ describe "includes all of the Template attributes" do
+ before(:each) do
+ @template = @json[:items].first[:dmp_template]
+ end
+
+ it "includes the :title" do
+ expect(@template[:title]).to eql(@template1.title)
+ end
+ it "includes the :description" do
+ expect(@template[:description]).to eql(@template1.description)
+ end
+ it "includes the :version" do
+ expect(@template[:version]).to eql(@template1.version)
+ end
+ it "includes the :created" do
+ expect(@template[:created]).to eql(@template1.created_at.to_formatted_s(:iso8601))
+ end
+ it "includes the :modified" do
+ expect(@template[:modified]).to eql(@template1.updated_at.to_formatted_s(:iso8601))
+ end
+ it "includes the :affiliation" do
+ expect(@template[:affiliation][:name]).to eql(@template1.org.name)
+ end
+ it "includes the :template_ids" do
+ expect(@template[:template_id][:identifier]).to eql(@template1.id.to_s)
+ expect(@template[:template_id][:type]).to eql("other")
+ end
+ end
+
+end
diff --git a/spec/views/api/v1/token.json.jbuilder_spec.rb b/spec/views/api/v1/token.json.jbuilder_spec.rb
new file mode 100644
index 0000000000..d05c39c61d
--- /dev/null
+++ b/spec/views/api/v1/token.json.jbuilder_spec.rb
@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "api/v1/token.json.jbuilder" do
+
+ before(:each) do
+ @url = Faker::Internet.url
+ @payload = { client_id: "foo" }
+ @token = Api::V1::Auth::Jwt::JsonWebToken.encode(payload: @payload)
+ @exp = @payload[:exp]
+ @type = Faker::Lorem.word.capitalize
+
+ assign :token, @token
+ assign :expiration, @exp
+ assign :token_type, @type
+
+ @resp = OpenStruct.new(status: 200)
+ @req = Net::HTTPGenericRequest.new("GET", nil, nil, @url)
+
+ render template: "api/v1/token",
+ locals: { response: @resp, request: @req }
+ @json = JSON.parse(rendered).with_indifferent_access
+ end
+
+ describe "authentication responses from controllers" do
+ it "renders the token template" do
+ expect(response).to render_template("api/v1/token")
+ end
+ it ":access_token is the JSON Web Token" do
+ expect(@json[:access_token]).to eql(@token)
+ end
+ it ":token_type is set" do
+ expect(@json[:token_type]).to eql(@type)
+ end
+ it ":expires_in is set" do
+ expect(@json[:expires_in]).to eql(@exp)
+ end
+ it ":created_at is set" do
+ expect(@json[:created_at].present?).to eql(true)
+ end
+ end
+
+end
diff --git a/spec/views/branded/contact_us/contacts/_new_right.html.erb_spec.rb b/spec/views/branded/contact_us/contacts/_new_right.html.erb_spec.rb
new file mode 100644
index 0000000000..82d612e402
--- /dev/null
+++ b/spec/views/branded/contact_us/contacts/_new_right.html.erb_spec.rb
@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+describe "contact_us/contacts/_new_right.html.erb" do
+
+ it "renders the panel correctly" do
+ controller.prepend_view_path "app/views/branded"
+ # rubocop:disable Metrics/LineLength
+ org = {
+ name: Faker::Company.name,
+ address_line1: Faker::Address.street_address,
+ address_line2: Faker::Address.secondary_address,
+ address_line3: Faker::Address.community,
+ address_line4: "#{Faker::Address.city}, #{Faker::Address.state_abbr} #{Faker::Address.zip_code}",
+ address_country: Faker::Address.country,
+ google_maps_link: Faker::Internet.url
+ }
+ # rubocop:enable Metrics/LineLength
+ Rails.configuration.branding[:organisation] = org
+ render
+ expect(rendered.include?("#{org[:name]}")).to eql(true)
+ expect(rendered.include?("#{org[:address_line1]} ")).to eql(true)
+ expect(rendered.include?("#{org[:address_line2]} ")).to eql(true)
+ expect(rendered.include?("#{org[:address_line3]} ")).to eql(true)
+ expect(rendered.include?("#{org[:address_line4]} ")).to eql(true)
+ expect(rendered.include?("#{org[:address_country]} ")).to eql(true)
+ expect(rendered.include?("Users")).to eql(true)
+ expect(rendered.include?("