blufin-lib 1.4.0

data/lib/blufin-lib/core/tools.rb

@@ -0,0 +1,108 @@
+require 'rbconfig'
+
+module Blufin
+
+    class Tools
+
+        OS_WINDOWS = 'windows'
+        OS_MAC     = 'mac'
+        OS_LINUX   = 'linux'
+        OS_UNIX    = 'unix'
+        OS_OTHER   = 'other'
+
+        # Get PATH to assets, scripts, etc.
+        # @return String
+        def self.get_base_path
+            base_path = File.dirname(File.expand_path(__FILE__))
+            base_path = base_path.gsub(/\/\w+\/\w+\z/i, '')
+            base_path
+        end
+
+        # Check that remote host is reachable.
+        # @return void
+        def self.check_remote_is_reachable(host_address)
+            if ping(host_address) != 0
+                Tools::Terminal::error('Cannot reach remote host', ["#{Tools::Terminal::format_highlight(host_address)} cannot be reached.", 'Please make sure the host is online and/or configured correctly.'])
+            end
+        end
+
+        # Ping a URL or IP and returns the exit status. 0 = success, anything else means it failed.
+        # @return Integer
+        def self.ping(host_address, verbose = true)
+            Tools::Terminal::output("Checking if #{Tools::Terminal::format_highlight(host_address)} is reachable...") if verbose == true
+            `ping -t 1 -c 1 #{host_address}`
+            $?.exitstatus
+        end
+
+        # Check that SSHPASS is installed.
+        # @return void
+        def self.check_sshpass_is_installed
+            if @sshpass_installed.nil?
+                sshpass_result = Tools::Terminal::command_capture('sshpass -h', nil, false, false)
+                sshpass_result = sshpass_result[0].split(' ')
+                unless sshpass_result[0].downcase == 'usage:'
+                    if this_is_a_mac
+                        error_message = "Find how to install it at: #{Tools::Terminal::format_highlight('https://www.google.co.uk/search?q=install+sshpass+on+mac')}"
+                    else
+                        error_message = "Install it using: #{Tools::Terminal::format_command('sudo apt-get install sshpass')}"
+                    end
+                    Tools::Terminal::error("#{Tools::Terminal::format_highlight('sshpass')} is not installed", error_message, true)
+                end
+                @sshpass_installed = true
+            end
+        end
+
+        # Returns TRUE if Mac, FALSE if Linux (or anything else for that matter)
+        # @return boolean
+        def self.this_is_a_mac
+            return os == OS_MAC
+        end
+
+        # Get the operating system.
+        # @return String
+        def self.os
+            @os ||= (
+            host_os = RbConfig::CONFIG['host_os']
+            case host_os
+                when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
+                    OS_WINDOWS
+                when /darwin|mac os/
+                    OS_MAC
+                when /linux/
+                    OS_LINUX
+                when /solaris|bsd/
+                    OS_UNIX
+                else
+                    OS_OTHER
+            end
+            )
+        end
+
+        # Checks if a String or Integer is a whole number,
+        # @return boolean
+        def self.is_whole_number(value)
+            if value =~ /^\s*\d+\s*$/
+                true
+            elsif value.is_a? Integer
+                true
+            else
+                false
+            end
+        end
+
+        # Get the character at a specific index in a string.
+        # @return string
+        def self.get_char_at(char_at, string)
+            if is_whole_number(char_at)
+                char_at = char_at.to_i
+                char_at = (char_at - 1)
+                string[char_at]
+            else
+                raise(RuntimeError, "The value for CharAt must be a whole number. The script received (#{char_at.class}) #{char_at}.")
+            end
+        end
+
+
+    end
+
+end

data/lib/blufin-lib/test/TestEnvironmentValidator.rb

@@ -0,0 +1,98 @@
+module Blufin
+
+    module Test
+
+        class EnvironmentValidator
+
+            CHECK_API       = 'check-api'
+            CHECK_CRON      = 'check-cron'
+            CHECK_WORKER    = 'check-worker'
+            CHECK_MYSQL     = 'check-mysql'
+            CHECK_RABBIT_MQ = 'check-rabbit-mq'
+
+            def initialize(opts, base_prefix)
+
+                raise RuntimeError, "Opts must be an array, you passed: #{opts.class}" unless opts.is_a?(Hash)
+
+                @base_prefix = base_prefix
+
+                valid_opts = [CHECK_API, CHECK_CRON, CHECK_WORKER, CHECK_MYSQL, CHECK_RABBIT_MQ]
+
+                opts.keys.each { |opt| raise RuntimeError, "#{opt} is not a valid value" unless valid_opts.include?(opt) }
+
+                Blufin::Terminal::info('Checking for necessary components...') if opts.length > 0
+
+                validation_results = []
+                validation_results << check_api(opts[CHECK_API]) if opts.keys.include?(CHECK_API)
+                validation_results << check_cron(opts[CHECK_CRON]) if opts.keys.include?(CHECK_CRON)
+                validation_results << check_worker(opts[CHECK_WORKER]) if opts.keys.include?(CHECK_WORKER)
+                validation_results << check_mysql if opts.keys.include?(CHECK_MYSQL)
+                validation_results << check_rabbit_mq if opts.keys.include?(CHECK_RABBIT_MQ)
+
+                Blufin::Terminal::error('Your environment is not setup correctly. Please check the above output.', nil, true) if validation_results.include?(false)
+
+                puts
+
+            end
+
+            private
+
+            # Checks that the API is running.
+            # @return void
+            def check_api(uri)
+                check_service_common(uri, 'api')
+            end
+
+            # Checks that the WORKER is running.
+            # @return void
+            def check_cron(uri)
+                check_service_common(uri, 'cron')
+            end
+
+            # Checks that the WORKER is running.
+            # @return void
+            def check_worker(uri)
+                check_service_common(uri, 'worker')
+            end
+
+            # Checks that the MySQL is running.
+            # @return void
+            def check_mysql
+                if system('mysqladmin version >& /dev/null')
+                    Blufin::Terminal::output(Blufin::Terminal::format_highlight('mysql'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Pass', 22)
+                    true
+                else
+                    Blufin::Terminal::output(Blufin::Terminal::format_invalid('mysql'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Fail', 196)
+                    false
+                end
+            end
+
+            # Checks that the RabbitMQ is running.
+            # @return void
+            def check_rabbit_mq
+                if system('rabbitmqadmin --help >& /dev/null')
+                    Blufin::Terminal::output(Blufin::Terminal::format_highlight('rabbit-mq'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Pass', 22)
+                    return true
+                else
+                    Blufin::Terminal::output(Blufin::Terminal::format_invalid('rabbit-mq'), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Fail', 196)
+                end
+                false
+            end
+
+            # Common method for checking Java services are running.
+            def check_service_common(uri, service_name)
+                service_name = "#{@base_prefix}-#{service_name}"
+                if system("curl -I #{uri} -k >& /dev/null")
+                    Blufin::Terminal::output(Blufin::Terminal::format_highlight(service_name), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Pass', 22)
+                    return true
+                else
+                    Blufin::Terminal::output(Blufin::Terminal::format_invalid(service_name), Blufin::Terminal::MSG_CUSTOM_AUTO_PAD, 'Fail', 196)
+                end
+                false
+            end
+
+        end
+
+    end
+
+end

data/lib/version.rb

@@ -0,0 +1 @@
+BLUFIN_LIB_VERSION = '1.4.0'

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: blufin-lib
+version: !ruby/object:Gem::Version
+  version: 1.4.0
+platform: ruby
+authors:
+- Albert Rannetsperger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Common functionality shared between ruby gems.
+email: alb3rtuk@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/blufin-lib.rb
+- lib/blufin-lib/core/arrays.rb
+- lib/blufin-lib/core/browser.rb
+- lib/blufin-lib/core/datetime_utils.rb
+- lib/blufin-lib/core/encryptor.rb
+- lib/blufin-lib/core/files.rb
+- lib/blufin-lib/core/network.rb
+- lib/blufin-lib/core/numbers.rb
+- lib/blufin-lib/core/routes.rb
+- lib/blufin-lib/core/ssh.rb
+- lib/blufin-lib/core/strings.rb
+- lib/blufin-lib/core/terminal.rb
+- lib/blufin-lib/core/tools.rb
+- lib/blufin-lib/test/TestEnvironmentValidator.rb
+- lib/version.rb
+homepage: https://github.com/alb3rtuk
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Blufin Lib
+test_files: []