4414 - Fix typo in bulk export api

app/controllers/api/api_controller.rb

@@ -6,4 +6,4 @@ def help
       render plain: api_routes.map {|r| "#{r.verb}\t#{r.path.spec}" }.join("\n")
     end
   end
-end
+end

app/controllers/api/v1/bulk_export_controller.rb

@@ -17,60 +17,55 @@ def index
         else
           exports = @api_user.bulk_exports
         end
-        render json: exports.to_json(except: [:updated_at, :user_id, :collection_id], include: {:collection => {only: [:title, :slug]}})
+        render json: exports.to_json(except: [:updated_at, :user_id, :collection_id], include: { collection: { only: [:title, :slug] } })
       else
         render status: 401, json: 'You must use an API token to access bulk exports'
       end
     end
 
-
     def start
       if @api_user
         collection_slug = params[:collection_slug]
-        if collection_slug
-          collection = Collection.where(slug: collection_slug).first
-          if collection.nil?
-            render status: 404, json: "No collection exists with the slug #{collection_slug}"
-            return
-          end
+        collection = Collection.where(slug: collection_slug).first
+        if collection.nil?
+          render status: 404, json: "No collection exists with the slug #{collection_slug}"
+          return
+        end
 
-          if collection.show_to?(@api_user)
-            # try to parse the bulk_export
-            bulk_export = BulkExport.new
-            bulk_export.collection = collection
-            bulk_export.user = @api_user
-            bulk_export.status = BulkExport::Status::NEW
-            bulk_export.plaintext_verbatim_page = !(params[:plaintext_verbatim_page].blank?)
-            bulk_export.plaintext_verbatim_work = !(params[:plaintext_verbatim_work].blank?)
-            bulk_export.plaintext_emended_page = !(params[:plaintext_emended_page].blank?)
-            bulk_export.plaintext_emended_work = !(params[:plaintext_emended_work].blank?)
-            bulk_export.plaintext_searchable_page = !(params[:plaintext_searchable_page].blank?)
-            bulk_export.plaintext_searchable_work = !(params[:plaintext_searchable_work].blank?)
-            bulk_export.tei_work = !(params[:tei_work].blank?)
-            bulk_export.html_page = !(params[:html_page].blank?)
-            bulk_export.html_work = !(params[:html_work].blank?)
-            bulk_export.subject_csv_collection = !(params[:subject_csv_collection].blank?)
-            bulk_export.subject_details_csv_collection = !(params[:subject_details_csv_collection].blank?)
-            bulk_export.table_csv_collection = !(params[:table_csv_collection].blank?)
-            bulk_export.table_csv_work = !(params[:table_csv_work].blank?)
-            bulk_export.notes_csv = !(params[:notes_csv].blank?)
-            bulk_export.save
-            bulk_export.submit_export_process
+        if collection.show_to?(@api_user)
+          # try to parse the bulk_export
+          bulk_export = BulkExport.new
+          bulk_export.collection = collection
+          bulk_export.user = @api_user
+          bulk_export.status = BulkExport::Status::NEW
+          bulk_export.plaintext_verbatim_page = !params[:plaintext_verbatim_page].blank?
+          bulk_export.plaintext_verbatim_work = !params[:plaintext_verbatim_work].blank?
+          bulk_export.plaintext_emended_page = !params[:plaintext_emended_page].blank?
+          bulk_export.plaintext_emended_work = !params[:plaintext_emended_work].blank?
+          bulk_export.plaintext_searchable_page = !params[:plaintext_searchable_page].blank?
+          bulk_export.plaintext_searchable_work = !params[:plaintext_searchable_work].blank?
+          bulk_export.tei_work = !params[:tei_work].blank?
+          bulk_export.html_page = !params[:html_page].blank?
+          bulk_export.html_work = !params[:html_work].blank?
+          bulk_export.subject_csv_collection = !params[:subject_csv_collection].blank?
+          bulk_export.subject_details_csv_collection = !params[:subject_details_csv_collection].blank?
+          bulk_export.table_csv_collection = !params[:table_csv_collection].blank?
+          bulk_export.table_csv_work = !params[:table_csv_work].blank?
+          bulk_export.notes_csv = !params[:notes_csv].blank?
+          bulk_export.save
+          bulk_export.submit_export_process
 
-            response = {
-              :id => bulk_export.id,
-              :status => bulk_export.status,
-              :status_uri => api_v1_bulk_export_status_url(bulk_export.id),
-              :download_uri => api_v1_bulk_export_download_url(bulk_export.id)
-            }
+          response = {
+            id: bulk_export.id,
+            status: bulk_export.status,
+            status_uri: api_v1_bulk_export_status_url(bulk_export.id),
+            download_uri: api_v1_bulk_export_download_url(bulk_export.id)
+          }
 
-            render status: 202, json: response.to_json
+          render status: 202, json: response.to_json
 
-          else
-            render status: 403, json: 'User #{@api_user} is not authorized to view #{collection.title}'
-          end
         else
-          render status: 401, json: 'You must use a collection slug in the URL to create a bulk export'
+          render status: 403, json: "User #{@api_user} is not authorized to view #{collection.title}"
         end
       else
         render status: 401, json: 'You must use an API token to access bulk exports'
@@ -80,59 +75,49 @@ def start
     def status
       if @api_user
         bulk_export_id = params[:bulk_export_id]
-        if bulk_export_id
-          bulk_export = @api_user.bulk_exports.where(:id => bulk_export_id).first
-          if bulk_export
-            response = {
-              :id => bulk_export.id,
-              :status => bulk_export.status,
-              :status_uri => api_v1_bulk_export_status_url(bulk_export.id),
-              :download_uri => api_v1_bulk_export_download_url(bulk_export.id)
-            }
-            render status: 200, json: response.to_json
-          else
-            render status: 403, json: 'User #{@api_user} has no bulk export with ID #{bulk_export_id}'
-          end
+        bulk_export = @api_user.bulk_exports.find_by(id: bulk_export_id)
+
+        if bulk_export
+          response = {
+            id: bulk_export.id,
+            status: bulk_export.status,
+            status_uri: api_v1_bulk_export_status_url(bulk_export.id),
+            download_uri: api_v1_bulk_export_download_url(bulk_export.id)
+          }
+          render status: 200, json: response.to_json
         else
-          render status: 401, json: 'You must use a bulk export ID in the URL'
+          render status: 403, json: "User #{@api_user} has no bulk export with ID #{bulk_export_id}"
         end
       else
         render status: 401, json: 'You must use an API token to access bulk exports'
       end
     end
 
-
     def download
       if @api_user
         bulk_export_id = params[:bulk_export_id]
-        if bulk_export_id
-          bulk_export = @api_user.bulk_exports.where(:id => bulk_export_id).first
-          if bulk_export
-            if bulk_export.status == BulkExport::Status::FINISHED
-              send_file(bulk_export.zip_file_name, 
-                filename: "fromthepage_export.zip", 
-                :content_type => "application/zip")
-            else
-              if bulk_export.status == BulkExport::Status::CLEANED
-                render status: 410, json: "Bulk export #{bulk_export_id} has been deleted.  Please start a new export."
-              elsif bulk_export.status == BulkExport::Status::ERROR
-                render status: 410, json: "Bulk export #{bulk_export_id} failed with an error.  Please report this to support.  Re-running an export with different requested formats might succeed."
-              else
-                render status: 409, json: "Bulk export #{bulk_export_id} is not ready to download.  It is probably still running, but might have failed with an un-caught error."
-              end
-            end
+        bulk_export = @api_user.bulk_exports.find_by(id: bulk_export_id)
+        if bulk_export
+          case bulk_export.status
+          when BulkExport::Status::FINISHED
+            send_file(
+              bulk_export.zip_file_name,
+              filename: 'fromthepage_export.zip',
+              content_type: 'application/zip'
+            )
+          when BulkExport::Status::CLEANED
+            render status: 410, json: "Bulk export #{bulk_export_id} has been deleted.  Please start a new export."
+          when BulkExport::Status::ERROR
+            render status: 410, json: "Bulk export #{bulk_export_id} failed with an error.  Please report this to support.  Re-running an export with different requested formats might succeed."
           else
-            render status: 403, json: 'User #{@api_user} has no bulk export with ID #{bulk_export_id}'
+            render status: 409, json: "Bulk export #{bulk_export_id} is not ready to download.  It is probably still running, but might have failed with an un-caught error."
           end
         else
-          render status: 401, json: 'You must use a bulk export ID in the URL'
+          render status: 403, json: "User #{@api_user} has no bulk export with ID #{bulk_export_id}"
         end
       else
         render status: 401, json: 'You must use an API token to access bulk exports'
       end
     end
-
-    private
-
   end
-end
+end

config/routes.rb

@@ -362,7 +362,7 @@
     namespace :v1 do
       get 'bulk_export', to: 'bulk_export#index'
       get 'bulk_export/:collection_slug', to: 'bulk_export#index'
-      post 'bulk_export/:collection_slug', to: 'bulk_export#start'
+      post 'bulk_export/:collection_slug', to: 'bulk_export#start', as: 'bulk_export_start'
       get 'bulk_export/:bulk_export_id/status', to: 'bulk_export#status', as: 'bulk_export_status'
       get 'bulk_export/:bulk_export_id/download', to: 'bulk_export#download', as: 'bulk_export_download'
     end

spec/factories/bulk_export.rb

@@ -0,0 +1,30 @@
+FactoryBot.define do
+  factory :bulk_export do
+    collection_id { association(:collection).id }
+    user_id { association(:user).id }
+
+    trait :new do
+      status { BulkExport::Status::NEW }
+    end
+
+    trait :queued do
+      status { BulkExport::Status::QUEUED }
+    end
+
+    trait :processing do
+      status { BulkExport::Status::PROCESSING }
+    end
+
+    trait :finished do
+      status { BulkExport::Status::FINISHED }
+    end
+
+    trait :cleaned do
+      status { BulkExport::Status::CLEANED }
+    end
+
+    trait :error do
+      status { BulkExport::Status::ERROR }
+    end
+  end
+end

spec/factories/user.rb

@@ -17,5 +17,24 @@
       sequence(:display_name) { |n| "admin_#{n}_login" }
       sequence(:login) { |n| "admin_#{n}_login" }
     end
+
+    factory :unique_user do
+      sequence(:login) { "user_#{SecureRandom.hex(2)}_login" }
+      sequence(:email) { "user_#{SecureRandom.hex(2)}@sample.com" }
+      password { 'password' }
+      password_confirmation { 'password' }
+
+      trait :with_api_key do
+        api_key { User.generate_api_key }
+      end
+
+      trait :owner do
+        admin { true }
+      end
+
+      trait :admin do
+        admin { true }
+      end
+    end
   end
 end

spec/interactors/article/combine_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Article::Combine do
-  let(:user) { User.find_by(login: OWNER) }
+  let!(:user) { create(:unique_user, :owner) }
   let!(:collection) { create(:collection, owner_user_id: user.id) }
   let!(:work) { create(:work, collection: collection, owner_user_id: user.id) }
   let!(:from_related_page) { create(:page, work: work, source_text: '[[Duplicate]]', source_translation: '[[Duplicate]]') }

spec/interactors/article/destroy_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Article::Destroy do
-  let(:user) { User.find_by(login: OWNER) }
+  let!(:user) { create(:unique_user, :owner) }
   let!(:collection) { create(:collection, owner_user_id: user.id) }
   let!(:article) { create(:article, collection: collection) }
 
@@ -25,7 +25,7 @@
   end
 
   context 'when user is not owner' do
-    let(:other_user) { User.find_by(login: NEW_OWNER) }
+    let!(:other_user) { create(:unique_user) }
 
     let(:result) do
       described_class.call(

spec/interactors/article/update_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Article::Update do
-  let(:user) { User.find_by(login: OWNER) }
+  let!(:user) { create(:unique_user, :owner) }
   let!(:collection) { create(:collection, owner_user_id: user.id) }
   let!(:work) { create(:work, collection: collection, owner_user_id: user.id) }
   let!(:related_page) { create(:page, work: work, source_text: '[[Original]]', source_translation: '[[Original]]') }

spec/interactors/work/refresh_metadata_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Work::RefreshMetadata do
-  let(:owner) { User.find_by(login: OWNER) }
+  let!(:owner) { create(:unique_user, :owner) }
   let(:collection) { create(:collection, owner_user_id: owner.id) }
   let(:original_metadata) { [{ label: 'en', value: ['Original Metadata'] }].to_json }
   let(:at_id) { 'http://example.com/manifest' }

spec/requests/api/api_controller_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Api::ApiController do
+  describe '#help' do
+    let(:action_path) { api_path }
+
+    let(:subject) { get action_path }
+
+    it 'renders status and plain_text' do
+      subject
+
+      expect(response).to have_http_status(:ok)
+      expect(response.content_type).to eq('text/plain; charset=utf-8')
+    end
+  end
+end