Merge #29

29: Deprecate all S3 functions r=morris25 a=morris25

Deprecates all the things in S3 and removes most of the tests in preparation for dropping the module.
Part of #12.

Co-authored-by: morris25 <sam.morrison@invenia.ca>

Project.toml

@@ -1,7 +1,7 @@
 name = "AWSTools"
 uuid = "83bcdc74-1232-581c-948a-f29122bf8259"
 authors = ["Invenia Technical Computing"]
-version = "1.10.0"
+version = "1.10.1"
 
 [deps]
 AWSCore = "4f1ea46c-232b-54a6-9b17-cc2d0f3e6598"

docs/src/index.md

@@ -67,11 +67,3 @@ AWSTools.EC2.instance_metadata(::AbstractString)
 AWSTools.EC2.instance_availability_zone()
 AWSTools.EC2.instance_region()
 ```
-
-### S3
-
-#### Exported
-
-```@docs
-AWSTools.S3.upload
-```

src/S3.jl

@@ -2,45 +2,29 @@ __precompile__()
 module S3
 
 using AWSCore
-using AWSS3
+using AWSS3: AWSS3
 using Dates
 using FilePathsBase
-using Memento
-
-import FilePathsBase: sync
 
 export S3Path, sync, upload
 
-const logger = getlogger(@__MODULE__)
-
-# Register the module level logger at runtime so that folks can access the logger via
-# `getlogger(MyModule)`. If this line is not included then the precompiled
-# `MyModule.logger` won't be registered at runtime.
-function __init__()
-    Memento.register(logger)
-end
-
-# Couple extra methods that should probably be included in AWSS3 at some point.
-"""
-    upload(src::AbstractPath, dest::S3Path)
+@deprecate S3Path(args...) AWSS3.S3Path(args...)
+@deprecate upload(src::AbstractPath, dest::AWSS3.S3Path) Base.cp(src, dest)
 
-Uploads a local file to the s3 path specified by `dest`.
-"""
-upload
-
-const upload = Base.cp
-
-# Note: naming copied from Go SDK:
-# https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/s3-example-presigned-urls.html
-function presign(
-    path::S3Path,
-    duration::Period=Hour(1);
-    config::AWSConfig=aws_config(),
+@deprecate(
+    presign(path::AWSS3.S3Path, duration::Period=Hour(1); config::AWSConfig=aws_config()),
+    AWSS3.s3_sign_url(config, path.bucket, path.key, Dates.value(Second(duration))),
 )
-    AWSS3.s3_sign_url(config, path.bucket, path.key, Dates.value(Second(duration)))
-end
 
 # TODO: Remove the sync methods below as they are now pirating.
-@deprecate sync(src::AbstractString, dest::AbstractString; delete::Bool=false, config::AWSConfig=aws_config()) sync(Path(src), Path(dest); delete=delete)
+@deprecate(
+    sync(
+        src::AbstractString,
+        dest::AbstractString;
+        delete::Bool=false,
+        config::AWSConfig=aws_config(),
+    ),
+    FilePathsBase.sync(Path(src), Path(dest); delete=delete),
+)
 
 end  # S3