care 0.1.0

data/lib/care/seed.rb

@@ -0,0 +1,21 @@
+module Care
+  class Seed
+    def self.execute
+      Dir[File.join(Rails.root, "db", "seeds", "*.json")].sort.each do |path|
+        table_name = path.split("/").last.gsub(".json", "").gsub(/^\d*_/, "")
+        puts "*** Преднаполнение таблицы #{table_name} ***"
+        items = ActiveSupport::JSON.decode(File.read(path))
+        begin
+          items_class = table_name.classify.constantize
+          items_class.import(items, on_duplicate_key_update: :all)
+        rescue NameError => _e # Не обнаружен класс с описанием модели
+          keys = items[0].keys.join(",")
+          values = items.map { |i| "(#{i.values.map { |v| "'#{v}'" }.join(",")})" }.join(",")
+          sql = "insert into #{table_name}(#{keys}) values #{values} on conflict (id) do nothing"
+          puts sql
+          ActiveRecord::Base.connection.execute sql
+        end
+      end
+    end
+  end
+end

data/lib/care/support/authorization_helper.rb

@@ -0,0 +1,20 @@
+RSpec.shared_context "set_authorization" do
+
+  let(:organization_id) { SecureRandom.uuid }
+
+  let(:payload) do
+    {
+      iss: "DocShell",
+      iat: DateTime.now.to_i,
+      jti: SecureRandom.uuid,
+      exp: (DateTime.now + 1.year).to_i,
+      account: {
+        id: SecureRandom.uuid,
+        email: Faker::Internet.email,
+      },
+      permissions: { organization_id  => permissions }
+    }
+  end
+  let(:Authorization) { "Bearer #{Care::JwtService.new.encode(payload)}" }
+end
+

data/lib/care/support/error_collection.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "error_collection" do |codes|
+  if codes.include?("400")
+    response 400, " Недопустимые параметры" do
+      let(:params) { {data: "invalid"} }
+      schema "$ref": "#/components/schemas/ErrorsOutput"
+      run_test!
+    end
+  end
+
+  if codes.include?("401")
+    response 401, "Учетная запись не авторизована" do
+      let(:Authorization) { nil }
+      schema "$ref": "#/components/schemas/ErrorsOutput"
+      run_test!
+    end
+  end
+
+  if codes.include?("403")
+    response 403, "Нет прав доступа к ресурсу" do
+      let(:permissions) {[]}
+      schema "$ref": "#/components/schemas/ErrorsOutput"
+      run_test!
+    end
+  end
+
+  if codes.include?("404")
+    response 404, "Ресурс не найден" do
+      let(:organization_id) { SecureRandom.uuid }
+      schema "$ref": "#/components/schemas/ErrorsOutput"
+      run_test!
+    end
+  end
+
+  if codes.include?("422")
+    response 422, "Недопустимая модель ресурса" do
+      let(:params) { invalid_params }
+      schema "$ref": "#/components/schemas/ErrorsOutput"
+      run_test!
+    end
+  end
+end

data/lib/care/support/factory_bot.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+end

data/lib/care/support/pagination.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "headers" do |header_tags|
+  if header_tags.include?(:Authorization)
+    header "X-Pagination-Count", type: :integer, description: "Общее количество с учетом search"
+    header "X-Pagination-Limit", type: :integer, description: "Количество элементов на странице"
+    header "X-Pagination-Page", type: :integer, description: "Номер текущей страницы"
+  end
+end

data/lib/care/support/parameters.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+RSpec.shared_context "parameters" do |parameter_tags|
+  if parameter_tags.include?(:Authorization)
+    parameter name: :Authorization,
+              description: "Client token",
+              in: :header,
+              type: :string,
+              required: true
+  end
+  if parameter_tags.include?(:organization_id)
+    parameter name: :organization_id,
+              description: "Organization ID текущей организации",
+              in: :header,
+              type: :string,
+              required: true
+  end
+  if parameter_tags.include?(:id)
+    parameter name: :id,
+              description: "Идентификатор",
+              in: :path,
+              type: :string,
+              required: true
+  end
+  if parameter_tags.include?(:base_for_index)
+    parameter name: :search,
+              description: "Строка для поиска ресурса (часть имени, как пример)",
+              in: :query, type: :string, required: false
+    parameter name: :limit,
+              description: "Ограничение кол-ва записей на странице.(20)",
+              in: :query, type: :integer, required: false
+    parameter name: :sort,
+              description: "Поле по которому производится сортировка.",
+              in: :query, type: :integer, required: false
+    parameter name: :page,
+              description: "Номер страницы",
+              in: :query, type: :integer, required: false
+  end
+end

data/lib/care/support/request_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RequestHelper
+  def json
+    JSON.parse(response.body, symbolize_names: true)
+  end
+end
+
+RSpec.configure do |config|
+  config.include RequestHelper, type: :request
+end

data/lib/care/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Care
+  VERSION = "0.1.0"
+end

data/lib/generators/care/install/USAGE

@@ -0,0 +1,19 @@
+Description:
+  Adds care initializer for configuration
+
+Example:
+    rails generate care:install
+
+    This will create:
+        spec/swagger_helper.rb
+        spec/support/#{app_name}.yml
+        config/initializers/rswag_api.rb
+        config/initializers/rswag-ui.rb
+        config/initializers/active_model_serializer.rb
+        config/initializers/centrifuge.rb
+
+    Will be recursively executed rails generate rspec:install
+
+    Will add route
+        mount Rswag::Api::Engine => '/api-docs'
+        mount Rswag::Ui::Engine => '/api-docs'

data/lib/generators/care/install/install_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+
+module Care
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::AppName
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def add_initializer
+      gem 'rspec-rails', group: [:development, :test], version: '~> 4.0.1'
+      gem "rswag"
+      template('swagger_helper.rb', 'spec/swagger_helper.rb')
+      template("swagger.yml", "spec/support/#{app_name}.yml")
+      template('rswag_api.rb', 'config/initializers/rswag_api.rb')
+      template('rswag-ui.rb', 'config/initializers/rswag-ui.rb')
+
+      gem "active_model_serializers", version: "~> 0.10.10"
+      template('active_model_serializer.rb', 'config/initializers/active_model_serializer.rb')
+
+      gem "centrifuge", version: "~> 1.2"
+      template('centrifuge.rb', 'config/initializers/centrifuge.rb')
+    end
+
+    def install_components
+      generate 'rspec:install'
+    end
+
+    def add_routes
+      route("mount Rswag::Api::Engine => '/api-docs'")
+      route("mount Rswag::Ui::Engine => '/api-docs'")
+    end
+  end
+end

data/lib/generators/care/install/templates/.env.local.example

@@ -0,0 +1,62 @@
+# secrets.yml
+SECRET_KEY_BASE=4e8814eb30bf558ce07b3a41fcbc657b257344670003d45e828c493c3febc72d25cf24eea9437f9092644e30e839018328f70704f8dce697c007062717801d76
+JWT_SECRET_PATH=jwtRS256.key.pub
+JWT_EXPIRATION_HOURS=24
+
+# database.yml
+DATABASE_HOST=postgres
+DATABASE_PORT=5432
+DATABASE_NAME=docshell
+DATABASE_USERNAME=postgres
+DATABASE_PASSWORD=admin
+
+# MAILER
+MAILER_ADDRESS=smtp.yandex.ru
+MAILER_PORT=465
+MAILER_DOMAIN=yandex.ru
+MAILER_USERNAME=info@docshell.ru
+MAILER_PASSWORD=secret
+MAILER_TLS=true
+MAILER_ENABLE_STARTTLS_AUTO=true
+
+#  SUPPORT SERVICE
+SUPPORT_SERVICE_URL=https://support.docshell.ru
+SUPPORT_API_KEY=s1B2c3D4e5F63421234xcSd
+SUPPORT_EMAIL_TO=dev@dev.dev
+SUPPORT_PHONE=88005553555
+SUPPORT_USE_MAIL=false
+
+#  REPORT SERVICE
+REPORT_SERVICE_HOST=fastreport
+REPORT_SERVICE_PORT=8081
+REPORT_SERVICE_PATH=Home/ExportTemplate
+REPORT_SERVICE_IMAGEHOST=http://api:80
+
+# GOSSOPKA
+GOSSOPKA_URL=
+
+#  REDIS
+REDIS_HOST=redis
+REDIS_PORT=6379
+REDIS_DB=db
+
+# CENTRIFUGO
+CENTRIFUGO_SCHEME=http
+CENTRIFUGO_HOST=centrifugo
+CENTRIFUGO_PORT=8000
+# Секретный ключ должен совпадать с ключом, указанным в файле
+# config/centrifugo/config.json
+CENTRIFUGO_SECRET=c2f0b6a3-ea33-4f20-b708-7943fa7f3bd4
+
+# ROLLBAR
+# Если отсутствует переменная конфигурации rollbar_server_token
+# или содержит пустое значение, то Rollbar отключается
+ROLLBAR_SERVER_TOKEN=secret
+
+# Максимальное количество паралельных заданий на генерацию
+# документов через Fastreport
+# Значение используется с файле
+# engines/parameter_core/app/workers/parameter_core/fastreport_worker.rb
+FASTREPORT_CONCURRENCY_LIMIT=1
+
+

data/lib/generators/care/install/templates/active_model_serializer.rb

@@ -0,0 +1 @@
+ActiveModel::Serializer.config.adapter = :json

data/lib/generators/care/install/templates/centrifuge.rb

@@ -0,0 +1,4 @@
+Centrifuge.scheme = ENV["CENTRIFUGO_SCHEME"]
+Centrifuge.host = ENV["CENTRIFUGO_HOST"]
+Centrifuge.port = ENV["CENTRIFUGO_PORT"]
+Centrifuge.secret = ENV["CENTRIFUGO_SECRET"]

data/lib/generators/care/install/templates/rswag-ui.rb

@@ -0,0 +1,3 @@
+Rswag::Ui.configure do |c|
+  c.swagger_endpoint '/api-docs/<%= app_name %>.yaml', 'DocShell API. <%= app_name.camelize %>.'
+end

data/lib/generators/care/install/templates/rswag_api.rb

@@ -0,0 +1,3 @@
+Rswag::Api.configure do |c|
+  c.swagger_root = Rails.root.to_s + '/swagger'
+end

data/lib/generators/care/install/templates/swagger.yml

@@ -0,0 +1,76 @@
+---
+openapi: 3.0.1
+info:
+  title: DocShell API.<%= app_name.camelize %>
+  version: v1
+tags:
+  - name: DemoModel
+    description: Демо
+paths: {}
+components:
+  securitySchemes:
+    token:
+      type: apiKey
+      name: Authorization
+      in: header
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+  parameters:
+    page:
+      name: page
+      description: Номер страницы
+      in: query
+      required: false
+      schema:
+        type: integer
+    page_limit:
+      name: limit
+      description: Ограничение кол-ва записей на странице.(20)
+      in: query
+      required: false
+      schema:
+        type: integer
+    sort:
+      name: sort
+      description: Поле по которому производится сортировка.
+      in: query
+      required: false
+      schema:
+        type: string
+    query_filter:
+      name: search
+      description: Строка для поиска ресурса (часть имени, как пример)
+      in: query
+      required: false
+      schema:
+        type: string
+  schemas:
+    ErrorsOutput:
+      properties:
+        errors:
+          type: array
+          example:
+            [ '<Локализованное название атрибута> <Локализованное сообщение об ошибке>' ]
+          items:
+            type: string
+        source:
+          type: object
+          example: { <Название атрибута>: [ '<Локализованное сообщение об ошибке>' ] }
+security:
+  - bearerAuth: []
+servers:
+  - url: https://{host}:{port}/
+    description: Development server
+    variables:
+      host:
+        default: localhost
+      port:
+        default: '3000'
+  - url: https://new.docshell.ru/api/<%= app_name %>/v1
+    description: Production server
+  - url: https://demo.docshell.ru/api/<%= app_name %>/v1
+    description: Demo server
+  - url: https://10.0.100.249:8081/api/<%= app_name %>/v1
+    description: Staging server

data/lib/generators/care/install/templates/swagger_helper.rb

@@ -0,0 +1,24 @@
+require "rails_helper"
+
+RSpec.configure do |config|
+  # Specify a root folder where Swagger JSON files are generated
+  # NOTE: If you're using the rswag-api to serve API descriptions, you'll need
+  # to ensure that it's configured to serve Swagger from the same folder
+  config.swagger_root = Rails.root.join("swagger").to_s
+
+  # Define one or more Swagger documents and provide global metadata for each one
+  # When you run the 'rswag:specs:swaggerize' rake task, the complete Swagger will
+  # be generated at the provided relative path under swagger_root
+  # By default, the operations defined in spec files are added to the first
+  # document below. You can override this behavior by adding a swagger_doc tag to the
+  # the root example_group in your specs, e.g. describe '...', swagger_doc: 'v2/swagger.json'
+  config.swagger_docs = {
+      "<%= app_name %>.yml" => YAML.load_file(File.join(__dir__, "support/<%= app_name %>.yml")).with_indifferent_access,
+  }
+
+  # Specify the format of the output Swagger file when running 'rswag:specs:swaggerize'.
+  # The swagger_docs configuration option has the filename including format in
+  # the key, this may want to be changed to avoid putting yaml in json files.
+  # Defaults to json. Accepts ':json' and ':yaml'.
+  config.swagger_format = :yaml
+end

data/lib/patch/action_controller/api.rb

@@ -0,0 +1,17 @@
+require "action_view"
+require 'action_controller/api'
+require_relative 'concerns/authentication'
+require_relative 'concerns/exception_handler'
+require_relative 'concerns/authorization'
+require_relative 'concerns/filter_sort_pagination'
+
+module ActionController
+  class API < Metal
+    # include ActionController::MimeResponds
+    # include ActiveSupport::Rescuable
+    include ExceptionHandler
+    include Authentication
+    include Authorization
+    include FilterSortPagination
+  end
+end

data/lib/patch/action_controller/concerns/authentication.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# В модуле сгруппированы методы отвечающие за аутентификацию
+#
+module Authentication
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :authenticate_request
+    attr_reader :access_token
+
+    private
+
+    def authenticate_request
+      raise AuthenticationError unless access_token
+    end
+
+    def access_token
+      @access_token ||= decode(http_auth_header)
+    end
+
+    def http_auth_header
+      request.headers["Authorization"]&.split(" ")&.last
+    end
+
+    def decode(token)
+      decoded_token = JWT.decode(token, secret_key, true, algorithm: "RS256")
+      HashWithIndifferentAccess.new(decoded_token[0])
+    end
+
+    def secret_key
+      secret_key_file_open { |f| OpenSSL::PKey::RSA.new(f) }
+    end
+
+    def secret_key_file_open(&block)
+      File.open(ENV['JWT_SECRET_PATH'], &block)
+    end
+  end
+
+  #  Используется для сигнализации ошибки во время аутентификации
+  #
+  class AuthenticationError < StandardError
+    attr_reader :param
+
+    def initialize(param)
+      @param = param
+      super("Ошибка аутентификации: #{param}")
+    end
+  end
+end