s3_website 2.8.6 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 147c1079964479122eef8b8c049d8c14795b7605
-  data.tar.gz: 4fac5c7fe84796797d2a242656f504be508caa52
+  metadata.gz: ee583948eaac40a396bdd7dcce3ac0f17b026b53
+  data.tar.gz: fb3b7ff28372c6844d2c637f59b8fbc1a08a112e
 SHA512:
-  metadata.gz: df826a2926ecb33997c516c8dcf4f9a8af7f92a05cd0f1af5c18b7b8c860781a784c160ad139d5f7c927a23820e3bf72bd6235d74ce62c13b59cef445594c85e
-  data.tar.gz: 796902606cb3a9c1aec1fb69a76decdbf6919b8bcfde45708444dc23dbefa964133b9b12d247dc2969bac9691375c9553fc65c561ddeadc21a0852d365055b20
+  metadata.gz: a06324e37ab33faa10ca761537336020dc2c712b980facfad0aece7fc3c010fafb1c2782c4878a5b566a85d3f5ca357756abfe9f1207847f3cd1b93ec7b23336
+  data.tar.gz: b7db3637d2582366540f0938f8fe3608340b1b74ff6ba308db40da17f794061fd382dedcdde8af090ac1713f182e27c2c5161bd8c7333dd25c993e3a025556d4

data/README.md

@@ -91,8 +91,12 @@ incomprehensible or inconsistent.
 
 ### Cache Control
 
-You can use the `max_age` configuration option to enable more effective browser
-caching of your static assets. There are two possible ways to use the option:
+You can use either the setting `max_age` or `cache_control`to enable more 
+effective browser caching of your static assets. 
+
+#### max_age
+
+There are two possible ways to use the option:
 you can specify a single age (in seconds) like so:
 
 ```yaml
@@ -108,11 +112,23 @@ max_age:
   "*": 300
 ```
 
-Place the configuration into the file `s3_website.yml`.
-
 After changing the `max_age` setting, push with the `--force` option.
 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 
+will put on all the S3 objects of your website.
+  
+Here's an example:  
+
+```yaml
+cache_control: public, no-transform, max-age=1200, s-maxage=1200
+```
+
+After changing the `cache_control` setting, push with the `--force` option.
+Force-pushing allows you to update the S3 object metadata of existing files.
+
 ### Gzip Compression
 
 If you choose, you can use compress certain file types before uploading them to
@@ -157,6 +173,8 @@ s3_endpoint: ap-northeast-1
 The valid `s3_endpoint` values consist of the [S3 location constraint
 values](http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region).
 
+Note that at the moment s3_website does not support the *eu-central-1* region.
+
 ### Ignoring files you want to keep on AWS
 
 Sometimes there are files or directories you want to keep on S3, but not on

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 2.9.0
+
+* Add setting `cache_control`
+
 ## 2.8.6
 
 * Detect changed file even though the file has the same contents with another file on the S3 bucket

data/lib/s3_website/version.rb

@@ -1,3 +1,3 @@
 module S3Website
-  VERSION = '2.8.6'
+  VERSION = '2.9.0'
 end

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

@@ -4,6 +4,7 @@ class Logger(val verboseOutput: Boolean, onLog: Option[(String) => _] = None) {
   def debug(msg: String) = if (verboseOutput) log(Debug, msg)
   def info(msg: String) = log(Info, msg)
   def fail(msg: String) = log(Failure, msg)
+  def warn(msg: String) = log(Warn, msg)
 
   def info(report: SuccessReport) = log(Success, report.reportMessage)
   def info(report: ErrorReport) = fail(report.reportMessage)
@@ -36,6 +37,9 @@ class Logger(val verboseOutput: Boolean, onLog: Option[(String) => _] = None) {
   case object Wait extends LogType {
     val prefix = "wait".yellow
   }
+  case object Warn extends LogType {
+    val prefix = "warn".yellow
+  }
 
   /**
    * Idea copied from https://github.com/ktoso/scala-rainbow.

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

@@ -61,7 +61,7 @@ object S3 {
       retryAction  = newAttempt => this.delete(s3Key, newAttempt)
     )
 
-  def toPutObjectRequest(source: Either[Upload, Redirect])(implicit config: Config): Try[PutObjectRequest] =
+  def toPutObjectRequest(source: Either[Upload, Redirect])(implicit config: Config, logger: Logger): Try[PutObjectRequest] =
     source.fold(
       upload =>
         for {
@@ -72,14 +72,20 @@ object S3 {
           md setContentLength uploadFile.length
           md setContentType contentType
           upload.encodingOnS3.map(_ => "gzip") foreach md.setContentEncoding
-          upload.maxAge foreach { seconds =>
-            md.setCacheControl(
-              if (seconds == 0)
-                s"no-cache; max-age=$seconds"
-              else
-                s"max-age=$seconds"
-            )
+          val cacheControl: Option[String] = (upload.maxAge, config.cache_control) match {
+            case (maxAge: Some[Int], cacheCtrl: Some[String]) =>
+              logger.warn("Overriding the max_age setting with the cache_control setting")
+              cacheCtrl
+            case (_, cacheCtrl: Some[String]) =>
+              cacheCtrl
+            case (maxAgeSeconds: Some[int], None) =>
+              maxAgeSeconds.map({
+                case seconds if seconds == 0 => s"no-cache; max-age=0"
+                case seconds                 => s"max-age=$seconds"
+              })
+            case (None, None) => None
           }
+          cacheControl foreach { md.setCacheControl }
           val req = new PutObjectRequest(config.s3_bucket, upload.s3Key, new FileInputStream(uploadFile), md)
           config.s3_reduced_redundancy.filter(_ == true) foreach (_ => req setStorageClass ReducedRedundancy)
           req

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

@@ -15,6 +15,7 @@ case class Config(
   s3_endpoint:                S3Endpoint,
   site:                       Option[String],
   max_age:                    Option[Either[Int, Map[String, Int]]],
+  cache_control:              Option[String],
   gzip:                       Option[Either[Boolean, Seq[String]]],
   gzip_zopfli:                Option[Boolean],
   ignore_on_server:           Option[Either[String, Seq[String]]],

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

@@ -40,6 +40,7 @@ object Site {
           s3_endpoint <- loadEndpoint.right
           site <- loadOptionalString("site").right
           max_age <- loadMaxAge.right
+          cache_control <- loadOptionalString("cache_control").right
           gzip <- loadOptionalBooleanOrStringSeq("gzip").right
           gzip_zopfli <- loadOptionalBoolean("gzip_zopfli").right
           extensionless_mime_type <- loadOptionalString("extensionless_mime_type").right
@@ -66,6 +67,7 @@ object Site {
             s3_endpoint getOrElse S3Endpoint.defaultEndpoint,
             site,
             max_age,
+            cache_control,
             gzip,
             gzip_zopfli,
             ignore_on_server = ignore_on_server,

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

@@ -477,6 +477,46 @@ class S3WebsiteSpec extends Specification {
     }
   }
 
+  "cache_control in config" should {
+    "be applied to all files" in new BasicSetup {
+      config = "cache_control: public, no-transform, max-age=1200, s-maxage=1200"
+      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
+                 |cache_control: public, max-age=90
+               """.stripMargin
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("public, max-age=90")
+    }
+
+    "log a warning if both cache_control and max_age are present" in new BasicSetup {
+      val logEntries = new mutable.MutableList[String]
+      config = """
+                 |max_age: 120
+                 |cache_control: public, max-age=90
+               """.stripMargin
+      setLocalFile("index.html")
+      push(logCapturer = Some((logEntry: String) =>
+        logEntries += logEntry
+      ))
+      logEntries must contain("[\u001B[33mwarn\u001B[0m] Overriding the max_age setting with the cache_control settin")
+    }
+  }
+
+  "cache control" can {
+    "be undefined" in new BasicSetup {
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must beNull
+    }
+  }
+
   "max_age in config" can {
     "be applied to all files" in new BasicSetup {
       config = "max_age: 60"

metadata

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