prelands_rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9963abae54f24ecedee07af2eda355eb1dda5790141cc4579a4037f2bf12a7d3
-  data.tar.gz: 8e3608256bd2073be0abc06745e323e55748e8e7418b1907af2b446aa7c48018
+  metadata.gz: 7215ed2505e3982375df9f4af396e1cf41f664e66a8b94d0048b4cf825cae7f4
+  data.tar.gz: b7537bb7fe333adea7c257964dcf2fc6a45c262e84571345217c7f28e575cee9
 SHA512:
-  metadata.gz: 5f815e3ba1532e9e34d67931796a82621b9926421db2db46fcd96ee917271f5bbc155076be23e711a5218ca77c916658ffd96626ba3c2f41a8aed2fd7fae42c4
-  data.tar.gz: 822108a653b8296a33a542b195fef4c588b6b6f0d7796e148cf354fbe6b1f8ae421d2fc41616549b02534fae312ba2690c939400339ff0b3af7f6ac805f57423
+  metadata.gz: 5e58628c60bb44f6fd8ca4455b6459410daab098e2bc5e393ad8438b48adb73304897c3a41e3d58f302bc81c0bb12f3f57313969609bafe6003cc6f3f8c15714
+  data.tar.gz: e14305a5130d5f552f09f5f20d02db037ada4ca9e88a8c5b49780cfb36a39f30ff2346d7dc1a0e3ca778eeefe70e56ed86c33a54e41af11f96adc7cecc02a8ac

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prelands_rails (0.1.4)
+    prelands_rails (0.1.5)
       aws-sdk
       interactor (~> 3.0)
       interactor-contracts

data/README.md

@@ -7,4 +7,20 @@
 1. Bump version inside `prelands_rails.gemspec`.
 2. Make commit & push to `master` branch.
 3. Then checkout `tags` branch and `git rebase master` (accept theirs if there are any conflicts).
-4. Then `git push` - and Gitlab CI publish the new version of the gem.
+4. Then `git push` - and Gitlab CI publish the new version of the gem.
+
+# Local developing
+
+Execute in bash console using the actual path to the gem folder:
+
+    bundle config local.prelands_rails /home/scout/git/prelands_rails/
+    
+Expected output:
+    
+    You are replacing the current global value of local.prelands_rails, which is currently "/home/scout/git/preland_rails/"
+
+In the Gemfile of a host application specify actual gem version, branch and semi-github path:
+
+    gem 'prelands_rails', '0.1.4', github: 'prelands_rails/prelands_rails', branch: 'master'
+    
+Run `bundle`, launch puma server. Now your host application uses the local files.

data/lib/prelands_rails/concerns/my_aws_client.rb

@@ -92,6 +92,33 @@ module PrelandsRails
       end
     end
 
+    # Переместит файл в пределах +bucket_name+
+    # @return true если успешно переместил
+    def move_file(s3_old_file_name, s3_new_file_name, bucket_name)
+      log :move_file, ['', s3_old_file_name, ' moving to ', s3_new_file_name, ' in ', bucket_name, '.'].join('"')
+
+      obj        = Aws::S3::Object.new(bucket_name, s3_old_file_name, client: @s3.client)
+      new_target = [bucket_name, s3_new_file_name].join('/')
+
+      begin
+        obj.move_to new_target
+      rescue Aws::S3::Errors::NoSuchKey
+        log :move_file, 'Aws::S3::Errors::NoSuchKey: The specified key does not exist: "%s"' % s3_old_file_name
+        return false
+      end
+
+      obj = Aws::S3::Object.new(bucket_name, s3_new_file_name, client: @s3.client)
+
+      begin
+        obj.acl.put({ acl: ACL_PUBLIC_READ })
+      rescue Aws::S3::Errors::NoSuchKey
+        log :move_file_acl_put, 'Aws::S3::Errors::NoSuchKey: The specified key does not exist: "%s"' % s3_old_file_name
+        return false
+      end
+
+      true
+    end
+
     private
 
     def log(method, output)

data/lib/prelands_rails/recompile_simple_source/rename_zip_file.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class RecompileSimpleSource
+    class RenameZipFile
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+
+      expects do
+        required(:aws_prefix).value(type?: String)
+        required(:old_aws_prefix).value(type?: String)
+        required(:s3_credentials).schema do
+          required(:access_key).filled(:str?)
+          required(:secret_key).filled(:str?)
+          required(:region).filled(:str?)
+        end
+        required(:zip_bucket_name).filled(:str?)
+      end
+
+      assures do
+        required(:is_zip_moved).filled(:bool?)
+      end
+
+      def act
+        old_name = '%s/src.zip' % context.old_aws_prefix
+        new_name = '%s/src.zip' % context.aws_prefix
+
+        context.is_zip_moved =
+          client.move_file old_name, new_name, context.zip_bucket_name
+      end
+
+      private
+
+      def client
+        return @client if defined?(@client)
+
+        creds   = context.s3_credentials
+        @client = ::PrelandsRails::MyAwsClient.new creds[:access_key], creds[:secret_key], creds[:region]
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/recompile_simple_source/update_record.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class RecompileSimpleSource
+    #
+    # обновит запись ::Preland::SimpleSource
+    #
+    class UpdateRecord
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      expects do
+        required(:aws_prefix).value(type?: String)
+        required(:old_aws_prefix).value(type?: String)
+        required(:model_preland_simple_source).filled
+      end
+
+      assures do
+        required(:preland_simple_source).filled
+      end
+
+      def act
+        source.aws_prefix = context.aws_prefix
+        source.save!
+        context.preland_simple_source = source
+      end
+
+      private
+
+      def source
+        @source ||= context.model_preland_simple_source.find_by aws_prefix: context.old_aws_prefix
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/recompile_simple_source.rb

@@ -18,6 +18,7 @@ module PrelandsRails
         required(:region).filled(:str?)
       end
       required(:bucket_names).value(type?: Array)
+      required(:model_preland_simple_source).filled
     end
 
     before do
@@ -33,6 +34,8 @@ module PrelandsRails
       required(:incoming_locales).filled(type?: Array)
       required(:files_content).value(type?: Hash)
       required(:compiled_htmls).value(type?: Hash)
+      required(:old_aws_prefix).value(type?: String)
+      required(:is_zip_moved).filled(:bool?)
     end
 
     after do
@@ -44,7 +47,11 @@ module PrelandsRails
              ::PrelandsRails::CreateSimpleSource::DetectIncomingLocales,
              ::PrelandsRails::CreateSimpleSource::CheckZipFiles,
              ::PrelandsRails::CreateSimpleSource::Compile,
-             Upload
+             ::PrelandsRails::UpdateSimpleSource::GenerateNewAwsPrefix,
+             Upload,
+             UpdateRecord,                                                      # update aws_prefix
+             ::PrelandsRails::UpdateSimpleSource::RemoveContentFromOldAwsPrefix,
+             RenameZipFile
 
     on_breach { |breaches| bad_expects breaches }
 

data/lib/prelands_rails/update_simple_source/generate_new_aws_prefix.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class UpdateSimpleSource
+
+    class GenerateNewAwsPrefix
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+
+      expects do
+        required(:aws_prefix).value(type?: String)
+      end
+
+      assures do
+        required(:old_aws_prefix).value(type?: String)
+      end
+
+      def act
+        context.old_aws_prefix = context.aws_prefix
+        context.aws_prefix     = SecureRandom.uuid[0..7]
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/update_simple_source/remove_content_from_old_aws_prefix.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class UpdateSimpleSource
+
+    class RemoveContentFromOldAwsPrefix
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::UpdateSimpleSource::Upload::DeleteCompiledFiles
+
+      expects do
+        required(:old_aws_prefix).value(type?: String)
+        required(:s3_credentials).schema do
+          required(:access_key).filled(:str?)
+          required(:secret_key).filled(:str?)
+          required(:region).filled(:str?)
+        end
+        required(:bucket_names).value(type?: Array)
+      end
+
+      def act
+        delete_compiled_files(context.old_aws_prefix)
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/update_simple_source/update_record.rb

@@ -11,7 +11,8 @@ module PrelandsRails
 
       expects do
         required(:archive)                                                      # Входящий архив с исходниками от фрилансера. Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
-        required(:aws_prefix).value(type?: String)                              # имя директории в букете
+        required(:aws_prefix).value(type?: String)
+        required(:old_aws_prefix).value(type?: String)
         required(:preland_id).filled
         required(:preland_domain_ids).value(type?: Array)
         required(:incoming_locales).filled(type?: Array)
@@ -27,10 +28,11 @@ module PrelandsRails
       end
 
       def act
-        source                    = context.model_preland_simple_source.find_by aws_prefix: context.aws_prefix
+        source                    = context.model_preland_simple_source.find_by aws_prefix: context.old_aws_prefix
         source.archive            = context.archive if context.archive
         source.preland_domain_ids = context.preland_domain_ids
         source.locales            = context.incoming_locales
+        source.aws_prefix         = context.aws_prefix
         source.save!
         context.preland_simple_source = source
       end

data/lib/prelands_rails/update_simple_source/upload/delete_compiled_files.rb

@@ -7,16 +7,17 @@ module PrelandsRails
       # Удалить из +bucket_names+ файлы преленда из директории +aws_prefix+.
       #
       module DeleteCompiledFiles
-        def delete_compiled_files
-          creds  = context.s3_credentials
-          client = ::PrelandsRails::MyAwsClient.new creds[:access_key], creds[:secret_key], creds[:region]
+        def delete_compiled_files(that_aws_prefix = nil)
+          aws_prefix = that_aws_prefix || context.aws_prefix
+          creds      = context.s3_credentials
+          client     = ::PrelandsRails::MyAwsClient.new creds[:access_key], creds[:secret_key], creds[:region]
 
           context.bucket_names.each do |bucket_name|
             files = client.list_objects bucket_name
             next unless files
 
             files = files.map do |file_name|
-              { key: file_name } if file_name.index(context.aws_prefix) == 0
+              { key: file_name } if file_name.index(aws_prefix) == 0
             end.compact
 
             next if files.empty?

data/lib/prelands_rails/update_simple_source.rb

@@ -2,7 +2,11 @@
 
 module PrelandsRails
   #
-  # Примет zip-файл с исходниками преленда и опубликует этот преленд.
+  # Примет zip-файл с исходниками преленда и обновит исходники этого преленда.
+  # В результате будет обновлён `aws_prefix` -- имя директории в букете,
+  # что позволит избежать кэширования статического контента. . Другими словами,
+  # при обновлении файлов не надо ждать, пока Amazon обновит кэш или
+  # очищать кэш Amazon-а.
   #
   class UpdateSimpleSource
     include ::PrelandsRails::AbstractInteractor
@@ -41,8 +45,10 @@ module PrelandsRails
              CheckZipFiles,
              ValidateZipContent,
              Compile,
-             Upload,
-             UpdateRecord
+             GenerateNewAwsPrefix,
+             Upload,                                                            # to new aws_prefix
+             UpdateRecord,                                                      # also update aws_prefix
+             RemoveContentFromOldAwsPrefix
 
     on_breach { |breaches| bad_expects breaches }
   end

data/lib/prelands_rails.rb

@@ -32,6 +32,8 @@ require 'prelands_rails/create_simple_source'
 require 'prelands_rails/update_simple_source/upload/delete_compiled_files'
 require 'prelands_rails/update_simple_source/check_zip_files'
 require 'prelands_rails/update_simple_source/compile'
+require 'prelands_rails/update_simple_source/generate_new_aws_prefix'
+require 'prelands_rails/update_simple_source/remove_content_from_old_aws_prefix'
 require 'prelands_rails/update_simple_source/update_record'
 require 'prelands_rails/update_simple_source/upload'
 require 'prelands_rails/update_simple_source/validate_zip_content'
@@ -39,8 +41,10 @@ require 'prelands_rails/update_simple_source'
 
 require 'prelands_rails/validate_simple_source'
 
-require 'prelands_rails/recompile_simple_source/upload'
 require 'prelands_rails/recompile_simple_source/download_zip'
+require 'prelands_rails/recompile_simple_source/rename_zip_file'
+require 'prelands_rails/recompile_simple_source/update_record'
+require 'prelands_rails/recompile_simple_source/upload'
 require 'prelands_rails/recompile_simple_source'
 
 module PrelandsRails

data/prelands_rails.gemspec

@@ -5,7 +5,7 @@ end
 
 Gem::Specification.new do |spec|
   spec.name          = "prelands_rails"
-  spec.version       = "0.1.4"
+  spec.version       = "0.1.5"
   spec.authors       = ["C80609A"]
   spec.email         = ["c080609a@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prelands_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - C80609A
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor
@@ -314,10 +314,14 @@ files:
 - lib/prelands_rails/create_simple_source/validate_zip_content/validate_js/js.rb
 - lib/prelands_rails/recompile_simple_source.rb
 - lib/prelands_rails/recompile_simple_source/download_zip.rb
+- lib/prelands_rails/recompile_simple_source/rename_zip_file.rb
+- lib/prelands_rails/recompile_simple_source/update_record.rb
 - lib/prelands_rails/recompile_simple_source/upload.rb
 - lib/prelands_rails/update_simple_source.rb
 - lib/prelands_rails/update_simple_source/check_zip_files.rb
 - lib/prelands_rails/update_simple_source/compile.rb
+- lib/prelands_rails/update_simple_source/generate_new_aws_prefix.rb
+- lib/prelands_rails/update_simple_source/remove_content_from_old_aws_prefix.rb
 - lib/prelands_rails/update_simple_source/update_record.rb
 - lib/prelands_rails/update_simple_source/upload.rb
 - lib/prelands_rails/update_simple_source/upload/delete_compiled_files.rb