s3_website_monadic 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e02998ffcdd53134cc43365b7d958d6e5ac84d8
-  data.tar.gz: 06f5c5be34c990d4d8cef7fc03ed6993680a833c
+  metadata.gz: 68d01d8499eba5c41c9b42d0d6ead9ea5386590a
+  data.tar.gz: 5a6381dfa127b1f824c1ded97efe0cb390b179ec
 SHA512:
-  metadata.gz: 8fd0bfa68863f8c6ac38bf2292deed7e6096e92625905dbf03e92af8c377e120d434e17c657361215ca692b6ba7c67d8efdf4a140b31ce8ba483916cfb5f00d0
-  data.tar.gz: 0df2a5712cf8fcbb144f586158fe7a6560566907b1864fe6d604c4de2775c43215eb460702bcebffbcc579d283187d450e3c55c317d73472924fb6afcc6f9a4e
+  metadata.gz: 1e35433d2fb1ad9ce6f737dcfaba2e0b49ca02ab57ae1092e7370ede5e5b50292e19b50236dff44cf5d8ceb76460ccb25a5c1fd15b78e886954616f037ebdafc
+  data.tar.gz: 9bcc6e4226a57017089ddd4e65918a53eee9f3fd3bf3b2c7a2d93542de249fdb4e0c51b762875d2615168721cbcbb847aac31126d23605afe8e46ee7bedca72d

data/s3_website.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "s3_website_monadic"
-  s.version     = "0.0.14"
+  s.version     = "0.0.15"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Lauri Lehmijoki"]
   s.email       = ["lauri.lehmijoki@iki.fi"]

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

@@ -61,7 +61,7 @@ object CloudFront {
   type CloudFrontClientProvider = (Config) => AmazonCloudFront
 
   case class SuccessfulInvalidation(invalidatedItemsCount: Int) extends SuccessReport {
-    def reportMessage = s"Invalidated ${countToString(invalidatedItemsCount, "item")} on CloudFront"
+    def reportMessage = s"Invalidated ${invalidatedItemsCount ofType "item"} on CloudFront"
   }
 
   case class FailedInvalidation(error: Throwable) extends FailureReport {
@@ -71,18 +71,36 @@ object CloudFront {
   def awsCloudFrontClient(config: Config) =
     new AmazonCloudFrontClient(new BasicAWSCredentials(config.s3_id, config.s3_secret))
   
-  def toInvalidationBatches(pushSuccessReports: Seq[PushSuccessReport])(implicit config: Config): Seq[InvalidationBatch] =
-    pushSuccessReports
-      .filter(needsInvalidation) // Assume that redirect objects are never cached.
-      .map(toInvalidationPath)
-      .map (applyInvalidateRootSetting)
+  def toInvalidationBatches(pushSuccessReports: Seq[PushSuccessReport])(implicit config: Config): Seq[InvalidationBatch] = {
+    val invalidationPaths: Seq[String] = {
+      def withDefaultPathIfNeeded(paths: Seq[String]) = {
+        // This is how we support the Default Root Object @ CloudFront (http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html)
+        // We do this more accurately by fetching the distribution config (http://docs.aws.amazon.com/AmazonCloudFront/latest/APIReference/GetConfig.html)
+        // and reading the Default Root Object from there.
+        val containsPotentialDefaultRootObject = paths
+          .exists(
+            _
+              .replaceFirst("^/", "") // S3 keys do not begin with a slash
+              .contains("/") == false // See if the S3 key is a top-level key (i.e., it is not within a directory)
+          )
+        if (containsPotentialDefaultRootObject) paths :+ "/" else paths
+      }
+      val paths = pushSuccessReports
+        .filter(needsInvalidation) // Assume that redirect objects are never cached.
+        .map(toInvalidationPath)
+        .map (applyInvalidateRootSetting)
+      withDefaultPathIfNeeded(paths)
+    }
+
+    invalidationPaths
       .grouped(1000) // CloudFront supports max 1000 invalidations in one request (http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#InvalidationLimits)
       .map { batchKeys =>
         new InvalidationBatch() withPaths
           (new Paths() withItems batchKeys withQuantity batchKeys.size) withCallerReference
-            s"s3_website gem ${System.currentTimeMillis()}"
+          s"s3_website gem ${System.currentTimeMillis()}"
       }
       .toSeq
+  }
 
   def applyInvalidateRootSetting(path: String)(implicit config: Config) =
     if (config.cloudfront_invalidate_root.exists(_ == true))

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

@@ -156,11 +156,11 @@ object Push {
           "There was nothing to push."
       case PushCounts(updates, newFiles, failures, redirects, deletes) =>
         val reportClauses: scala.collection.mutable.ArrayBuffer[String] = ArrayBuffer()
-        if (updates > 0)   reportClauses += s"Updated ${countToString(updates, "file")}."
-        if (newFiles > 0)  reportClauses += s"Created ${countToString(newFiles, "file")}."
-        if (failures > 0)  reportClauses += s"${countToString(failures, "operation")} failed." // This includes both failed uploads and deletes.
-        if (redirects > 0) reportClauses += s"Applied ${countToString(redirects, "redirect")}."
-        if (deletes > 0)   reportClauses += s"Deleted ${countToString(deletes, "file")}."
+        if (updates > 0)   reportClauses += s"Updated ${updates ofType "file"}."
+        if (newFiles > 0)  reportClauses += s"Created ${newFiles ofType "file"}."
+        if (failures > 0)  reportClauses += s"${failures ofType "operation"} failed." // This includes both failed uploads and deletes.
+        if (redirects > 0) reportClauses += s"Applied ${redirects ofType "redirect"}."
+        if (deletes > 0)   reportClauses += s"Deleted ${deletes ofType "file"}."
         reportClauses.mkString(" ")
     }
 

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

@@ -51,8 +51,12 @@ package object website {
     httpStatusCode.exists(c => c >= 400 && c < 500)
   }
   
-  def countToString(count: Int, singular: String) = {
-    def plural = s"${singular}s"
-    s"$count ${if (count > 1) plural else singular}"
+  implicit class NumReport(val num: Int) extends AnyVal {
+    def ofType(itemType: String) = countToString(num, itemType)
+
+    private def countToString(count: Int, singular: String) = {
+      def plural = s"${singular}s"
+      s"$count ${if (count > 1) plural else singular}"
+    }
   }
 }

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

@@ -136,11 +136,11 @@ class S3WebsiteSpec extends Specification {
     "invalidate the updated CloudFront items" in new SiteDirectory with MockAWS {
       implicit val site = siteWithFiles(
         config = defaultConfig.copy(cloudfront_distribution_id = Some("EGM1J2JJX9Z")),
-        localFiles = "test.css" :: "articles/index.html" :: Nil
+        localFiles = "css/test.css" :: "articles/index.html" :: Nil
       )
-      setOutdatedS3Keys("test.css", "articles/index.html")
+      setOutdatedS3Keys("css/test.css", "articles/index.html")
       Push.pushSite
-      sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/test.css" :: "/articles/index.html" :: Nil).sorted)
+      sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/css/test.css" :: "/articles/index.html" :: Nil).sorted)
     }
 
     "not send CloudFront invalidation requests on new objects"  in new SiteDirectory with MockAWS {
@@ -191,23 +191,37 @@ class S3WebsiteSpec extends Specification {
       Push.pushSite
       sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/articles/arnold's%20file.html" :: Nil).sorted)
     }
+
+    /*
+     * Because CloudFront supports Default Root Objects (http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html),
+     * we have to guess
+     */
+    "invalidate the root object '/' if a top-level object is updated or deleted" in new SiteDirectory with MockAWS {
+      implicit val site = siteWithFiles(
+        config = defaultConfig.copy(cloudfront_distribution_id = Some("EGM1J2JJX9Z")),
+        localFiles = "maybe-index.html" :: Nil
+      )
+      setOutdatedS3Keys("maybe-index.html")
+      Push.pushSite
+      sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/" :: "/maybe-index.html" :: Nil).sorted)
+    }
   }
 
   "cloudfront_invalidate_root: true" should {
     "convert CloudFront invalidation paths with the '/index.html' suffix into '/'"  in new SiteDirectory with MockAWS {
       implicit val site = siteWithFiles(
         config = defaultConfig.copy(cloudfront_distribution_id = Some("EGM1J2JJX9Z"), cloudfront_invalidate_root = Some(true)),
-        localFiles = "index.html" :: "articles/index.html" :: Nil
+        localFiles = "articles/index.html" :: Nil
       )
-      setOutdatedS3Keys("index.html", "articles/index.html")
+      setOutdatedS3Keys("articles/index.html")
       Push.pushSite
-      sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/" :: "/articles/" :: Nil).sorted)
+      sentInvalidationRequest.getInvalidationBatch.getPaths.getItems.toSeq.sorted must equalTo(("/articles/" :: Nil).sorted)
     }
   }
 
   "a site with over 1000 items" should {
     "split the CloudFront invalidation requests into batches of 1000 items" in new SiteDirectory with MockAWS {
-      val files = (1 to 1002).map { i => s"file-$i"}
+      val files = (1 to 1002).map { i => s"lots-of-files/file-$i"}
       implicit val site = siteWithFiles(
         config = defaultConfig.copy(cloudfront_distribution_id = Some("EGM1J2JJX9Z")),
         localFiles = files

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_website_monadic
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk