gloo-mysql 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: beba2426ad60ec2727ed3486d9187bd19a47886316aa7e2eead82035f2c6f10e
+  data.tar.gz: 9b7c4869ff4e00bad57da63bdd0af0862230e9c3b03f3e7188fdf99a9282a7a5
+SHA512:
+  metadata.gz: c1f304466d3ee1f9cb1f4295d6bfc3b1adf1cab8c95fda234d1feba698efddf97251beb837ffcd9da4b1f7760b8869bbcff22eb6006e8ec41184bef90c2bfc98
+  data.tar.gz: d9893e456e7c933a4d4f6e7e456e1f079f13f577c8754ef426b3a53d83ba51bc745a0a6c166da54df339e9467b89392a3b0f152946f5025ca262582f09e9aa35

data/lib/gloo-mysql.rb

@@ -0,0 +1,20 @@
+# 
+# Shim to allow `require 'gloo-mysql'`
+# 
+# This file is loaded when someone does `require 'gloo-mysql'`
+# 
+require 'mysql'
+
+# 
+# Registers the extension.
+# 
+class MysqlInit < Gloo::Plugin::Base
+
+    # 
+    # Register verbs and objects.
+    # 
+    def register( callback )
+      callback.register_obj( Mysql )
+    end
+
+end

data/lib/mysql.rb

@@ -0,0 +1,250 @@
+# 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'
+
+class Mysql < Gloo::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)
+  # ---------------------------------------------------------------------
+
+  #
+  # Get the client object.
+  # It might be cached, so check first.
+  # If it is not cached, create a new one.
+  #
+  def get_client
+    app = @engine.running_app
+
+    client = app.db_client_for_obj( self ) if app 
+
+    if client && client.ping
+      @engine.log.debug "Connection is established and active."
+      return client
+    elsif client
+      @engine.log.debug "Connection is established but NOT active.  Reconnecting."
+    else
+      @engine.log.debug "Opening a new Connection."
+    end
+
+    h = {
+      host: host_value,
+      database: db_value,
+      username: user_value,
+      password: passwd_value
+    }
+    client = Mysql2::Client.new( h )
+
+    app.cache_db_client( self, client ) if app
+    
+    return client
+  end
+
+  #
+  # Open a connection and execute the SQL statement.
+  # Return the resulting data.
+  #
+  def query( sql, params = nil )
+    client = get_client
+
+    heads = []
+    data = []
+    begin
+      if params
+        pst = client.prepare( sql )
+        rs = pst.execute( *params, :as => :array )
+        if rs
+          rs.each do |row|
+            arr = []
+            row.each do |o| 
+              arr << o
+            end
+            data << arr
+          end
+        end
+      else
+        rs = client.query( sql, :as => :array ) 
+        if rs
+          rs.each do |row|
+            data << row
+          end
+        end
+      end
+
+      heads = rs.fields if rs
+    rescue => e
+      @engine.log_exception e
+    end
+
+    return [ heads, data ]
+  end
+
+  # 
+  # Based on the result set, build a QueryResult object.
+  # 
+  def get_query_result( result )
+    return QueryResult.new result[0], result[1], @engine
+  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 = Gloo::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 = Gloo::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 = Gloo::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 = Gloo::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.log_exception e
+      @engine.heap.it.set_to false
+      return false
+    end
+    return true
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: gloo-mysql
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Eric Crane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-06 00:00:00.000000000 Z
+dependencies:
+- !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
+description: Adds MySQL support to Gloo.
+email:
+- eric.crane@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gloo-mysql.rb
+- lib/mysql.rb
+homepage: https://gloo.ecrane.us/
+licenses:
+- MIT
+metadata:
+  gloo.type: core-library
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Gloo core library. MySQL support.
+test_files: []