docgen-adapter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5843bd2a380e11e802a39d91839e5daa56ed848ebf3f9c1ec8d4c02a5fe96331
+  data.tar.gz: a1d2955903f75f3b1a5d64cc03cd16b879c7346aab5e5259bdd6a7c376557609
+SHA512:
+  metadata.gz: 62f713cb8e3a6047295e8dabf3a2f11d20498e53448dcb2ffa75d5fe1e1b02fd4295b6871aa0a3a28d5910930c5d2202725df36bf3eba77da8d4ab740819e148
+  data.tar.gz: 23d0dd3ac4e4686756df2f0237997b45db796a4c80e0e665d20a6ad1d019156370da7e207c8b0f5f5bca7c7dd7e9e1f837e37342628197e955aa9967539f49ab

data/README.md

@@ -0,0 +1,64 @@
+# DocGen Adapter
+[![Gem Version](https://badge.fury.io/rb/docgen-adapter.svg)](https://badge.fury.io/rb/docgen-adapter)
+
+Гем для адаптации собственного сервиса генерации документов и упрощения работы с ним.
+
+## Установка
+
+Добавить в Gemfile
+
+```ruby
+gem 'docgen-adapter'
+```
+
+И выполнить:
+
+```bash
+bundle
+```
+
+## Конфигурация
+
+Добавьте файл конфигурации `config/initializers/docgen_adapter.rb` и задайте необходимые настройки:
+
+```ruby
+DocgenAdapter.configure do |config|
+
+  config.redis_host     = ''
+  config.redis_port     = ''
+  config.redis_password = ''
+
+end
+```
+
+## Использование
+
+Использование с помощью вызова метода `generate` класса `DocgenAdapter`. Например:
+
+```ruby
+params = {
+  DocumentNumber: 12345678,
+  Houses: [
+    {
+      HouseAddress: 'г. Калуга',
+      PersonFIO: 'Иванов ИИ',
+      PersonState: 'электромонтер',
+      PersonPhone: '89171234567',
+      OrganizationName: 'Россети',
+      OrganizationAddress: 'г. Обнинск',
+      OrganizationPhone: '1234567',
+      OrganizationCite: 'https://www.rosseti.ru'
+    }
+  ]
+}
+
+DocgenAdapter.new(type: 'docx', doc_id: 1, debug: true).generate(params)
+```
+
+Опции:
+
+- `type` - тип документа, возможные значения: `docx`, `xlsx`
+
+- `doc_id` - ID документа
+
+- `debug` - необязательная опция для дебага, при передаче `debug: true` при вызове отображаются формируемые параметры

data/lib/docgen-adapter.rb

@@ -0,0 +1 @@
+require 'docgen_adapter'

data/lib/docgen_adapter/configuration.rb

@@ -0,0 +1,17 @@
+class DocgenAdapter
+  class Configuration
+
+    attr_accessor :redis_host,
+                  :redis_port,
+                  :redis_password
+  end
+
+  def self.configure
+    yield(config)
+    config
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+end

data/lib/docgen_adapter.rb

@@ -0,0 +1,125 @@
+require 'docgen_adapter/configuration'
+require 'redis'
+
+class DocgenAdapter
+
+  def initialize(type:, doc_id:, debug: false)
+    # аргументы сервиса
+    @type = type
+    @doc_id = doc_id
+    @debug = Rails.env.development? && debug
+    @task_id = SecureRandom.uuid
+
+    # формирование названия генерируемого файла
+    dir = Dir.mktmpdir
+    @filename = "#{dir}/#{@task_id}_#{@doc_id}.#{@type}"
+  end
+
+  # выполнение генерации документа
+  def generate(params = {})
+    @service_params = build_params(params)
+
+    # отображение параметров для проверки
+    puts JSON.pretty_generate(JSON.parse(@service_params)) if @debug
+
+    # подписка ка канал и ожидание сообщений в другом потоке
+    Thread.new { subscribe_and_listen }
+
+    # ожидание
+    sleep(0.5)
+
+    # отправка сообщения с заданием
+    redis.publish('TASKS', @service_params)
+
+    # путь до сгенерированного файла в ответе
+    @filename
+  end
+
+  private
+
+  # соединение с микросервисом через Redis
+  def redis
+    @redis ||= Redis.new(
+      host: DocgenAdapter.config.redis_host,
+      port: DocgenAdapter.config.redis_port,
+      password: DocgenAdapter.config.redis_password
+    )
+  end
+
+  # подписаться на канал задания и ожидать сообщения
+  def subscribe_and_listen
+    redis.subscribe(@task_id) do |on|
+      on.subscribe do |channel|
+        puts "Подписка на канал задания #{channel}"
+      end
+
+      # обработка сообщений
+      on.message do |_channel, message|
+        handle_redis_message(message)
+      end
+
+      on.unsubscribe do |channel|
+        puts "Отписка от канала задания #{channel}"
+      end
+    end
+  end
+
+  # формирование объекта с параметрами
+  def build_params(params)
+    {
+      ИдентификаторЗадачи: @task_id,
+      ИдентификаторДокумента: @doc_id,
+      ТипДокумента: @type,
+      Md5ДополнительныхФайлов: [],
+      ПараметрыДокумента: params
+    }.to_json
+  end
+
+  # обработка сообщения пришедшего в канал Redis
+  def handle_redis_message(message)
+    # игнорируем сообщение с ID задания
+    return if message == @task_id
+
+    case message.encoding.to_s
+    when 'UTF-8'
+      handle_doc_info(message)
+    when 'ASCII-8BIT'
+      handle_doc_file(message)
+    end
+  end
+
+  # обработка JSON с информацией о документе
+  def handle_doc_info(message)
+    object = JSON.parse(message)
+
+    case object['Результат']
+    when 0
+      # успех
+      # TODO: добавить обработку
+    when 1
+      # ошибка
+      exception_msg = handle_exception(object)
+      raise StandardError.new(exception_msg)
+    end
+  end
+
+  # обработка бинарных данных файла документа
+  def handle_doc_file(message)
+    # запись бинарных данных в файл
+    File.write @filename, message.force_encoding('utf-8')
+
+    # сообщение с файлом приходит последним - отписка от канала Redis
+    redis.unsubscribe
+  end
+
+  def handle_exception(object)
+    text = "Генерация документа #{@doc_type}: #{object['ИдентификаторЗадачи']}\n" + object['ОписаниеОшибки']['Сообщение'] + object['ОписаниеОшибки']['СтекВызовов']
+
+    if Rails.env.development?
+      puts text
+    else
+      Rollbar.error(text, params: @service_params)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: docgen-adapter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Павел Бабин
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+description: Адаптер собственного сервиса генерации документов
+email: babin359@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/docgen-adapter.rb
+- lib/docgen_adapter.rb
+- lib/docgen_adapter/configuration.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Адаптер собственного сервиса генерации документов
+test_files: []