qravan 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e949467a3511cd09097521ddbb22bc800ced21d5f04f5672083d816943919ce
+  data.tar.gz: 65388d22cdb49a14bd4a487ff3c2e098312cfc60f0e924211da49a01c21bc3d0
+SHA512:
+  metadata.gz: 0e2674928b9507a6a57192cc552b2d8aa77ecea25e3738bfe1a6984ca05036c4f0a3122a9668d87fa1ece5f2e4e8d18919a87acb648d647c589760e6f87c8b47
+  data.tar.gz: 8a24081627122c14559d1f14007471b8d87e055165f1cc41f3d63524e21697819ee880cc3b9abea1441a0480f66d8a2cfa025ceec18c331c2acab39abb16c529

data/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

data/.gitignore

@@ -0,0 +1,61 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+.idea
+.idea/*
+logs/*
+logs/db.log
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rspec_status

@@ -0,0 +1,4 @@
+example_id                  | status | run_time        |
+--------------------------- | ------ | --------------- |
+./spec/qravan_spec.rb[1:1] | passed | 0.00082 seconds |
+./spec/qravan_spec.rb[1:2] | passed | 0.00037 seconds |

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0.2
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+# Specify your gem's dependencies in qravan.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,143 @@
+PATH
+  remote: .
+  specs:
+    qravan (0.1.0)
+      async (~> 1.30.1)
+      async-http (~> 0.59.2)
+      async-io (~> 1.34.1)
+      async-sequel (~> 0.1.0)
+      falcon (~> 0.42.3)
+      logger (>= 1.5.3)
+      rack (~> 3.0.2)
+      rack-unreloader (>= 1.8)
+      rake (~> 13.0)
+      redis (~> 5.0.5)
+      rspec (~> 3.0)
+      rubocop (~> 1.7)
+      sequel (>= 5.62)
+      sequel_pg (>= 1.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    async (1.30.3)
+      console (~> 1.10)
+      nio4r (~> 2.3)
+      timers (~> 4.1)
+    async-container (0.16.12)
+      async
+      async-io
+    async-http (0.59.4)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.23.1)
+      protocol-http1 (~> 0.14.0)
+      protocol-http2 (~> 0.14.0)
+      traces (>= 0.8.0)
+    async-http-cache (0.4.3)
+      async-http (~> 0.56)
+    async-io (1.34.1)
+      async
+    async-pool (0.3.12)
+      async (>= 1.25)
+    async-sequel (0.1.0)
+      sequel
+    build-environment (1.13.0)
+    connection_pool (2.3.0)
+    console (1.16.2)
+      fiber-local
+    diff-lcs (1.5.0)
+    falcon (0.42.3)
+      async
+      async-container (~> 0.16.0)
+      async-http (~> 0.57)
+      async-http-cache (~> 0.4.0)
+      async-io (~> 1.22)
+      build-environment (~> 1.13)
+      bundler
+      localhost (~> 1.1)
+      openssl (~> 3.0)
+      process-metrics (~> 0.2.0)
+      protocol-rack (~> 0.1)
+      samovar (~> 2.1)
+    fiber-local (1.0.0)
+    json (2.6.3)
+    localhost (1.1.9)
+    logger (1.5.3)
+    mapping (1.1.1)
+    nio4r (2.5.8)
+    openssl (3.1.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pg (1.4.5)
+    process-metrics (0.2.1)
+      console (~> 1.8)
+      samovar (~> 2.1)
+    protocol-hpack (1.4.2)
+    protocol-http (0.23.12)
+    protocol-http1 (0.14.6)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.14.2)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
+    protocol-rack (0.2.4)
+      protocol-http (~> 0.23)
+      rack (>= 1.0)
+    rack (3.0.3)
+    rack-unreloader (2.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (5.0.5)
+      redis-client (>= 0.9.0)
+    redis-client (0.11.2)
+      connection_pool
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    samovar (2.1.4)
+      console (~> 1.0)
+      mapping (~> 1.0)
+    sequel (5.64.0)
+    sequel_pg (1.17.1)
+      pg (>= 0.18.0, != 1.2.0)
+      sequel (>= 4.38.0)
+    timers (4.3.5)
+    traces (0.8.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  qravan!
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,5 @@
+CAPAA License
+
+Copyright (c) 2022 Panasenkov Alexander (a@panasenkov.ru)
+
+LICENSE — https://github.com/capaa/capaal

data/README.md

@@ -0,0 +1,191 @@
+# Qravan 
+Qravan — сервер для быстрого создания API обмена данными, консолидирующий различные источники с SQL-интерфейсами.
+
+![](assets/images/qravan.png)
+## Установка
+
+Добавить строку ниже в свой Gemfile:
+
+```ruby
+gem 'qravan'
+```
+
+Потом выполнить:
+
+    $ bundle install
+
+Или установить просто как Gem (предпочтительно):
+
+    $ gem install qravan
+
+## Запуск
+Запустить сервер Qravan:
+
+    $ qravan
+
+Сервер станет доступен по адресу `http://localhost:3300/`
+
+## Методы сервера
+Сервер содержит следующие методы:
+1. GET /ping — проверить запусщенность сервера (ответ PONG!)
+2. GET /models — список загруженных моделей
+3. GET /sources — список загруженных источников
+4. POST /data — выполнить запрос
+
+
+## Настройка моделей данных и ресурсов
+### Модели
+Модели данных описываются в соответствии со спецификацией в формате 
+YAML в папке `models/[model_name]/[model_version x.x]/model.yaml`
+
+Версионирование моделей должно осуществляться в двухразрядном формате. 
+По-умолчанию сервер запускает модель по симлинку с `current`. 
+
+### Ресурсы
+Источники описывются также в соответствии со спецификацией в формате
+YAML в папке `sources/[source_name]/[source_version x.x]/source.yaml`
+
+Версионирование источников должно осуществляться в двухразрядном формате. 
+По-умолчанию сервер запускает источники по симлинку с `current`.
+
+```
+qravan
+│ README.md
+│ credentials.yaml 
+│      
+└─models
+│   └─base
+│   │ │ current
+│   │ └─1.0
+│   │   │ model.yaml
+│   │
+│   └─vehicles
+│     │ current
+│     └─1.0
+│     │ └─ model.yaml
+│     └─2.0
+│       └─ model.yaml
+│     
+└─sources
+│   └─vehicles
+│     │ current
+│     └─1.0
+│     │ └─ source.yaml
+│     └─2.0
+│       └─ source.yaml
+```
+## Пример использования
+
+Запрос объединенных данных о владельце автомобиля из Prostore и Postgres:
+```json
+{
+  "query":{
+    "driver":{
+      "conditions":{
+        "DriverLicenseSerNum":"abc",
+        "norm_DriverLicenseSerNum":"5"
+      },
+      "attributes":[
+        "DriverLastname",
+        "DriverFirstname",
+        "DriverMiddlename",
+        "Driverlicenseid"
+        ]
+    },
+    "driver_license":{
+      "conditions":{
+        "DriverLicenseSerNum":"abc",
+        "norm_DriverLicenseSerNum":"3"
+      },
+      "attributes":[
+        "DriverLastname",
+        "DriverFirstname",
+        "DriverMiddlename",
+        "Driverlicenseid"
+        ]
+    }
+  },
+  "credentials":{
+    "system":{
+      "mnemonic":"117bed7f-1c07-4079-a446-1161588db4e5",
+      "instance_id":"ccb4a88f-f44b-43e7-8a97-3e45c8345e90",
+      "user_id":"5ed38461-0907-486a-930a-7b443482932c"
+    },
+    "request":{
+      "id":"df5a0073-c6be-4d8c-8eb2-9b2f4188a429",
+      "sub_id":"0cdb59ce-224b-4118-8da1-c5ea08a5d955",
+      "name":"driver_data",
+      "purpose_id":"ed1170f1-3caa-4985-aa38-c9c5a190b770",
+      "audit":"false",
+      "audit_id":"fc1048fe-323d-4eeb-92df-5710b3d1d100",
+      "audit_token":"39e47aac-45d2-44c1-8c26-2d9b28b1703b"
+    },
+    "signature":{
+      "digest": null,
+      "signature": null
+    }
+  }
+}
+```
+
+Ответ для данного запроса будет иметь вид:
+```json
+{
+  "response": [
+    {
+      "driver": [
+        [
+          {
+            "driverlastname": "Сидоров",
+            "driverfirstname": "Олег",
+            "drivermiddlename": "Львович",
+            "driverlicenseid": 2222
+          }
+        ],
+        {
+          "time": "REST Duration: 0.053709s "
+        }
+      ]
+    },
+    {
+      "driver_license": [
+        {
+          "driverlastname": "Петречук",
+          "driverfirstname": "Петр",
+          "drivermiddlename": "Петрович",
+          "driverlicenseid": 2
+        },
+        {
+          "time": "DB Duration: 0.010184s"
+        }
+      ]
+    }
+  ],
+  "credentials": {
+    "response": {
+      "id": "c11ba197-ae96-4a6a-bc11-a3464d54496c",
+      "sub_id": "50bcef8c-ef6e-4c6e-a893-4b42641919be",
+      "started_at": "2023-01-19 00:34:39 +0300",
+      "finished_at": "2023-01-19 00:34:39 +0300"
+    },
+    "system": {
+      "mnemonic": "117bed7f-1c07-4079-a446-1161588db4e5",
+      "instance_id": "ccb4a88f-f44b-43e7-8a97-3e45c8345e90",
+      "user_id": "5ed38461-0907-486a-930a-7b443482932c"
+    },
+    "request": {
+      "id": "df5a0073-c6be-4d8c-8eb2-9b2f4188a429",
+      "sub_id": "0cdb59ce-224b-4118-8da1-c5ea08a5d955",
+      "name": "driver_data",
+      "purpose_id": "ed1170f1-3caa-4985-aa38-c9c5a190b770",
+      "audit": "false",
+      "audit_id": "fc1048fe-323d-4eeb-92df-5710b3d1d100",
+      "audit_token": "39e47aac-45d2-44c1-8c26-2d9b28b1703b"
+    },
+    "signature": {
+      "digest": null,
+      "signature": null
+    }
+  }
+}
+```

data/Rakefile

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+require "rake/extensiontask"
+
+task build: :compile
+
+Rake::ExtensionTask.new("qravan") do |ext|
+  ext.lib_dir = "lib/qravan"
+end
+
+task default: %i[clobber compile spec clean install] # rubocop
+
+GEM_NAME = "qravan"
+GEM_VERSION = "0.1.0"
+
+task :build do
+  system "gem build #{GEM_NAME}.gemspec"
+end
+
+task install: :build do
+  system "gem install #{GEM_NAME}-#{GEM_VERSION}.gem"
+end
+
+task publish: :build do
+  system "gem push #{GEM_NAME}-#{GEM_VERSION}.gem"
+end
+
+task :clean do
+  system "rm *.gem"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "qravan"
+
+# 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/config.ru

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# This file is used by Rack-based servers to start the application.
+# use Rack::Deflater
+
+require "bundler/setup"
+require "qravan"
+
+Console.logger.info Qravan::BANNER
+Qravan::CARGO = Qravan::Cargo.new
+
+qravan = Rack::Builder.new do
+
+  # use Rack::ShowExceptions
+  use Rack::Logger
+
+  map "/data" do
+    use Rack::Lint
+    run Qravan::Query.freeze.new(Qravan::CARGO)
+  end
+
+  map "/model" do
+    use Rack::Lint
+    run Qravan::Model.freeze.new(Qravan::CARGO)
+  end
+
+  map "/spec" do
+    use Rack::Lint
+    run Qravan::Spec.new
+  end
+
+  map "/sources" do
+    use Rack::Lint
+    run Qravan::Source.freeze.new(Qravan::CARGO)
+  end
+
+  map "/ping" do
+    use Rack::Lint
+    run do |env|
+      [200, {}, ["PONG!"]]
+    end
+  end
+
+end
+
+run qravan

data/examples/queries.md

@@ -0,0 +1,114 @@
+# Примеры запросов Qravan
+
+Запрос объединенных данных о владельце автомобиля из Prostore и Postgres:
+```json
+{
+  "query":{
+    "driverlicense":{
+      "conditions":{
+        "DriverLicenseSerNum":"abc",
+        "norm_DriverLicenseSerNum":"5"
+      },
+      "attributes":[
+        "DriverLastname",
+        "DriverFirstname",
+        "DriverMiddlename",
+        "Driverlicenseid"
+        ],
+      "source": "prostore"
+    },
+    "driverlicense_new":{
+      "conditions":{
+        "DriverLicenseSerNum":"abc",
+        "norm_DriverLicenseSerNum":"3"
+      },
+      "attributes":[
+        "DriverLastname",
+        "DriverFirstname",
+        "DriverMiddlename",
+        "Driverlicenseid"
+        ],
+      "source": "postgres"
+    }
+  },
+  "credentials":{
+    "system":{
+      "mnemonic":"117bed7f-1c07-4079-a446-1161588db4e5",
+      "instance_id":"ccb4a88f-f44b-43e7-8a97-3e45c8345e90",
+      "user_id":"5ed38461-0907-486a-930a-7b443482932c"
+    },
+    "request":{
+      "id":"df5a0073-c6be-4d8c-8eb2-9b2f4188a429",
+      "sub_id":"0cdb59ce-224b-4118-8da1-c5ea08a5d955",
+      "name":"driver_data",
+      "purpose_id":"ed1170f1-3caa-4985-aa38-c9c5a190b770",
+      "audit":"false",
+      "audit_id":"fc1048fe-323d-4eeb-92df-5710b3d1d100",
+      "audit_token":"39e47aac-45d2-44c1-8c26-2d9b28b1703b"
+    },
+    "signature":{
+      "digest": null,
+      "signature": null
+    }
+  }
+}
+```
+
+Ответ для данного запроса будет иметь вид:
+```json
+{
+  "response": [
+    {
+      "driverlicense": [
+        [
+          {
+            "driverlastname": "Петров",
+            "driverfirstname": "Иван",
+            "drivermiddlename": "Иванович",
+            "driverlicenseid": 1111
+          }
+        ],
+        {
+          "time": "Duration: 0.052415s for 1 (RPS: 19 r/s)"
+        }
+      ]
+    },
+    {
+      "driverlicense_new": [
+        {
+          "driverlastname": "Евгеничук",
+          "driverfirstname": "Евгений",
+          "drivermiddlename": "Олегович",
+          "driverlicenseid": 333
+        }
+      ]
+    }
+  ],
+  "credentials": {
+    "response": {
+      "id": null,
+      "sub_id": null,
+      "started_at": null,
+      "finished_at": null
+    },
+    "system": {
+      "mnemonic": "117bed7f-1c07-4079-a446-1161588db4e5",
+      "instance_id": "ccb4a88f-f44b-43e7-8a97-3e45c8345e90",
+      "user_id": "5ed38461-0907-486a-930a-7b443482932c"
+    },
+    "request": {
+      "id": "df5a0073-c6be-4d8c-8eb2-9b2f4188a429",
+      "sub_id": "0cdb59ce-224b-4118-8da1-c5ea08a5d955",
+      "name": "driver_data",
+      "purpose_id": "ed1170f1-3caa-4985-aa38-c9c5a190b770",
+      "audit": "false",
+      "audit_id": "fc1048fe-323d-4eeb-92df-5710b3d1d100",
+      "audit_token": "39e47aac-45d2-44c1-8c26-2d9b28b1703b"
+    },
+    "signature": {
+      "digest": null,
+      "signature": null
+    }
+  }
+}
+```

data/exe/qravan

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "qravan"
+
+system "bundle exec falcon host"

data/ext/qravan/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+create_makefile("qravan/qravan")