The image-uploads from alex-meteor

A solution to uploading photos in Meteor.js

Note: I haven't finished the unit-tests for this yet 😫
but its usable in all HTML5 browsers (so 9<IE). This works great for mobile devices and desktop (Safri, Chrome and Firefox) but requires a Non-HTML5 Fallback for IE9 and below. So if you need to support older browsers, either help me with the IE work (fork+send a pull request!) or look for an alternative. Thanks. :-)

Features

Uses config.js file for S3 Credentials (so we aren't leaking info)

You will need to cp private/config-example.json private/config.json and update your S3 details

Switch from imagemagick to https://github.com/aheckmann/gm for rotation
Implement (Auto) Rotation using gm
Write tests including rotation ...

Update: I've abstracted the upload part of this to Stream the File to S3 (much faster)
that has a separate module: https://github.com/nelsonic/stream-to-s3 (fully tested / 100% coverage)
Only a couple more steps to get this all wired up! :-)

Why?

Helping people communicate in pictures makes their lives better.

What?

At present there is no "right way" of uploading images in Meteor.js

This example image uploader

Uploads images (to S3) effortlessly
Use ImageMagic to automatically re-size & optimise the image for mobile devices
Return a list of the images that were uploaded to S3 for use in other objects.
Displays the photo inline on without refreshing* the page
Shows a Progress Bar to improve User Experience
Styled upload button gives "native-like" experience

Results

Try it!

On your local machine, clone this repository

git clone [email protected]:ideaq/image-uploads.git

If you do not already have node.js or meteor installed, you will need to install:

Node.js: http://nodejs.org/download/
Meteor: https://www.meteor.com/
Meteorite: http://oortcloud.github.io/meteorite/
ImageMagick (see below)

Once all of those are installed, you will need to:

Run meteorite to download the two dependencies $ mrt
Update update the Amazon Web Services credentials in server_save_file.js
Run the app!

$ meteor

Visit: http://localhost:3000/

And start uploading!

How? (implementation details)

I've included

Using NPM Modules in Meteor

Instead of using an untested meteor (wrapper) module I'm using https://github.com/arunoda/meteor-npm which allows us to use the actual npm module inside meteor.

npm install -g meteor-npm

then create a packages.json file (note the s in packages)

{
	"imagemagick": "0.1.3",
	"knox"       : "0.8.9",
	"tmp"        : "0.0.23"
}

Install dependencies:

mrt

Uploading to S3 using AWS SDK

Before Amazon decided to support Node.js the go-to module for S3 was Knox: https://github.com/LearnBoost/knox

Meteor example: https://gist.github.com/dnprock/6689567 Learn from the tests: https://github.com/LearnBoost/knox/blob/master/test/createClient.test.js

Latest version: https://www.npmjs.org/package/knox (for your packages.json)

The (*Official*) Amazon Web Services (AWS) SDK https://github.com/aws/aws-sdk-js

Utterly Useless!! :-(
http://stackoverflow.com/questions/14502143/cant-upload-images-in-nodejs-using-asw-sdk

Latest version check: https://www.npmjs.org/package/aws-sdk

Usage Examples: http://docs.aws.amazon.com/AWSJavaScriptSDK/guide/node-examples.html

Image Re-Sizing using ImageMagic

On a Mac you will need Homebrew to install ImageMagic (the easy & fast way.)

brew install imagemagick

Now install node-imagemagick (already done above the first time you ran mrt)

Usage: https://github.com/rsms/node-imagemagick Latest version: https://www.npmjs.org/package/imagemagick

Image Rotation

We started using this code in staging today and users started uploading images imediately.

"Its faster than Instagram!" ~ A User

Was a user comment that delighted us.

However they uploaded images from their iDevices which were not in the correct orientation...

So we need to add rotation.

Assumptions

Aproximately 90% of people are right-handed.

Therefore we need to rotate images 90 degrees clockwise.

Investigation

ImageMagic has the ability to rotate images:

However the source-code for node imagemagic does not expose the distort method:

https://github.com/rsms/node-imagemagick/blob/master/imagemagick.js

There is no mention of distortion/rotation. :-(

Alternatives > GraphicsMagic

http://www.graphicsmagick.org/ (forked from ImageMagic)
GM for Node.js https://github.com/aheckmann/gm
http://code.google.com/p/jqueryrotate/
http://pixenate.com/

Understanding JPEG Exif Orientation

For convenience, here is what the letter F would look like if it were tagged correctly and displayed by a program that ignores the orientation tag (thus showing the stored image):

  1          2         3        4         5                 6           7            8

888888    888888        88    88        8888888888    88                   88   8888888888
88            88        88    88        88  88        88  88           88  88       88  88
8888        8888      8888    8888      88            8888888888   8888888888           88
88            88        88    88
88            88    888888    888888

See: Jpeg Exif Orientation http://sylvana.net/jpegcrop/exif_orientation.html for more detail

Temporary Folder / Files

Usage: https://github.com/raszi/node-tmp
Latest version: https://www.npmjs.org/package/tmp

Research (way more detail than you'll ever need)

Image-upload-as-a-Service Provider

Transloadit: https://transloadit.com/ (tried it meteor doesn't like it) Reached out to Transloadit team on twitter: https://twitter.com/nelsonic/status/440509092281319424 didn't get a reply. so moved on to next service.
Filepicker.io: http://filepicker.io
http://www.imgix.com
http://cloudinary.com
http://www.blitline.com
http://www.smartimage.com

How are others solving the problem?

http://stackoverflow.com/questions/19570496/how-to-upload-files-to-amazon-s3-with-meteor
Direct browser upload (no resizing): http://stackoverflow.com/questions/19620929/direct-browser-upload-to-s3-with-meteor-jquery-and-the-aws-sdk
http://stackoverflow.com/questions/10099202/how-would-one-handle-a-file-upload-with-meteor
https://gist.github.com/dariocravero/3922137 (out of date!)
(filepicker.io) http://stackoverflow.com/questions/13016382/integrating-filepicker-io-with-meteor
http://stackoverflow.com/questions/19570496/how-to-upload-files-to-amazon-s3-with-meteor
http://stackoverflow.com/questions/19593313/how-to-upload-images-from-filereader-to-amazon-s3-using-meteor
S3 Upload: https://gist.github.com/dnprock/6689567
Direct S3 Upload (no server-side): http://aws.amazon.com/articles/1434
AWS Node SDK: https://aws.amazon.com/sdkfornodejs/

There was a suggestion to use Meteor CollectionFS: https://github.com/CollectionFS/Meteor-CollectionFS to upload/store images. This is a terrible idea because the file gets stored in MongoDB! Not only is MongoDB storage considerably more expensive, its also slower than a CDN!! (If you know why this is a good idea, please tell me!)

Avoid Filename Collisions with Hashes

All the big players are storing files with generated names (instead of using the files' original name such as "photo1.jpg" thus avoiding name collisions) e.g:

Google is maintaining the file name and storing it in a folder:

https://lh6.googleusercontent.com/-273qnruKEa8/Us0Xnng-KeI/AAAAAAAAAXI/WVr-OfaLRUA/w886-h589/Christmas%2Bin%2BGlenluce%2B2013_001.jpg

Should we maintain the filename? I tend to re-name all the photos I want to be able find later. So does giving these hash.jpg on our system loose some valuable information...? (feedback please...!)

Helpful Links

http://stackoverflow.com/questions/18378809/find-absolute-base-path-of-the-project-directory-after-meteor-0-6-5
Uploads in express: http://howtonode.org/78e21b7d5503a5b2b372f6c2a5de077a1e809267/really-simple-file-uploads
Temporary file name: http://stackoverflow.com/questions/7055061/nodejs-temporary-file-name
Crypto SHA1 Hash: http://stackoverflow.com/questions/6984139/how-do-get-the-sha1-hash-of-a-string-in-nodejs
Build a Meteor "Smart Package": http://stackoverflow.com/questions/10114526/how-to-build-a-meteor-smart-package
Unoffical Meteor FAQ: https://github.com/oortcloud/unofficial-meteor-faq
File extension in node: http://stackoverflow.com/questions/10865347/node-js-get-file-extension
Prevent non-image files from being uploaded: http://stackoverflow.com/questions/12303660/restricting-file-types-in-jquery-file-upload-demo
Clear file input after upload: http://stackoverflow.com/questions/829571/clearing-an-html-file-upload-field-via-js
Fontawesome intro video: http://youtu.be/BdyI6T-_7ts
Meteor Fontawesome4: https://github.com/chrismbeckett/meteor-fontawesome4 (icons)

Troubleshooting

If you get an enoent error while trying to run gm see: http://stackoverflow.com/questions/16222116/error-spawn-enoent-while-using-gm-in-node

History

I've partially "solved" this problem before:

I need to re-visit these and get them working together (with tests :-)

Popular Image Web/Mobile Sites/Apps

The more successful image apps on the web/mobile:

Flickr (Yahoo): http://gizmodo.com/5910223/how-yahoo-killed-flickr-and-lost-the-internet
Picassa (Google): http://news.cnet.com/Google-picks-up-photo-management-firm/2100-1025_3-5267730.html
Imgur: http://www.businessinsider.com/imgur-and-yahoo-acquisition-talks-2013-12
Instagram (Facebook): http://techcrunch.com/2012/09/06/facebook-closes-instagram-acquisition-instagram-announces-5-billion-photos-shared/
SnapChat (Which Sucker?): http://mashable.com/2014/01/06/snapchat-facebook-acquisition-2

Try: https://github.com/aheckmann/gm (instead of node-imagemagick)

alex-meteor / image-uploads Goto Github PK

image-uploads's Introduction