s3_website 2.10.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a869e0bbb5276a123020d7ae96f52d729d56b166
-  data.tar.gz: b6b51944723aaf3f1c22f949a56261137cc74dcc
+  metadata.gz: 7df2add8f3589b718b7f8f1eca3cde4b7d03112b
+  data.tar.gz: eba43c04b20fc754a8cfe7c69b2a4cc596c03acd
 SHA512:
-  metadata.gz: 2f3705e5c621c1b44225e8b3f7070496d59d258780f268b3d4183d709e5d988041d26d47a9a8bffdaac89d6f86c5b8e3caff99afafd18d1cfaa1f3cceb7ea99b
-  data.tar.gz: d13a8bd0492c4cc10e92bc4bd08ecf71eded8f0bac47ffa7bee15b9bd4909de2dcae7ce3e92d80aead594fcbe0eb13d747dc0fdf11517beb4f5b62397a5351f9
+  metadata.gz: 26d815278b9d10e2238f52445436d8fd740d1415244c95c16dc3bf9563697ca68a1a82b943810ddf895389bd3d045cbdd27e72bc15503c970f564bd031b1bb14
+  data.tar.gz: 96f3b42495fc67196253d39d2614f9a3154b508962adf9b692141fed8152f03298cf9495482a0ea383d5ea382a2364a683e335191934c4cf0d1b0646b42513a0

data/README.md

@@ -91,8 +91,8 @@ incomprehensible or inconsistent.
 
 ### Cache Control
 
-You can use either the setting `max_age` or `cache_control`to enable more 
-effective browser caching of your static assets. 
+You can use either the setting `max_age` or `cache_control`to enable more
+effective browser caching of your static assets.
 
 #### max_age
 
@@ -117,10 +117,10 @@ Force-pushing allows you to update the S3 object metadata of existing files.
 
 #### cache_control
 
-The `cache_control` setting allows you to define an arbitrary string that s3_website 
+The `cache_control` setting allows you to define an arbitrary string that s3_website
 will put on all the S3 objects of your website.
-  
-Here's an example:  
+
+Here's an example:
 
 ```yaml
 cache_control: public, no-transform, max-age=1200, s-maxage=1200
@@ -241,7 +241,7 @@ When you run the command `s3_website cfg apply`, it will ask you whether you
 want to deliver your website via CloudFront. If you answer yes, the command will
 create a CloudFront distribution for you.
 
-If you do not want to receive this prompt, or if you are running the command in a non-interactive session, you can use `s3_website cfg apply --headless`.
+If you do not want to receive this prompt, or if you are running the command in a non-interactive session, you can use `s3_website cfg apply --headless` (and optionally also use `--autocreate-cloudfront-dist` if desired).
 
 #### Using your existing CloudFront distribution
 
@@ -323,6 +323,14 @@ redirects:
   music-files/promo.mp4: http://www.youtube.com/watch?v=dQw4w9WgXcQ
 ```
 
+On terminology: the left value is the redirect source and the right value is the redirect
+target. For example above, *about.php* is the redirect source and */about.html* the target.
+
+If the `s3_key_prefix` setting is defined, it will be applied to the redirect
+target if and only if the redirect target points to a site-local resource and
+does not start with a slash. E.g., `about.php: about.html` will be translated
+into `about.php: VALUE-OF-S3_KEY_PREFIX/about.html`.
+
 #### Routing Rules
 
 You can configure more complex redirect rules by adding the following
@@ -396,6 +404,17 @@ operation would actually do if run without the dry switch.
 You can use the dry run mode if you are unsure what kind of effects the `push`
 operation would cause to your live website.
 
+### S3 website in a subdirectory of the bucket
+
+If your S3 website shares the same S3 bucket with other applications, you can
+push your website into a "subdirectory" on the bucket.
+
+Define the subdirectory like so:
+
+```yaml
+s3_key_prefix: your-subdirectory
+```
+
 ## Migrating from v1 to v2
 
 Please read the [release note](/changelog.md#200) on version 2. It contains

data/build.sbt

@@ -4,7 +4,7 @@ name := "s3_website"
 
 version := "0.0.1"
 
-scalaVersion := "2.11.2"
+scalaVersion := "2.11.7"
 
 scalacOptions += "-feature"
 

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 2.11.0
+
+* Add the `s3_key_prefix` setting
+
 ## 2.10.0
 
 * Support glob hashes in `cache_control`

data/lib/s3_website/version.rb

@@ -1,3 +1,3 @@
 module S3Website
-  VERSION = '2.10.0'
+  VERSION = '2.11.0'
 end

data/resources/configuration_file_template.yml

@@ -7,6 +7,9 @@ s3_bucket: your.blog.bucket.com
 
 # site: path-to-your-website
 
+# index_document: index.html
+# error_document: error.html
+
 # max_age:
 #   "assets/*": 6000
 #   "*": 300

data/resources/s3_website.jar.md5

@@ -1 +1 @@
-b714f0abf164b76a1bd2c73a8bae575d
+cf1a6f74b8eaceb16173937afc198952

data/src/main/scala/s3/website/CloudFront.scala

@@ -81,7 +81,7 @@ object CloudFront {
       if (containsPotentialDefaultRootObject) Some("/") else None
     }
     val indexPath = config.cloudfront_invalidate_root collect {
-      case true if pushSuccessReports.nonEmpty => "/index.html"
+      case true if pushSuccessReports.nonEmpty => config.s3_key_prefix.map(prefix => s"/$prefix").getOrElse("") + "/index.html"
     }
 
     val invalidationPaths: Seq[String] = {

data/src/main/scala/s3/website/S3.scala

@@ -52,7 +52,7 @@ object S3 {
             (implicit config: Config, s3Settings: S3Setting, pushOptions: PushOptions, executor: ExecutionContextExecutor, logger: Logger):
   Future[Either[FailedDelete, SuccessfulDelete]] =
     Future {
-      if (!pushOptions.dryRun) s3Settings.s3Client(config) deleteObject(config.s3_bucket, s3Key)
+      if (!pushOptions.dryRun) s3Settings.s3Client(config) deleteObject(config.s3_bucket, s3Key.key)
       val report = SuccessfulDelete(s3Key)
       logger.info(report)
       Right(report)
@@ -86,13 +86,13 @@ object S3 {
             case (None, None) => None
           }
           cacheControl foreach { md.setCacheControl }
-          val req = new PutObjectRequest(config.s3_bucket, upload.s3Key, new FileInputStream(uploadFile), md)
+          val req = new PutObjectRequest(config.s3_bucket, upload.s3Key.key, new FileInputStream(uploadFile), md)
           config.s3_reduced_redundancy.filter(_ == true) foreach (_ => req setStorageClass ReducedRedundancy)
           req
         }
       ,
       redirect => {
-        val req = new PutObjectRequest(config.s3_bucket, redirect.s3Key, redirect.redirectTarget)
+        val req = new PutObjectRequest(config.s3_bucket, redirect.s3Key.key, redirect.redirectTarget)
         req.setMetadata({
           val md = new ObjectMetadata()
           md.setContentLength(0) // Otherwise the AWS SDK will log a warning
@@ -116,21 +116,28 @@ object S3 {
   def awsS3Client(config: Config) = new AmazonS3Client(awsCredentials(config))
 
   def resolveS3Files(nextMarker: Option[String] = None, alreadyResolved: Seq[S3File] = Nil,  attempt: Attempt = 1)
-                              (implicit config: Config, s3Settings: S3Setting, ec: ExecutionContextExecutor, logger: Logger, pushOptions: PushOptions):
+                              (implicit site: Site, s3Settings: S3Setting, ec: ExecutionContextExecutor, logger: Logger, pushOptions: PushOptions):
   Future[Either[ErrorReport, Seq[S3File]]] = Future {
     logger.debug(nextMarker.fold
       ("Querying S3 files")
       {m => s"Querying more S3 files (starting from $m)"}
     )
-    val objects: ObjectListing = s3Settings.s3Client(config).listObjects({
+    val objects: ObjectListing = s3Settings.s3Client(site.config).listObjects({
       val req = new ListObjectsRequest()
-      req.setBucketName(config.s3_bucket)
+      req.setBucketName(site.config.s3_bucket)
       nextMarker.foreach(req.setMarker)
       req
     })
     objects
   } flatMap { (objects: ObjectListing) =>
-    val s3Files = alreadyResolved ++ (objects.getObjectSummaries.toIndexedSeq.toSeq map (S3File(_)))
+
+    /**
+     * We could filter the keys by prefix already on S3, but unfortunately s3_website test infrastructure does not currently support testing of that.
+     * Hence fetch all the keys from S3 and then filter by s3_key_prefix.
+     */
+    def matchesPrefix(os: S3ObjectSummary) = site.config.s3_key_prefix.fold(true)(prefix => os.getKey.startsWith(prefix))
+
+    val s3Files = alreadyResolved ++ (objects.getObjectSummaries.filter(matchesPrefix).toIndexedSeq.toSeq map (S3File(_)))
     Option(objects.getNextMarker)
       .fold(Future(Right(s3Files)): Future[Either[ErrorReport, Seq[S3File]]]) // We've received all the S3 keys from the bucket
       { nextMarker => // There are more S3 keys on the bucket. Fetch them.
@@ -149,7 +156,7 @@ object S3 {
 
   sealed trait PushFailureReport extends ErrorReport
   sealed trait PushSuccessReport extends SuccessReport {
-    def s3Key: String
+    def s3Key: S3Key
   }
 
   case class SuccessfulRedirectDetails(uploadType: UploadType, redirectTarget: String)
@@ -211,15 +218,15 @@ object S3 {
     }
   }
 
-  case class SuccessfulDelete(s3Key: String)(implicit pushOptions: PushOptions) extends PushSuccessReport {
+  case class SuccessfulDelete(s3Key: S3Key)(implicit pushOptions: PushOptions) extends PushSuccessReport {
     def reportMessage = s"${Deleted.renderVerb} $s3Key"
   }
 
-  case class FailedUpload(s3Key: String, error: Throwable)(implicit logger: Logger) extends PushFailureReport {
+  case class FailedUpload(s3Key: S3Key, error: Throwable)(implicit logger: Logger) extends PushFailureReport {
     def reportMessage = errorMessage(s"Failed to upload $s3Key", error)
   }
 
-  case class FailedDelete(s3Key: String, error: Throwable)(implicit logger: Logger) extends PushFailureReport {
+  case class FailedDelete(s3Key: S3Key, error: Throwable)(implicit logger: Logger) extends PushFailureReport {
     def reportMessage = errorMessage(s"Failed to delete $s3Key", error)
   }
 

data/src/main/scala/s3/website/UploadHelper.scala

@@ -1,5 +1,6 @@
 package s3.website
 
+import s3.website.S3Key.isIgnoredBecauseOfPrefix
 import s3.website.model.Files.listSiteFiles
 import s3.website.model._
 import s3.website.Ruby.rubyRegexMatches
@@ -46,7 +47,9 @@ object UploadHelper {
 
   def resolveDeletes(s3Files: Future[Either[ErrorReport, Seq[S3File]]], redirects: Seq[Redirect])
                     (implicit site: Site, logger: Logger, executor: ExecutionContextExecutor): Future[Either[ErrorReport, Seq[S3Key]]] =
-    if (site.config.ignore_on_server.contains(Left(DELETE_NOTHING_MAGIC_WORD))) {
+    if (site.config.ignore_on_server exists (
+      ignoreRegexes => ignoreRegexes.s3KeyRegexes exists( regex => regex matches S3Key.build(DELETE_NOTHING_MAGIC_WORD, site.config.s3_key_prefix))
+    )) {
       logger.debug(s"Ignoring all files on the bucket, since the setting $DELETE_NOTHING_MAGIC_WORD is on.")
       Future(Right(Nil))
     } else {
@@ -56,12 +59,12 @@ object UploadHelper {
         for {
           remoteS3Keys <- s3Files.right.map(_ map (_.s3Key)).right
         } yield {
-          val keysToRetain = (localS3Keys ++ (redirects map { _.s3Key })).toSet
+          val keysIgnoredBecauseOf_s3_key_prefix = remoteS3Keys.filterNot(isIgnoredBecauseOfPrefix)
+          val keysToRetain = (
+            localS3Keys ++ (redirects map { _.s3Key }) ++ keysIgnoredBecauseOf_s3_key_prefix
+          ).toSet
           remoteS3Keys filterNot { s3Key =>
-            val ignoreOnServer = site.config.ignore_on_server.exists(_.fold(
-              (ignoreRegex: String) => rubyRegexMatches(s3Key, ignoreRegex),
-              (ignoreRegexes: Seq[String]) => ignoreRegexes.exists(rubyRegexMatches(s3Key, _))
-            ))
+            val ignoreOnServer = site.config.ignore_on_server.exists(_ matches s3Key)
             if (ignoreOnServer) logger.debug(s"Ignoring $s3Key on server")
             (keysToRetain contains s3Key) || ignoreOnServer
           }

data/src/main/scala/s3/website/model/Config.scala

@@ -1,11 +1,13 @@
 package s3.website.model
 
 import java.io.File
+import java.util
 
+import scala.util.matching.Regex
 import scala.util.{Failure, Try}
 import scala.collection.JavaConversions._
 import s3.website.Ruby.rubyRuntime
-import s3.website.ErrorReport
+import s3.website._
 import com.amazonaws.auth.{AWSCredentialsProvider, BasicAWSCredentials, DefaultAWSCredentialsProviderChain}
 
 case class Config(
@@ -14,16 +16,17 @@ case class Config(
   s3_bucket:                  String,
   s3_endpoint:                S3Endpoint,
   site:                       Option[String],
-  max_age:                    Option[Either[Int, Map[String, Int]]],
-  cache_control:              Option[Either[String, Map[String, String]]],
+  max_age:                    Option[Either[Int, S3KeyGlob[Int]]],
+  cache_control:              Option[Either[String, S3KeyGlob[String]]],
   gzip:                       Option[Either[Boolean, Seq[String]]],
   gzip_zopfli:                Option[Boolean],
-  ignore_on_server:           Option[Either[String, Seq[String]]],
-  exclude_from_upload:        Option[Either[String, Seq[String]]],
+  s3_key_prefix:              Option[String],
+  ignore_on_server:           Option[S3KeyRegexes],
+  exclude_from_upload:        Option[S3KeyRegexes],
   s3_reduced_redundancy:      Option[Boolean],
   cloudfront_distribution_id: Option[String],
   cloudfront_invalidate_root: Option[Boolean],
-  redirects:                  Option[Map[String, String]],
+  redirects:                  Option[Map[S3Key, String]],
   concurrency_level:          Int,
   treat_zero_length_objects_as_redirects: Option[Boolean]
 )
@@ -56,41 +59,52 @@ object Config {
     yamlValue getOrElse Left(ErrorReport(s"The key $key has to have a boolean or [string] value"))
   }
 
-  def loadOptionalStringOrStringSeq(key: String)(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[Either[String, Seq[String]]]] = {
+  def loadOptionalS3KeyRegexes(key: String)(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[S3KeyRegexes]] = {
     val yamlValue = for {
       valueOption <- loadOptionalValue(key)
     } yield {
+      def toS3KeyRegexes(xs: Seq[String]) = S3KeyRegexes(xs map (str => str.r) map S3KeyRegex)
       Right(valueOption.map {
-        case value if value.isInstanceOf[String] => Left(value.asInstanceOf[String])
-        case value if value.isInstanceOf[java.util.List[_]] => Right(value.asInstanceOf[java.util.List[String]].toIndexedSeq)
+        case value if value.isInstanceOf[String] =>
+          toS3KeyRegexes(value.asInstanceOf[String] :: Nil)
+        case value if value.isInstanceOf[java.util.List[_]] =>
+          toS3KeyRegexes(value.asInstanceOf[java.util.List[String]].toIndexedSeq)
       })
     }
 
     yamlValue getOrElse Left(ErrorReport(s"The key $key has to have a string or [string] value"))
   }
 
-  def loadMaxAge(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[Either[Int, Map[String, Int]]]] = {
+  def loadMaxAge(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[Either[Int, S3KeyGlob[Int]]]] = {
     val key = "max_age"
     val yamlValue = for {
       maxAgeOption <- loadOptionalValue(key)
     } yield {
-      Right(maxAgeOption.map {
-        case maxAge if maxAge.isInstanceOf[Int] => Left(maxAge.asInstanceOf[Int])
-        case maxAge if maxAge.isInstanceOf[java.util.Map[_,_]] => Right(maxAge.asInstanceOf[java.util.Map[String,Int]].toMap)
-      })
-    }
+        // TODO below we are using an unsafe call to asInstance of – we should implement error handling
+        Right(maxAgeOption.map {
+          case maxAge if maxAge.isInstanceOf[Int] =>
+            Left(maxAge.asInstanceOf[Int])
+          case maxAge if maxAge.isInstanceOf[java.util.Map[_,_]] =>
+            val globs: Map[String, Int] = maxAge.asInstanceOf[util.Map[String, Int]].toMap
+            Right(S3KeyGlob(globs))
+        })
+      }
 
     yamlValue getOrElse Left(ErrorReport(s"The key $key has to have an int or (string -> int) value"))
   }
 
-  def loadCacheControl(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[Either[String, Map[String, String]]]] = {
+  def loadCacheControl(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[Either[String, S3KeyGlob[String]]]] = {
     val key = "cache_control"
     val yamlValue = for {
       cacheControlOption <- loadOptionalValue(key)
     } yield {
+        // TODO below we are using an unsafe call to asInstance of – we should implement error handling
         Right(cacheControlOption.map {
-          case cacheControl if cacheControl.isInstanceOf[String] => Left(cacheControl.asInstanceOf[String])
-          case cacheControl if cacheControl.isInstanceOf[java.util.Map[_,_]] => Right(cacheControl.asInstanceOf[java.util.Map[String,String]].toMap) // TODO an unsafe call to asInstanceOf
+          case cacheControl if cacheControl.isInstanceOf[String] =>
+            Left(cacheControl.asInstanceOf[String])
+          case cacheControl if cacheControl.isInstanceOf[java.util.Map[_,_]] =>
+            val globs: Map[String, String] = cacheControl.asInstanceOf[util.Map[String, String]].toMap
+            Right(S3KeyGlob(globs))
         })
       }
 
@@ -106,12 +120,16 @@ object Config {
       }
     }
 
-  def loadRedirects(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[Map[String, String]]] = {
+  def loadRedirects(s3_key_prefix: Option[String])(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[Map[S3Key, String]]] = {
     val key = "redirects"
     val yamlValue = for {
       redirectsOption <- loadOptionalValue(key)
-      redirects <- Try(redirectsOption.map(_.asInstanceOf[java.util.Map[String,String]].toMap))
-    } yield Right(redirects)
+      redirectsOption <- Try(redirectsOption.map(_.asInstanceOf[java.util.Map[String,String]].toMap))
+    } yield Right(redirectsOption.map(
+        redirects => redirects.map(
+          ((key: String, value: String) => (S3Key.build(key, s3_key_prefix), value)).tupled
+        )
+      ))
 
     yamlValue getOrElse Left(ErrorReport(s"The key $key has to have a (string -> string) value"))
   }

data/src/main/scala/s3/website/model/Site.scala

@@ -15,11 +15,10 @@ import s3.website.model.Config.UnsafeYaml
 import scala.util.Success
 
 case class Site(rootDirectory: File, config: Config) {
-  def resolveS3Key(file: File) = file.getAbsolutePath.replace(rootDirectory.getAbsolutePath, "").replace(File.separator,"/").replaceFirst("^/", "")
-
-  def resolveFile(s3File: S3File): File = resolveFile(s3File.s3Key)
-
-  def resolveFile(s3Key: S3Key): File = new File(s"$rootDirectory/$s3Key")
+  def resolveS3Key(file: File) = S3Key.build(
+    file.getAbsolutePath.replace(rootDirectory.getAbsolutePath, "").replace(File.separator,"/").replaceFirst("^/", ""),
+    config.s3_key_prefix
+  )
 }
 
 object Site {
@@ -44,13 +43,14 @@ object Site {
           gzip <- loadOptionalBooleanOrStringSeq("gzip").right
           gzip_zopfli <- loadOptionalBoolean("gzip_zopfli").right
           extensionless_mime_type <- loadOptionalString("extensionless_mime_type").right
-          ignore_on_server <- loadOptionalStringOrStringSeq("ignore_on_server").right
-          exclude_from_upload <- loadOptionalStringOrStringSeq("exclude_from_upload").right
+          s3_key_prefix <- loadOptionalString("s3_key_prefix").right
+          ignore_on_server <- loadOptionalS3KeyRegexes("ignore_on_server").right
+          exclude_from_upload <- loadOptionalS3KeyRegexes("exclude_from_upload").right
           s3_reduced_redundancy <- loadOptionalBoolean("s3_reduced_redundancy").right
           cloudfront_distribution_id <- loadOptionalString("cloudfront_distribution_id").right
           cloudfront_invalidate_root <- loadOptionalBoolean("cloudfront_invalidate_root").right
           concurrency_level <- loadOptionalInt("concurrency_level").right
-          redirects <- loadRedirects.right
+          redirects <- loadRedirects(s3_key_prefix).right
           treat_zero_length_objects_as_redirects <- loadOptionalBoolean("treat_zero_length_objects_as_redirects").right
         } yield {
           gzip_zopfli.foreach(_ => logger.info(
@@ -70,6 +70,7 @@ object Site {
             cache_control,
             gzip,
             gzip_zopfli,
+            s3_key_prefix,
             ignore_on_server = ignore_on_server,
             exclude_from_upload = exclude_from_upload,
             s3_reduced_redundancy,

data/src/main/scala/s3/website/model/push.scala

@@ -21,11 +21,11 @@ object Encoding {
   case class Gzip()
   case class Zopfli()
 
-  def encodingOnS3(s3Key: String)(implicit config: Config): Option[Either[Gzip, Zopfli]] =
+  def encodingOnS3(s3Key: S3Key)(implicit config: Config): Option[Either[Gzip, Zopfli]] =
     config.gzip.flatMap { (gzipSetting: Either[Boolean, Seq[String]]) =>
       val shouldZipThisFile = gzipSetting.fold(
-        shouldGzip => defaultGzipExtensions exists s3Key.endsWith,
-        fileExtensions => fileExtensions exists s3Key.endsWith
+        shouldGzip => defaultGzipExtensions exists s3Key.key.endsWith,
+        fileExtensions => fileExtensions exists s3Key.key.endsWith
       )
       if (shouldZipThisFile && config.gzip_zopfli.isDefined)
         Some(Right(Zopfli()))
@@ -71,51 +71,21 @@ case class Upload(originalFile: File, uploadType: UploadType)(implicit site: Sit
       mimeType
   }
 
-  lazy val maxAge: Option[Int] = {
-    type GlobsMap = Map[String, Int]
-    site.config.max_age.flatMap { (intOrGlobs: Either[Int, GlobsMap]) =>
-      type GlobsSeq = Seq[(String, Int)]
-      def respectMostSpecific(globs: GlobsMap): GlobsSeq = globs.toSeq.sortBy(_._1.length).reverse
-      intOrGlobs
-        .right.map(respectMostSpecific)
-        .fold(
-          (seconds: Int) => Some(seconds),
-          (globs: GlobsSeq) => {
-            val matchingMaxAge = (glob: String, maxAge: Int) =>
-              rubyRuntime.evalScriptlet(
-                s"""|# encoding: utf-8
-                    |File.fnmatch('$glob', "$s3Key")""".stripMargin)
-                .toJava(classOf[Boolean])
-                .asInstanceOf[Boolean]
-            val fileGlobMatch = globs find Function.tupled(matchingMaxAge)
-            fileGlobMatch map (_._2)
-          }
-        )
-    }
-  }
+  lazy val maxAge: Option[Int] =
+    site.config.max_age.flatMap(
+      _ fold(
+        (maxAge: Int) => Some(maxAge),
+        (globs: S3KeyGlob[Int]) => globs.globMatch(s3Key)
+      )
+    )
 
-  lazy val cacheControl: Option[String] = {
-    type GlobsMap = Map[String, String]
-    site.config.cache_control.flatMap { (intOrGlobs: Either[String, GlobsMap]) =>
-      type GlobsSeq = Seq[(String, String)]
-      def respectMostSpecific(globs: GlobsMap): GlobsSeq = globs.toSeq.sortBy(_._1.length).reverse
-      intOrGlobs
-        .right.map(respectMostSpecific)
-        .fold(
-          (cacheCtrl: String) => Some(cacheCtrl),
-          (globs: GlobsSeq) => {
-            val matchingCacheControl = (glob: String, cacheControl: String) =>
-              rubyRuntime.evalScriptlet(
-                s"""|# encoding: utf-8
-                   |File.fnmatch('$glob', "$s3Key")""".stripMargin)
-                .toJava(classOf[Boolean])
-                .asInstanceOf[Boolean]
-            val fileGlobMatch = globs find Function.tupled(matchingCacheControl)
-            fileGlobMatch map (_._2)
-          }
-        )
-    }
-  }
+  lazy val cacheControl: Option[String] =
+    site.config.cache_control.flatMap(
+      _ fold(
+        (cacheCtrl: String) => Some(cacheCtrl),
+        (globs: S3KeyGlob[String]) => globs.globMatch(s3Key)
+      )
+    )
 
   /**
    * May throw an exception, so remember to call this in a Try or Future monad
@@ -158,15 +128,11 @@ object Files {
   }
 
   def listSiteFiles(implicit site: Site, logger: Logger) = {
-    def excludeFromUpload(s3Key: String) = {
+    def excludeFromUpload(s3Key: S3Key) = {
       val excludeByConfig = site.config.exclude_from_upload exists {
-        _.fold(
-          // For backward compatibility, use Ruby regex matching
-          (exclusionRegex: String) => rubyRegexMatches(s3Key, exclusionRegex),
-          (exclusionRegexes: Seq[String]) => exclusionRegexes exists (rubyRegexMatches(s3Key, _))
-        )
+        _.s3KeyRegexes.exists(_ matches s3Key)
       }
-      val neverUpload = "s3_website.yml" :: ".env" :: Nil
+      val neverUpload = "s3_website.yml" :: ".env" :: Nil map (k => S3Key.build(k, site.config.s3_key_prefix))
       val doNotUpload = excludeByConfig || (neverUpload contains s3Key)
       if (doNotUpload) logger.debug(s"Excluded $s3Key from upload")
       doNotUpload
@@ -177,11 +143,11 @@ object Files {
   }
 }
 
-case class Redirect(s3Key: String, redirectTarget: String, needsUpload: Boolean) {
+case class Redirect(s3Key: S3Key, redirectTarget: String, needsUpload: Boolean) {
   def uploadType = RedirectFile
 }
 
-private case class RedirectSetting(source: String, target: String)
+private case class RedirectSetting(source: S3Key, target: String)
 
 object Redirect {
   type Redirects = Future[Either[ErrorReport, Seq[Redirect]]]
@@ -191,7 +157,7 @@ object Redirect {
     val redirectSettings = config.redirects.fold(Nil: Seq[RedirectSetting]) { sourcesToTargets =>
       sourcesToTargets.foldLeft(Seq(): Seq[RedirectSetting]) {
         (redirects, sourceToTarget) =>
-          redirects :+ RedirectSetting(sourceToTarget._1, applySlashIfNeeded(sourceToTarget._2))
+          redirects :+ RedirectSetting(sourceToTarget._1, applyRedirectRules(sourceToTarget._2))
       }
     }
     def redirectsWithExistsOnS3Info =
@@ -212,21 +178,22 @@ object Redirect {
       allConfiguredRedirects
   }
 
-  private def applySlashIfNeeded(redirectTarget: String) = {
+  private def applyRedirectRules(redirectTarget: String)(implicit config: Config) = {
     val isExternalRedirect = redirectTarget.matches("https?:\\/\\/.*")
     val isInSiteRedirect = redirectTarget.startsWith("/")
     if (isInSiteRedirect || isExternalRedirect)
       redirectTarget
     else
-      "/" + redirectTarget // let the user have redirect settings like "index.php: index.html" in s3_website.ml
+      s"${config.s3_key_prefix.map(prefix => s"/$prefix").getOrElse("")}/$redirectTarget"
   }
 
   def apply(redirectSetting: RedirectSetting, needsUpload: Boolean): Redirect =
       Redirect(redirectSetting.source, redirectSetting.target, needsUpload)
 }
 
-case class S3File(s3Key: String, md5: MD5, size: Long)
+case class S3File(s3Key: S3Key, md5: MD5, size: Long)
 
 object S3File {
-  def apply(summary: S3ObjectSummary): S3File = S3File(summary.getKey, summary.getETag, summary.getSize)
+  def apply(summary: S3ObjectSummary)(implicit site: Site): S3File =
+    S3File(S3Key.build(summary.getKey, None), summary.getETag, summary.getSize)
 }

data/src/main/scala/s3/website/package.scala

@@ -1,5 +1,7 @@
 package s3
 
+import s3.website.Ruby._
+
 import scala.concurrent.{ExecutionContextExecutor, Future}
 import scala.concurrent.duration.{TimeUnit, Duration}
 import s3.website.S3.{PushSuccessReport, PushFailureReport}
@@ -7,6 +9,8 @@ import com.amazonaws.AmazonServiceException
 import s3.website.model.{Config, Site}
 import java.io.File
 
+import scala.util.matching.Regex
+
 package object website {
   trait Report {
     def reportMessage: String
@@ -52,7 +56,43 @@ package object website {
     def force: Boolean
   }
 
-  type S3Key = String
+  case class S3KeyRegex(keyRegex: Regex) {
+    def matches(s3Key: S3Key) = rubyRegexMatches(s3Key.key, keyRegex.pattern.pattern())
+  }
+
+  trait S3Key {
+    val key: String
+    override def toString = key
+  }
+
+  object S3Key {
+    def prefix(s3_key_prefix: Option[String]) = s3_key_prefix.map(prefix => if (prefix.endsWith("/")) prefix else prefix + "/").getOrElse("")
+
+    def isIgnoredBecauseOfPrefix(s3Key: S3Key)(implicit site: Site) = s3Key.key.startsWith(prefix(site.config.s3_key_prefix))
+
+    case class S3KeyClass(key: String) extends S3Key
+    def build(key: String, s3_key_prefix: Option[String]): S3Key = S3KeyClass(prefix(s3_key_prefix) + key)
+  }
+  
+  case class S3KeyGlob[T](globs: Map[String, T]) {
+    def globMatch(s3Key: S3Key): Option[T] = {
+      def respectMostSpecific(globs: Map[String, T]) = globs.toSeq.sortBy(_._1.length).reverse
+      val matcher = (glob: String, value: T) =>
+        rubyRuntime.evalScriptlet(
+          s"""|# encoding: utf-8
+             |File.fnmatch('$glob', "$s3Key")""".stripMargin)
+          .toJava(classOf[Boolean])
+          .asInstanceOf[Boolean]
+      val fileGlobMatch = respectMostSpecific(globs) find Function.tupled(matcher)
+      fileGlobMatch map (_._2)
+    }
+  }
+  
+  case class S3KeyRegexes(s3KeyRegexes: Seq[S3KeyRegex]) {
+    def matches(s3Key: S3Key) = s3KeyRegexes exists (
+      (keyRegex: S3KeyRegex) => keyRegex matches s3Key
+    )
+  }
 
   type UploadDuration = Long
 

data/src/test/scala/s3/website/S3WebsiteSpec.scala

@@ -83,6 +83,14 @@ class S3WebsiteSpec extends Specification {
       noUploadsOccurred must beTrue
     }
 
+    "not upload a file if it has not changed and s3_key_prefix is defined" in new BasicSetup {
+      config = "s3_key_prefix: test"
+      setLocalFileWithContent(("index.html", "<div>hello</div>"))
+      setS3File("test/index.html", md5Hex("<div>hello</div>"))
+      push()
+      noUploadsOccurred must beTrue
+    }
+
     "detect a changed file even though another file has the same contents as the changed file" in new BasicSetup {
       setLocalFilesWithContent(("1.txt", "foo"), ("2.txt", "foo"))
       setS3File("1.txt", md5Hex("bar"))
@@ -110,6 +118,27 @@ class S3WebsiteSpec extends Specification {
       sentDelete must equalTo("old.html")
     }
 
+    "delete files that match the s3_key_prefix" in new BasicSetup {
+      config = "s3_key_prefix: production"
+      setS3File("production/old.html", md5Hex("<h1>old text</h1>"))
+      push()
+      sentDelete must equalTo("production/old.html")
+    }
+
+    "retain files that do not match the s3_key_prefix" in new BasicSetup {
+      config = "s3_key_prefix: production"
+      setS3File("old.html", md5Hex("<h1>old text</h1>"))
+      push()
+      noDeletesOccurred
+    }
+
+    "retain files that do not match the s3_key_prefix" in new BasicSetup {
+      config = "s3_key_prefix: test"
+      setS3File("test1.html")
+      push()
+      noDeletesOccurred
+    }
+
     "try again if the upload fails" in new BasicSetup {
       setLocalFile("index.html")
       uploadFailsAndThenSucceeds(howManyFailures = 5)
@@ -230,6 +259,17 @@ class S3WebsiteSpec extends Specification {
       push()
       sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/" :: "/maybe-index.html" :: Nil).sorted)
     }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config = """
+                 |cloudfront_distribution_id: EGM1J2JJX9Z
+                 |s3_key_prefix: production
+               """.stripMargin
+      setLocalFile("index.html")
+      setOutdatedS3Keys("production/index.html")
+      push()
+      sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/production/index.html" :: Nil).sorted)
+    }
   }
 
   "cloudfront_invalidate_root: true" should {
@@ -255,6 +295,20 @@ class S3WebsiteSpec extends Specification {
       sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq must contain("/index.html")
     }
 
+    "treat the s3_key_prefix as the root path" in new BasicSetup {
+      config = """
+                 |cloudfront_distribution_id: EGM1J2JJX9Z
+                 |cloudfront_invalidate_root: true
+                 |s3_key_prefix: test
+               """.stripMargin
+      setLocalFile("articles/index.html")
+      setOutdatedS3Keys("test/articles/index.html")
+      push()
+      sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(
+        ("/test/index.html" :: "/test/articles/" :: Nil).sorted
+      )
+    }
+
     "not invalidate anything if there was nothing to push" in new BasicSetup {
       config = """
         |cloudfront_distribution_id: EGM1J2JJX9Z
@@ -333,12 +387,35 @@ class S3WebsiteSpec extends Specification {
     }
   }
 
+  "s3_key_prefix in config" should {
+    "apply the prefix into all the S3 keys" in new BasicSetup {
+      config = "s3_key_prefix: production"
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getKey must equalTo("production/index.html")
+    }
+
+    "work with slash" in new BasicSetup {
+      config = "s3_key_prefix: production/"
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getKey must equalTo("production/index.html")
+    }
+  }
+
   "s3_website.yml file" should {
     "never be uploaded" in new BasicSetup {
       setLocalFile("s3_website.yml")
       push()
       noUploadsOccurred must beTrue
     }
+
+    "never be uploaded even when s3_key_prefix is defined" in new BasicSetup {
+      config = "s3_key_prefix: production"
+      setLocalFile("s3_website.yml")
+      push()
+      noUploadsOccurred must beTrue
+    }
   }
 
   ".env file" should { // The .env file is the https://github.com/bkeepers/dotenv file
@@ -347,6 +424,13 @@ class S3WebsiteSpec extends Specification {
       push()
       noUploadsOccurred must beTrue
     }
+
+    "never be uploaded even when s3_key_prefix is defined" in new BasicSetup {
+      config = "s3_key_prefix: production"
+      setLocalFile(".env")
+      push()
+      noUploadsOccurred must beTrue
+    }
   }
 
   "exclude_from_upload: string" should {
@@ -356,6 +440,16 @@ class S3WebsiteSpec extends Specification {
       push()
       noUploadsOccurred must beTrue
     }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config = """
+                 |s3_key_prefix: production
+                 |exclude_from_upload: hello.txt
+               """.stripMargin
+      setLocalFile("hello.txt")
+      push()
+      noUploadsOccurred must beTrue
+    }
   }
 
   """
@@ -373,6 +467,17 @@ class S3WebsiteSpec extends Specification {
       push()
       noUploadsOccurred must beTrue
     }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config = """
+                 |s3_key_prefix: production
+                 |exclude_from_upload:
+                 |- hello.txt
+               """.stripMargin
+      setLocalFile("hello.txt")
+      push()
+      noUploadsOccurred must beTrue
+    }
   }
 
   "ignore_on_server: value" should {
@@ -389,6 +494,16 @@ class S3WebsiteSpec extends Specification {
       push()
       noDeletesOccurred must beTrue
     }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config = """
+                 |s3_key_prefix: production
+                 |ignore_on_server: hello.txt
+               """.stripMargin
+      setS3File("hello.txt")
+      push()
+      noDeletesOccurred must beTrue
+    }
   }
 
   "ignore_on_server: _DELETE_NOTHING_ON_THE_S3_BUCKET_" should {
@@ -400,6 +515,16 @@ class S3WebsiteSpec extends Specification {
       push()
       noDeletesOccurred
     }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config = s"""
+                  |s3_key_prefix: production
+                  |ignore_on_server: $DELETE_NOTHING_MAGIC_WORD
+      """.stripMargin
+      setS3File("file.txt")
+      push()
+      noDeletesOccurred
+    }
   }
 
   """
@@ -426,6 +551,17 @@ class S3WebsiteSpec extends Specification {
       push()
       noDeletesOccurred must beTrue
     }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config = """
+                 |s3_key_prefix: production
+                 |ignore_on_server:
+                 |- hello.*
+               """.stripMargin
+      setS3File("hello.txt")
+      push()
+      noDeletesOccurred must beTrue
+    }
   }
 
   "error message" should {
@@ -485,6 +621,17 @@ class S3WebsiteSpec extends Specification {
       sentPutObjectRequest.getMetadata.getCacheControl must equalTo("public, no-transform, max-age=1200, s-maxage=1200")
     }
 
+    "work with s3_key_prefix" in new BasicSetup {
+      config =
+        """
+          |cache_control: public, no-transform, max-age=1200, s-maxage=1200
+          |s3_key_prefix: foo
+        """.stripMargin
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("public, no-transform, max-age=1200, s-maxage=1200")
+    }
+
     "should take precedence over max_age" in new BasicSetup {
       config = """
                  |max_age: 120
@@ -557,6 +704,29 @@ class S3WebsiteSpec extends Specification {
       setLocalFile("tags/笔记/index.html")
       push() must equalTo(0)
     }
+
+    "have overlapping definitions in the glob, and then the most specific glob will win" in new BasicSetup {
+      config = """
+                 |cache_control:
+                 |  "*.js": no-cache, no-store
+                 |  "assets/**/*.js": public, must-revalidate, max-age=120
+               """.stripMargin
+      setLocalFile("assets/lib/jquery.js")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("public, must-revalidate, max-age=120")
+    }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config =
+        """
+          |cache_control:
+          |  "*.html": public, no-transform, max-age=1200, s-maxage=1200
+          |s3_key_prefix: foo
+        """.stripMargin
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("public, no-transform, max-age=1200, s-maxage=1200")
+    }
   }
 
   "cache control" can {
@@ -575,6 +745,17 @@ class S3WebsiteSpec extends Specification {
       sentPutObjectRequest.getMetadata.getCacheControl must equalTo("max-age=60")
     }
 
+    "work with s3_key_prefix" in new BasicSetup {
+      config =
+        """
+          |max_age: 60
+          |s3_key_prefix: test
+        """.stripMargin
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("max-age=60")
+    }
+
     "supports all valid URI characters in the glob setting" in new BasicSetup {
       config = """
         |max_age:
@@ -631,20 +812,41 @@ class S3WebsiteSpec extends Specification {
       setLocalFile("tags/笔记/index.html")
       push() must equalTo(0)
     }
-  }
 
-  "max-age in config" should {
+    "have overlapping definitions in the glob, and then the most specific glob will win" in new BasicSetup {
+      config = """
+                 |max_age:
+                 |  "*.js": 33
+                 |  "assets/**/*.js": 90
+               """.stripMargin
+      setLocalFile("assets/lib/jquery.js")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("max-age=90")
+    }
+
     "respect the more specific glob" in new BasicSetup {
       config = """
-        |max_age:
-        |  "assets/*": 150
-        |  "assets/*.gif": 86400
-      """.stripMargin
+                 |max_age:
+                 |  "assets/*": 150
+                 |  "assets/*.gif": 86400
+               """.stripMargin
       setLocalFiles("assets/jquery.js", "assets/picture.gif")
       push()
       sentPutObjectRequests.find(_.getKey == "assets/jquery.js").get.getMetadata.getCacheControl must equalTo("max-age=150")
       sentPutObjectRequests.find(_.getKey == "assets/picture.gif").get.getMetadata.getCacheControl must equalTo("max-age=86400")
     }
+
+    "work with s3_key_prefix" in new BasicSetup {
+      config =
+        """
+          |max_age:
+          |  "*.html": 60
+          |s3_key_prefix: test
+        """.stripMargin
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("max-age=60")
+    }
   }
 
   "s3_reduced_redundancy: true in config" should {
@@ -675,6 +877,28 @@ class S3WebsiteSpec extends Specification {
       sentPutObjectRequest.getRedirectLocation must equalTo("/index.html")
     }
 
+    "refer to site root when the s3_key_prefix is defined and the redirect target starts with a slash" in new BasicSetup {
+      config = """
+                 |s3_key_prefix: production
+                 |redirects:
+                 |  index.php: /index.html
+               """.stripMargin
+      push()
+      sentPutObjectRequest.getKey must equalTo("production/index.php")
+      sentPutObjectRequest.getRedirectLocation must equalTo("/index.html")
+    }
+
+    "use s3_key_prefix as the root when the redirect target does not start with a slash" in new BasicSetup {
+      config = """
+                 |s3_key_prefix: production
+                 |redirects:
+                 |  index.php: index.html
+               """.stripMargin
+      push()
+      sentPutObjectRequest.getKey must equalTo("production/index.php")
+      sentPutObjectRequest.getRedirectLocation must equalTo("/production/index.html")
+    }
+
     "add slash to the redirect target" in new BasicSetup {
       config = """
                  |redirects:
@@ -987,7 +1211,7 @@ class S3WebsiteSpec extends Specification {
 
     def setS3Files(s3Files: S3File*) {
       s3Files.foreach { s3File =>
-        setS3File(s3File.s3Key, s3File.md5)
+        setS3File(s3File.s3Key.key, s3File.md5)
       }
     }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_website
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 2.11.0
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor