gloo 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62d4c3076b0a61719c6a62ef65aa793a758074e0ab306376671b445582e70822
-  data.tar.gz: a2938182e0675a6992861da6dfea7da7a23e6998f235a9cb6b376ee823b7d8a7
+  metadata.gz: 795a2a504aa74f3089a84d31a2328bb390ddf1aa7f635e2ff195f8fb702c1a3b
+  data.tar.gz: bdd936b143644a0738b7608af0a7babd3449dfca44cbfb5eafa93ce5cafafba0
 SHA512:
-  metadata.gz: a3de2e0895ec0da13278af8ea8e3ffca79bf69d65c503254198ad4441f2e29d84f5393db01768ec5a0458c12666de14f6e06a2d33f1005c083039b7dfa4abc80
-  data.tar.gz: 40e4aa7fc2a957e53cccc880c8aa2e0e9061fb0dd8eb2294ca6b93866e1820b086e694b06207897daabe89747e01cca6830952c8045078a5f4aa53ddf5b588a3
+  metadata.gz: 86ddd2862739a3a1b7a889129d6417c546b15e59e4fb7cc86fad6452eb2edc0e2d2176fedfec2b890ec6225ceeaaaf612eb4f2d9d73d867aa68348a25c4c70dd
+  data.tar.gz: fa430128e804363656cfc02a07d6223db8e9f55a50efa3cace35a8095c5a3a911d837c80c769ac57060ea5e1f9e0aea4937d06680faf1a0657221b1ad168f0a0

data/gloo.gemspec

@@ -49,6 +49,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'openssl', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'net-ssh', '~> 6.1', '>= 6.1.0'
-  # spec.add_dependency 'mysql2', '~> 0.5', '>= 0.5.3'
-  # spec.add_dependency 'sqlite3', '~> 1.4', '>= 1.4.2'
+  spec.add_dependency 'mysql2', '~> 0.5', '>= 0.5.3'
+  spec.add_dependency 'sqlite3', '~> 1.4', '>= 1.4.2'
 end

data/lib/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/gloo/objs/data/mysql.rb

@@ -0,0 +1,192 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A MySQL database connection.
+#
+#
+# https://github.com/brianmario/mysql2
+# https://www.rubydoc.info/gems/mysql2/0.2.3/Mysql2/Client
+#
+# Connection Parameters
+#   user     = opts[:username]
+#   pass     = opts[:password]
+#   host     = opts[:host] || 'localhost'
+#   port     = opts[:port] || 3306
+#   database = opts[:database]
+#   socket   = opts[:socket]
+#   flags    = opts[:flags] || 0
+#
+require 'mysql2'
+
+module Gloo
+  module Objs
+    class Mysql < GlooLang::Core::Obj
+
+      KEYWORD = 'mysql'.freeze
+      KEYWORD_SHORT = 'mysql'.freeze
+
+      HOST = 'host'.freeze
+      DB = 'database'.freeze
+      USER = 'username'.freeze
+      PASSWD = 'password'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      #
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      #
+      def add_children_on_create?
+        return true
+      end
+
+      #
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      #
+      def add_default_children
+        fac = @engine.factory
+        fac.create_string HOST, nil, self
+        fac.create_string DB, nil, self
+        fac.create_string USER, nil, self
+        fac.create_string PASSWD, nil, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'verify' ]
+      end
+
+      #
+      # SSH to the host and execute the command, then update result.
+      #
+      def msg_verify
+        return unless connects?
+
+        @engine.heap.it.set_to true
+      end
+
+      # ---------------------------------------------------------------------
+      #    DB functions (all database connections)
+      # ---------------------------------------------------------------------
+
+      #
+      # Open a connection and execute the SQL statement.
+      # Return the resulting data.
+      #
+      def query( sql, params = nil )
+        h = {
+          host: host_value,
+          database: db_value,
+          username: user_value,
+          password: passwd_value
+        }
+        client = Mysql2::Client.new( h )
+        return client.query( sql ) unless params
+
+        pst = client.prepare( sql )
+        return pst.execute( *params )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get the host from the child object.
+      # Returns nil if there is none.
+      #
+      def host_value
+        o = find_child HOST
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      #
+      # Get the Database name from the child object.
+      # Returns nil if there is none.
+      #
+      def db_value
+        o = find_child DB
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      #
+      # Get the Username from the child object.
+      # Returns nil if there is none.
+      #
+      def user_value
+        o = find_child USER
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      #
+      # Get the Password name from the child object.
+      # Returns nil if there is none.
+      #
+      def passwd_value
+        o = find_child PASSWD
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( @engine, o )
+        return o.value
+      end
+
+      #
+      # Try the connection and make sure it works.
+      # Returns true if we can establish a connection.
+      #
+      def connects?
+        begin
+          h = {
+            host: host_value,
+            database: db_value,
+            username: user_value,
+            password: passwd_value
+          }
+          Mysql2::Client.new( h )
+        rescue => e
+          @engine.err e.message
+          @engine.heap.it.set_to false
+          return false
+        end
+        return true
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/data/sqlite.rb

@@ -0,0 +1,159 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A Sqlite3 database connection.
+#
+# https://www.rubydoc.info/gems/sqlite3/1.3.11
+# https://www.devdungeon.com/content/ruby-sqlite-tutorial
+#
+# db.results_as_hash = true
+#   Set results to return as Hash object.
+#   This is slower but offers a huge convenience.
+#   Consider turning it off for high performance situations.
+#   Each row will have the column name as the hash key.
+#
+# # Alternatively, to only get one row and discard the rest,
+# replace `db.query()` with `db.get_first_value()`.
+#
+require 'sqlite3'
+
+module Gloo
+  module Objs
+    class Sqlite < GlooLang::Core::Obj
+
+      KEYWORD = 'sqlite'.freeze
+      KEYWORD_SHORT = 'sqlite'.freeze
+
+      DB = 'database'.freeze
+      DEFAULT_DB = 'test.db'.freeze
+
+      DB_REQUIRED_ERR = 'The database name is required!'.freeze
+      DB_NOT_FOUND_ERR = 'The database file was not found!'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      #
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      #
+      def add_children_on_create?
+        return true
+      end
+
+      #
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      #
+      def add_default_children
+        fac = @engine.factory
+        fac.create_string DB, DEFAULT_DB, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'verify' ]
+      end
+
+      #
+      # Verify access to the Sqlite database specified.
+      #
+      def msg_verify
+        name = db_value
+        if name.empty?
+          @engine.err DB_REQUIRED_ERR
+          @engine.heap.it.set_to false
+          return
+        end
+
+        unless File.exist? name
+          @engine.err DB_NOT_FOUND_ERR
+          @engine.heap.it.set_to false
+          return
+        end
+
+        return unless connects?
+
+        @engine.heap.it.set_to true
+      end
+
+      # ---------------------------------------------------------------------
+      #    DB functions (all database connections)
+      # ---------------------------------------------------------------------
+
+      #
+      # Open a connection and execute the SQL statement.
+      # Return the resulting data.
+      #
+      def query( sql, params = nil )
+        name = db_value
+        unless name
+          @engine.err DB_REQUIRED_ERR
+          return
+        end
+
+        db = SQLite3::Database.open name
+        db.results_as_hash = true
+        return db.query( sql, params )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get the Database file from the child object.
+      # Returns nil if there is none.
+      #
+      def db_value
+        o = find_child DB
+        return nil unless o
+
+        return o.value
+      end
+
+      #
+      # Try the connection and make sure it works.
+      # Returns true if we can connect and do a query.
+      #
+      def connects?
+        begin
+          db = SQLite3::Database.open db_value
+          sql = "SELECT COUNT(name) FROM sqlite_master WHERE type='table'"
+          db.get_first_value sql
+        rescue => e
+          @engine.err e.message
+          @engine.heap.it.set_to false
+          return false
+        end
+        return true
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gloo
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Crane
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-05 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -224,6 +224,46 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 description: A scripting languge to keep it all together.
 email:
 - eric.crane@mac.com
@@ -264,6 +304,8 @@ files:
 - lib/gloo/objs/cli/pastel.rb
 - lib/gloo/objs/cli/prompt.rb
 - lib/gloo/objs/cli/select.rb
+- lib/gloo/objs/data/mysql.rb
+- lib/gloo/objs/data/sqlite.rb
 - lib/gloo/objs/dev/git.rb
 - lib/gloo/objs/dev/stats.rb
 - lib/gloo/objs/snd/play.rb