Add file uploads with configurable storage

.github/workflows/ci.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: "*"
+    branches: '*'
 
 jobs:
   check_format:
@@ -54,6 +54,12 @@ jobs:
       - uses: crystal-lang/install-crystal@v1
         with:
           crystal: ${{matrix.crystal_version}}
+      - name: Install ImageMagick (Ubuntu)
+        if: runner.os == 'Linux'
+        run: sudo apt-get install -y imagemagick
+      - name: Install ImageMagick (macOS)
+        if: runner.os == 'macOS'
+        run: brew install imagemagick
       - name: Install shards
         run: shards install --skip-postinstall --skip-executables
         env:

Dockerfile

@@ -2,7 +2,7 @@ FROM crystallang/crystal:latest
 WORKDIR /data
 
 RUN apt-get update && \
-  apt-get install -y curl libreadline-dev unzip && \
+  apt-get install -y curl libreadline-dev unzip file imagemagick && \
   curl -fsSL https://bun.sh/install | bash && \
   ln -s /root/.bun/bin/bun /usr/local/bin/bun && \
   # Cleanup leftovers

shard.yml

@@ -1,7 +1,7 @@
 name: lucky
 version: 1.4.0
 
-crystal: ">= 1.16.3"
+crystal: '>= 1.16.3'
 
 authors:
   - Paul Smith <paulcsmith0218@gmail.com>
@@ -56,5 +56,11 @@ development_dependencies:
   ameba:
     github: crystal-ameba/ameba
     version: ~> 1.6.4
+  awscr-s3:
+    github: taylorfinnell/awscr-s3
+    version: ~> 0.10.0
+  webmock:
+    github: manastech/webmock.cr
+    branch: master
 
 license: MIT

spec/lucky/attachment/extractor/dimensions_from_magick_spec.cr

@@ -0,0 +1,65 @@
+require "../../../spec_helper"
+
+describe Lucky::Attachment::Extractor::DimensionsFromMagick do
+  describe "#extract" do
+    subject = Lucky::Attachment::Extractor::DimensionsFromMagick.new
+    png_path = "spec/fixtures/lucky_logo_tiny.png"
+
+    context "when neither magick nor identify is installed" do
+      it "raises Lucky::Attachment::Error" do
+        original_path = ENV["PATH"]
+        ENV["PATH"] = ""
+        uploaded_file = build_uploaded_file(filename: "test.png")
+
+        begin
+          expect_raises(
+            Lucky::Attachment::Error,
+            /The `magick|identify` command-line tool is not installed/
+          ) do
+            subject.extract(
+              uploaded_file,
+              metadata: {} of String => Lucky::Attachment::MetadataValue
+            )
+          end
+        ensure
+          ENV["PATH"] = original_path
+        end
+      end
+    end
+
+    context "when magick or identify is installed" do
+      it "extracts width and height from a PNG file" do
+        uploaded_file = build_uploaded_file(
+          path: png_path,
+          filename: "lucky_logo_tiny.png"
+        )
+        metadata = {} of String => Lucky::Attachment::MetadataValue
+        result = subject.extract(uploaded_file, metadata: metadata)
+
+        result.should be_nil
+        metadata["width"].should eq(69)
+        metadata["height"].should eq(16)
+      end
+
+      it "does not modify metadata for an unrecognised file" do
+        uploaded_file = build_uploaded_file(filename: "empty.bin")
+        metadata = {} of String => Lucky::Attachment::MetadataValue
+        subject.extract(uploaded_file, metadata: metadata)
+
+        metadata.should be_empty
+      end
+    end
+  end
+end
+
+private def build_uploaded_file(
+  filename : String,
+  path : String? = nil,
+) : Lucky::UploadedFile
+  headers = HTTP::Headers.new
+  headers["Content-Disposition"] =
+    %[form-data; name="file"; filename="#{filename}"]
+  body = path ? File.open(path) : IO::Memory.new
+  part = HTTP::FormData::Part.new(headers: headers, body: body)
+  Lucky::UploadedFile.new(part)
+end

spec/lucky/attachment/extractor/filename_from_io_spec.cr

@@ -0,0 +1,58 @@
+require "../../../spec_helper"
+
+describe Lucky::Attachment::Extractor::FilenameFromIO do
+  describe "#extract" do
+    subject = Lucky::Attachment::Extractor::FilenameFromIO.new
+
+    context "when a filename is provided in options" do
+      it "returns the filename from options, ignoring the uploaded file's filename" do
+        uploaded_file = build_uploaded_file(filename: "original.jpg")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue,
+          filename: "override.txt"
+        )
+
+        result.should eq("override.txt")
+      end
+    end
+
+    context "when no filename option is given" do
+      it "returns the filename from the uploaded file" do
+        uploaded_file = build_uploaded_file(filename: "photo.jpg")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should eq("photo.jpg")
+      end
+
+      it "falls back to the basename of the tempfile path when filename is blank" do
+        uploaded_file = build_uploaded_file(filename: nil)
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should match(/^\w{24}$/)
+      end
+    end
+  end
+end
+
+private def build_uploaded_file(filename : String?) : Lucky::UploadedFile
+  headers = HTTP::Headers.new
+  headers["Content-Disposition"] = content_disposition(filename)
+  body = IO::Memory.new
+  part = HTTP::FormData::Part.new(headers: headers, body: body)
+  Lucky::UploadedFile.new(part)
+end
+
+private def content_disposition(filename)
+  if filename.presence
+    %[form-data; name="file"; filename="#{filename}"]
+  else
+    %[form-data; name="file"]
+  end
+end

spec/lucky/attachment/extractor/mime_from_extension_spec.cr

@@ -0,0 +1,70 @@
+require "../../../spec_helper"
+
+describe Lucky::Attachment::Extractor::MimeFromExtension do
+  describe "#extract" do
+    subject = Lucky::Attachment::Extractor::MimeFromExtension.new
+
+    context "with a known extension" do
+      it "returns the MIME type for a PNG file" do
+        uploaded_file = build_uploaded_file(filename: "photo.png")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should eq("image/png")
+      end
+
+      it "returns the MIME type for a PDF file" do
+        uploaded_file = build_uploaded_file(filename: "document.pdf")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should eq("application/pdf")
+      end
+
+      it "uses only the last extension for dotted filenames" do
+        uploaded_file = build_uploaded_file(filename: "my.profile.photo.jpg")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should eq("image/jpeg")
+      end
+    end
+
+    context "with an unknown or missing extension" do
+      it "returns nil for an unknown extension" do
+        uploaded_file = build_uploaded_file(filename: "file.unknownextension")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should be_nil
+      end
+
+      it "returns nil for a filename with no extension" do
+        uploaded_file = build_uploaded_file(filename: "Makefile")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should be_nil
+      end
+    end
+  end
+end
+
+private def build_uploaded_file(filename : String) : Lucky::UploadedFile
+  headers = HTTP::Headers.new
+  headers["Content-Disposition"] =
+    %[form-data; name="file"; filename="#{filename}"]
+  body = IO::Memory.new
+  part = HTTP::FormData::Part.new(headers: headers, body: body)
+  Lucky::UploadedFile.new(part)
+end

spec/lucky/attachment/extractor/mime_from_file_spec.cr

@@ -0,0 +1,94 @@
+require "../../../spec_helper"
+
+describe Lucky::Attachment::Extractor::MimeFromFile do
+  describe "#extract" do
+    subject = Lucky::Attachment::Extractor::MimeFromFile.new
+
+    context "when the file is empty" do
+      it "returns nil without invoking the file utility" do
+        uploaded_file = build_uploaded_file(content: "", size: 0_u64)
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should be_nil
+      end
+    end
+
+    context "when the file utility is not installed" do
+      it "raises Lucky::Attachment::Error" do
+        original_path = ENV["PATH"]
+        ENV["PATH"] = ""
+        uploaded_file = build_uploaded_file(content: "Hello, world!")
+
+        begin
+          expect_raises(
+            Lucky::Attachment::Error,
+            "The `file` command-line tool is not installed"
+          ) do
+            subject.extract(
+              uploaded_file,
+              metadata: {} of String => Lucky::Attachment::MetadataValue
+            )
+          end
+        ensure
+          ENV["PATH"] = original_path
+        end
+      end
+    end
+
+    context "when the file utility is installed" do
+      it "returns the MIME type for a PNG file" do
+        png_base64 = "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAA" \
+                     "DUlEQVR42mP8z8BQDwADhQGAWjR9awAAAABJRU5ErkJggg=="
+        uploaded_file = build_uploaded_file(
+          content: Base64.decode(png_base64),
+          filename: "test.png"
+        )
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should eq("image/png")
+      end
+
+      it "returns the MIME type for plain text" do
+        uploaded_file = build_uploaded_file(content: "Hello, world!")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should eq("text/plain")
+      end
+
+      it "strips surrounding whitespace from the output" do
+        uploaded_file = build_uploaded_file(content: "Hello, world!")
+        result = subject.extract(
+          uploaded_file,
+          metadata: {} of String => Lucky::Attachment::MetadataValue
+        )
+
+        result.should eq(result.try &.strip)
+      end
+    end
+  end
+end
+
+private def build_uploaded_file(
+  content : String | Bytes,
+  filename : String = "test.bin",
+  size : UInt64? = nil,
+) : Lucky::UploadedFile
+  headers = HTTP::Headers.new
+  disposition = String.build do |io|
+    io << %[form-data; name="file"; filename="#{filename}"]
+    io << "; size=#{size}" if size
+  end
+  headers["Content-Disposition"] = disposition
+  body = IO::Memory.new(content)
+  part = HTTP::FormData::Part.new(headers: headers, body: body)
+  Lucky::UploadedFile.new(part)
+end