s3_website 2.14.3 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12868fe79f5723e84fb08c7e73d8349fedceb99e
-  data.tar.gz: 54a74071dc921c0427c42776bf0bfb103740b349
+  metadata.gz: 3817c71cb9e62df94035abdb0c2a82518086f31f
+  data.tar.gz: f865711262a86542bbbbe79889fed47695f00ced
 SHA512:
-  metadata.gz: d4ab32468213f00239e201c02bd0cf102e893576ca5772589b66fb0231225c2e0386b1c8251e4deed5c16f0aa4a1e1310fe11b2936b4d3b13e5306cc99a8b0c4
-  data.tar.gz: 4c95f59e5f2cf98e1481b136cd09109ec772cca2bd82bbdf7e2a3f8e5127478818e44bc36d098e41e039f84bfd36cc78016b606074e3546f7c255defd5b17d99
+  metadata.gz: b8fdf4cc12c1e05ed5189e1ad0e447e83794c510f7347786eca40cc08d22336fafb6f5d88a439451f7fd7d1002529b8aab9407c064f065993c991b8d43cae4ee
+  data.tar.gz: 462f392810758a973b71aece6a052651d95978b98740ae421cb6b35373c5167bcccf31e4d1d19ee4643ba3a83335714dafd3fe551c1cf4b55e621e8d41e809c8

data/README.md

@@ -146,6 +146,18 @@ cache_control:
 After changing the `cache_control` setting, push with the `--force` option.
 Force-pushing allows you to update the S3 object metadata of existing files.
 
+### Content type detection
+
+By default, s3_website automatically detects the content type of a file with the help of Apache Tika.
+
+For some file types Tika's auto detection does not work correctly. Should this problem affect you, use the `content_type`
+setting to override Tika's decision:
+
+```yaml
+content_type:
+  "*.myextension": application/my-custom-type
+```
+
 ### Gzip Compression
 
 If you choose, you can use compress certain file types before uploading them to
@@ -513,42 +525,7 @@ Creux](https://github.com/pcreux) on
 [jekyll-s3](https://github.com/laurilehmijoki/jekyll-s3), this project would not
 exist.
 
-Contributors (in alphabetical order)
-* Akshay Karle
-* Alan deLevie
-* Almir Sarajčić
-* Andrew T. Baker
-* Cory Kaufman-Schofield
-* Chris Kelly
-* Chris Moos
-* Christian Grobmeier
-* Christopher Petersen
-* David Michael Barr
-* David Raffensperger
-* Douglas Teoh
-* Greg Karékinian
-* Ian Hattendorf
-* John Allison
-* Jon Frisby
-* Jordan White
-* Justin Latimer
-* László Bácsi
-* Mason Turner
-* Michael Bleigh
-* maxberger
-* Philip I. Thomas
-* Philippe Creux
-* Piotr Janik
-* PJ Kelly
-* Rodrigo Reis
-* Ross Hunter
-* Shigeaki Matsumura
-* stanislas
-* Tate Johnson
-* Toby Marsden
-* Tom Bell
-* Trevor Fitzgerald
-* Zee Spencer
+See the [Contributors](https://github.com/laurilehmijoki/s3_website/graphs/contributors).
 
 ## Community articles
 

data/changelog.md

@@ -2,9 +2,15 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 2.15.0
+
+* Add new setting `content_type`
+ 
+  See <https://github.com/laurilehmijoki/s3_website/issues/232> for discussion
+
 ## 2.14.3
 
-  Fix mime type of an already-gzipped .json file
+* Fix mime type of an already-gzipped .json file
   
   See <https://github.com/laurilehmijoki/s3_website/pull/231>
 

data/lib/s3_website/version.rb

@@ -1,3 +1,3 @@
 module S3Website
-  VERSION = '2.14.3'
+  VERSION = '2.15.0'
 end

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

@@ -26,6 +26,7 @@ case class Config(
   s3_reduced_redundancy:                  Option[Boolean],
   cloudfront_distribution_id:             Option[String],
   cloudfront_invalidate_root:             Option[Boolean],
+  content_type:                           Option[S3KeyGlob[String]],
   redirects:                              Option[Map[S3Key, String]],
   concurrency_level:                      Int,
   cloudfront_wildcard_invalidation:       Option[Boolean],
@@ -112,6 +113,23 @@ object Config {
     yamlValue getOrElse Left(ErrorReport(s"The key $key has to have a string or (string -> string) value"))
   }
 
+  def loadContentType(implicit unsafeYaml: UnsafeYaml): Either[ErrorReport, Option[S3KeyGlob[String]]] = {
+    val key = "content_type"
+    val yamlValue = for {
+      contentTypeOption <- loadOptionalValue(key)
+    } yield {
+      // TODO below we are using an unsafe call to asInstance of – we should implement error handling
+      Right(contentTypeOption.map { xs =>
+          val globs: Map[String, String] = xs.asInstanceOf[util.Map[String, String]].toMap
+          S3KeyGlob(globs)
+        }
+      )
+    }
+
+    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

@@ -49,6 +49,7 @@ object Site {
           s3_reduced_redundancy <- loadOptionalBoolean("s3_reduced_redundancy").right
           cloudfront_distribution_id <- loadOptionalString("cloudfront_distribution_id").right
           cloudfront_invalidate_root <- loadOptionalBoolean("cloudfront_invalidate_root").right
+          content_type <- loadContentType.right
           concurrency_level <- loadOptionalInt("concurrency_level").right
           cloudfront_wildcard_invalidation <- loadOptionalBoolean("cloudfront_wildcard_invalidation").right
           redirects <- loadRedirects(s3_key_prefix).right
@@ -77,6 +78,7 @@ object Site {
             s3_reduced_redundancy,
             cloudfront_distribution_id,
             cloudfront_invalidate_root,
+            content_type,
             redirects,
             concurrency_level.fold(20)(_ max 20),
             cloudfront_wildcard_invalidation,

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

@@ -74,7 +74,10 @@ case class Upload(originalFile: File, uploadType: UploadType)(implicit site: Sit
       } else {
         originalFile
       }
-    val mimeType = tika.detect(file)
+    val mimeType =
+      site.config.content_type
+        .flatMap { _.globMatch(s3Key) }
+        .getOrElse { tika.detect(file) }
     if (mimeType.startsWith("text/") || mimeType == "application/json")
       mimeType + "; charset=utf-8"
     else

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

@@ -1052,6 +1052,18 @@ class S3WebsiteSpec extends Specification {
     }
   }
 
+  "content_type in config file" should {
+    "override tika's opinion"  in new BasicSetup {
+      config = """
+                 |content_type:
+                 |  "*.html": text/foobar
+               """.stripMargin
+      setLocalFileWithContent(("index.html", "<html><body><h1>hi</h1></body></html>"))
+      push()
+      sentPutObjectRequest.getMetadata.getContentType must equalTo("text/foobar; charset=utf-8")
+    }
+  }
+
   "ERB in config file" should {
     "be evaluated"  in new BasicSetup {
       config = """

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_website
 version: !ruby/object:Gem::Version
-  version: 2.14.3
+  version: 2.15.0
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-06 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor