legion-data 0.2.0 → 1.2.0

data/NOTICE.txt

@@ -0,0 +1,9 @@
+Legion::Crypt(legion-crypt)
+Copyright 2021 Optum
+
+Project Description:
+====================
+Manage
+
+Author(s):
+Esity

data/README.md

@@ -1,37 +1,74 @@
-# Legion::Data
+Legion::Data
+=====
 
-Legion::Data is used by the framework to connect to a database. All database changes should be
-added as a migration with proper up/downs.
+Legion::Data is a gem for the LegionIO framework to use persistent storage. Currently only MySQL is supported
 
-## Installation
+Supported Ruby versions and implementations
+------------------------------------------------
 
-Add this line to your application's Gemfile:
+Legion::Json should work identically on:
 
-```ruby
-gem 'legion-data'
-```
+* Ruby 2.5+
 
-And then execute:
 
-    $ bundle
+Installation and Usage
+------------------------
 
-Or install it yourself as:
+You can verify your installation using this piece of code:
 
-    $ gem install legion-data
+```bash
+gem install legion-data
+```
 
-## Usage
+```ruby
+require 'legion/data'
 
-You can create a new connection to the database with the following example
-``` Legion::Data::Connection.new.database.connection ```
-Keep in mind that if you need access to the database as part of a LEX, you should instead add it as a
-requirement inside your definitions with the following
+Legion::Data.setup
+Legion::Data.connected? # => true
+Legion::Data::Model::Extension.all # Sequel::Dataset
 ```
-def requirements
-  %w[legion-transport legion-data]
-end
+
+Settings
+----------
+
+```json
+{
+  "connected": false,
+  "cache": {
+    "connected": false,
+    "auto_enable": null,
+    "ttl": 60
+  },
+  "connection": {
+    "log": false,
+    "log_connection_info": false,
+    "log_warn_duration": 1,
+    "log_warn_duration": "debug",
+    "max_connections": 10,
+    "preconnect": false
+  },
+  "creds": {
+    "username": "legion",
+    "password": "legion",
+    "database": "legionio",
+    "host": "127.0.0.1",
+    "port": 3306
+  },
+  "migrations": {
+    "continue_on_fail": false,
+    "auto_migrate": true,
+    "ran": false,
+    "version": null
+  },
+  "models": {
+    "continue_on_load_fail": false,
+    "autoload": true
+  },
+  "connect_on_start": true
+}
 ```
-and the framework will take care of the rest.
 
-## Contributing
+Authors
+----------
 
-Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/legion-io/legion-data.
+* [Matthew Iverson](https://github.com/Esity) - current maintainer

data/SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Supported Versions
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.x.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+To be added

data/attribution.txt

@@ -0,0 +1 @@
+Add attributions here.

data/legion-data.gemspec

@@ -1,49 +1,33 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'legion/data/version'
+# frozen_string_literal: true
+
+require_relative 'lib/legion/data/version'
 
 Gem::Specification.new do |spec|
-  spec.name = (RUBY_ENGINE == 'jruby' ? 'legion-data-java' : 'legion-data')
+  spec.name = 'legion-data'
   spec.version       = Legion::Data::VERSION
   spec.authors       = ['Esity']
-  spec.email         = ['matthewdiverson@gmail.com']
-
-  spec.summary       = 'Used by Legion to connect to the database'
-  spec.description   = 'The Legion connect gem'
-  spec.homepage = 'https://bitbucket.org/legion-io/legion-data'
-
-  spec.metadata['bug_tracker_uri'] = 'https://bitbucket.org/legion-io/legion-data/issues?status=new&status=open'
-  spec.metadata['changelog_uri'] = 'https://bitbucket.org/legion-io/legion-data/src/CHANGELOG.md'
-  spec.metadata['documentation_uri'] = 'https://bitbucket.org/legion-io/legion-data'
-  spec.metadata['homepage_uri'] = 'https://bitbucket.org/legion-io/legion-data'
-  spec.metadata['source_code_uri'] = 'https://bitbucket.org/legion-io/legion-data'
-  spec.metadata['wiki_uri'] = 'https://bitbucket.org/legion-io/legion-data/wiki/Home'
+  spec.email         = %w[matthewdiverson@gmail.com ruby@optum.com]
 
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.summary       = 'Manages the connects to the backend database'
+  spec.description   = 'A LegionIO gem to connect to a persistent data store'
+  spec.homepage      = 'https://github.com/Optum/legion-data'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.5'
   spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'codecov'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rspec_junit_formatter'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-md'
-  spec.add_development_dependency 'rubocop-performance'
-  spec.add_development_dependency 'rubocop-rspec'
-  spec.add_development_dependency 'rubocop-sequel'
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files        = spec.files.select { |p| p =~ %r{^test/.*_test.rb} }
+  spec.extra_rdoc_files  = %w[README.md LICENSE CHANGELOG.md]
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/Optum/legion-data/issues',
+    'changelog_uri' => 'https://github.com/Optum/legion-data/src/main/CHANGELOG.md',
+    'documentation_uri' => 'https://github.com/Optum/legion-data',
+    'homepage_uri' => 'https://github.com/Optum/LegionIO',
+    'source_code_uri' => 'https://github.com/Optum/legion-data',
+    'wiki_uri' => 'https://github.com/Optum/legion-data/wiki'
+  }
 
   spec.add_dependency 'legion-logging'
   spec.add_dependency 'legion-settings'
-
-  if RUBY_ENGINE == 'jruby'
-    spec.add_dependency 'jdbc-mysql'
-  else
-    spec.add_dependency 'mysql2'
-  end
+  spec.add_dependency 'mysql2'
   spec.add_dependency 'sequel'
 end

data/lib/legion/data.rb

@@ -1,10 +1,10 @@
 require 'legion/data/version'
-require_relative 'data/settings'
+require 'legion/data/settings'
 require 'sequel'
 
-require_relative 'data/connection'
-require_relative 'data/model'
-require_relative 'data/migration'
+require 'legion/data/connection'
+require 'legion/data/model'
+require 'legion/data/migration'
 
 module Legion
   module Data
@@ -13,7 +13,7 @@ module Legion
         connection_setup
         migrate
         load_models
-        # setup_cache
+        setup_cache
       end
 
       def connection_setup
@@ -34,25 +34,22 @@ module Legion
         Legion::Data::Connection.sequel
       end
 
-      def setup_cache # rubocop:disable Metrics/AbcSize
-        return if Legion::Settings[:data][:cache][:enable]
+      def setup_cache
+        return if Legion::Settings[:data][:cache][:enabled]
 
-        unless Legion::Settings[:cache][:connected]
-          Legion::Logging.warn 'Legion::Data has caching enabled but Legion::Cache is not started'
-        end
-        return unless Legion::Settings[:cache][:connected]
+        return unless defined?(::Legion::Cache)
 
         # Legion::Data::Model::Relationship.plugin :caching, Legion::Cache, ttl: 10
-        Legion::Data::Model::Chain.plugin :caching, Legion::Cache, ttl: 60
-        Legion::Data::Model::Datacenter.plugin :caching, Legion::Cache, ttl: 120
-        Legion::Data::Model::Extension.plugin :caching, Legion::Cache, ttl: 120
-        Legion::Data::Model::Function.plugin :caching, Legion::Cache, ttl: 120
-        Legion::Data::Model::Namespace.plugin :caching, Legion::Cache, ttl: 120
-        Legion::Data::Model::Node.plugin :caching, Legion::Cache, ttl: 10
-        Legion::Data::Model::TaskLog.plugin :caching, Legion::Cache, ttl: 12
-        Legion::Data::Model::Task.plugin :caching, Legion::Cache, ttl: 10
-        Legion::Data::Model::User.plugin :caching, Legion::Cache, ttl: 120
-        Legion::Data::Model::Group.plugin :caching, Legion::Cache, ttl: 120
+        # Legion::Data::Model::Runner.plugin :caching, Legion::Cache, ttl: 60
+        # Legion::Data::Model::Chain.plugin :caching, Legion::Cache, ttl: 60
+        # Legion::Data::Model::Function.plugin :caching, Legion::Cache, ttl: 120
+        # Legion::Data::Model::Extension.plugin :caching, Legion::Cache, ttl: 120
+        # Legion::Data::Model::Node.plugin :caching, Legion::Cache, ttl: 10
+        # Legion::Data::Model::TaskLog.plugin :caching, Legion::Cache, ttl: 12
+        # Legion::Data::Model::Task.plugin :caching, Legion::Cache, ttl: 10
+        # Legion::Data::Model::User.plugin :caching, Legion::Cache, ttl: 120
+        # Legion::Data::Model::Group.plugin :caching, Legion::Cache, ttl: 120
+        # Legion::Logging.info 'Legion::Data connected to Legion::Cache'
       end
 
       def shutdown

data/lib/legion/data/connection.rb

@@ -4,33 +4,41 @@ module Legion
   module Data
     module Connection
       class << self
-        attr_reader :sequel
-        if RUBY_ENGINE == 'jruby'
-          require_relative 'connections/jdbc'
-          include Legion::Data::Connections::JDBC
-        else
-          require_relative 'connections/mysql2'
-          include Legion::Data::Connections::MySQL2
+        attr_accessor :sequel
+
+        def adapter
+          @adapter ||= RUBY_ENGINE == 'jruby' ? :jdbc : :mysql2
         end
 
         def setup
-          @sequel = ::Sequel.connect(adapter: adapter, **creds_builder)
+          @sequel = if adapter == :mysql2
+                      ::Sequel.connect(adapter: adapter, **creds_builder)
+                    else
+                      ::Sequel.connect("jdbc:mysql://#{creds_builder[:host]}:#{creds_builder[:port]}/#{creds_builder[:database]}?user=#{creds_builder[:username]}&password=#{creds_builder[:password]}&serverTimezone=UTC") # rubocop:disable Layout/LineLength
+                    end
           Legion::Settings[:data][:connected] = true
-          return unless Legion::Settings[:data][:connection][:log]
+          return if Legion::Settings[:data][:connection].nil? || Legion::Settings[:data][:connection][:log].nil?
 
-          @sequel.logger = Legion::Logging::Logger.new(level: 'debug')
+          @sequel.logger = Legion::Logging
           @sequel.sql_log_level = Legion::Settings[:data][:connection][:sql_log_level]
           @sequel.log_warn_duration = Legion::Settings[:data][:connection][:log_warn_duration]
         end
 
         def shutdown
-          @sequel.disconnect
+          @sequel&.disconnect
+          Legion::Settings[:data][:connected] = false
         end
 
-        def creds_builder # rubocop:disable Metrics/AbcSize
-          final_creds = {}
-          final_creds.merge! default_creds
-          final_creds.merge! Legion::Settings[:data][:creds]
+        def creds_builder(final_creds = {})
+          final_creds.merge! Legion::Data::Settings.creds
+          final_creds.merge! Legion::Settings[:data][:creds] if Legion::Settings[:data][:creds].is_a? Hash
+
+          # if Legion::Settings[:data][:connection][:max_connections].is_a? Integer
+          #   final_creds[:max_connections] = Legion::Settings[:data][:connection][:max_connections]
+          # end
+
+          # final_creds[:preconnect] = :concurrently if Legion::Settings[:data][:connection][:preconnect]
+
           return final_creds if Legion::Settings[:vault].nil?
 
           if Legion::Settings[:vault][:connected] && ::Vault.sys.mounts.key?(:database)
@@ -44,19 +52,14 @@ module Legion
 
         def default_creds
           {
-            host:            '127.0.0.1',
-            port:            3306,
-            username:        'legion',
-            password:        'legion',
-            database:        'legion',
-            max_connections: 32,
-            preconnect:      'concurrently'
+            host: '127.0.0.1',
+            port: 3306,
+            username: 'legion',
+            password: 'legion',
+            database: 'legion',
+            max_connections: 4
           }
         end
-
-        def adapter
-          'mysql2'
-        end
       end
     end
   end

data/lib/legion/data/migration.rb

@@ -4,9 +4,9 @@ module Legion
   module Data
     module Migration
       class << self
-        def migrate(connection = Legion::Data.connection, path = __dir__ + '/migrations')
-          Legion::Settings[:data][:migrations][:version] = Sequel::Migrator.run(connection, path)
-          Legion::Logging.info 'Legion::Data::Migration ran successfully to version ' + Legion::Settings[:data][:migrations][:version].to_s # rubocop:disable Layout/LineLength
+        def migrate(connection = Legion::Data.connection, path = "#{__dir__}/migrations", **opts)
+          Legion::Settings[:data][:migrations][:version] = Sequel::Migrator.run(connection, path, **opts)
+          Legion::Logging.info("Legion::Data::Migration ran successfully to version #{Legion::Settings[:data][:migrations][:version]}") # rubocop:disable Layout/LineLength
           Legion::Settings[:data][:migrations][:ran] = true
         end
       end

data/lib/legion/data/migrations/001_add_schema_columns.rb

@@ -8,7 +8,7 @@ Sequel.migration do
   end
 
   down do
-    alter_table(:schema) do
+    alter_table(:schema_info) do
       drop_column :catalog
       drop_column :updated_at
       drop_column :created_at

data/lib/legion/data/migrations/002_add_nodes.rb

@@ -0,0 +1,20 @@
+Sequel.migration do
+  up do
+    run "CREATE TABLE `nodes` (
+      `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+      `name` varchar(128) NOT NULL DEFAULT '',
+      `status` varchar(255) NOT NULL DEFAULT 'unknown',
+      `active` tinyint(1) unsigned NOT NULL DEFAULT '1',
+      `created` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      `updated` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
+      PRIMARY KEY (`id`),
+      UNIQUE KEY `name` (`name`),
+      KEY `active` (`active`),
+      KEY `status` (`status`)
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;"
+  end
+
+  down do
+    drop_table :nodes
+  end
+end

data/lib/legion/data/migrations/003_add_settings.rb

@@ -0,0 +1,18 @@
+Sequel.migration do
+  up do
+    run "CREATE TABLE `settings` (
+      `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+      `key` varchar(128) NOT NULL,
+      `value` varchar(256) NOT NULL,
+      `encrypted` tinyint(1) unsigned NOT NULL DEFAULT '0',
+      `created` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      `updated` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
+      PRIMARY KEY (`id`),
+      UNIQUE KEY `key` (`key`)
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;"
+  end
+
+  down do
+    drop_table :settings
+  end
+end

data/lib/legion/data/migrations/004_add_extensions.rb

@@ -0,0 +1,25 @@
+Sequel.migration do
+  up do
+    run "CREATE TABLE `extensions` (
+      `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+      `active` tinyint(1) unsigned NOT NULL DEFAULT '1',
+      `name` varchar(128) NOT NULL,
+      `namespace` varchar(128) NOT NULL DEFAULT '',
+      `exchange` varchar(255) DEFAULT NULL,
+      `uri` varchar(256) DEFAULT NULL,
+      `schema_version` int(11) unsigned NOT NULL DEFAULT 0,
+      `updated` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
+      `created` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      PRIMARY KEY (`id`),
+      UNIQUE KEY `name_namespace` (`name`,`namespace`),
+      KEY `active` (`active`),
+      KEY `name` (`name`),
+      KEY `namespace` (`namespace`),
+      key `schema_version` (`schema_version`)
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;"
+  end
+
+  down do
+    drop_table :extensions
+  end
+end

data/lib/legion/data/migrations/005_add_runners.rb

@@ -0,0 +1,21 @@
+Sequel.migration do
+  up do
+    run "CREATE TABLE `runners` (
+      `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+      `extension_id` int(11) unsigned NOT NULL,
+      `name` varchar(256) NOT NULL DEFAULT '',
+      `namespace` varchar(256) NOT NULL DEFAULT '',
+      `active` tinyint(1) unsigned NOT NULL DEFAULT '1',
+      `queue` varchar(256) DEFAULT NULL,
+      `uri` varchar(256) DEFAULT NULL,
+      `created` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP,
+      `updated` datetime DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
+      PRIMARY KEY (`id`),
+      CONSTRAINT `runner_extension_id` FOREIGN KEY (`extension_id`) REFERENCES `extensions` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
+    ) ENGINE=InnoDB DEFAULT CHARSET=utf8;"
+  end
+
+  down do
+    drop_table :runners
+  end
+end