[F] Add external identifier attribute to relevant APIs

Author: Tim Standen

api/app/controllers/api/v1/journals_controller.rb

@@ -56,6 +56,24 @@ def scope_visibility
 
         Journal.all
       end
+
+      private
+
+      def journal_params
+        params.require(:data)
+        attributes = [:title, :subtitle, :hashtag, :description, :facebook_id, :twitter_id,
+                      :instagram_id, :remove_avatar, attachment(:avatar),
+                      attachment(:hero), attachment(:logo), :remove_hero, :draft,
+                      :remove_logo, metadata(Journal), :avatar_color, :pending_slug,
+                      { tag_list: [] }, :image_credits, :social_description,
+                      attachment(:custom_icon), :hero_layout, :remove_custom_icon,
+                      :social_title, attachment(:social_image), :remove_social_image,
+                      :hero_background_color, :show_on_homepage, :home_page_priority, :external_identifier]
+
+        relationships = [:collaborators, :creators, :contributors, :subjects]
+        param_config = structure_params(attributes: attributes, relationships: relationships)
+        params.permit(param_config)
+      end
     end
   end
 end

api/app/controllers/api/v1/project_collections/relationships/collection_projects_controller.rb

@@ -56,6 +56,14 @@ def location
           def includes
             %w()
           end
+
+          def collection_project_params
+            params.require(:data)
+            attributes = [:position]
+            relationships = []
+            param_config = structure_params(attributes: attributes, relationships: relationships)
+            params.permit(param_config)
+          end
         end
       end
     end

api/app/controllers/api/v1/project_collections_controller.rb

@@ -66,6 +66,21 @@ def scope_for_project_collections
           [:subjects, :collection_projects]
         )
       end
+
+      private
+
+      def project_collection_params
+        params.require(:data)
+        attributes = [:title, :sort_order, :visible, :homepage, :smart, :position, :icon,
+                      { tag_list: [] }, :number_of_projects, :featured_only, :description, :short_description,
+                      :pending_slug, :homepage_start_date, :homepage_end_date,
+                      :homepage_count, :social_description, attachment(:custom_icon),
+                      attachment(:hero), :hero_layout, :remove_hero, :remove_custom_icon,
+                      :social_title, attachment(:social_image), :remove_social_image, :external_identifier]
+        relationships = [:projects, :subjects]
+        param_config = structure_params(attributes: attributes, relationships: relationships)
+        params.permit(param_config)
+      end
     end
   end
 end

api/app/controllers/api/v1/projects_controller.rb

@@ -68,6 +68,27 @@ def scope_visibility
 
         Project.existing.all
       end
+
+      private
+
+      def project_params
+        params.require(:data)
+        attributes = [:title, :subtitle, :featured, :hashtag, :description, :purchase_url,
+                      :purchase_price_currency, :facebook_id, :purchase_call_to_action, :twitter_id,
+                      :hide_activity, :instagram_id, :remove_avatar, attachment(:avatar),
+                      attachment(:hero), :download_url, attachment(:cover), :remove_hero, :draft,
+                      :remove_cover, :download_call_to_action, :publication_date, metadata(Project),
+                      :avatar_color, { tag_list: [] }, :dark_mode, :image_credits,
+                      :standalone_mode, :standalone_mode_press_bar_text, :restricted_access,
+                      :standalone_mode_press_bar_url, :finished, :restricted_access_heading,
+                      :restricted_access_body, :open_access, :disable_engagement,
+                      :journal_issue_pending_sort_title, :journal_issue_number, :pending_slug,
+                      :social_title, attachment(:social_image), :remove_social_image,
+                      :social_description, :external_identifier]
+        relationships = [:collaborators, :creators, :contributors, :subjects, :journal_volume]
+        param_config = structure_params(attributes: attributes, relationships: relationships)
+        params.permit(param_config)
+      end
     end
   end
 end

api/app/controllers/concerns/validation.rb

@@ -69,41 +69,6 @@ def reading_group_params
     params.permit(param_config)
   end
 
-  def project_params
-    params.require(:data)
-    attributes = [:title, :subtitle, :featured, :hashtag, :description, :purchase_url,
-                  :purchase_price_currency, :facebook_id, :purchase_call_to_action, :twitter_id,
-                  :hide_activity, :instagram_id, :remove_avatar, attachment(:avatar),
-                  attachment(:hero), :download_url, attachment(:cover), :remove_hero, :draft,
-                  :remove_cover, :download_call_to_action, :publication_date, metadata(Project),
-                  :avatar_color, { tag_list: [] }, :dark_mode, :image_credits,
-                  :standalone_mode, :standalone_mode_press_bar_text, :restricted_access,
-                  :standalone_mode_press_bar_url, :finished, :restricted_access_heading,
-                  :restricted_access_body, :open_access, :disable_engagement,
-                  :journal_issue_pending_sort_title, :journal_issue_number, :pending_slug,
-                  :social_title, attachment(:social_image), :remove_social_image,
-                  :social_description]
-    relationships = [:collaborators, :creators, :contributors, :subjects, :journal_volume]
-    param_config = structure_params(attributes: attributes, relationships: relationships)
-    params.permit(param_config)
-  end
-
-  def journal_params
-    params.require(:data)
-    attributes = [:title, :subtitle, :hashtag, :description, :facebook_id, :twitter_id,
-                  :instagram_id, :remove_avatar, attachment(:avatar),
-                  attachment(:hero), attachment(:logo), :remove_hero, :draft,
-                  :remove_logo, metadata(Journal), :avatar_color, :pending_slug,
-                  { tag_list: [] }, :image_credits, :social_description,
-                  attachment(:custom_icon), :hero_layout, :remove_custom_icon,
-                  :social_title, attachment(:social_image), :remove_social_image,
-                  :hero_background_color, :show_on_homepage, :home_page_priority]
-
-    relationships = [:collaborators, :creators, :contributors, :subjects]
-    param_config = structure_params(attributes: attributes, relationships: relationships)
-    params.permit(param_config)
-  end
-
   def journal_volume_params
     params.require(:data)
     attributes = [:number, :pending_slug]
@@ -166,27 +131,6 @@ def resource_collection_params
     params.permit(param_config)
   end
 
-  def project_collection_params
-    params.require(:data)
-    attributes = [:title, :sort_order, :visible, :homepage, :smart, :position, :icon,
-                  { tag_list: [] }, :number_of_projects, :featured_only, :description, :short_description,
-                  :pending_slug, :homepage_start_date, :homepage_end_date,
-                  :homepage_count, :social_description, attachment(:custom_icon),
-                  attachment(:hero), :hero_layout, :remove_hero, :remove_custom_icon,
-                  :social_title, attachment(:social_image), :remove_social_image]
-    relationships = [:projects, :subjects]
-    param_config = structure_params(attributes: attributes, relationships: relationships)
-    params.permit(param_config)
-  end
-
-  def collection_project_params
-    params.require(:data)
-    attributes = [:position]
-    relationships = []
-    param_config = structure_params(attributes: attributes, relationships: relationships)
-    params.permit(param_config)
-  end
-
   def action_callout_params
     params.require(:data)
     attributes = [:title, :kind, :location, :button, :position, :remove_attachment, :url,
@@ -521,7 +465,7 @@ def analytics_params
 
   def user_group_params
     params.require(:data)
-    attributes = [:name]
+    attributes = %i[name external_identifier]
     relationships = %i[members entitleables]
     param_config = structure_params(attributes: attributes, relationships: relationships)
     params.permit(param_config)

api/spec/requests/project_collections_spec.rb

@@ -76,6 +76,21 @@
       post path, headers: admin_headers, params: valid_params
       expect(response).to have_http_status(:created)
     end
+
+    context "when the user submits an external identifier" do
+      let(:headers) { admin_headers }
+
+      it "creates an external identifier" do
+        params = build_json_payload(
+          attributes: { title: "foo", external_identifier: "SKU123" },
+          relationships: relationships
+        )
+
+        expect do
+          post path, headers: headers, params: params
+        end.to change(ExternalIdentifier, :count).by 1
+      end
+    end
   end
 
   describe "updates a collection" do

api/spec/requests/projects_spec.rb

@@ -98,6 +98,20 @@
         expect(response).to have_http_status(:forbidden)
       end
     end
+
+    context "when the user submits an external identifier" do
+      let(:headers) { admin_headers }
+
+      it "creates an external identifier" do
+        params = build_json_payload(
+          attributes: { title: "foo", external_identifier: "SKU123" }
+        )
+
+        expect do
+          post path, headers: headers, params: params
+        end.to change(ExternalIdentifier, :count).by 1
+      end
+    end
   end
 
   describe "updates a project" do