blackstack-db 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0071d134f56134425dfa5667077f9ca8ee1d57fc4c23783be3ad6fb05afca2a9
+  data.tar.gz: 694fe13b831760553ad8736a120d56615650f437f4fa3987711bb5534d1783b2
+SHA512:
+  metadata.gz: adc65af017b86399f60d1015f474fdf18565fffa4ee25c420bc1ac51f9257cbca87407dca6e7b436faf706e4f2828b1445a90ef9e76c32ba4b2454f439107c31
+  data.tar.gz: 9c16d76967f2eb07a74e32c12fc984e925e844e934ca3079ef8d52a6f5f8b8adc38a331466e51ec098500683b174879dd3c8a476024f8c3245141d59117ab82f

data/lib/blackstack-db/crdb.rb

@@ -0,0 +1,153 @@
+module BlackStack
+    module CRDB
+        # database connection parameters
+        @@db_url = nil
+        @@db_port = nil
+        @@db_cluster = nil
+        @@db_name = nil
+        @@db_user = nil
+        @@db_password = nil
+        @@db_sslmode = nil
+
+        # return the connection string for a postgresql database
+        def self.connection_string
+            ret = nil
+            if @@db_cluster
+                ret = "postgresql://#{@@db_user}:#{@@db_password}@#{@@db_url}:#{@@db_port}/#{@@db_cluster}.#{@@db_name}?sslmode=#{@@db_sslmode}"
+            else
+                ret = "postgresql://#{@@db_user}:#{@@db_password}@#{@@db_url}:#{@@db_port}/#{@@db_name}?sslmode=#{@@db_sslmode}"
+            end
+            ret
+        end # connection_string
+
+        # return the connection string for a postgresql database
+        #
+        # DEPRECATED!
+        #
+        def self.connection_string_2
+            "postgresql://#{@@db_user}:#{@@db_password}@#{@@db_url}:#{@@db_port}?sslmode=#{@@db_sslmode}&options=--cluster%3D#{@@db_cluster}"
+        end # connection_string
+
+        # create database connection
+        def self.connect
+            BlackStack::set_db_type(BlackStack::TYPE_CRDB)
+            Sequel.connect(BlackStack::CRDB.connection_string)
+        end
+
+        # database connection getters
+        def self.db_url
+            @@db_url
+        end
+        def self.db_port
+            @@db_port
+        end
+        def self.db_cluster
+            @@db_cluster
+        end
+        def self.db_name
+            @@db_name
+        end
+        def self.db_user
+            @@db_user
+        end
+        def self.db_password
+            @@db_password
+        end
+        def self.db_sslmode
+            @@db_sslmode
+        end
+        def self.set_db_params(h)
+            # validate: the parameter h is requred
+            raise "The parameter h is required." if h.nil?
+
+            # validate: the parameter h must be a hash
+            raise "The parameter h must be a hash" unless h.is_a?(Hash)
+
+            # validate: the :db_url key is required
+            raise 'The key :db_url is required' unless h.has_key?(:db_url)
+
+            # validate: the :db_port key is required
+            raise 'The key :db_port is required' unless h.has_key?(:db_port)
+
+            # validate: the db_name key is required
+            raise 'The key :db_name is required' unless h.has_key?(:db_name)
+
+            # validate: the db_user key is required
+            raise 'The key :db_user is required' unless h.has_key?(:db_user)
+
+            # validate: the db_password key is required
+            raise 'The key :db_password is required' unless h.has_key?(:db_password)
+
+            # validate: the :db_url key must be a string
+            raise 'The key :db_url must be a string' unless h[:db_url].is_a?(String)
+
+            # validate: the :db_port key must be an integer, or a string that can be converted to an integer
+            raise 'The key :db_port must be an integer' unless h[:db_port].is_a?(Integer) || (h[:db_port].is_a?(String) && h[:db_port].to_i.to_s == h[:db_port])
+
+            # validate: the :db_name key must be a string
+            raise 'The key :db_name must be a string' unless h[:db_name].is_a?(String)
+
+            # validate: the :db_user key must be a string
+            raise 'The key :db_user must be a string' unless h[:db_user].is_a?(String)
+
+            # validate: the :db_password key must be a string
+            raise 'The key :db_password must be a string' unless h[:db_password].is_a?(String)
+
+            # map values
+            @@db_url = h[:db_url]
+            @@db_port = h[:db_port].to_i
+            @@db_cluster = h[:db_cluster] # default is nil
+            @@db_name = h[:db_name]
+            @@db_user = h[:db_user]
+            @@db_password = h[:db_password]
+            @@db_sslmode = h[:db_sslmode] || 'verify-full' # default is verify-full
+        end # set_db_params
+
+        # return a postgresql uuid
+        def self.guid()
+            DB['SELECT gen_random_uuid() AS id'].first[:id]
+        end
+            
+        # return current datetime with format `%Y-%m-%d %H:%M:%S %Z`, using the timezone of the database (`select current_setting('TIMEZONE')`)
+        # TODO: I am hardcoding the value of `tz` because for any reason `SELECT current_setting('TIMEZONE')` returns `UTC` instead of 
+        # `America/Argentina/Buenos_Aires` when I run it from Ruby. Be sure your database is ALWAYS configured with the correct timezone.
+        def self.now()
+            tz = 'America/Argentina/Buenos_Aires' #DB["SELECT current_setting('TIMEZONE') AS tz"].first[:tz]
+            DB["SELECT current_timestamp() at TIME ZONE '#{tz}' AS now"].first[:now]
+        end
+=begin
+        # test the connection to the database.
+        # raise an exception if the connection fails, or if any incongruence is found.
+        def self.test(l=nil)
+            l = BlackStack::DummyLogger.new if l.nil?
+            @db = nil
+
+            #l.log "Connection String:"
+            #l.log BlackStack::TYPE_CRDB::connection_string
+            
+            l.logs "Testing connection... "
+            begin
+                @db = BlackStack::Deployer::DB::connect(
+                    BlackStack::TYPE_CRDB::connection_string # use the connection parameters setting in ./config.rb
+                )
+                l.logf "success"
+            rescue => e
+                l.logf "failed"
+                l.log e.message
+            end
+            
+            # if the name of databsase in `config.rb` is wrong, the connection is made to the defaultdb.
+            # This validation checks the connection to the correct database.
+            begin
+                l.logs "Verify database name... "
+                s = @db["SHOW DATABASES"].first.to_s
+                raise 'Wrong database name' if s !~ /:database_name=>\"#{Regexp.escape(BlackStack::TYPE_CRDB::db_name)}\"/i
+                l.logf "success"
+            rescue => e
+                l.logf "failed"
+                l.log e.message
+            end
+        end
+=end
+    end # module CRDB
+end # module BlackStack

data/lib/blackstack-db/postgresql.rb

@@ -0,0 +1,135 @@
+module BlackStack
+    module PostgreSQL
+        # database connection parameters
+        @@db_url = nil
+        @@db_port = nil
+        @@db_name = nil
+        @@db_user = nil
+        @@db_password = nil
+
+        # return the connection string for a postgresql database
+        def self.connection_string
+            "postgresql://#{@@db_user}:#{@@db_password}@#{@@db_url}:#{@@db_port}/#{@@db_name}"
+        end # connection_string
+
+        # database connection getters
+        def self.db_url
+            @@db_url
+        end
+        def self.db_port
+            @@db_port
+        end
+        def self.db_name
+            @@db_name
+        end
+        def self.db_user
+            @@db_user
+        end
+        def self.db_password
+            @@db_password
+        end
+
+        def self.set_db_params(h)
+            # validate: the parameter h is requred
+            raise "The parameter h is required." if h.nil?
+
+            # validate: the parameter h must be a hash
+            raise "The parameter h must be a hash" unless h.is_a?(Hash)
+
+            # validate: the :db_url key is required
+            raise 'The key :db_url is required' unless h.has_key?(:db_url)
+
+            # validate: the :db_port key is required
+            raise 'The key :db_port is required' unless h.has_key?(:db_port)
+
+            # validate: the db_name key is required
+            raise 'The key :db_name is required' unless h.has_key?(:db_name)
+
+            # validate: the db_user key is required
+            raise 'The key :db_user is required' unless h.has_key?(:db_user)
+
+            # validate: the db_password key is required
+            raise 'The key :db_password is required' unless h.has_key?(:db_password)
+
+            # validate: the :db_url key must be a string
+            raise 'The key :db_url must be a string' unless h[:db_url].is_a?(String)
+
+            # validate: the :db_port key must be an integer, or a string that can be converted to an integer
+            raise 'The key :db_port must be an integer' unless h[:db_port].is_a?(Integer) || (h[:db_port].is_a?(String) && h[:db_port].to_i.to_s == h[:db_port])
+
+            # validate: the :db_name key must be a string
+            raise 'The key :db_name must be a string' unless h[:db_name].is_a?(String)
+
+            # validate: the :db_user key must be a string
+            raise 'The key :db_user must be a string' unless h[:db_user].is_a?(String)
+
+            # validate: the :db_password key must be a string
+            raise 'The key :db_password must be a string' unless h[:db_password].is_a?(String)
+
+            # map values
+            @@db_url = h[:db_url]
+            @@db_port = h[:db_port].to_i
+            @@db_name = h[:db_name]
+            @@db_user = h[:db_user]
+            @@db_password = h[:db_password]
+        end # set_db_params
+
+        # create database connection
+        def self.connect
+            BlackStack::set_db_type(BlackStack::TYPE_POSTGRESQL)
+            Sequel.connect(BlackStack::PostgreSQL.connection_string)
+        end
+
+        # return a postgresql uuid
+        def self.guid()
+            DB['SELECT uuid_generate_v4() AS id'].first[:id]
+        end
+            
+        # return current datetime with format `%Y-%m-%d %H:%M:%S %Z`, using the timezone of the database (`select current_setting('TIMEZONE')`)
+        # TODO: I am hardcoding the value of `tz` because for any reason `SELECT current_setting('TIMEZONE')` returns `UTC` instead of 
+        # `America/Argentina/Buenos_Aires` when I run it from Ruby. Be sure your database is ALWAYS configured with the correct timezone.
+        def self.now()
+            tz = 'America/Argentina/Buenos_Aires' #DB["SELECT current_setting('TIMEZONE') AS tz"].first[:tz]
+            DB["SELECT current_timestamp at TIME ZONE '#{tz}' AS now"].first[:now]
+        end
+
+        def self.seconds_ago(n)
+            tz = 'America/Argentina/Buenos_Aires' #DB["SELECT current_setting('TIMEZONE') AS tz"].first[:tz]
+            DB["SELECT (current_timestamp - interval '#{n} seconds') at TIME ZONE '#{tz}' AS now"].first[:now]
+        end
+=begin
+        # test the connection to the database.
+        # raise an exception if the connection fails, or if any incongruence is found.
+        def self.test(l=nil)
+            l = BlackStack::DummyLogger.new if l.nil?
+            @db = nil
+
+            #l.log "Connection String:"
+            #l.log BlackStack::PostgreSQL::connection_string
+            
+            l.logs "Testing connection... "
+            begin
+                @db = BlackStack::Deployer::DB::connect(
+                    BlackStack::PostgreSQL::connection_string # use the connection parameters setting in ./config.rb
+                )
+                l.logf "success"
+            rescue => e
+                l.logf "failed"
+                l.log e.message
+            end
+            
+            # if the name of databsase in `config.rb` is wrong, the connection is made to the defaultdb.
+            # This validation checks the connection to the correct database.
+            begin
+                l.logs "Verify database name... "
+                s = @db["SHOW DATABASES"].first.to_s
+                raise 'Wrong database name' if s !~ /:database_name=>\"#{Regexp.escape(BlackStack::PostgreSQL::db_name)}\"/i
+                l.logf "success"
+            rescue => e
+                l.logf "failed"
+                l.log e.message
+            end
+        end
+=end
+    end # module PostgreSQL
+end

data/lib/blackstack-db.rb

@@ -0,0 +1,39 @@
+require 'sequel'
+require_relative './blackstack-db/postgresql.rb'
+require_relative './blackstack-db/crdb.rb'
+
+module BlackStack
+    TYPE_POSTGRESQL = 0
+    TYPE_CRDB = 1
+    @@db_type = nil
+
+    def self.set_db_type(n)
+        @@db_type = n
+    end # set_db_type
+
+    def self.db_type
+        @@db_type
+    end # db_type
+end # BlackStack
+
+# return a postgresql uuid
+def guid()
+    if BlackStack.db_type == BlackStack::TYPE_POSTGRESQL
+        return BlackStack::PostgreSQL.guid
+    elsif BlackStack.db_type == BlackStack::TYPE_CRDB
+        return BlackStack::CRDB.guid
+    else
+        raise "Unknown database type"
+    end
+end
+            
+# return current datetime with format `YYYY-MM-DD HH:MM:SS`
+def now()
+    if BlackStack.db_type == BlackStack::TYPE_POSTGRESQL
+        return BlackStack::PostgreSQL.now
+    elsif BlackStack.db_type == BlackStack::TYPE_CRDB
+        return BlackStack::CRDB.now
+    else
+        raise "Unknown database type"
+    end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: blackstack-db
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Leandro Daniel Sardi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.56.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.56.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.56.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.56.0
+description: 'Modules for simple setup of database connections: https://github.com/leandrosardi/blackstack-db.'
+email: leandro@connectionsphere.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/blackstack-db.rb
+- lib/blackstack-db/crdb.rb
+- lib/blackstack-db/postgresql.rb
+homepage: https://rubygems.org/gems/blackstack-db
+licenses:
+- MIT
+metadata: {}
+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.3.7
+signing_key: 
+specification_version: 4
+summary: Modules for simple setup of database connections.
+test_files: []