s3_website 1.6.5 → 1.6.6

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: f01a1cadbd9a8dcf5ff073f3b84ae1eca69d4fd3
-  data.tar.gz: 51193b4ace5ef371448d4378f67f0caa0ced7ff2
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDYyZDQwYWE3MDMzYmQ1ZjBmY2RjNjg5OTMzMjA1YjYwM2NjOGFjNA==
+  data.tar.gz: !binary |-
+    MGRhNmEyZDhiYmQ5ZTIwNGNlYmMyOTFiOTYwOWJjMTJjOWMzZTU1YQ==
 SHA512:
-  metadata.gz: b7943e03d17a5a5291eed51841434fb01d9fcdaa9e0d5e3dd87a697c2460060d209681f7a2c03df7a0a75dbc563365f3e9257d760921362575597c57160c825e
-  data.tar.gz: b5b10a4c5d399ec341e7f1051d652a85991f93aeb5ede93ce2fa360a4e62857b4158877777ffdb1deab34b1a5d82f37cba60986eb2bcb60d8dacbd8b2533cee9
+  metadata.gz: !binary |-
+    MTU4NGIzMDIxYjQxYTMzMzFiNWZmZDQ0MjQxOTY2MmNiNWY3YjExOTRmMzUy
+    MGM2ZjJiZWY4ZjZlMzQzODIxMzgzMTQyMzE3NDU1M2M1MzNhZGNkODdhZjU2
+    ZDQ4OTFhMDI2ZGI5NTcwMDdkM2ExYTI3YmI0NDViZDUwOWE1ZGE=
+  data.tar.gz: !binary |-
+    MmNiN2Q5OTdiNzQ5NzUxNTU4YTU0ZThjODA4NzAxNTE3MzhhMGM4ZmU3MDRh
+    MWEyMzNkOGY4YjRmNGEwNmI2NjZjZDRmMDZhMDcxOGUxMDQzYzkzOTdjMmI1
+    YmQwMjhhNmY2MzQ3YzgwMGEyMzhlZDY5YzZlMTc1ZTY4ZGU2ZjU=

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 1.6.6
+
+* Mark all text documents as UTF-8 encoded
+
 ## 1.6.5
 
 * In case of error, exit with status 1

data/features/support/test_site_dirs/site-with-text-doc.com/_site/file.txt

@@ -0,0 +1 @@
+hello world

data/lib/s3_website/upload.rb

@@ -67,18 +67,23 @@ module S3Website
     end
 
     def upload_options
-      opts = {
-        :content_type => mime_type,
-        :reduced_redundancy => config['s3_reduced_redundancy']
-      }
-
-      opts[:content_type] = "text/html; charset=utf-8" if mime_type == 'text/html'
+      opts = {}
+      opts[:reduced_redundancy] = config['s3_reduced_redundancy']
+      opts[:content_type] = resolve_content_type
       opts[:content_encoding] = "gzip" if gzip?
       opts[:cache_control] = cache_control_value if cache_control?
-
       opts
     end
 
+    def resolve_content_type
+      is_text = mime_type.start_with? 'text/' || mime_type == 'application/json'
+      if is_text
+        "#{mime_type}; charset=utf-8" # Let's consider UTF-8 as the de-facto encoding standard for text
+      else
+        mime_type
+      end
+    end
+
     def cache_control_value
       if max_age == 0
         "no-cache, max-age=0"
@@ -120,7 +125,7 @@ module S3Website
       if !!config['extensionless_mime_type'] && File.extname(path) == ""
         config['extensionless_mime_type']
       else
-        MIME::Types.type_for(path).first
+        MIME::Types.type_for(path).first.to_s
       end
     end
   end

data/s3_website.gemspec

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

data/spec/lib/upload_spec.rb

@@ -50,78 +50,70 @@ describe S3Website::Upload do
     }
 
     it 'allows storing a file under the Reduced Redundancy Storage' do
-      file_to_upload = 'index.html'
-      s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+      should_upload(
+        file = 'index.html',
+        site = 'features/support/test_site_dirs/my.blog.com/_site', config) { |s3_object|
         s3_object.should_receive(:write).with(
           anything(),
-          :content_type => 'text/html; charset=utf-8',
-          :reduced_redundancy => true
+          include(:reduced_redundancy => true)
         )
-      end
-      S3Website::Upload.new(file_to_upload,
-                             s3_client,
-                             config,
-                             'features/support/test_site_dirs/my.blog.com/_site').perform!
+      }
     end
   end
 
   describe 'content type resolving' do
-    let(:config) {
-      { 's3_reduced_redundancy' => false }
-    }
-
     it 'adds the content type of the uploaded CSS file into the S3 object' do
-      file_to_upload = 'css/styles.css'
-      s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+      should_upload(
+        file = 'css/styles.css',
+        site = 'features/support/test_site_dirs/my.blog.com/_site') { |s3_object|
         s3_object.should_receive(:write).with(
           anything(),
-          :content_type => 'text/css',
-          :reduced_redundancy => false
+          include(:content_type => 'text/css; charset=utf-8')
         )
-      end
-      S3Website::Upload.new(file_to_upload,
-                             s3_client,
-                             config,
-                             'features/support/test_site_dirs/my.blog.com/_site').perform!
+      }
     end
 
     it 'adds the content type of the uploaded HTML file into the S3 object' do
-      file_to_upload = 'index.html'
-      s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+      should_upload(
+        file = 'index.html',
+        site = 'features/support/test_site_dirs/my.blog.com/_site') { |s3_object|
         s3_object.should_receive(:write).with(
           anything(),
-          :content_type => 'text/html; charset=utf-8',
-          :reduced_redundancy => false
+          include(:content_type => 'text/html; charset=utf-8')
         )
+      }
+    end
+
+    describe 'encoding of text documents' do
+      it 'should mark all text documents as utf-8' do
+        should_upload(
+          file = 'file.txt',
+          site = 'features/support/test_site_dirs/site-with-text-doc.com/_site') { |s3_object|
+          s3_object.should_receive(:write).with(
+            anything(),
+            include(:content_type => 'text/plain; charset=utf-8')
+          )
+        }
       end
-      S3Website::Upload.new(file_to_upload,
-                             s3_client,
-                             config,
-                             'features/support/test_site_dirs/my.blog.com/_site').perform!
     end
 
     context 'the user specifies a mime-type for extensionless files' do
       let(:config) {{
-        'extensionless_mime_type' => "text/html",
-        's3_reduced_redundancy' => false
+        'extensionless_mime_type' => "text/html"
       }}
 
       it 'adds the content type of the uploaded extensionless file into the S3 object' do
-        file_to_upload = 'index'
-        s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+        should_upload(
+          file = 'index',
+          site = 'features/support/test_site_dirs/my.blog-with-clean-urls.com/_site',
+          config) { |s3_object|
           s3_object.should_receive(:write).with(
             anything(),
-            :content_type => 'text/html; charset=utf-8',
-            :reduced_redundancy => false
+            include(:content_type => 'text/html; charset=utf-8')
           )
-        end
-        S3Website::Upload.new(file_to_upload,
-                             s3_client,
-                             config,
-                             'features/support/test_site_dirs/my.blog-with-clean-urls.com/_site').perform!
+        }
       end
     end
-
   end
 
   describe 'gzip compression' do
@@ -256,26 +248,36 @@ describe S3Website::Upload do
     end
   end
 
-  def create_verifying_s3_client(file_to_upload, &block)
-    def create_objects(file_to_upload, &block)
-      def create_html_s3_object(file_to_upload, &block)
-        s3_object = stub('s3_object')
-        yield s3_object
-        s3_object
+  def should_upload(file_to_upload, site_dir, config = {})
+    def create_verifying_s3_client(file_to_upload, &block)
+      def create_objects(file_to_upload, &block)
+        def create_html_s3_object(file_to_upload, &block)
+          s3_object = stub('s3_object')
+          yield s3_object
+          s3_object
+        end
+        objects = {}
+        objects[file_to_upload] = create_html_s3_object(file_to_upload, &block)
+        objects
       end
-      objects = {}
-      objects[file_to_upload] = create_html_s3_object(file_to_upload, &block)
-      objects
+      def create_bucket(file_to_upload, &block)
+        bucket = stub('bucket')
+        bucket.stub(:objects => create_objects(file_to_upload, &block))
+        bucket
+      end
+      buckets = stub('buckets')
+      buckets.stub(:[] => create_bucket(file_to_upload, &block))
+      s3 = stub('s3')
+      s3.stub(:buckets => buckets)
+      s3
     end
-    def create_bucket(file_to_upload, &block)
-      bucket = stub('bucket')
-      bucket.stub(:objects => create_objects(file_to_upload, &block))
-      bucket
+
+    s3_client = create_verifying_s3_client(file_to_upload) do |s3_object|
+      yield s3_object
     end
-    buckets = stub('buckets')
-    buckets.stub(:[] => create_bucket(file_to_upload, &block))
-    s3 = stub('s3')
-    s3.stub(:buckets => buckets)
-    s3
+    S3Website::Upload.new(file_to_upload,
+                          s3_client,
+                          config,
+                          site_dir).perform!
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_website
 version: !ruby/object:Gem::Version
-  version: 1.6.5
+  version: 1.6.6
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-12 00:00:00.000000000 Z
+date: 2014-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -112,42 +112,42 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -168,14 +168,14 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -206,7 +206,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-description: "\n    Sync website files, set redirects, use HTTP performance optimisations,
+description: ! "\n    Sync website files, set redirects, use HTTP performance optimisations,
   deliver via\n    CloudFront.\n  "
 email:
 - lauri.lehmijoki@iki.fi
@@ -292,6 +292,7 @@ files:
 - features/support/test_site_dirs/only-changed-files.com/s3_website.yml
 - features/support/test_site_dirs/site-that-contains-s3-website-file.com/_site/s3_website.yml
 - features/support/test_site_dirs/site-that-contains-s3-website-file.com/s3_website.yml
+- features/support/test_site_dirs/site-with-text-doc.com/_site/file.txt
 - features/support/test_site_dirs/site.with.css-maxage.com/_site/css/styles.css
 - features/support/test_site_dirs/site.with.css-maxage.com/_site/index.html
 - features/support/test_site_dirs/site.with.css-maxage.com/s3_website.yml
@@ -354,17 +355,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Manage your S3 website
@@ -436,6 +437,7 @@ test_files:
 - features/support/test_site_dirs/only-changed-files.com/s3_website.yml
 - features/support/test_site_dirs/site-that-contains-s3-website-file.com/_site/s3_website.yml
 - features/support/test_site_dirs/site-that-contains-s3-website-file.com/s3_website.yml
+- features/support/test_site_dirs/site-with-text-doc.com/_site/file.txt
 - features/support/test_site_dirs/site.with.css-maxage.com/_site/css/styles.css
 - features/support/test_site_dirs/site.with.css-maxage.com/_site/index.html
 - features/support/test_site_dirs/site.with.css-maxage.com/s3_website.yml