s3_website 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee583948eaac40a396bdd7dcce3ac0f17b026b53
-  data.tar.gz: fb3b7ff28372c6844d2c637f59b8fbc1a08a112e
+  metadata.gz: a869e0bbb5276a123020d7ae96f52d729d56b166
+  data.tar.gz: b6b51944723aaf3f1c22f949a56261137cc74dcc
 SHA512:
-  metadata.gz: a06324e37ab33faa10ca761537336020dc2c712b980facfad0aece7fc3c010fafb1c2782c4878a5b566a85d3f5ca357756abfe9f1207847f3cd1b93ec7b23336
-  data.tar.gz: b7db3637d2582366540f0938f8fe3608340b1b74ff6ba308db40da17f794061fd382dedcdde8af090ac1713f182e27c2c5161bd8c7333dd25c993e3a025556d4
+  metadata.gz: 2f3705e5c621c1b44225e8b3f7070496d59d258780f268b3d4183d709e5d988041d26d47a9a8bffdaac89d6f86c5b8e3caff99afafd18d1cfaa1f3cceb7ea99b
+  data.tar.gz: d13a8bd0492c4cc10e92bc4bd08ecf71eded8f0bac47ffa7bee15b9bd4909de2dcae7ce3e92d80aead594fcbe0eb13d747dc0fdf11517beb4f5b62397a5351f9

data/README.md

@@ -126,6 +126,15 @@ Here's an example:
 cache_control: public, no-transform, max-age=1200, s-maxage=1200
 ```
 
+You can also specify a hash of globs, and all files matching those globs will have
+the specified cache-control string:
+
+```yaml
+cache_control:
+  "assets/*": public, max-age=3600
+  "*": no-cache, no-store
+```
+
 After changing the `cache_control` setting, push with the `--force` option.
 Force-pushing allows you to update the S3 object metadata of existing files.
 

data/changelog.md

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

data/lib/s3_website/version.rb

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

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

@@ -72,7 +72,7 @@ object S3 {
           md setContentLength uploadFile.length
           md setContentType contentType
           upload.encodingOnS3.map(_ => "gzip") foreach md.setContentEncoding
-          val cacheControl: Option[String] = (upload.maxAge, config.cache_control) match {
+          val cacheControl: Option[String] = (upload.maxAge, upload.cacheControl) match {
             case (maxAge: Some[Int], cacheCtrl: Some[String]) =>
               logger.warn("Overriding the max_age setting with the cache_control setting")
               cacheCtrl

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

@@ -15,7 +15,7 @@ case class Config(
   s3_endpoint:                S3Endpoint,
   site:                       Option[String],
   max_age:                    Option[Either[Int, Map[String, Int]]],
-  cache_control:              Option[String],
+  cache_control:              Option[Either[String, Map[String, String]]],
   gzip:                       Option[Either[Boolean, Seq[String]]],
   gzip_zopfli:                Option[Boolean],
   ignore_on_server:           Option[Either[String, Seq[String]]],
@@ -83,6 +83,20 @@ object Config {
     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]]]] = {
+    val key = "cache_control"
+    val yamlValue = for {
+      cacheControlOption <- loadOptionalValue(key)
+    } yield {
+        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
+        })
+      }
+
+    yamlValue getOrElse Left(ErrorReport(s"The key $key has to have a string or (string -> string) value"))
+  }
+
   def loadEndpoint(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[S3Endpoint]] =
     loadOptionalString("s3_endpoint").right flatMap { endpointString =>
       endpointString.map(S3Endpoint.forString) match {

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

@@ -40,7 +40,7 @@ object Site {
           s3_endpoint <- loadEndpoint.right
           site <- loadOptionalString("site").right
           max_age <- loadMaxAge.right
-          cache_control <- loadOptionalString("cache_control").right
+          cache_control <- loadCacheControl.right
           gzip <- loadOptionalBooleanOrStringSeq("gzip").right
           gzip_zopfli <- loadOptionalBoolean("gzip_zopfli").right
           extensionless_mime_type <- loadOptionalString("extensionless_mime_type").right

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

@@ -94,6 +94,29 @@ case class Upload(originalFile: File, uploadType: UploadType)(implicit site: Sit
     }
   }
 
+  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)
+          }
+        )
+    }
+  }
+
   /**
    * May throw an exception, so remember to call this in a Try or Future monad
    */

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

@@ -507,6 +507,56 @@ class S3WebsiteSpec extends Specification {
       ))
       logEntries must contain("[\u001B[33mwarn\u001B[0m] Overriding the max_age setting with the cache_control settin")
     }
+
+    "supports all valid URI characters in the glob setting" in new BasicSetup {
+      config = """
+                 |cache_control:
+                 |  "*.html": public, max-age=120
+               """.stripMargin
+      val allValidUrlCharacters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~:/?#[]@!$&'()*+,;=" // See http://stackoverflow.com/a/1547940/990356 for discussion
+      setLocalFile(s"$allValidUrlCharacters.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("public, max-age=120")
+    }
+
+    "be applied to files that match the glob" in new BasicSetup {
+      config = """
+                 |cache_control:
+                 |  "*.html": no-store
+               """.stripMargin
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("no-store")
+    }
+
+    "be applied to directories that match the glob" in new BasicSetup {
+      config = """
+                 |cache_control:
+                 |  "assets/**/*.js": no-cache, no-store
+               """.stripMargin
+      setLocalFile("assets/lib/jquery.js")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must equalTo("no-cache, no-store")
+    }
+
+    "not be applied if the glob doesn't match" in new BasicSetup {
+      config = """
+                 |cache_control:
+                 |  "*.js": max-age=120
+               """.stripMargin
+      setLocalFile("index.html")
+      push()
+      sentPutObjectRequest.getMetadata.getCacheControl must beNull
+    }
+
+    "support non-US-ASCII directory names"  in new BasicSetup {
+      config = """
+                 |cache_control:
+                 |  "*": no-cache
+               """.stripMargin
+      setLocalFile("tags/笔记/index.html")
+      push() must equalTo(0)
+    }
   }
 
   "cache control" can {

metadata

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