Add workflow export functionality to the REST API

Author: raspberry-lef

CHANGELOG.md

@@ -6,8 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [current]
+### Added
+- Workflow export functionality via the REST API (so workflows can be imported later).
+
 ### Changed
-- Replace agent type dropdown with card based selector.
+- UI: replace agent type dropdown with card-based selector.
 
 ### Removed
 Removed third party agents:
@@ -28,7 +31,7 @@ Removed third party agents:
 - Human task agent (mechanical turk).
 
 ### Fixed
-- Support official image on rootles docker (or podman).
+- Support official image on rootless docker (or podman).
 
 
 ## [0.9.12] - 2020-11-23
@@ -42,7 +45,7 @@ Removed third party agents:
   to install on MacOS.
 - Updated `puma` - MacOS related [issue](https://github.com/puma/puma/issues/2304).
 - Renamed `headers_to_save` to `headers_to_include` in HTTP Status Agent.
-- Replace `working` with `issues` and add desctiptions.
+- Replace `working` with `issues` and add descriptions.
 - Update `bundler` to 2.1.4.
 - Numerous UI improvements.
 
@@ -56,7 +59,7 @@ Removed third party agents:
   job control functionality of bash. Fixes #9.
 
 ### Changed
-- Both docker-compose and deployment to heroku (via single button deployment)
+- Both docker-compose and deployment to Heroku (via single button deployment)
   switched to using official docker images of ActiveWorkflow by default instead
   of building images from source - mostly to save time spent building docker
   image every single time. Of course, you can still build your own images from
@@ -185,7 +188,7 @@ Removed third party agents:
 
 ## [0.9.2] - 2019-08-07
 ### Fixed
-- Docker compose doesn't restart container anymore.
+- Docker compose doesn't restart container any more.
 - Updated dependencies.
 
 

app/api/api/v1/root.rb

@@ -56,6 +56,19 @@ class Root < Grape::API
           workflow = current_user.workflows.find(params[:workflow_id])
           present workflow, with: API::V1::Entities::Workflow, with_agents: true
         end
+
+        get ':workflow_id/export' do
+          workflow = current_user.workflows.find(params[:workflow_id])
+          exporter = AgentsExporter.new(name: workflow.name,
+                                        description: workflow.description,
+                                        guid: workflow.guid,
+                                        tag_fg_color: workflow.tag_fg_color,
+                                        tag_bg_color: workflow.tag_bg_color,
+                                        icon: workflow.icon,
+                                        agents: workflow.agents)
+          header 'Content-Disposition', 'attachment; filename="' + exporter.filename + '"'
+          exporter.as_json
+        end
       end
     end
   end

app/views/devise/registrations/edit.html.erb

@@ -2,10 +2,13 @@
 
 <div class="container">
   <div class="row">
+    <p>If you want to access ActiveWorkflow via the REST API the token for your user is:
+      <pre><code class="text-info"><%= JsonWebToken.encode(user_id: current_user.id) %></code></pre>
+    </p>
+
     <div class="col-md-6">
 
         <h2>Edit <%= resource_name.to_s.humanize %></h2>
-
         <%= form_for(resource, as: resource_name, url: registration_path(resource_name), html: { method: :put, class: 'form-horizontal' }) do |f| %>
           <%= render 'devise/shared/error_messages', resource: resource %>
 

spec/requests/api/v1/root_spec.rb

@@ -123,4 +123,22 @@
                                 ))
     end
   end
+
+  context '/api/v1/workflows/:workflow_id/export' do
+    let(:workflow) { workflows(:bob_status) }
+
+    it 'returns full workflow as json' do
+      get "/api/v1/workflows/#{workflow.id}/export", headers: headers
+      result = JSON.parse(response.body)
+      expect(result['name']).to eq workflow.name
+      expect(result['agents'])
+        .to include(include('type' => 'Agents::HttpStatusAgent'))
+    end
+
+    it 'sets content-disposition header (filename)' do
+      get "/api/v1/workflows/#{workflow.id}/export", headers: headers
+      expect(response.headers['Content-Disposition'])
+        .to eq 'attachment; filename="bob-s-status-alert-workflow.json"'
+    end
+  end
 end