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,55 @@
+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 magick is not installed" do
+      it "raises Lucky::Attachment::Error" do
+        original_path = ENV["PATH"]
+        ENV["PATH"] = ""
+        io = IO::Memory.new
+
+        begin
+          expect_raises(
+            Lucky::Attachment::Error,
+            /The `magick|identify` command-line tool is not installed/
+          ) do
+            subject.extract(io, metadata: Lucky::Attachment::MetadataHash.new)
+          end
+        ensure
+          ENV["PATH"] = original_path
+        end
+      end
+    end
+
+    context "when magick is installed" do
+      it "extracts width and height from a PNG file" do
+        file = File.open(png_path)
+        metadata = Lucky::Attachment::MetadataHash.new
+        result = subject.extract(file, metadata: metadata)
+
+        result.should be_nil
+        metadata["width"].should eq(69)
+        metadata["height"].should eq(16)
+      end
+
+      it "does not modify metadata when magick returns no output" do
+        io = IO::Memory.new
+        metadata = Lucky::Attachment::MetadataHash.new
+        subject.extract(io, metadata: metadata)
+
+        metadata.should be_empty
+      end
+
+      it "rewinds the IO after reading" do
+        file = File.open(png_path)
+        metadata = Lucky::Attachment::MetadataHash.new
+        subject.extract(file, metadata: metadata)
+
+        file.pos.should eq(0)
+      end
+    end
+  end
+end

spec/lucky/attachment/extractor/filename_from_io_spec.cr

@@ -0,0 +1,142 @@
+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" do
+        io = PlainIO.new
+        result = subject.extract(io, metadata: nil, filename: "override.txt")
+
+        result.should eq("override.txt")
+      end
+
+      it "prefers options filename over #original_filename" do
+        io = IOWithOriginalFilename.new("ignored.txt")
+        result = subject.extract(io, metadata: nil, filename: "override.txt")
+
+        result.should eq("override.txt")
+      end
+    end
+
+    context "when the IO responds to #original_filename" do
+      it "returns the original filename" do
+        io = IOWithOriginalFilename.new("photo.jpg")
+        result = subject.extract(io, metadata: nil)
+
+        result.should eq("photo.jpg")
+      end
+
+      it "returns nil when original_filename is nil" do
+        io = IOWithOriginalFilename.new(nil)
+        result = subject.extract(io, metadata: nil)
+
+        result.should be_nil
+      end
+    end
+
+    context "when the IO responds to #filename but not #original_filename" do
+      it "returns the filename" do
+        io = IOWithFilename.new("document.pdf")
+        result = subject.extract(io, metadata: nil)
+
+        result.should eq("document.pdf")
+      end
+
+      it "returns nil when filename is blank" do
+        io = IOWithFilename.new("")
+        result = subject.extract(io, metadata: nil)
+
+        result.should be_nil
+      end
+
+      it "returns nil when filename is nil" do
+        io = IOWithFilename.new(nil)
+        result = subject.extract(io, metadata: nil)
+
+        result.should be_nil
+      end
+    end
+
+    context "when the IO responds to #path but not #original_filename or #filename" do
+      it "returns the basename of the path" do
+        io = IOWithPath.new("/uploads/tmp/archive.zip")
+        result = subject.extract(io, metadata: nil)
+
+        result.should eq("archive.zip")
+      end
+
+      it "returns just the filename when path has no directory component" do
+        io = IOWithPath.new("archive.zip")
+        result = subject.extract(io, metadata: nil)
+
+        result.should eq("archive.zip")
+      end
+    end
+
+    context "when the IO responds to none of the known methods" do
+      it "returns nil" do
+        io = PlainIO.new
+        result = subject.extract(io, metadata: nil)
+
+        result.should be_nil
+      end
+    end
+  end
+end
+
+private class PlainIO < IO
+  def read(slice : Bytes)
+    raise "not implemented"
+  end
+
+  def write(slice : Bytes) : Nil
+    raise "not implemented"
+  end
+end
+
+private class IOWithOriginalFilename < IO
+  getter original_filename : String?
+
+  def initialize(@original_filename : String?)
+  end
+
+  def read(slice : Bytes)
+    raise "not implemented"
+  end
+
+  def write(slice : Bytes) : Nil
+    raise "not implemented"
+  end
+end
+
+private class IOWithFilename < IO
+  getter filename : String?
+
+  def initialize(@filename : String?)
+  end
+
+  def read(slice : Bytes)
+    raise "not implemented"
+  end
+
+  def write(slice : Bytes) : Nil
+    raise "not implemented"
+  end
+end
+
+private class IOWithPath < IO
+  getter path : String
+
+  def initialize(@path : String)
+  end
+
+  def read(slice : Bytes)
+    raise "not implemented"
+  end
+
+  def write(slice : Bytes) : Nil
+    raise "not implemented"
+  end
+end