prelands_rails 0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 C80609A
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,4 @@
+DIR = $(shell pwd)
+
+setup_local_gem:
+	bundle config local.prelands_rails $(DIR)

data/README.md

@@ -0,0 +1,4 @@
+# PrelandsRails (Rails based gem) 
+
+Код, занимающийся валидацией и публикацией прелендов V4.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prelands_rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/prelands_rails/concerns/abstract_interactor.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  module AbstractInteractor
+    include ::Interactor
+    include ::Interactor::Contracts
+    include CanHandleErrors
+
+    delegate :fail!, :to => :context
+
+    def call
+      begin
+        act
+      rescue ::Interactor::Failure # bad promises
+        report_error 'Bad promises: %s' % context.errors, context.to_h
+        fail! errors: context.errors
+      rescue ::ActiveRecord::RecordNotFound => e
+        report_error e.message, context.to_h
+        fail! errors: 'not found'
+      rescue StandardError => e
+        error_handler e, context.to_h
+        fail! errors: e.message
+        custom_error_handler e
+      end
+    end
+
+    private
+
+    def act
+      raise NotImplementedError, "The `act` method must be defined in #{self.class}"
+    end
+
+    def custom_error_handler(_e); end
+
+    protected
+
+    def bad_expects(breaches)
+      errors = build_errors_message breaches
+      fail! errors: errors
+    end
+
+    # [{0=>["fail1", "fail2"], 1=>["fail1", "fail3"]}] => "fail1 ; fail2 ; fail3"
+    def build_errors_message(breaches)
+      msgs = breaches.map(&:messages).inspect.scan /(?<=")[^"\]\[{}]+(?=")/
+      (msgs - [', ']).map { |m| [m,nil] }.to_h.keys.join('; ')
+    end
+  end
+end

data/lib/prelands_rails/concerns/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  module Base
+
+    private
+
+    RX_HTML_FILE = /\.html/
+    NAME_RX      = /index_(\w{2})\.html/
+
+    # извлекаем входящие html файлы из контекста
+    def incoming_html_files
+      context.files_content.select { |key| key =~ RX_HTML_FILE }
+    end
+
+    # извлекаем скомпилированные html файлы из контекста
+    def compiled_html_files
+      context.compiled_htmls.select { |key| key =~ RX_HTML_FILE }
+    end
+
+    def make_tmp_path
+      'tmp/cache/%s' % SecureRandom.uuid
+    end
+  end
+end

data/lib/prelands_rails/concerns/can_handle_errors.rb

@@ -0,0 +1,31 @@
+# # frozen_string_literal: true
+
+module PrelandsRails
+  module CanHandleErrors
+    private
+
+    # Отправит ошибку в Sentry, выведет в лог красным название класса, текст ошибки и backtrace
+    def error_handler(error, extra = {})
+      error_text = ['[%s] ' % self.class, error.message].join
+      Rails.logger.warn "\n\t\e[31m\e[1m%s\e[0m" % error_text
+      Rails.logger.warn "\n\e[31m\t%s \e[0m\n" % (error.backtrace[0..9] *  "\n\t")
+      Raven.capture_exception(error, extra: extra) if defined?(Raven)
+    end
+
+    # Отправит message в Sentry, в dev/test лог скинет pretty extra info
+    def report_error(error_message = context.errors, extra = {})
+      message = ['[%s] ' % self.class, error_message].join
+
+      if Rails.env.test? || Rails.env.development?
+        div = '-' * 120
+        Rails.logger.warn div
+        Rails.logger.warn "\e[31m\e[1m%s\e[0m\n" % message
+        # Rails.logger.ap extra
+        Rails.logger.warn div
+      else
+        Raven.capture_message(message, extra: extra) if defined?(Raven)
+      end
+
+    end
+  end
+end

data/lib/prelands_rails/concerns/hash.rb

@@ -0,0 +1,11 @@
+class Hash
+  def to_struct
+    Struct.new(*keys).new(*values)
+  end
+
+  # Convert Hash to OpenStruct recursively
+  # https://coderwall.com/p/74rajw/convert-a-complex-nested-hash-to-an-object
+  def to_o
+    JSON.parse to_json, object_class: OpenStruct
+  end
+end

data/lib/prelands_rails/concerns/my_aws_client.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-s3'
+
+module PrelandsRails
+  class MyAwsClient
+
+    ACL_PUBLIC_READ = 'public-read'
+
+    def initialize(access_key, secret_key, region)
+      @s3 = Aws::S3::Resource.new(region: region, access_key_id: access_key, secret_access_key: secret_key)
+    end
+
+    def bucket_objects_count(bucket_name)
+      bucket = @s3.bucket bucket_name
+      result = bucket.objects.count
+      log :bucket_objects_count, 'bucket_name=%s, result=%s' % [bucket_name, result]
+      result
+    rescue Aws::S3::Errors::NoSuchBucket
+      log :bucket_objects_count, ['No such bucket: ', bucket_name].join
+    end
+
+    # @return [struct Aws::S3::Types::ListBucketsOutput]
+    def list_buckets
+      result = @s3.client.list_buckets({})
+      log :list_buckets, result.buckets.map(&:name)
+    end
+
+    # @return [True]
+    def create_bucket_if_not_exists(bucket_name)
+      log :create_bucket_if_not_exists, 'bucket_name=%s' % bucket_name
+      @s3.create_bucket bucket: bucket_name
+      true
+    rescue Aws::S3::Errors::BucketAlreadyOwnedByYou
+      true
+    rescue StandardError => e
+      log :create_bucket_if_not_exists, e.message
+      false
+    end
+
+    def delete_bucket(bucket_name)
+      log :delete_bucket, 'bucket_name=%s' % bucket_name
+      @s3.client.delete_bucket bucket: bucket_name
+    rescue StandardError => e
+      log :delete_bucket, e.message
+      false
+    end
+
+    def list_objects(bucket_name)
+      log :list_objects, 'bucket_name=%s' % bucket_name
+      result = (@s3.client.list_objects bucket: bucket_name).contents.map(&:key)
+      log :list_objects, result
+      result
+    rescue StandardError => e
+      log :list_objects, e.message
+      false
+    end
+
+    def delete_objects(bucket_name, objects)
+      log :delete_objects, 'bucket_name=%s' % bucket_name
+      result = @s3.client.delete_objects({
+        bucket: bucket_name,
+        delete: {
+          objects: objects
+        }
+      })
+      log :delete_objects, result
+    rescue StandardError => e
+      log :delete_objects, e.message
+      false
+    end
+
+    # @param [String] path_to_file  Абсолютный к файлу на хосте.
+    # @param [String] s3_file_name  Под каким именем будет сохранён файл на AWS.
+    # @param [String] bucket_name   Название bucket
+
+    def upload_file(path_to_file, s3_file_name, bucket_name)
+      begin
+        obj = @s3.bucket(bucket_name).object s3_file_name
+        begin
+          if obj.get
+            log :upload_file, [s3_file_name, ' exists, skipping..'].join('')
+          end
+        rescue Aws::S3::Errors::NoSuchKey => _e
+          obj.upload_file path_to_file, acl: ACL_PUBLIC_READ
+          log :upload_file, [s3_file_name, ' uploaded to "', bucket_name, '".'].join('')
+        end
+      rescue Aws::S3::Errors::NoSuchBucket => _e
+        log :upload_file, 'No such bucket, create bucket: \'%s\'] ' % bucket_name
+        create_bucket_if_not_exists bucket_name
+        retry
+      end
+    end
+
+    private
+
+    def log(method, output)
+      Rails.logger.info "\r\t\e[33m\e[1m<MyAwsClient.%s> %s\e[0m" % [method, output]
+      nil
+    end
+  end
+end
+
+# require 'my_aws_client'
+# client = MyAwsClient.new ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_S3_REGION']
+#
+# client.list_buckets
+# => #<struct Aws::S3::Types::ListBucketsOutput
+#  buckets=
+#    #<struct Aws::S3::Types::Bucket name="psckeditor-dev", creation_date=2020-12-24 13:22:29 UTC>,
+#  owner=#<struct Aws::S3::Types::Owner display_name=nil, id="ca37dafdbd424d0f11ccb2c87a2152b6174bf3986ebbf22760d77eb306f608c2
+#
+# client.bucket_objects_count "psckeditor-dev"
+# => 3
+#
+# client.bucket_objects_count "psckeditor-dev222222222"
+# => nil
+#
+# client.create_bucket_if_not_exists 'psckeditor-dev2'
+# => true
+#
+# MyAwsClient.create_bucket_if_not_exists 'psckeditor-dev2'
+# => true

data/lib/prelands_rails/create_simple_source/check_zip_files/detect_absent_files.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class CheckZipFiles
+      #
+      # Вернёт массив вида ['index.js not found',..]
+      # или пустой массив, если все ожидаемые файлы присутствуют в архиве с исходниками преленда
+      #
+      module DetectAbsentFiles
+        def detect_absent_files(expected_files, incoming_files)
+          raise 'expected_files must be present' unless expected_files.present?
+
+          # опрашиваем по списку пришедший контент
+          expected_files.map do |efile|
+            sought = incoming_files&.find { |ifile| ifile.ftype == efile.ftype && ifile.name == efile.name }
+            if sought.nil?
+              '%s not found' % efile.name
+            end
+          end.compact
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/check_zip_files/extract_files.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class CheckZipFiles
+      module ExtractFiles
+
+        # @return [Hash] { file_name => file_content, ... }
+        def read_into_memory(expected_files, tempfile)
+          Zip::File.open(tempfile) do |zipfile|
+            zipfile.map do |entry|
+              next unless expected_files.find_index { |efile| efile.name == entry.name }.present?
+
+              # Extract
+              tmp_path = Rails.root.join make_tmp_path
+              entry.extract tmp_path
+
+              # Read into memory
+              content = entry.get_input_stream.read
+
+              # Remove tmp file
+              File.delete(tmp_path) if File.exist?(tmp_path)
+
+              [entry.name, content]
+            end.compact.to_h
+          end
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/check_zip_files.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    #
+    # Проверит наличие файлов и директорий в архиве с исходниками преленда:
+    #
+    #   * должен быть файл index.js
+    #   * должен быть файл index.css
+    #   * должна быть директория images/
+    #   * должны быть все языковые файлы index_<lang>.html, согласно локалям преленда
+    #   * размер любого файла не должен превышать 8мб
+    #
+    class CheckZipFiles
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+      include DetectAbsentFiles
+      include ExtractFiles
+
+      expects do
+        required(:archive).filled                                               # Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+        required(:expected_locales).value(type?: Array)
+        required(:incoming_locales).filled(type?: Array)
+      end
+
+      assures do
+        required(:files_content).value(type?: Hash)                             # js,html,css: { file_name => file_content, ... }
+      end
+
+      before do
+        @expected_files =
+          [
+            { ftype: :directory, name: 'images/'   },
+            { ftype: :file,      name: 'index.css' },
+            { ftype: :file,      name: 'index.js'  }
+          ]
+
+        # читаем в память [и компилируем] все входящие с исходником локали
+        (context.expected_locales + context.incoming_locales).uniq.each do |short_name|
+          @expected_files << { ftype: :file, name: 'index_%s.html' % short_name }
+        end
+
+        @expected_files = @expected_files.map(&:to_struct).freeze
+      end
+
+      def act
+        # если нет хотя бы одного файла - уходим с ошибкой
+        absents = detect_absent_files @expected_files, incoming_files
+        if absents.present?
+          fail! errors: absents.join('; ')
+        end
+
+        # считываем в память файлы, которые необходимо валидировать
+        rx1   = /\.(css|js|html)/
+        files = @expected_files.select { |file| file.ftype == :file && file.name =~ rx1 }
+        context.files_content, context.tmp_paths = read_into_memory files, context.archive.tempfile
+      end
+
+      def incoming_files
+        @incoming_files ||= Zip::File.open(context.archive.tempfile) do |zipfile|
+          zipfile.map do |file|
+            if file.size > MAX_SIZE
+              fail! errors: 'File too large when extracted (must be less than %s bytes)' % MAX_SIZE
+            end
+            { ftype: file.ftype, name: file.name }
+          end
+        end.map(&:to_struct).freeze
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+
+      private
+
+      MAX_SIZE = 1024**2 * 8 # 8 MiB
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/compile/html_compiler.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    class Compile
+      #
+      # Компилирует html преленда.
+      #
+      class HtmlCompiler
+
+        attr_reader :compiled
+
+        # @param [String] string    Исходное содержимое входящего html файла.
+        # @param [String] index_css Исходное содержимое файла index.css
+        # @param [String] index_js  Исходное содержимое файла index.js
+        # @param [String] lang      Локаль
+        #
+        def initialize(string, index_css, index_js, lang, static_js_path)
+          @string         = string.gsub(/(\r\n?|\n)/, '') # убираем переносы, мешающие регуляркам
+          @index_css      = index_css
+          @index_js       = index_js
+          @lang           = lang
+          @static_js_path = static_js_path
+          prepare
+        end
+
+        private
+
+        META = '<meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1.0">'
+        HTML = '<!DOCTYPE html><html lang="%{lang}">%{head}%{body}</html>'
+
+        attr_accessor :head, :body
+
+        def prepare
+          build_head
+          build_body
+          build_html
+        end
+
+        # Из входящего head выберем только то, что нужно,
+        # добавим meta,
+        # впишем авторский стиль из index.css,
+        # добавим наш скрипт
+
+        def build_head
+          # фиксируем head
+          head_rx = /(?<=<head).+(?=<\/head>)/
+          result  = @string[head_rx]
+
+          # фиксируем title
+          title_rx = /<title[^>]*>[^<]+<\/title>/
+          title    = @string[title_rx]
+
+          # из head выбираем подключаемые скрипты (js)
+          head_script_rx = /<script[^>]*>[^<]*<\/script>/
+          head_scripts   = result.scan head_script_rx
+
+          # из head выбираем подключаемые линки (css), исключая `index.css`
+          head_link_rx = /<link[^>]+>/
+          head_links   = result.scan head_link_rx
+          head_links   = head_links.select { |string| !string['index.css'] }.compact
+
+          # собираем извлечённое в один массив
+          @head = head_scripts.concat(head_links)
+          @head.unshift title
+          @head.unshift META
+          @head << ('<style>%s</style>' % @index_css)
+          @head = '<head>%s</head>' % @head.join('')
+
+        end
+
+        def build_body
+          body_rx = /<body[^>]*>.+<\/body>/
+          result  = @string[body_rx]
+          @body   = result
+          @body  += static_js
+        end
+
+        # собираем результат
+        def build_html
+          @compiled =
+            HTML % {
+              lang: @lang,
+              head: @head,
+              body: @body
+            }
+        end
+
+        def static_js
+          <<-JS
+<script>
+  (function(d, s, id){
+    var js, fjs = d.getElementsByTagName(s)[0];
+    if (d.getElementById(id)) {return;}
+    js = d.createElement(s); js.id = id;
+    js.async = true;
+    js.src = "#{@static_js_path}?" + Math.random();
+    fjs.parentNode.insertBefore(js, fjs);
+  }(document, 'script', 'sdk'));
+</script>
+          JS
+        end
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/compile.rb

@@ -0,0 +1,44 @@
+module PrelandsRails
+  class CreateSimpleSource
+    #
+    # Из валидных исходников соберёт преленд.
+    #
+    class Compile
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      expects do
+        required(:files_content).value(type?: Hash)                             # { file_name[String] => file_content[String], ... }
+        required(:static_js_path).value(type?: String)
+      end
+
+      assures do
+        required(:compiled_htmls).value(type?: Hash)                            # { file_name[String] => compiled_content[String], ... }
+      end
+
+      def act
+        context[:compiled_htmls] =
+          incoming_html_files.map do |key, content|
+            if NAME_RX =~ key
+              compiled = HtmlCompiler.new(content, index_css, index_js, $1, context.static_js_path).compiled
+              [key, compiled]
+            end
+          end.to_h
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+
+      private
+
+      def index_js
+        context.files_content['index.js']
+      end
+
+      def index_css
+        context.files_content['index.css']
+      end
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/create_record.rb

@@ -0,0 +1,44 @@
+module PrelandsRails
+  class CreateSimpleSource
+    #
+    # Создаст/обновит запись ::Preland::SimpleSource
+    #
+    class CreateRecord
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      expects do
+        required(:archive).filled                                               # Входящий архив с исходниками от фрилансера. 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
+        params = {
+          aws_prefix:         context.aws_prefix,
+          archive:            context.archive,
+          preland_id:         context.preland_id,
+          preland_domain_ids: context.preland_domain_ids,
+          locales:            context.incoming_locales
+        }
+        context.preland_simple_source =
+          context.model_preland_simple_source.create! params
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end

data/lib/prelands_rails/create_simple_source/detect_incoming_locales.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module PrelandsRails
+  class CreateSimpleSource
+    #
+    # запоминаем, какие локали пришли в исходнике
+    #
+    class DetectIncomingLocales
+      include ::PrelandsRails::AbstractInteractor
+      include ::Interactor
+      include ::Interactor::Contracts
+      include ::PrelandsRails::Base
+
+      expects do
+        required(:archive).filled                                               # Входящий архив с исходниками от фрилансера. Rack::Test::UploadedFile | ActionDispatch::Http::UploadedFile
+      end
+
+      assures do
+        required(:incoming_locales).filled(type?: Array)
+      end
+
+      def act
+        context.incoming_locales =
+          Zip::File.open(context.archive.tempfile) do |zipfile|
+            zipfile.map do |file|
+              file.name[NAME_RX]
+              $1
+            end
+          end.compact
+      end
+
+      on_breach { |breaches| bad_expects breaches }
+    end
+  end
+end