asset_sync 2.15.3 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd0deada18130ef42d80d6f05d5ff0611a7587dd33d177bbc38641e6b6cad3a9
-  data.tar.gz: cd514b4901f6a3859a00b80282139d9d712db8414ed03ab115de2c7a3dfd3c78
+  metadata.gz: 30fcfd0667904cde532ba24578e9bbc15f33051d5bde3e345226915c7135ccde
+  data.tar.gz: 67cff250568d8473c940733f182e425b811550be1c95e940498508fe5d81e656
 SHA512:
-  metadata.gz: eb9cabad00c3dfd61c1ca47c3ba9d6a768375d3dcd6a6798e97a55cc91ee1dd5a030ebd85eeab1f2018dbcc6e6ea18f43591f09bc02f2cd0558a361a13efafb9
-  data.tar.gz: 0c13d03567e9773383179cdfda43699e70352a0ec20c7a7c980017f32b6164eb89e4a4957e6480f1ee1a6a5cc41e270f75bcc0d5fa0dd92363129e0f227c76c7
+  metadata.gz: 6c2471c8dcad1fdd461fac5e7881723f012888e295e5f8bda6c13137ff1cb31f3aef2db669d71588a3a699dbd2d56366abacdf9ab0d0cae4b8e7b5dba2bff8f8
+  data.tar.gz: 1c5fb8a038bc21c0f8218a1dd74ec6cff47df3b43588e0b9599032559a639564341814f1576faa5b6a9f9378ca2e37de1c08f219748999f0e7a437f48e96fe22

data/.github/workflows/codeql.yml

@@ -0,0 +1,43 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: "11 12 * * 0"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language:
+          - javascript
+          - ruby
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"

data/.github/workflows/tests.yaml

@@ -29,6 +29,7 @@ jobs:
           - 2.7
           - 3.0
           - 3.1
+          - 3.2
           - jruby
         gemfile:
           - gemfiles/rails_6_0.gemfile

data/CHANGELOG.md

@@ -7,7 +7,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
-- Nothing
+- Add `fog_options` configuration option.
 
 ### Changed
 
@@ -18,6 +18,22 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [2.17.0] - 2023-01-13
+
+### Added
+
+- Add option `fog_options`
+  (https://github.com/AssetSync/asset_sync/pull/431)
+
+
+## [2.16.0] - 2022-08-26
+
+### Added
+
+- Add option `remote_file_list_cache_file_path`
+  (https://github.com/AssetSync/asset_sync/pull/428)
+
+
 ## [2.15.3] - 2022-08-25
 
 ### Fixed
@@ -1054,7 +1070,9 @@ Changes:
     * Merge branch 'sinatra'
 
 
-[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.15.3...HEAD
+[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.17.0...HEAD
+[2.17.0]: https://github.com/AssetSync/asset_sync/compare/v2.16.0...v2.17.0
+[2.16.0]: https://github.com/AssetSync/asset_sync/compare/v2.15.3...v2.16.0
 [2.15.3]: https://github.com/AssetSync/asset_sync/compare/v2.15.2...v2.15.3
 [2.15.2]: https://github.com/AssetSync/asset_sync/compare/v2.15.1...v2.15.2
 [2.15.1]: https://github.com/AssetSync/asset_sync/compare/v2.15.0...v2.15.1

data/README.md

@@ -1,6 +1,6 @@
 
 [![Gem Version](https://img.shields.io/gem/v/asset_sync.svg?style=flat-square)](http://badge.fury.io/rb/asset_sync)
-[![Build Status](https://img.shields.io/travis/AssetSync/asset_sync.svg?style=flat-square)](http://travis-ci.org/AssetSync/asset_sync)
+[![Tests](https://github.com/AssetSync/asset_sync/actions/workflows/tests.yaml/badge.svg)](https://github.com/AssetSync/asset_sync/actions/workflows/tests.yaml)
 [![Coverage Status](http://img.shields.io/coveralls/AssetSync/asset_sync.svg?style=flat-square)](https://coveralls.io/r/AssetSync/asset_sync)
 
 
@@ -244,8 +244,8 @@ AssetSync.configure do |config|
   #
   # Change canned ACL of uploaded object. Default is unset. Will override fog_public if set.
   # Choose from: private | public-read | public-read-write | aws-exec-read |
-  #              authenticated-read | bucket-owner-read | bucket-owner-full-control 
-  # config.aws_acl = nil 
+  #              authenticated-read | bucket-owner-read | bucket-owner-full-control
+  # config.aws_acl = nil
   #
   # Change host option in fog (only if you need to)
   # config.fog_host = 's3.amazonaws.com'
@@ -256,6 +256,10 @@ AssetSync.configure do |config|
   # Use http instead of https.
   # config.fog_scheme = 'http'
   #
+  # Extra fog options.
+  # Overrides any existing value (even those set by AssetSync)
+  # config.fog_options = {}
+  #
   # Automatically replace files with their equivalent gzip compressed version
   # config.gzip_compression = true
   #
@@ -275,6 +279,9 @@ AssetSync.configure do |config|
   # Path to cache file to skip scanning remote
   # config.remote_file_list_cache_file_path = './.asset_sync_remote_file_list_cache.json'
   #
+  # Path on remote storage to persist remote file list file
+  # config.remote_file_list_remote_path = '/remote/asset_sync_remote_file.json'
+  #
   # Fail silently.  Useful for environments such as Heroku
   # config.fail_silently = true
   #
@@ -319,7 +326,7 @@ defaults: &defaults
   #
   # Change canned ACL of uploaded object. Default is unset. Will override fog_public if set.
   # Choose from: private | public-read | public-read-write | aws-exec-read |
-  #              authenticated-read | bucket-owner-read | bucket-owner-full-control 
+  #              authenticated-read | bucket-owner-read | bucket-owner-full-control
   # aws_acl: null
   #
   # Change host option in fog (only if you need to)
@@ -384,6 +391,7 @@ AssetSync.config.gzip_compression == ENV['ASSET_SYNC_GZIP_COMPRESSION']
 * **concurrent_uploads**: (`true, false`) when enabled, will upload the files in different Threads, this greatly improves the upload speed. **default:** `'false'`
 * **concurrent_uploads_max_threads**: when concurrent_uploads is enabled, this determines the number of threads that will be created. **default:** `10`
 * **remote_file_list_cache_file_path**: if present, use this path to cache remote file list to skip scanning remote **default:** `nil`
+* **remote_file_list_remote_path**: if present, use this path to download remote file list file to cache file list in local to skip scanning remote. useful in container environment where you cannot maintain the local file, remote_file_list_cache_file_path also needed to make use of this option **default:** `nil`
 * **enabled**: (`true, false`) when false, will disable asset sync. **default:** `'true'` (enabled)
 * **ignored\_files**: an array of files to ignore e.g. `['ignore_me.js', %r(ignore_some/\d{32}\.css)]` Useful if there are some files that are created dynamically on the server and you don't want to upload on deploy **default**: `[]`
 * **cache\_asset\_regexps**: an array of files to add cache headers e.g. `['cache_me.js', %r(cache_some\.\d{8}\.css)]` Useful if there are some files that are added to sprockets assets list and need to be set as 'Cacheable' on uploaded server.  Only rails compiled regexp is matched internally **default**: `[]`
@@ -432,6 +440,7 @@ The blocks are run when local files are being scanned and uploaded
 
 * **fog\_region**: the region your storage bucket is in e.g. *eu-west-1* (AWS),  *ord* (Rackspace), *japanwest* (Azure Blob)
 * **fog\_path\_style**: To use buckets with dot in names, check https://github.com/fog/fog/issues/2381#issuecomment-28088524
+* **fog\_options**: For extra fog options. Overrides any existing value (even those set by AssetSync)
 
 #### AWS
 

data/lib/asset_sync/config.rb

@@ -28,12 +28,14 @@ module AssetSync
     attr_accessor :concurrent_uploads
     attr_accessor :concurrent_uploads_max_threads
     attr_accessor :remote_file_list_cache_file_path
+    attr_accessor :remote_file_list_remote_path
 
     # FOG configuration
     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_reader   :fog_public            # e.g. true, false, "default"
+    attr_accessor :fog_options           # e.g. { enable_signature_v4_streaming: true }
 
     # Amazon AWS
     attr_accessor :aws_access_key_id
@@ -107,6 +109,7 @@ module AssetSync
       self.concurrent_uploads = false
       self.concurrent_uploads_max_threads = 10
       self.remote_file_list_cache_file_path = nil
+      self.remote_file_list_remote_path = nil
       @additional_local_file_paths_procs = []
 
       load_yml! if defined?(::Rails) && yml_exists?
@@ -254,6 +257,7 @@ module AssetSync
       self.concurrent_uploads     = yml['concurrent_uploads'] if yml.has_key?('concurrent_uploads')
       self.concurrent_uploads_max_threads = yml['concurrent_uploads_max_threads'] if yml.has_key?('concurrent_uploads_max_threads')
       self.remote_file_list_cache_file_path = yml['remote_file_list_cache_file_path'] if yml.has_key?('remote_file_list_cache_file_path')
+      self.remote_file_list_remote_path = yml['remote_file_list_remote_path'] if yml.has_key?('remote_file_list_remote_path')
 
       self.azure_storage_account_name = yml['azure_storage_account_name'] if yml.has_key?("azure_storage_account_name")
       self.azure_storage_access_key   = yml['azure_storage_access_key'] if yml.has_key?("azure_storage_access_key")
@@ -335,6 +339,7 @@ module AssetSync
         raise ArgumentError, "AssetSync Unknown provider: #{fog_provider} only AWS, Rackspace and Google are supported currently."
       end
 
+      options.merge!(@fog_options) if @fog_options
       options
     end
 

data/lib/asset_sync/engine.rb

@@ -50,6 +50,7 @@ module AssetSync
           config.include_manifest = (ENV['ASSET_SYNC_INCLUDE_MANIFEST'] == 'true') if ENV.has_key?('ASSET_SYNC_INCLUDE_MANIFEST')
           config.concurrent_uploads = (ENV['ASSET_SYNC_CONCURRENT_UPLOADS'] == 'true') if ENV.has_key?('ASSET_SYNC_CONCURRENT_UPLOADS')
           config.remote_file_list_cache_file_path = ENV['ASSET_SYNC_REMOTE_FILE_LIST_CACHE_FILE_PATH'] if ENV.has_key?('ASSET_SYNC_REMOTE_FILE_LIST_CACHE_FILE_PATH')
+          config.remote_file_list_remote_path = ENV['ASSET_SYNC_REMOTE_FILE_LIST_REMOTE_PATH'] if ENV.has_key?('ASSET_SYNC_REMOTE_FILE_LIST_REMOTE_PATH')
         end
       end
 

data/lib/asset_sync/storage.rb

@@ -47,6 +47,10 @@ module AssetSync
       self.config.remote_file_list_cache_file_path
     end
 
+    def remote_file_list_remote_path
+      self.config.remote_file_list_remote_path
+    end
+
     def ignored_files
       expand_file_names(self.config.ignored_files)
     end
@@ -72,6 +76,16 @@ module AssetSync
       return [] if ignore_existing_remote_files?
       return @remote_files if @remote_files
 
+      if remote_file_list_remote_path && remote_file_list_cache_file_path
+        log "Downloading file list file from remote"
+        remote_cache_file = bucket.files.get(remote_file_list_remote_path)
+        if remote_cache_file
+          File.open(remote_file_list_cache_file_path, 'w') do |local_file|
+            local_file.write(remote_cache_file.body)
+          end
+        end
+      end
+
       if remote_file_list_cache_file_path && File.file?(remote_file_list_cache_file_path)
         begin
           content = File.read(remote_file_list_cache_file_path)
@@ -94,6 +108,18 @@ module AssetSync
       end
     end
 
+    def update_remote_file_list_in_remote
+      return if ignore_existing_remote_files?
+      return unless remote_file_list_remote_path
+      return unless remote_file_list_cache_file_path
+      log "Updating file list file in remote"
+      remote_file = bucket.files.new({
+        :key    => remote_file_list_remote_path,
+        :body   => File.open(remote_file_list_cache_file_path)
+      })
+      remote_file.save
+    end
+
     def always_upload_files
       expand_file_names(self.config.always_upload) + get_manifest_path
     end
@@ -317,6 +343,7 @@ module AssetSync
       end
 
       update_remote_file_list_cache(local_files_to_upload)
+      update_remote_file_list_in_remote
     end
 
     def sync

data/lib/asset_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AssetSync
-  VERSION = "2.15.3"
+  VERSION = "2.17.0"
 end

data/lib/generators/asset_sync/templates/asset_sync.rb

@@ -81,6 +81,9 @@ if defined?(AssetSync)
     # Path to cache file to skip scanning remote
     # config.remote_file_list_cache_file_path = './.asset_sync_remote_file_list_cache.json'
     #
+    # Path on remote storage to persist remote file list file
+    # config.remote_file_list_remote_path = '/remote/asset_sync_remote_file.json'
+    #
     # Fail silently.  Useful for environments such as Heroku
     # config.fail_silently = true
     #

data/spec/unit/asset_sync_spec.rb

@@ -94,6 +94,10 @@ describe AssetSync do
     it "should default asset_regexps to empty array" do
       expect(AssetSync.config.cache_asset_regexps).to eq([])
     end
+
+    it "should default remote_file_list_remote_path to nil" do
+      expect(AssetSync.config.remote_file_list_remote_path).to be_nil
+    end
   end
 
   describe 'from yml' do
@@ -274,6 +278,28 @@ describe AssetSync do
     end
   end
 
+  describe 'with fog_options' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fog_provider = 'AWS'
+        config.fog_region = 'eu-west-1'
+        config.fog_path_style = 'true'
+        config.fog_options = { enable_signature_v4_streaming: true }
+      end
+    end
+
+    it "assigns fog_options" do
+      AssetSync.config.fog_options = { enable_signature_v4_streaming: true }
+      expect(AssetSync.config.fog_options).to include(
+        provider: 'AWS',
+        region: 'eu-west-1',
+        path_style: 'true',
+        enable_signature_v4_streaming: true,
+      )
+    end
+  end
+
   describe 'with invalid yml' do
     before(:each) do
       set_rails_root('with_invalid_yml')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_sync
 version: !ruby/object:Gem::Version
-  version: 2.15.3
+  version: 2.17.0
 platform: ruby
 authors:
 - Simon Hamilton
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -221,6 +221,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/codeql.yml"
 - ".github/workflows/tests.yaml"
 - ".gitignore"
 - ".travis.yml"
@@ -287,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
 summary: Synchronises Assets in a Rails 3 application and Amazon S3/Cloudfront and