-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* CSV async export using ActionCable and redis background processing
- Loading branch information
1 parent
d67a440
commit 338b902
Showing
29 changed files
with
722 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,9 @@ | ||
// Action Cable provides the framework to deal with WebSockets in Rails. | ||
// You can generate new channels where WebSocket features live using the `rails generate channel` command. | ||
// | ||
// app/assets/javascripts/cable.js | ||
//= require action_cable | ||
//= require_self | ||
//= require_tree ./channels | ||
|
||
(function() { | ||
this.App || (this.App = {}); | ||
|
||
App.cable = ActionCable.createConsumer(); | ||
|
||
}).call(this); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
function subscribeExportChannel(uuid, callback) { | ||
App.download = App.cable.subscriptions.create( | ||
{ channel: "ExportChannel", uuid: uuid }, | ||
{ | ||
connected: function() { | ||
callback(); | ||
}, | ||
|
||
disconnected: function() {}, | ||
|
||
received: function(data) { | ||
|
||
var blob = new Blob([data.csv], { | ||
type: "text/csv;charset=utf-8" | ||
}); | ||
|
||
saveAs(blob, data.filename); | ||
|
||
$(".export-btn") | ||
.html("Export Submissions to CSV").removeClass('cursor-not-allowed'); | ||
|
||
App.download.unsubscribe(); | ||
App.cable.disconnect(); | ||
delete App.download; | ||
} | ||
} | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# Changelog | ||
All notable changes to this project will be documented in this file. | ||
|
||
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). | ||
|
||
## [2.0.2] - 2019-05-14 | ||
|
||
- Catching an exception on Send (HEAD) ([#534]) | ||
|
||
## [2.0.0] - 2018-10-17 | ||
|
||
- Removed eval to resolve CSP ([#465]) | ||
|
||
## [2.0.0-rc.4] - 2018-10-17 | ||
|
||
- Don’t throw on module.exports | ||
|
||
## [2.0.0-rc.3] - 2018-09-27 | ||
|
||
- Switch export method | ||
|
||
## [2.0.0-rc.2] - 2018-09-26 | ||
|
||
- Added a changelog.md | ||
- Reverted `a.click()` to use dispatch with a try-catch ([#465], [#382]) | ||
- Made third argument to an object where you have to pass `{ autoBom: true }` | ||
- boolean are depricated but still works | ||
|
||
## [2.0.0-rc.1] - 2018-09-26 | ||
|
||
- saveAs don't return anything | ||
- The object that dispatched `writestart progress write writeend` are gone | ||
- detecting such features was never possible and nobody seems to use it. | ||
- Removed the demo folder | ||
- Removed date/version from top of the file | ||
- Dosen't crash in web workers ([#449]) | ||
- Support saving urls ([#260] with workarounds for cross origin) | ||
- Uses babel universal module pattern (UMD) to export the package | ||
- Provides source map now as well. | ||
- use a[download] before msSaveAs ([#193], [#294]) | ||
- removed dist from .gitignore (npm uses it if it don't find a .npmignore) | ||
- autoBom is now reversed so you have to tell when you want to use autoBom ([#432]) | ||
- `a.click()` since there are new and depricated event constructors that works differently ([#382]) | ||
- opens up a new popup (tab) directly for the fallback method since the FileReader is async | ||
- removed the explicitly MSIE [1-9] check | ||
- Uses new anchor link for each save (might solve multiple download problems) | ||
|
||
[#382]: https://github.com/eligrey/FileSaver.js/issues/382 | ||
[#449]: https://github.com/eligrey/FileSaver.js/issues/449 | ||
[#260]: https://github.com/eligrey/FileSaver.js/issues/260 | ||
[#193]: https://github.com/eligrey/FileSaver.js/issues/193 | ||
[#294]: https://github.com/eligrey/FileSaver.js/issues/294 | ||
[#432]: https://github.com/eligrey/FileSaver.js/issues/432 | ||
[#382]: https://github.com/eligrey/FileSaver.js/issues/382 | ||
[#465]: https://github.com/eligrey/FileSaver.js/issues/465 | ||
[#469]: https://github.com/eligrey/FileSaver.js/issues/469 | ||
[#470]: https://github.com/eligrey/FileSaver.js/issues/470 | ||
[#491]: https://github.com/eligrey/FileSaver.js/issues/491 | ||
[#534]: https://github.com/eligrey/FileSaver.js/issues/534 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
The MIT License | ||
|
||
Copyright © 2016 [Eli Grey][1]. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
|
||
[1]: http://eligrey.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,150 @@ | ||
If you need to save really large files bigger then the blob's size limitation or don't have | ||
enough RAM, then have a look at the more advanced [StreamSaver.js][7] | ||
that can save data directly to the hard drive asynchronously with the power of the new streams API. That will have | ||
support for progress, cancelation and knowing when it's done writing | ||
|
||
FileSaver.js | ||
============ | ||
|
||
FileSaver.js is the solution to saving files on the client-side, and is perfect for | ||
web apps that generates files on the client, However if the file is coming from the | ||
server we recommend you to first try to use [Content-Disposition][8] attachment response header as it has more cross-browser compatiblity. | ||
|
||
Looking for `canvas.toBlob()` for saving canvases? Check out | ||
[canvas-toBlob.js][2] for a cross-browser implementation. | ||
|
||
Supported Browsers | ||
------------------ | ||
|
||
| Browser | Constructs as | Filenames | Max Blob Size | Dependencies | | ||
| -------------- | ------------- | ------------ | ------------- | ------------ | | ||
| Firefox 20+ | Blob | Yes | 800 MiB | None | | ||
| Firefox < 20 | data: URI | No | n/a | [Blob.js](https://github.com/eligrey/Blob.js) | | ||
| Chrome | Blob | Yes | [2GB][3] | None | | ||
| Chrome for Android | Blob | Yes | [RAM/5][3] | None | | ||
| Edge | Blob | Yes | ? | None | | ||
| IE 10+ | Blob | Yes | 600 MiB | None | | ||
| Opera 15+ | Blob | Yes | 500 MiB | None | | ||
| Opera < 15 | data: URI | No | n/a | [Blob.js](https://github.com/eligrey/Blob.js) | | ||
| Safari 6.1+* | Blob | No | ? | None | | ||
| Safari < 6 | data: URI | No | n/a | [Blob.js](https://github.com/eligrey/Blob.js) | | ||
| Safari 10.1+ | Blob | Yes | n/a | None | | ||
|
||
Feature detection is possible: | ||
|
||
```js | ||
try { | ||
var isFileSaverSupported = !!new Blob; | ||
} catch (e) {} | ||
``` | ||
|
||
### IE < 10 | ||
|
||
It is possible to save text files in IE < 10 without Flash-based polyfills. | ||
See [ChenWenBrian and koffsyrup's `saveTextAs()`](https://github.com/koffsyrup/FileSaver.js#examples) for more details. | ||
|
||
### Safari 6.1+ | ||
|
||
Blobs may be opened instead of saved sometimes—you may have to direct your Safari users to manually | ||
press <kbd>⌘</kbd>+<kbd>S</kbd> to save the file after it is opened. Using the `application/octet-stream` MIME type to force downloads [can cause issues in Safari](https://github.com/eligrey/FileSaver.js/issues/12#issuecomment-47247096). | ||
|
||
### iOS | ||
|
||
saveAs must be run within a user interaction event such as onTouchDown or onClick; setTimeout will prevent saveAs from triggering. Due to restrictions in iOS saveAs opens in a new window instead of downloading, if you want this fixed please [tell Apple how this WebKit bug is affecting you](https://bugs.webkit.org/show_bug.cgi?id=167341). | ||
|
||
Syntax | ||
------ | ||
### Import `saveAs()` from file-saver | ||
```js | ||
import { saveAs } from 'file-saver'; | ||
``` | ||
|
||
```js | ||
FileSaver saveAs(Blob/File/Url, optional DOMString filename, optional Object { autoBom }) | ||
``` | ||
|
||
Pass `{ autoBom: true }` if you want FileSaver.js to automatically provide Unicode text encoding hints (see: [byte order mark](https://en.wikipedia.org/wiki/Byte_order_mark)). Note that this is only done if your blob type has `charset=utf-8` set. | ||
|
||
Examples | ||
-------- | ||
|
||
### Saving text using `require()` | ||
```js | ||
var FileSaver = require('file-saver'); | ||
var blob = new Blob(["Hello, world!"], {type: "text/plain;charset=utf-8"}); | ||
FileSaver.saveAs(blob, "hello world.txt"); | ||
``` | ||
|
||
### Saving text | ||
|
||
```js | ||
var blob = new Blob(["Hello, world!"], {type: "text/plain;charset=utf-8"}); | ||
FileSaver.saveAs(blob, "hello world.txt"); | ||
``` | ||
|
||
### Saving URLs | ||
|
||
```js | ||
FileSaver.saveAs("https://httpbin.org/image", "image.jpg"); | ||
``` | ||
Using URLs within the same origin will just use `a[download]`. | ||
Otherwise, it will first check if it supports cors header with a synchronous head request. | ||
If it does, it will download the data and save using blob URLs. | ||
If not, it will try to download it using `a[download]`. | ||
|
||
The standard W3C File API [`Blob`][4] interface is not available in all browsers. | ||
[Blob.js][5] is a cross-browser `Blob` implementation that solves this. | ||
|
||
### Saving a canvas | ||
```js | ||
var canvas = document.getElementById("my-canvas"); | ||
canvas.toBlob(function(blob) { | ||
saveAs(blob, "pretty image.png"); | ||
}); | ||
``` | ||
|
||
Note: The standard HTML5 `canvas.toBlob()` method is not available in all browsers. | ||
[canvas-toBlob.js][6] is a cross-browser `canvas.toBlob()` that polyfills this. | ||
|
||
### Saving File | ||
|
||
You can save a File constructor without specifying a filename. If the | ||
file itself already contains a name, there is a hand full of ways to get a file | ||
instance (from storage, file input, new constructor, clipboard event). | ||
If you still want to change the name, then you can change it in the 2nd argument. | ||
|
||
```js | ||
// Note: Ie and Edge don't support the new File constructor, | ||
// so it's better to construct blobs and use saveAs(blob, filename) | ||
var file = new File(["Hello, world!"], "hello world.txt", {type: "text/plain;charset=utf-8"}); | ||
FileSaver.saveAs(file); | ||
``` | ||
|
||
|
||
|
||
 | ||
|
||
[1]: http://eligrey.com/demos/FileSaver.js/ | ||
[2]: https://github.com/eligrey/canvas-toBlob.js | ||
[3]: https://bugs.chromium.org/p/chromium/issues/detail?id=375297#c107 | ||
[4]: https://developer.mozilla.org/en-US/docs/DOM/Blob | ||
[5]: https://github.com/eligrey/Blob.js | ||
[6]: https://github.com/eligrey/canvas-toBlob.js | ||
[7]: https://github.com/jimmywarting/StreamSaver.js | ||
[8]: https://github.com/eligrey/FileSaver.js/wiki/Saving-a-remote-file#using-http-header | ||
|
||
Installation | ||
------------------ | ||
|
||
```bash | ||
# Basic Node.JS installation | ||
npm install file-saver --save | ||
bower install file-saver | ||
``` | ||
|
||
Additionally, TypeScript definitions can be installed via: | ||
|
||
```bash | ||
# Additional typescript definitions | ||
npm install @types/file-saver --save-dev | ||
``` |
Oops, something went wrong.