aho 0.1.0 → 0.1.1

data/lib/aho/schema/validator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Aho
+  module Schema
+    class Validator
+      TYPES = {
+        'string' => String,
+        'number' => Numeric,
+        'integer' => Integer,
+        'boolean' => [TrueClass, FalseClass],
+        'array' => Array,
+        'object' => Hash
+      }.freeze
+
+      def initialize(body, schema, parent_key = nil)
+        @body = body
+        @schema = schema
+        @parent_key = parent_key
+      end
+
+      def validate!
+        validate_required_fields!
+        validate_properties!
+        true
+      end
+
+      private
+
+      def validate_required_fields!
+        @schema['required']&.each do |required_field|
+          raise Api::MissingFieldError, full_key_for(required_field) unless @body.key?(required_field)
+        end
+      end
+
+      def validate_properties!
+        @schema['properties'].each do |key, property_schema|
+          value = @body[key]
+          type = property_schema['type']
+          expected_class = TYPES[type]
+          full_key = full_key_for(key)
+
+          unless [*expected_class].any? { |klass| value.is_a?(klass) }
+            raise Api::InvalidTypeError.new(full_key, type.capitalize, value)
+          end
+
+          self.class.new(value, property_schema, full_key).validate! if type == 'object'
+        end
+      end
+
+      def full_key_for(key)
+        [@parent_key, key].compact.join('.')
+      end
+    end
+  end
+end

data/lib/aho/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Aho
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/lib/aho/web_server/application.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+module Aho
+  module WebServer
+    class Application
+      def call(env)
+        Aho.router.route_for(env) || [404, {}, []]
+      rescue Api::MissingFieldError,
+             Api::InvalidTypeError => e
+        bad_request_error(error: e)
+      rescue JSON::ParserError => e
+        common_error(error: e, status_code: 400)
+      rescue StandardError => e
+        common_error(error: e, status_code: 500)
+      end
+
+      private
+
+      def common_error(error:, status_code:)
+        [
+          status_code,
+          { 'Content-Type' => 'application/json' },
+          [
+            {
+              status: 'ERROR',
+              message: "Internal server error (#{error.class}): #{error.message}",
+              details: error.backtrace.first
+            }.to_json
+          ]
+        ]
+      end
+
+      def bad_request_error(error:)
+        [
+          422,
+          { 'Content-Type' => 'application/json' },
+          [{ status: 'ERROR', message: error.message }.to_json]
+        ]
+      end
+    end
+  end
+end

data/lib/aho/web_server/router.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Aho
+  module WebServer
+    class Router
+      attr_reader :routes
+
+      def initialize
+        @routes = Hash.new { |hash, key| hash[key] = {} }
+      end
+
+      def route_for(env)
+        path = env['PATH_INFO']
+        method = env['REQUEST_METHOD'].downcase
+        destination = routes.dig(method.to_sym, path)
+        return if destination.nil?
+
+        controller = Module.const_get(destination[:controller]).new(env)
+        controller.public_send(destination[:action])
+      end
+
+      %w[get post patch delete].each do |method|
+        define_method(method) do |path, to:|
+          endpoint = Aho::Schema::Parser.new(method, path, to)
+          routes[method.to_sym][path] = {
+            controller: endpoint.controller,
+            action: endpoint.action,
+            schema: endpoint.schema
+          }
+        end
+      end
+    end
+  end
+end

data/lib/aho.rb

@@ -1,15 +1,57 @@
 # frozen_string_literal: true
 
-require_relative "aho/version"
+require 'logger'
+require 'time'
+require 'yaml'
+require 'json'
+require 'rack'
+
+require_relative 'aho/version'
+require_relative 'aho/configuration'
+
+require_relative 'aho/metrics_logger'
+require_relative 'aho/metrics_formatter'
+require_relative 'aho/metrics_logger/period'
+require_relative 'aho/schema/parser'
+require_relative 'aho/schema/validator'
+require_relative 'extensions/hash'
+require_relative 'extensions/dot_hash'
+
+require_relative 'aho/web_server/application'
+require_relative 'aho/web_server/router'
+
+require_relative '../app/controllers/dsp/api/v1/base_controller'
+require_relative '../app/controllers/dsp/api/v1/agent_controller'
+require_relative '../app/controllers/dsp/api/v1/config_controller'
+require_relative '../app/controllers/dsp/api/v1/metrics_controller'
+require_relative '../app/controllers/dsp/api/v1/healthcheck_controller'
+
+require_relative 'aho/metrics_aggregator'
 
 module Aho
-  class Error < StandardError; end
+  class << self
+    def root_path
+      File.dirname __dir__
+    end
 
-  def self.root
-    File.dirname __dir__
-  end
+    def logs_path
+      FileUtils.mkdir_p("#{root_path}/logs").first
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def logger
+      @logger ||= MetricsLogger.new
+    end
+
+    def router
+      @router ||= Aho::WebServer::Router.new
+    end
 
-  def self.logs
-    File.join root, "logs"
+    def metrics
+      Aho::MetricsAggregator.new.metrics
+    end
   end
 end

data/lib/extensions/dot_hash.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class DotHash < Hash
+  def initialize(hash = {})
+    super()
+    hash.each do |key, value|
+      self[key] = value.is_a?(Hash) ? DotHash.new(value) : value
+    end
+  end
+
+  def to_h
+    transform_values { |value| value.is_a?(DotHash) ? value.to_h : value }
+  end
+
+  def method_missing(method_name, *args, &)
+    key = method_name.to_s
+    if key?(key)
+      self[key]
+    elsif key?(method_name)
+      self[method_name]
+    else
+      super
+    end
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    key?(method_name.to_s) || key?(method_name) || super
+  end
+end

data/lib/extensions/hash/deep_mergeable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DeepMergeable
+  def deep_merge(other, &)
+    dup.deep_merge!(other, &)
+  end
+
+  # Same as #deep_merge, but modifies +self+.
+  def deep_merge!(other, &block)
+    merge!(other) do |key, this_val, other_val|
+      if this_val.is_a?(DeepMergeable) && this_val.deep_merge?(other_val)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        yield(key, this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  def deep_merge?(other)
+    other.is_a?(self.class)
+  end
+end

data/lib/extensions/hash.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'hash/deep_mergeable'
+
+class Hash
+  include DeepMergeable
+
+  def deep_transform_values(&)
+    _deep_transform_values_in_object(self, &)
+  end
+
+  def deep_transform_values!(&)
+    _deep_transform_values_in_object!(self, &)
+  end
+
+  def stringify_keys
+    transform_keys(&:to_s)
+  end
+
+  private
+
+  def _deep_transform_values_in_object(object, &block)
+    case object
+    when Hash
+      object.transform_values { |value| _deep_transform_values_in_object(value, &block) }
+    when Array
+      object.map { |e| _deep_transform_values_in_object(e, &block) }
+    else
+      yield(object)
+    end
+  end
+
+  def _deep_transform_values_in_object!(object, &block)
+    case object
+    when Hash
+      object.transform_values! { |value| _deep_transform_values_in_object!(value, &block) }
+    when Array
+      object.map! { |e| _deep_transform_values_in_object!(e, &block) }
+    else
+      yield(object)
+    end
+  end
+end

data/openapi.yml

@@ -0,0 +1,386 @@
+openapi: 3.1.0
+info:
+  title: Aho API
+  version: 1.0.0
+
+paths:
+  /dsp/api/v1/config:
+    post:
+      summary: Configure the agent
+      description: Configures the agent with specified settings.
+      operationId: configureAgent
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                server_id:
+                  type: string
+                  description: ID сервера в Студии
+                jwt:
+                  type: string
+                  description: Токен авторизации
+                ignore_metrics:
+                  type: integer
+                  description: Ограничение сбора метрик
+                upload:
+                  type: object
+                  description: Периодичность сброса данных
+                  properties:
+                    limit_time:
+                      type: integer
+                      description: По времени
+                    limit_lines:
+                      type: integer
+                      description: По количеству событий
+                    limit_size:
+                      type: integer
+                      description: По размеру файла
+                studio_settings:
+                  type: object
+                  description: Настройки API студии для сброса данных
+                  properties:
+                    url:
+                      type: string
+                      description: Протокол, адрес, порт
+                agent_settings:
+                  type: object
+                  description: Настройки агента
+                  properties:
+                    port:
+                      type: integer
+                      description: API порт агента
+                storage:
+                  type: object
+                  description: Настройки хранилища
+                  properties:
+                    limit_size:
+                      type: integer
+                      description: Ограничение на размер хранимых данных
+                    limit_time:
+                      type: integer
+                      description: Ограничение на время хранимых файлов
+                    directory:
+                      type: string
+                      description: Расположение файлов агента
+                file:
+                  type: object
+                  description: Ограничение одного файла ротации
+                  properties:
+                    limit_size:
+                      type: integer
+                      description: По размеру
+                    limit_time:
+                      type: integer
+                      description: По времени
+                archive:
+                  type: object
+                  description: Настройки архивации
+                  properties:
+                    on_files:
+                      type: integer
+                      description: Начинается при создании n-го файла ротации
+                    on_size:
+                      type: integer
+                      description: Начинается при достижении размера данных X mb
+                    limit_files:
+                      type: integer
+                      description: Количество файлов данных, которые архивируется за 1 шаг архивации
+                    compression_level:
+                      type: integer
+                      description: Уровень сжатия
+                aggregation:
+                  type: object
+                  description: Настройки агрегации
+                  properties:
+                    on_files:
+                      type: integer
+                      description: Начинается при создании n-го файла ротации
+                    on_size:
+                      type: integer
+                      description: Начинается при достижении размера данных X mb
+                    level:
+                      type: integer
+                      description: Уровень агрегации данных
+              required:
+                - server_id
+                - jwt
+                - ignore_metrics
+                - upload
+                - studio_settings
+                - agent_settings
+                - storage
+                - file
+                - archive
+                - aggregation
+            examples:
+              validConfig:
+                summary: Example agent configuration
+                value:
+                  server_id: "Server1"
+                  jwt: "1q2w3e4r5t6y"
+                  ignore_metrics: 0
+                  upload:
+                    limit_time: 9999
+                    limit_lines: 100
+                    limit_size: 1
+                  studio_settings:
+                    url: "http://studio.example.com:8088/dsp/api/v1/"
+                  agent_settings:
+                    port: 16888
+                  storage:
+                    limit_size: 0
+                    limit_time: 86400
+                    directory: "/opt/dtms-billing-agent/"
+                  file:
+                    limit_size: 1
+                    limit_time: 0
+                  archive:
+                    on_files: 500
+                    on_size: 0
+                    limit_files: 10
+                    compression_level: -1
+                  aggregation:
+                    on_files: 10
+                    on_size: 0
+                    level: 1
+              invalidType:
+                summary: Example agent configuration
+                value:
+                  server_id: "Server1"
+                  jwt: "1q2w3e4r5t6y"
+                  ignore_metrics: 0
+                  upload:
+                    limit_time: 3600
+                    limit_lines: 100
+                    limit_size: 1
+                  studio_settings:
+                    url: "http://studio.example.com:8088/dsp/api/v1/"
+                  agent_settings:
+                    port: 16888
+                  storage:
+                    limit_size: 0
+                    limit_time: 86400
+                    directory: "/opt/dtms-billing-agent/"
+                  file:
+                    limit_size: 1
+                    limit_time: 'hello_world'
+                  archive:
+                    on_files: 500
+                    on_size: 0
+                    limit_files: 10
+                    compression_level: -1
+                  aggregation:
+                    on_files: 10
+                    on_size: 0
+                    level: 1
+              missingField:
+                summary: Missing field
+                value:
+                  server_id: "Server1"
+      responses:
+        '200':
+          description: Successful configuration
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                  message:
+                    type: string
+              examples:
+                success:
+                  summary: Successful configuration update
+                  value:
+                    status: "OK"
+                    message: "Configuration applied successfully"
+        '400': # TODO: write rspec request example
+          description: Invalid request or permission error
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                  message:
+                    type: string
+              examples:
+                permissionError:
+                  summary: Permission error
+                  value:
+                    status: "ERROR"
+                    message: "You don't have permission to access"
+        '403': # TODO: write rspec request example
+          description: Invalid server ID
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                  message:
+                    type: string
+              examples:
+                invalidServerID:
+                  summary: Invalid server ID
+                  value:
+                    status: "ERROR"
+                    message: "Invalid server ID"
+        '422':
+          description: Invalid configuration
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                  message:
+                    type: string
+              examples:
+                missingField:
+                  summary: Missing required field
+                  value:
+                    status: "ERROR"
+                    message: "Missing required field 'jwt'"
+                invalidType:
+                  summary: Invalid type for field
+                  value:
+                    status: "ERROR"
+                    message: "Invalid type for 'file.limit_time'. Expected Integer, got String"
+        '500': # TODO: write rspec request example
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  status:
+                    type: string
+                  message:
+                    type: string
+              examples:
+                internalError:
+                  summary: Example of an internal server error
+                  value:
+                    status: "ERROR"
+                    message: >
+                      Internal server error (NameError): undefined local variable or method `hello_world'
+                      for an instance of Aho::Schema::Validator
+                    details: "/aho/lib/aho/schema/validator.rb:22:in `validate!'"
+    get:
+      summary: Retrieve the current agent configuration
+      description: Returns the current configuration of the agent.
+      operationId: getAgentConfig
+      responses:
+        '200':
+          description: Current agent configuration
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  server_id:
+                    type: string
+                  ignore_metrics:
+                    type: integer
+                  life_jwt_time:
+                    type: integer
+                  scrape_interval_time:
+                    type: integer
+                  enable_agent:
+                    type: integer
+                  upload:
+                    type: object
+                    properties:
+                      limit_time:
+                        type: integer
+                      limit_lines:
+                        type: integer
+                      limit_size:
+                        type: integer
+                  studio_settings:
+                    type: object
+                    properties:
+                      url:
+                        type: string
+                  agent_settings:
+                    type: object
+                    properties:
+                      port:
+                        type: integer
+                  storage:
+                    type: object
+                    properties:
+                      limit_size:
+                        type: integer
+                      limit_time:
+                        type: integer
+                      directory:
+                        type: string
+                  file:
+                    type: object
+                    properties:
+                      limit_size:
+                        type: integer
+                      limit_time:
+                        type: integer
+                  archive:
+                    type: object
+                    properties:
+                      files_on:
+                        type: integer
+                      size_on:
+                        type: integer
+                      files_limit:
+                        type: integer
+                      compression_level:
+                        type: integer
+                  aggregation:
+                    type: object
+                    properties:
+                      files_on:
+                        type: integer
+                      size_on:
+                        type: integer
+                      level:
+                        type: integer
+              examples:
+                success:
+                  summary: Current agent configuration
+                  value:
+                    server_id: "STUDIO_SERVER_ID"
+                    ignore_metrics: -1
+                    life_jwt_time: 3600
+                    scrape_interval_time: 60
+                    enable_agent: -1
+                    upload:
+                      limit_time: 3600
+                      limit_lines: 100
+                      limit_size: 1
+                    studio_settings:
+                      url: "http://localhost:8088/dsp/api/v1/vmagent"
+                    agent_settings:
+                      port: 16888
+                    storage:
+                      limit_size: 0
+                      limit_time: 86400
+                      directory: "/opt/dtms-billing-agent/"
+                    file:
+                      limit_size: 1
+                      limit_time: 86400
+                    archive:
+                      files_on: 0
+                      size_on: 0
+                      files_limit: 10
+                      compression_level: -1
+                    aggregation:
+                      files_on: 0
+                      size_on: 0
+                      level: 1