vidalia 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b5a6fbc4dd3d45c4dd8d850caaa1b42869169bc
-  data.tar.gz: c3807062d65f7cec8c50b039d783b7e670192c56
+  metadata.gz: 92a70e783f733342346ebffc2d6b66a9f96f97eb
+  data.tar.gz: 4a3507832379a02bea49cc367ba2bbc4bb3b668e
 SHA512:
-  metadata.gz: 5bfe7d16f79ff5aca0468658ea9c0ef0a8c3c1b5984a98ee7c9bbc7fe6ca07c10d60e69b6b36af77fb934c2c46031b0c40911dc48c3da425313631a904858035
-  data.tar.gz: ef08fcee1c8d640984caaac480692925469cbca483874a01023e7cceb5550ef61a005797ba1021d44ed2c7c4f63e6802010a680d8767588170056b419f976f1c
+  metadata.gz: 07778b6c8d0679fb6d98851b285fb88e97e5f8588b7168338e790bd510a151cdc60684d17ccda1019baf5aad54b2802f145d6521a4c91b66fe4f4aa36a755191
+  data.tar.gz: 5c49f169c08208c1f69f7b5807b2ab4a66f875937d3eace20009816897b8e161512e75597944aafdf8540d9bae53386f8fefd734a615ffe3342ac59437c7a748

data/lib/vidalia/mysql.rb

@@ -0,0 +1,156 @@
+module Vidalia
+
+  class Mysql
+
+    require 'mysql2'
+
+    # Instantiate a database object
+    #
+    # @param printable_name [String] Human-readable name of the database (for 
+    #   logging purposes)
+    # @param host [String] Hostname of the database
+    # @param port [String] Port on which the database can be accessed.
+    # @param database_name [String] Name of the database (in MySQL)
+    # @param username [String] Database account username
+    # @param password [String] Database account password
+    # @param sslca [String] Full file path of the SSL CA bundle
+    # @example
+    #   db = Vidalia::Mysql.new(
+    #     printable_name: 'Application MySQL Database',
+    #     host: 'sql.server.com',
+    #     database_name: 'appdb01',
+    #     username: 'admin',
+    #     password: 'passw0rd',
+    #     sslca: '/tmp/bundle.pem'
+    #   )
+    #
+    def initialize(
+          printable_name:,
+          host:,
+          port: '3306',
+          database_name:,
+          username:,
+          password:,
+          sslca: nil
+        )
+      @printable_name = printable_name
+      @username = username
+      @password = password
+      @host = host
+      @database_name = database_name
+      @port = port
+      @sslca = sslca
+    end
+
+    # Run a query against the database
+    #
+    # This method opens a database connection and ensures that it is closed in
+    #   the event of an error.
+    #
+    # @param query [String] SQL query to be run against the database.
+    # @returns results [Array] Array of rows of query results
+    # @example
+    #   db = Vidalia::Mysql.new(
+    #     printable_name: 'Application MySQL Database',
+    #     host: 'sql.server.com',
+    #     database_name: 'appdb01',
+    #     username: 'admin',
+    #     password: 'passw0rd',
+    #     sslca: '/tmp/bundle.pem'
+    #   )
+    #   db.run(query: "SELECT * FROM my_table")
+    #
+    def run(query:)
+      Vidalia::log("SQL query text: \"#{query}\"",:style => :debug)
+      open_connection
+      result = launch_query_command(query: query)
+      if result.size > 0
+        count = 1
+        result.each do |r|
+          Vidalia::log("SQL query result (#{count}): \"#{r.inspect}\"",:style => :debug)
+          count += 1
+        end
+      else
+        Vidalia::log("SQL query: NO RESULTS FOUND",:style => :debug)
+      end
+    rescue Exception => e
+      raise e
+    else
+      return result
+    ensure
+      close_connection
+    end
+
+    private
+
+    # Open a connection to the database
+    #
+    # @example
+    #   db = Vidalia::Mysql.new(
+    #     printable_name: 'Application MySQL Database',
+    #     host: 'sql.server.com',
+    #     database_name: 'appdb01',
+    #     username: 'admin',
+    #     password: 'passw0rd',
+    #     sslca: '/tmp/bundle.pem'
+    #   )
+    #   db.open_connection
+    #
+    def open_connection
+      if sslca then
+        @db = Mysql2::Client.new(
+          host: @host, 
+          username: @username, 
+          password: @password, 
+          port: @port, 
+          database: @database_name,
+          sslca: @sslca)
+      else
+        @db = Mysql2::Client.new(
+          host: @host, 
+          username: @username, 
+          password: @password, 
+          port: @port, 
+          database: @database_name)
+      end
+    end
+
+    # Run a query against the database
+    #
+    # @param query [String] SQL query to be run against the database
+    # @returns results [Array] Array of rows of query results
+    # @example
+    #   db = Vidalia::Mysql.new(
+    #     printable_name: 'Application MySQL Database',
+    #     host: 'sql.server.com',
+    #     database_name: 'appdb01',
+    #     username: 'admin',
+    #     password: 'passw0rd',
+    #     sslca: '/tmp/bundle.pem'
+    #   )
+    #   db.open
+    #   my_results = db.query("SELECT * FROM my_table")
+    #
+    def launch_query_command(query:)
+      @db.query(query, as: :hash)
+    end
+
+    # Close a connection to the database
+    #
+    # @example
+    #   db = Vidalia::Mysql.new(
+    #     printable_name: 'Application MySQL Database',
+    #     host: 'sql.server.com',
+    #     database_name: 'appdb01',
+    #     username: 'admin',
+    #     password: 'passw0rd',
+    #     sslca: '/tmp/bundle.pem'
+    #   )
+    #   db.open_connection
+    #   db.close_connection
+    #
+    def close_connection
+      @db.close if @db
+    end
+  end
+end

data/lib/vidalia.rb

@@ -6,6 +6,7 @@ require 'vidalia/interface'
 require 'vidalia/object'
 require 'vidalia/element'
 require 'vidalia/dsl'
+require 'vidalia/mysql'
 
 # [cat]  something
 # something else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vidalia
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeremy Rotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-20 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,6 +38,7 @@ files:
 - lib/vidalia/element_definition.rb
 - lib/vidalia/interface.rb
 - lib/vidalia/interface_definition.rb
+- lib/vidalia/mysql.rb
 - lib/vidalia/object.rb
 - lib/vidalia/object_definition.rb
 homepage: https://github.com/jrotter/vidalia