asset_sync 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 629deff4029487b164c47ee0a479cf5111461a15
-  data.tar.gz: 06e62f086d0a574def1741993066f42cf11b96da
+  metadata.gz: b2b9e6c9d6ade5d65f516ee31d195c7feafc932f
+  data.tar.gz: 0ad6e154aafdbed6b570b31c07b5b8b317a5b41e
 SHA512:
-  metadata.gz: d37ddb643b78c91cdb24f1c8cf0fe3fb25162ace2c934eb6488ef8baf9eba8d080d892cdf85846eb0892677d58b2aea7b7a7baf3b35717de2082710d06ee8f75
-  data.tar.gz: fcb7bfb3c0a9b67fb341fb4eb8c4ca18e16e106e8eea852c150186685f59d75e97765246c90c2779feb4b4a1ebd707df9edc457a0db3fcf973e9994d0efce2e5
+  metadata.gz: b8ebe629fd1674e4d0834c472d5a376e100bc84230d06fa903a2034ab8b1fbfe7453986d6b495678465411bd52a853f8365053d892cf9432594236bacd1899cb
+  data.tar.gz: bacc8715e7117849d1f912882faff4519acb53431b4a3a4c858e6e9538f481027a7783e68a339b420210007dfc434af5dae7af44ff756836dfe15e51a4a7d8d5

data/.travis.yml

@@ -36,6 +36,7 @@ matrix:
     - rvm: 2.1.2
       gemfile: gemfiles/rails_4.1.gemfile
   allow_failures:
+    - rvm: 1.9.2
     - rvm: rbx-2
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,4 +1,41 @@
-# RELEASE HISTORY
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+
+## [Unreleased]
+
+### Added
+
+- Nothing
+
+### Changed
+
+- Nothing
+
+### Fixed
+
+- Nothing
+
+
+## [1.2.0] - 2016-08-17
+
+### Added
+
+- Support for `fog_path_style` config option (AWS only) (https://github.com/AssetSync/asset_sync/pull/302)
+
+### Changed
+
+- Set Expires and Cache-Control headers for .gz files (https://github.com/AssetSync/asset_sync/pull/329)
+
+### Fixed
+
+- Add missing runtime dependency declaration for `mime-types` to gemspec (https://github.com/AssetSync/asset_sync/pull/328)
+- Update outdated error message for unknown AssetSync provider (https://github.com/AssetSync/asset_sync/pull/298)
+- Allow hash digest in file name with over 32 chars (for sprockets 3+) (https://github.com/AssetSync/asset_sync/pull/315)
+- Fix `config.log_silently?` (https://github.com/AssetSync/asset_sync/pull/324)
+- Stop using deprecated Ruby API (https://github.com/AssetSync/asset_sync/pull/276)
+
 
 ## v1.1.0 / 2014-08-13
 
@@ -736,3 +773,6 @@ Changes:
     * Improve documentation on ignored_files config option
     * Merge branch 'sinatra'
 
+
+[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/AssetSync/asset_sync/compare/v1.1.0...v1.2.0

data/Gemfile

@@ -3,3 +3,4 @@ gemspec
 gem 'rcov',      :platforms => :mri_18, :group => [:development, :test]
 gem 'simplecov', :platforms => [:jruby, :mri_19, :ruby_19, :mri_20, :rbx], :group => [:development, :test], :require => false
 gem 'jruby-openssl', :platform => :jruby
+gem 'rails', '4.1.5'

data/README.md

@@ -1,5 +1,5 @@
 [![Build Status](https://secure.travis-ci.org/rumblelabs/asset_sync.png)](http://travis-ci.org/rumblelabs/asset_sync)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/rumblelabs/asset_sync)
+[![Code Climate](https://codeclimate.com/github/rumblelabs/asset_sync/badges/gpa.svg)](https://codeclimate.com/github/rumblelabs/asset_sync)
 
 # Asset Sync
 
@@ -14,16 +14,6 @@ This was initially built and is intended to work on [Heroku](http://heroku.com)
 
 If you are upgrading from a version of asset_sync **< 0.2.0** (i.e. 0.1.x). All of the references to config variables have changed to reference those used in **Fog**. Ensure to backup your `asset_sync.rb` or `asset_sync.yml` files and re-run the generator. You may also then need to update your ENV configuration variables (or you can change the ones that are referenced).
 
-## Heroku Labs (BETA)
-
-Previously there were [several issues](http://github.com/rumblelabs/asset_sync/blob/master/docs/heroku.md) with using asset_sync on Heroku as described in our [Heroku dev center article](http://devcenter.heroku.com/articles/cdn-asset-host-rails31).
-
-Now to get everything working smoothly with using **ENV** variables to configure `asset_sync` we just need to enable the [user-env-compile](http://devcenter.heroku.com/articles/labs-user-env-compile) functionality. In short:
-
-    heroku labs:enable user-env-compile -a myapp
-
-Hopefully this will make it's way into the platform as standard.
-
 ## Installation
 
 Add the gem to your Gemfile
@@ -32,25 +22,6 @@ Add the gem to your Gemfile
 gem 'asset_sync'
 ```
 
-If you want, you can put it within your **:assets** group in your Gemfile.
-
-``` ruby
-group :assets do
-  gem 'sass-rails',   '~> 3.2.3'
-  gem 'coffee-rails', '~> 3.2.1'
-  gem 'uglifier', '>= 1.0.3'
-  gem 'asset_sync'
-end
-```
-
-This is good practice when pre-compiling your assets as it will reduce load time and server memory in production. The only caveat being, you may not be able to use a custom initializer, without perhaps wrapping it with.
-
-``` ruby
-if defined?(AssetSync)
-...
-end
-```
-
 ### Optimized Fog loading
 
 Since AssetSync doesn't know which parts of Fog you intend to use, it will just load the entire library.
@@ -59,7 +30,7 @@ you need to load those parts of Fog yourself *before* loading AssetSync:
 
 In your Gemfile:
 ```ruby
-gem "fog", "~>1.20", require "fog/aws/storage"
+gem "fog", "~>1.20", require: "fog/aws/storage"
 gem "asset_sync"
 ```
 
@@ -141,7 +112,8 @@ If you need more control over configuration you will want to use a **custom rail
 
 Configuration using a **YAML** file (a common strategy for Capistrano deployments) is also supported.
 
-The recommend way to configure **asset_sync** is by using **environment variables** however it's up to you, it will work fine if you hard code them too. The main reason is that then your access keys are not checked into version control.
+The recommend way to configure **asset_sync** is by using **environment variables** however it's up to you, it will work fine if you hard code them too. The main reason why using environment variables is recommended is so your access keys are not checked into version control.
+
 
 ### Built-in Initializer (Environment Variables)
 
@@ -297,6 +269,7 @@ AssetSync.config.gzip_compression == ENV['ASSET_SYNC_GZIP_COMPRESSION']
 #### Fog (Optional)
 
 * **fog\_region**: the region your storage bucket is in e.g. *eu-west-1*
+* **fog\_path\_style**: To use buckets with dot in names, check https://github.com/fog/fog/issues/2381#issuecomment-28088524
 
 #### AWS
 
@@ -341,6 +314,44 @@ production:
   fog_region: 'eu-west-1'
 ```
 
+### Amazon (AWS) IAM Users
+
+Amazon has switched to the more secure IAM User security policy model. When generating a user & policy for asset_sync you will need to ensure the policy has the following permissions.
+You __must__ give the user permission to **s3:ListAllMyBuckets** as well as give permission to both the bucket, as well as the bucket's contents (/*). If not given all these permissions you'll see the error ```Expected(200) <=> Actual(403 Forbidden) ```
+
+IAM User Policy Example (replace "bucket_name" with your bucket):
+``` json
+{
+  "Statement": [
+    {
+      "Action": [
+        "s3:ListAllMyBuckets"
+      ],
+      "Effect": "Allow",
+      "Resource": "arn:aws:s3:::*"
+    },
+    {
+      "Action": "s3:*",
+      "Effect": "Allow",
+      "Resource": "arn:aws:s3:::bucket_name"
+    },
+    {
+      "Action": "s3:*",
+      "Effect": "Allow",
+      "Resource": "arn:aws:s3:::bucket_name/*"
+    }
+  ]
+}
+```
+
+If you want to use IAM roles you must set ```config.aws_iam_roles = true``` in your initializers.
+```
+AssetSync.configure do |config|
+  # ...
+  config.aws_iam_roles = true
+end
+```
+
 
 ## Automatic gzip compression
 
@@ -428,6 +439,18 @@ namespace :assets do
 end
 ```
 
+## Running the specs
+
+Make sure you have a .env file with these details:-
+
+    AWS_ACCESS_KEY_ID=<yourkeyid>
+    AWS_SECRET_ACCESS_KEY=<yoursecretkey>
+    FOG_DIRECTORY=<yourbucket>
+
+Make sure the bucket has read/write permissions.  Then to run the tests:-
+
+    foreman run rake
+
 ## Todo
 
 1. Add some before and after filters for deleting and uploading

data/asset_sync.gemspec

@@ -14,11 +14,14 @@ Gem::Specification.new do |s|
   s.summary     = %q{Synchronises Assets in a Rails 3 application and Amazon S3/Cloudfront and Rackspace Cloudfiles}
   s.description = %q{After you run assets:precompile your compiled assets will be synchronised with your S3 bucket.}
 
+  s.license = 'MIT'
+
   s.rubyforge_project = "asset_sync"
 
   s.add_dependency('fog', ">= 1.8.0")
   s.add_dependency('unf')
   s.add_dependency('activemodel')
+  s.add_dependency('mime-types')
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "bundler"

data/lib/asset_sync/asset_sync.rb

@@ -57,7 +57,7 @@ module AssetSync
     end
 
     def log(msg)
-      stdout.puts msg if config.log_silently?
+      stdout.puts msg unless config.log_silently?
     end
 
     def enabled?

data/lib/asset_sync/config.rb

@@ -24,6 +24,7 @@ module AssetSync
     attr_accessor :fog_provider          # Currently Supported ['AWS', 'Rackspace']
     attr_accessor :fog_directory         # e.g. 'the-bucket-name'
     attr_accessor :fog_region            # e.g. 'eu-west-1'
+    attr_accessor :fog_path_style        # e.g true
 
     # Amazon AWS
     attr_accessor :aws_access_key_id, :aws_secret_access_key, :aws_reduced_redundancy, :aws_iam_roles
@@ -78,7 +79,7 @@ module AssetSync
     end
 
     def aws?
-      fog_provider == 'AWS'
+      fog_provider =~ /aws/i
     end
 
     def aws_rrs?
@@ -94,7 +95,7 @@ module AssetSync
     end
 
     def log_silently?
-      ENV['RAILS_GROUPS'] == 'assets' || self.log_silently == false
+      ENV['RAILS_GROUPS'] == 'assets' || !!self.log_silently
     end
 
     def enabled?
@@ -102,15 +103,15 @@ module AssetSync
     end
 
     def rackspace?
-      fog_provider == 'Rackspace'
+      fog_provider =~ /rackspace/i
     end
 
     def google?
-      fog_provider == 'Google'
+      fog_provider =~ /google/i
     end
 
     def yml_exists?
-      defined?(Rails.root) ? File.exists?(self.yml_path) : false
+      defined?(Rails.root) ? File.exist?(self.yml_path) : false
     end
 
     def yml
@@ -139,6 +140,7 @@ module AssetSync
       self.fog_provider           = yml["fog_provider"]
       self.fog_directory          = yml["fog_directory"]
       self.fog_region             = yml["fog_region"]
+      self.fog_path_style         = yml["fog_path_style"]
       self.aws_access_key_id      = yml["aws_access_key_id"]
       self.aws_secret_access_key  = yml["aws_secret_access_key"]
       self.aws_reduced_redundancy = yml["aws_reduced_redundancy"]
@@ -203,10 +205,11 @@ module AssetSync
           :google_storage_access_key_id => google_storage_access_key_id
         })
       else
-        raise ArgumentError, "AssetSync Unknown provider: #{fog_provider} only AWS and Rackspace are supported currently."
+        raise ArgumentError, "AssetSync Unknown provider: #{fog_provider} only AWS, Rackspace and Google are supported currently."
       end
 
       options.merge!({:region => fog_region}) if fog_region && !rackspace?
+      options.merge!({:path_style => fog_path_style}) if fog_path_style && aws?
       return options
     end
 

data/lib/asset_sync/engine.rb

@@ -7,10 +7,10 @@ module AssetSync
       app_initializer = Rails.root.join('config', 'initializers', 'asset_sync.rb').to_s
       app_yaml = Rails.root.join('config', 'asset_sync.yml').to_s
 
-      if File.exists?( app_initializer )
+      if File.exist?( app_initializer )
         AssetSync.log "AssetSync: using #{app_initializer}"
         load app_initializer
-      elsif !File.exists?( app_initializer ) && !File.exists?( app_yaml )
+      elsif !File.exist?( app_initializer ) && !File.exist?( app_yaml )
         AssetSync.log "AssetSync: using default configuration from built-in initializer"
         AssetSync.configure do |config|
           config.fog_provider = ENV['FOG_PROVIDER'] if ENV.has_key?('FOG_PROVIDER')
@@ -44,7 +44,7 @@ module AssetSync
 
       end
 
-      if File.exists?( app_yaml )
+      if File.exist?( app_yaml )
         AssetSync.log "AssetSync: YAML file found #{app_yaml} settings will be merged into the configuration"
       end
     end

data/lib/asset_sync/storage.rb

@@ -73,7 +73,7 @@ module AssetSync
           log "Using: Rails 4.0 manifest access"
           manifest = Sprockets::Manifest.new(ActionView::Base.assets_manifest.environment, ActionView::Base.assets_manifest.dir)
           return manifest.assets.values.map { |f| File.join(self.config.assets_prefix, f) }
-        elsif File.exists?(self.config.manifest_path)
+        elsif File.exist?(self.config.manifest_path)
           log "Using: Manifest #{self.config.manifest_path}"
           yml = YAML.load(IO.read(self.config.manifest_path))
    
@@ -91,7 +91,8 @@ module AssetSync
       end
       log "Using: Directory Search of #{path}/#{self.config.assets_prefix}"
       Dir.chdir(path) do
-        Dir["#{self.config.assets_prefix}/**/**"]
+        to_load = self.config.assets_prefix.present? ? "#{self.config.assets_prefix}/**/**" : '**/**'
+        Dir[to_load]
       end
     end
 
@@ -136,7 +137,9 @@ module AssetSync
         :content_type => mime
       }
 
-      if /-[0-9a-fA-F]{32}$/.match(File.basename(f,File.extname(f)))
+      uncompressed_filename = f.sub(/\.gz\z/, '')
+      basename = File.basename(uncompressed_filename, File.extname(uncompressed_filename))
+      if /-[0-9a-fA-F]{32,}$/.match(basename)
         file.merge!({
           :cache_control => "public, max-age=#{one_year}",
           :expires => CGI.rfc1123_date(Time.now + one_year)
@@ -150,8 +153,8 @@ module AssetSync
         log "Overwriting #{f} with custom headers #{files_with_custom_headers[f].to_s}"
       elsif key = self.config.custom_headers.keys.detect {|k| f.match(Regexp.new(k))}
         headers = {}
-        self.config.custom_headers[key].each do |key, value|
-          headers[key.to_sym] = value
+        self.config.custom_headers[key].each do |k, value|
+          headers[k.to_sym] = value
         end
         file.merge! headers
         log "Overwriting matching file #{f} with custom headers #{headers.to_s}"
@@ -166,7 +169,7 @@ module AssetSync
         # as we will overwrite file.css with file.css.gz if it exists.
         log "Ignoring: #{f}"
         ignore = true
-      elsif config.gzip? && File.exists?(gzipped)
+      elsif config.gzip? && File.exist?(gzipped)
         original_size = File.size("#{path}/#{f}")
         gzipped_size = File.size(gzipped)
 

data/lib/asset_sync/version.rb

@@ -1,3 +1,3 @@
 module AssetSync
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/spec/dummy_app/Rakefile

@@ -3,7 +3,7 @@ require 'rubygems'
 ENV['RAILS_ROOT'] = File.dirname(__FILE__)
 # Set up gems listed in the Gemfile.
 ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
 # require 'rails/all'
 require "action_controller/railtie"
 require "sprockets/railtie"

data/spec/fixtures/aws_with_yml/config/asset_sync.yml

@@ -4,6 +4,7 @@ defaults: &defaults
   aws_secret_access_key: "zzzz"
   region: "eu-west-1"
   run_on_precompile: false
+  fog_path_style: true
 
 development:
   <<: *defaults

data/spec/unit/asset_sync_spec.rb

@@ -12,6 +12,7 @@ describe AssetSync do
         config.aws_secret_access_key = 'bbbb'
         config.fog_directory = 'mybucket'
         config.fog_region = 'eu-west-1'
+        config.fog_path_style = 'true'
         config.existing_remote_files = "keep"
       end
     end
@@ -50,6 +51,10 @@ describe AssetSync do
       expect(AssetSync.config.fog_region).to eq("eu-west-1")
     end
 
+    it "should configure path_style" do
+      expect(AssetSync.config.fog_path_style).to be_truthy
+    end
+
     it "should configure existing_remote_files" do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
@@ -65,6 +70,18 @@ describe AssetSync do
     it "should default log_silently to true" do
       expect(AssetSync.config.log_silently).to be_truthy
     end
+    
+    it "log_silently? should reflect the configuration" do
+      AssetSync.config.log_silently = false
+      expect(AssetSync.config.log_silently?).to eq(false)
+    end
+
+    it "log_silently? should always be true if ENV['RAILS_GROUPS'] == 'assets'" do
+      AssetSync.config.log_silently = false
+      # make sure ENV is actually being checked ...
+      expect(ENV).to receive(:[]).with('RAILS_GROUPS').and_return('assets') 
+      expect(AssetSync.config.log_silently?).to eq(true)
+    end
 
     it "should default cdn_distribution_id to nil" do
       expect(AssetSync.config.cdn_distribution_id).to be_nil
@@ -106,6 +123,10 @@ describe AssetSync do
       expect(AssetSync.config.fog_region).to eq("eu-west-1")
     end
 
+    it "should configure path_style" do
+      expect(AssetSync.config.fog_path_style).to be_truthy
+    end
+
     it "should configure existing_remote_files" do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end

data/spec/unit/storage_spec.rb

@@ -84,8 +84,20 @@ describe AssetSync::Storage do
 
 
     it 'should correctly set expire date' do
-      local_files = ['file1.jpg', 'file1-1234567890abcdef1234567890abcdef.jpg']
-      local_files += ['dir1/dir2/file2.jpg', 'dir1/dir2/file2-1234567890abcdef1234567890abcdef.jpg']
+      local_files = [
+        'file1.jpg',
+        'file1-1234567890abcdef1234567890abcdef.jpg',
+        'file1-1234567890abcdef1234567890abcdef.jpg.gz',
+        'file1-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg',
+        'file1-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg.gz'
+      ]
+      local_files += [
+        'dir1/dir2/file2.jpg',
+        'dir1/dir2/file2-1234567890abcdef1234567890abcdef.jpg',
+        'dir1/dir2/file2-1234567890abcdef1234567890abcdef.jpg.gz',
+        'dir1/dir2/file2-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg',
+        'dir1/dir2/file2-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg.gz'
+      ]
       remote_files = []
       storage = AssetSync::Storage.new(@config)
       allow(storage).to receive(:local_files).and_return(local_files)
@@ -99,7 +111,13 @@ describe AssetSync::Storage do
         when 'dir1/dir2/file2.jpg'
           !expect(file).not_to include(:cache_control, :expires)
         when 'file1-1234567890abcdef1234567890abcdef.jpg'
+        when 'file1-1234567890abcdef1234567890abcdef.jpg.gz'
+        when 'file1-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg'
+        when 'file1-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg.gz'
         when 'dir1/dir2/file2-1234567890abcdef1234567890abcdef.jpg'
+        when 'dir1/dir2/file2-1234567890abcdef1234567890abcdef.jpg.gz'
+        when 'dir1/dir2/file2-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg'
+        when 'dir1/dir2/file2-1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef.jpg.gz'
           expect(file).to include(:cache_control, :expires)
         else
           fail

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_sync
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Simon Hamilton
@@ -55,6 +55,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -176,7 +190,8 @@ files:
 - spec/unit/railsless_spec.rb
 - spec/unit/storage_spec.rb
 homepage: https://github.com/rumblelabs/asset_sync
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -194,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: asset_sync
-rubygems_version: 2.2.2
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Synchronises Assets in a Rails 3 application and Amazon S3/Cloudfront and