prelands_rails 0.1.2 → 0.1.5

data/README.md

@@ -2,3 +2,25 @@
 
 Код, занимающийся валидацией и публикацией прелендов V4.
 
+# How to publish gem
+
+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.
+
+# 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/create_simple_source/validate_zip_content/validate_html/html.rb

@@ -86,7 +86,7 @@ module PrelandsRails
             title_rx = /<title>[^<]+<\/title>/
             return if @string[title_rx]
 
-            'Tag <title> not found.'
+            'Tag `title` not found.'
           end
 
           def check_a_hrefs
@@ -97,10 +97,10 @@ module PrelandsRails
           end
 
           def check_favicon
-            favicon_rx = '<link rel="shortcut icon" href="icon.ico">'
+            favicon_rx = /<link.+href="icon.ico">/
             return if @string[favicon_rx]
 
-            '<link rel="shortcut icon" href="icon.ico"> not found.'
+            '`link href="icon.ico"` not found.'
           end
 
           protected

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_js.rb

@@ -16,13 +16,17 @@ module PrelandsRails
         end
 
         assures do
+          optional(:warnings).maybe(type?: Array)
+        end
 
+        before do
+          context.warnings ||= []
         end
 
         def act
           content = context[:files_content]['index.js']
           content = Js.new(content)
-          fail! errors: {'index.js' => content.errors} unless content.valid?
+          context.warnings += content.errors unless content.valid?
         end
 
         on_breach { |breaches| bad_expects breaches }

data/lib/prelands_rails/create_simple_source/validate_zip_content.rb

@@ -15,7 +15,7 @@ module PrelandsRails
       end
 
       assures do
-
+        optional(:warnings).maybe(type?: Array)
       end
 
       organize ValidateIncomingFiles, ValidateHtml, ValidateJs, ValidateCss

data/lib/prelands_rails/create_simple_source.rb

@@ -34,6 +34,7 @@ module PrelandsRails
       required(:files_content).value(type?: Hash)                               # распакованные файлы из архива { file_name[String] => file_content[String], ... }
       required(:compiled_htmls).value(type?: Hash)                              # скомпилированные исходники    { file_name[String] => compiled_content[String], ... }
       required(:preland_simple_source).filled
+      optional(:warnings).maybe(type?: Array)
     end
 
     organize DetectIncomingLocales,

data/lib/prelands_rails/recompile_simple_source/download_zip.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class RecompileSimpleSource
+    #
+    # Скачает и разместит в cache-директории zip-архив с исходником лендинга.
+    #
+    class DownloadZip
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      expects do
+        required(:prelanding).filled #.value(type?: ::Preland)
+      end
+
+      assures do
+        required(:archive).filled                                               # Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        required(:tmp_dest).value(type?: String)                                # путь к временному файлу
+      end
+
+      def act
+        archive_url = prelanding.preland_simple_source.archive.url
+        destination = make_tmp_path
+
+        IO.copy_stream(Kernel.open(archive_url), destination)
+
+        context.archive  = ActionDispatch::Http::UploadedFile.new(tempfile: destination)
+        context.tmp_dest = destination
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+
+      delegate :prelanding,
+               :to => :context
+    end
+  end
+end

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/upload.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class RecompileSimpleSource
+    #
+    # Сначала удалить файлы преленда из директории +aws_prefix+, затем загрузить.
+    #
+    class Upload
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::UpdateSimpleSource::Upload::DeleteCompiledFiles
+
+      expects do
+        required(:archive).filled                                               # Входящий архив с исходниками от фрилансера. Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        required(:compiled_htmls).value(type?: Hash)                            # скомпилированные исходники    { file_name[String] => compiled_content[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)
+        required(:aws_prefix).value(type?: String)
+        required(:files_content).value(type?: Hash)                             # { file_name => file_content, ... }
+      end
+
+      assures do
+      end
+
+      def act
+        delete_compiled_files
+        result = ::PrelandsRails::CreateSimpleSource::Upload.call context
+        fail! errors: result.errors unless result.success?
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/recompile_simple_source.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  #
+  # Перекомпилировать преленд на основе уже загруженного в aws архива.
+  #
+  class RecompileSimpleSource
+    include ::PrelandsRails::AbstractInteractor
+    include ::Interactor::Organizer
+    include ::Interactor::Contracts
+
+    expects do
+      required(:prelanding).filled#.value(type?: ::Preland)
+      required(:static_js_path).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)
+      required(:model_preland_simple_source).filled
+    end
+
+    before do
+      context.expected_locales = context.prelanding.locales.map(&:short_name)
+      context.aws_prefix       = context.prelanding.preland_simple_source.aws_prefix
+    end
+
+    assures do
+      required(:expected_locales).filled(type?: Array)
+      required(:aws_prefix).value(type?: String)
+      required(:archive).filled
+      required(:tmp_dest).value(type?: String)
+      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
+      clear_tmp_dest
+      context.prelanding.preland_simple_source.update_columns updated_at: Time.now
+    end
+
+    organize DownloadZip,
+             ::PrelandsRails::CreateSimpleSource::DetectIncomingLocales,
+             ::PrelandsRails::CreateSimpleSource::CheckZipFiles,
+             ::PrelandsRails::CreateSimpleSource::Compile,
+             ::PrelandsRails::UpdateSimpleSource::GenerateNewAwsPrefix,
+             Upload,
+             UpdateRecord,                                                      # update aws_prefix
+             ::PrelandsRails::UpdateSimpleSource::RemoveContentFromOldAwsPrefix,
+             RenameZipFile
+
+    on_breach { |breaches| bad_expects breaches }
+
+    private
+
+    def clear_tmp_dest
+      td = context.tmp_dest
+      File.delete(td) if File.exist?(td)
+    end
+  end
+end

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/validate_zip_content.rb

@@ -13,17 +13,15 @@ module PrelandsRails
       end
 
       assures do
-
-      end
-
-      before do
-
+        optional(:warnings).maybe(type?: Array)
       end
 
       def act
         if context.files_content
           result = ::PrelandsRails::CreateSimpleSource::ValidateZipContent.call context
-          unless result.success?
+          if result.success?
+            context.warnings = result.warnings
+          else
             fail!(errors: result.errors)
           end
         end

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
@@ -34,14 +38,17 @@ module PrelandsRails
       optional(:files_content).maybe(type?: Hash)                               # распакованные файлы из архива { file_name[String] => file_content[String], ... }
       optional(:compiled_htmls).value(type?: Hash)                              # скомпилированные исходники    { file_name[String] => compiled_content[String], ... }
       required(:preland_simple_source).filled
+      optional(:warnings).maybe(type?: Array)
     end
 
     organize ::PrelandsRails::CreateSimpleSource::DetectIncomingLocales,
              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/validate_simple_source.rb

@@ -15,6 +15,7 @@ module PrelandsRails
     end
 
     assures do
+      optional(:warnings).maybe(type?: Array)
     end
 
     organize ::PrelandsRails::CreateSimpleSource::DetectIncomingLocales,

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,5 +41,11 @@ require 'prelands_rails/update_simple_source'
 
 require 'prelands_rails/validate_simple_source'
 
+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
 end

data/prelands_rails.gemspec

@@ -5,7 +5,7 @@ end
 
 Gem::Specification.new do |spec|
   spec.name          = "prelands_rails"
-  spec.version       = "0.1.2"
+  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.2
+  version: 0.1.5
 platform: ruby
 authors:
 - C80609A
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-23 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: interactor
@@ -312,9 +312,16 @@ files:
 - lib/prelands_rails/create_simple_source/validate_zip_content/validate_incoming_files/zip_archive.rb
 - lib/prelands_rails/create_simple_source/validate_zip_content/validate_js.rb
 - 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
@@ -343,7 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Код, занимающийся валидацией и публикацией прелендов V4.