prelands_rails 0.1.0

data/lib/prelands_rails/create_simple_source/upload/uploader.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class Upload
+      #
+      # Загрузчик файлов на AWS.
+      #
+      class Uploader
+        def initialize(creds, aws_prefix, client_class = ::PrelandsRails::MyAwsClient)
+          @folder = aws_prefix
+          @client = client_class.new creds[:access_key], creds[:secret_key], creds[:region]
+        end
+
+        # На вход подан путь к файлу на хосте, который грузим на aws с указанным именем.
+        #
+        # @param [String] file_path
+        # @param [String] s3_file_name
+        # @param [String] bucket_name
+
+        def upload_file(s3_file_name, file_path, bucket_name)
+          @client.upload_file file_path, path(s3_file_name), bucket_name
+        end
+
+        # На вход подана строка +file_content+. Сохраняем её, как файл с указанным именем.
+        #
+        # @param [String] s3_file_name
+        # @param [String] file_content
+        # @param [String] bucket_name
+
+        def upload_content(s3_file_name, file_content, bucket_name)
+          Tempfile.create(SecureRandom.uuid) do |file|
+            file.write file_content.force_encoding('utf-8')
+            file.close
+            @client.upload_file file.path, path(s3_file_name), bucket_name
+          end
+        end
+
+        private
+
+        def path(file)
+          [@folder, file].join('/')
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/upload.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    #
+    # Загрузит на aws скомпилированные html, icon.ico, index.js и содержимое директории images/
+    #
+    class Upload
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      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
+
+      before do
+        @uploader = Uploader.new(context.s3_credentials, context.aws_prefix)
+      end
+
+      def act
+        context.bucket_names.each do |bucket_name|
+          images_files.map do |file_name, file_path|
+            @uploader.upload_file file_name, file_path, bucket_name
+          end
+
+          compiled_html_files.map do |file_name, content|
+            @uploader.upload_content file_name, content, bucket_name
+          end
+
+          @uploader.upload_content 'index.js', context.files_content['index.js'], bucket_name
+        end
+
+        del_tmp_files
+        context.uploaded_images = images_files
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+
+      private
+
+      IMAGES = /\A(images\/.+|icon\.ico)\z/
+
+      def images_files
+        return @images_files if defined?(@images_files)
+
+        @tmp_paths = []
+
+        @images_files ||= Zip::File.open(context.archive.tempfile) do |zipfile|
+          zipfile.map do |entry|
+            next if entry.name.index(IMAGES) != 0
+
+            tmp_path = Rails.root.join make_tmp_path
+            entry.extract tmp_path
+            @tmp_paths << tmp_path
+
+            [entry.name, tmp_path]
+          end.compact.to_h
+        end
+      end
+
+      def del_tmp_files
+        @tmp_paths.each do |path|
+          File.delete(path) if File.exists?(path)
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/validate_zip_content/validate_html/html.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      class ValidateHtml
+        #
+        # Принимает строку с html разметкой и валидирует её.
+        #
+        class Html
+          attr_reader :errors
+
+          # @param [String] string Содержимое html файла.
+          def initialize(string, continue_id)
+            @errors      = []
+            @continue_id = continue_id
+            @string      = string.gsub(/(\r\n?|\n)/, '') # убираем переносы, мешающие регуляркам
+          end
+
+          def valid?
+            @errors = [
+              check_internal_scripts,
+              check_internal_styles,
+              check_continue_element,
+              check_js_plug,
+              check_css_plug,
+              check_title_presence,
+              check_a_hrefs,
+              check_favicon
+            ].compact
+
+            !@errors.any?
+          end
+
+          private
+
+          # @return [nil]     Если внутри html НЕ содержится JavaScript код в виде <script>...</script>
+          # @return [String]  Иначе - вернёт сообщение об ошибке
+          def check_internal_scripts
+            rx  = /<script[^>]*>([^<]+)<\/script>/
+            return unless any(rx)
+
+            'A JavaScript code is detected inside html-file. Please, move it to index.js.'
+          end
+
+          def check_internal_styles
+            rx  = /<style[^>]*>([^<]+)<\/style>/
+            return unless any(rx)
+
+            'An internal CSS is detected inside html-file. Please, move it to index.css.'
+          end
+
+          def check_continue_element
+            rx  = Regexp.new('id="%s"' % @continue_id)
+            res = @string.scan(rx).flatten
+            return if res.size == 1
+
+            return 'The continue element with id="%s" must be uniq. Found %s matches.' % [@continue_id, res.size] if res.size > 1
+
+            'Not found continue element with id="%s"' % @continue_id
+          end
+
+          def check_js_plug
+            body_rx  = /<body[^>]*>(.+)<\/body>/
+            js_rx    = '<script src="index.js"'
+
+            @string[body_rx]
+            res = $1&.[](js_rx)
+            return if res.present?
+
+            'Plug index.js script before closing tag of body.'
+          end
+
+          def check_css_plug
+            head_rx  = /(?<=<head)(.+)(?=<\/head>)/
+            css_rx   = 'href="index.css"'
+
+            @string[head_rx]
+            res = $1&.[](css_rx)
+            return if res.present?
+
+            'Plug index.css before closing tag of head.'
+          end
+
+          def check_title_presence
+            title_rx = /<title>[^<]+<\/title>/
+            return if @string[title_rx]
+
+            'Tag <title> not found.'
+          end
+
+          def check_a_hrefs
+            ahref_rx = /<a[^>]+href="[^"]+"/
+            return unless @string[ahref_rx]
+
+            'Links with href attribute found.'
+          end
+
+          def check_favicon
+            favicon_rx = '<link rel="shortcut icon" href="icon.ico">'
+            return if @string[favicon_rx]
+
+            '<link rel="shortcut icon" href="icon.ico"> not found.'
+          end
+
+          protected
+
+          def any(regex)
+            @string.scan(regex).flatten.map(&:strip).map(&:present?).any?
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      #
+      # Валидирует все html файлы.
+      #
+      class ValidateHtml
+        include ::PrelandsRails::AbstractInteractor
+        include ::Interactor
+        include ::Interactor::Contracts
+        include ::PrelandsRails::Base
+
+        CONTINUE_ID = 'continue'
+
+        expects do
+          required(:files_content).value(type?: Hash)                           # { file_name => file_content, ... }
+        end
+
+        assures do
+
+        end
+
+        def act
+          errors =
+            incoming_html_files.map do |key, content|
+              content = Html.new(content, CONTINUE_ID)
+              next if content.valid?
+              [key, content.errors]
+            end.compact.to_h
+
+          fail! errors: errors if errors.any?
+        end
+
+        on_breach { |breaches| bad_expects breaches }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      class ValidateJs
+        #
+        # Принимает строку с JavaScript кодом разметкой и валидирует её.
+        #
+        class Js
+          attr_reader :errors
+
+          # @param [String] string Содержимое JavaScript файла.
+          def initialize(string)
+            @errors = []
+            @string = string.gsub(/(\r\n?|\n)/, '') # убираем переносы, мешающие регуляркам
+          end
+
+          def valid?
+            @errors = [
+              check_location_changes,
+              check_framework_calls
+            ].compact
+
+            !@errors.any?
+          end
+
+          private
+
+          def check_location_changes
+            match_data    = @string.match LOCATION_RX
+            is_loc_assign = ->(matched) { matched =~ /^('|")$/ || @string.match(/(;|\s*)#{matched}\s*=\s*('|")/) }
+            return unless match_data && is_loc_assign[match_data[3]]
+
+            'Location statement has found'
+          end
+
+          def check_framework_calls
+            res = FUNCS_RX.map do |key, func|
+              [ key, !!@string[func] ]
+            end
+
+            return if res.map { |kf| kf[1] }.all?
+
+            res.to_h.map do |key, result|
+              'Call of %s() not found' % key if !result
+            end.compact.join('; ')
+          end
+
+          private
+
+          LOCATION_RX = /(;|\s*)location(\.href\s*=|\.replace\(|\.assign\(|\s*=)\s*(\w+|"|')/
+          FUNCS_RX = {
+            post_email:  /post_email\([^)]+\)/,
+            post_gender: /post_gender\([^)]+\)/,
+            post_age:    /post_age\([^)]+\)/
+          }.freeze
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class ValidateZipContent
+      #
+      # Валидирует JavaScript код.
+      #
+      class ValidateJs
+        include ::PrelandsRails::AbstractInteractor
+        include ::Interactor
+        include ::Interactor::Contracts
+
+        expects do
+          required(:files_content).value(type?: Hash) # { file_name => file_content, ... }
+        end
+
+        assures do
+
+        end
+
+        def act
+          content = context[:files_content]['index.js']
+          content = Js.new(content)
+          fail! errors: {'index.js' => content.errors} unless content.valid?
+        end
+
+        on_breach { |breaches| bad_expects breaches }
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/validate_zip_content.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    #
+    # Примет содержимое файлов и валидирует их контент.
+    #
+    class ValidateZipContent
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor::Organizer
+      include ::Interactor::Contracts
+
+      expects do
+        required(:files_content).value(type?: Hash)                             # { file_name[String] => file_content[String], ... }
+      end
+
+      assures do
+
+      end
+
+      organize ValidateHtml, ValidateJs#, ValidateCss
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  #
+  # Примет zip-файл с исходниками преленда и опубликует этот преленд.
+  #
+  class CreateSimpleSource
+    include ::PrelandsRails::AbstractInteractor
+    include ::Interactor::Organizer
+    include ::Interactor::Contracts
+
+    expects do
+      required(:archive).filled                                                 # Входящий архив с исходниками от фрилансера. Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+      required(:preland_domain_ids).filled(type?: Array)
+      required(:expected_locales).filled(type?: Array)                          # Список локалей, для которых must were all index_<locale>.html files in the zip archive
+      required(:s3_credentials).schema do
+        required(:access_key).filled(:str?)
+        required(:secret_key).filled(:str?)
+        required(:region).filled(:str?)
+      end
+      required(:bucket_names).filled(type?: Array)
+      required(:aws_prefix).value(type?: String)                                # имя директории в букете
+      required(:preland_id).filled
+      required(:static_js_path).value(type?: String)                            # путь к размещённым в интернете нашим js скриптам
+      required(:model_preland_simple_source).filled
+    end
+
+    before do
+      fail!(errors: 'Preland domains missing') if context.preland_domain_ids.empty?
+    end
+
+    assures do
+      required(:incoming_locales).filled(type?: Array)
+      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
+    end
+
+    organize DetectIncomingLocales,
+             CheckZipFiles,
+             ValidateZipContent,
+             Compile,
+             Upload,
+             CreateRecord
+
+    on_breach { |breaches| bad_expects breaches }
+  end
+end

data/lib/prelands_rails/update_simple_source/check_zip_files.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class UpdateSimpleSource
+
+    class CheckZipFiles
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+
+      expects do
+        required(:archive)                                                      # Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        required(:expected_locales).value(type?: Array)
+        required(:incoming_locales).filled(type?: Array)
+      end
+
+      assures do
+        optional(:files_content).maybe(type?: Hash)                             # js,html,css: { file_name => file_content, ... }
+      end
+
+      before do
+
+      end
+
+      def act
+        if context.archive
+          result = ::PrelandsRails::CreateSimpleSource::CheckZipFiles.call context
+          if result.success?
+            context.files_content = result.files_content
+          else
+            fail!(errors: result.errors)
+          end
+        end
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/update_simple_source/compile.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class UpdateSimpleSource
+
+    class Compile
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+
+      expects do
+        optional(:files_content).maybe(type?: Hash)                             # js,html,css: { file_name => file_content, ... }
+        required(:static_js_path).value(type?: String)
+      end
+
+      assures do
+        optional(:compiled_htmls).value(type?: Hash)                            # { file_name[String] => compiled_content[String], ... }
+      end
+
+      before do
+
+      end
+
+      def act
+        if context.files_content
+          result = ::PrelandsRails::CreateSimpleSource::Compile.call context
+          if result.success?
+            context.compiled_htmls = result.compiled_htmls
+          else
+            fail!(errors: result.errors)
+          end
+        end
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/update_simple_source/update_record.rb

@@ -0,0 +1,41 @@
+module PrelandsRails
+  class UpdateSimpleSource
+    #
+    # обновит запись ::Preland::SimpleSource
+    #
+    class UpdateRecord
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      expects do
+        required(:archive)                                                      # Входящий архив с исходниками от фрилансера. Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        required(:aws_prefix).value(type?: String)                              # имя директории в букете
+        required(:preland_id).filled
+        required(:preland_domain_ids).value(type?: Array)
+        required(:incoming_locales).filled(type?: Array)
+        required(:model_preland_simple_source).filled
+      end
+
+      assures do
+        required(:preland_simple_source).filled
+      end
+
+      before do
+
+      end
+
+      def act
+        source                    = context.model_preland_simple_source.find_by aws_prefix: context.aws_prefix
+        source.archive            = context.archive if context.archive
+        source.preland_domain_ids = context.preland_domain_ids
+        source.locales            = context.incoming_locales
+        source.save!
+        context.preland_simple_source = source
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class UpdateSimpleSource
+    class Upload
+      #
+      # Удалить из +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]
+
+          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
+            end.compact
+
+            next if files.empty?
+
+            client.delete_objects bucket_name, files
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/update_simple_source/upload.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class UpdateSimpleSource
+
+    class Upload
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include DeleteCompiledFiles
+
+      expects do
+        required(:archive)                                                      # Входящий архив с исходниками от фрилансера. Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        optional(:compiled_htmls).maybe(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)
+        optional(:files_content).maybe(type?: Hash)                             # js,html,css: { file_name => file_content, ... }
+      end
+
+      assures do
+
+      end
+
+      before do
+
+      end
+
+      def act
+        if context.archive && context.compiled_htmls && context.files_content
+          delete_compiled_files
+          ::PrelandsRails::CreateSimpleSource::Upload.call context
+        end
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/update_simple_source/validate_zip_content.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class UpdateSimpleSource
+
+    class ValidateZipContent
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+
+      expects do
+        optional(:files_content).maybe(type?: Hash)                             # js,html,css: { file_name => file_content, ... }
+      end
+
+      assures do
+
+      end
+
+      before do
+
+      end
+
+      def act
+        if context.files_content
+          result = ::PrelandsRails::CreateSimpleSource::ValidateZipContent.call context
+          unless result.success?
+            fail!(errors: result.errors)
+          end
+        end
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end