Merge pull request #28 from taylorfinnell/make-file-uploader-return-s…

…ame-obj FileUploader#upload now returns true or raises an error. Closes #24
taylorfinnell · Jan 7, 2018 · 473158e · 473158e
2 parents 1ecd844 + c7100fe
commit 473158e
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/spec/awscr-s3/file_uploader_spec.cr b/spec/awscr-s3/file_uploader_spec.cr
@@ -12,7 +12,7 @@ module Awscr::S3
         uploader = FileUploader.new(client)
         small_io = IO::Memory.new("document")
 
-        uploader.upload("bucket", "object", small_io)
+        uploader.upload("bucket", "object", small_io).should be_true
       end
 
       it "passes additional headers, when provided" do
@@ -24,7 +24,7 @@ module Awscr::S3
         uploader = FileUploader.new(client)
         small_io = IO::Memory.new("document")
 
-        uploader.upload("bucket", "object", small_io, {"x-amz-meta-name" => "myobject"})
+        uploader.upload("bucket", "object", small_io, {"x-amz-meta-name" => "myobject"}).should be_true
       end
     end
 
@@ -54,7 +54,7 @@ module Awscr::S3
         uploader = FileUploader.new(client)
         big_io = IO::Memory.new("a" * 5_500_000)
 
-        uploader.upload("bucket", "object", big_io)
+        uploader.upload("bucket", "object", big_io).should be_true
       end
 
       it "passes additional headers, when provided" do
@@ -82,7 +82,7 @@ module Awscr::S3
         uploader = FileUploader.new(client)
         big_io = IO::Memory.new("a" * 5_500_000)
 
-        uploader.upload("bucket", "object", big_io, {"x-amz-meta-name" => "myobject"})
+        uploader.upload("bucket", "object", big_io, {"x-amz-meta-name" => "myobject"}).should be_true
       end
     end
   end

diff --git a/src/awscr-s3/file_uploader.cr b/src/awscr-s3/file_uploader.cr
@@ -8,11 +8,12 @@ module Awscr::S3
     def initialize(@client : Client)
     end
 
-    # Upload a file to a bucket
+    # Upload a file to a bucket. Returns true if successful, otherwise an
+    # `Http::ServerError` is thrown.
     #
     # ```
     # uploader = FileUpload.new(client)
-    # uploader.upload("bucket1", "obj", "DATA!")
+    # uploader.upload("bucket1", "obj", IO::Memory.new("DATA!"))
     # ```
     def upload(bucket : String, object : String, io : IO, headers : Hash(String, String) = Hash(String, String).new)
       if io.size < UPLOAD_THRESHOLD
@@ -21,6 +22,7 @@ module Awscr::S3
         uploader = MultipartFileUploader.new(@client)
         uploader.upload(bucket, object, io, headers)
       end
+      true
     end
   end
 end