brightpearl-cli 1.3.0 → 1.4.0

data/lib/core/config.rb

@@ -1,45 +1,14 @@
 require 'fileutils'
 require 'parseconfig'
 
-module Brightpearl
+module App
 
     class Config
 
-        CONFIG_FILE = '~/.brightpearlrc'
-
-        MAC = 'mac'
-        LINUX = 'linux'
-
-        WORKSTATION_IP = 'workstation_ip'
-        WORKSTATION_OS = 'workstation_os'
-        WORKSTATION_PATH_TO_BP_CODE = 'workstation_path_to_bp_code'
-        WORKSTATION_PATH_TO_BP_DB = 'workstation_path_to_bp_db'
-        VM_IP = 'vm_ip'
-        VM_USER = 'vm_user'
-        VM_USER_PASSWORD = 'vm_user_password'
-        VM_ROOT = 'vm_root'
-        VM_ROOT_PASSWORD = 'vm_root_password'
-        VM_MYSQL_USER = 'vm_mysql_user'
-        VM_MYSQL_PASSWORD = 'vm_mysql_password'
-
-        BETA = 'beta'
-        PREFERRED_TEXT_EDITOR = 'preferred_text_editor'
-        GIT_USERNAME = 'git_username'
-
-        CRYPT_KEY = 'crypt_key'
-        CRYPT_HEX = 'crypt_hex'
-        EC2_HOST = 'ec2_host'
-        EC2_USER = 'ec2_user'
-        EC2_PASS = 'ec2_pass'
-
         @params = {}
 
-        def self.param(param_name)
-            unless all_available_config_keys.include?(param_name)
-                Brightpearl::Terminal::error("#{Brightpearl::Terminal::format_highlight(param_name)} is not a valid config parameter", true)
-            end
-            @params[param_name]
-        end
+        extend ConfigUnique
+        include ConfigUnique
 
         def self.initialize
             if config_file_exists?
@@ -50,7 +19,7 @@ module Brightpearl
         end
 
         def self.config_file_exists?
-            unless File.exists?(File.expand_path(CONFIG_FILE))
+            unless File.exists? ("#{File.expand_path(CONFIG_FILE)}")
                 return false
             end
             true
@@ -71,53 +40,19 @@ module Brightpearl
 
         def self.first_journey_message
             puts
-            puts "Thank you for installing the #{Brightpearl::Terminal::format_highlight('brightpearl-cli')} ruby gem."
+            puts "Thank you for installing the #{App::Terminal::format_highlight("#{GEM_NAME}-cli")} ruby gem."
             puts "CLI stands for 'Command Line Interface'."
             puts
             puts "The first thing you'll need to do is setup your configuration file."
-            puts "The file is located at: #{Brightpearl::Terminal::format_directory('~/.brightpearlrc')}"
+            puts "The file is located at: #{App::Terminal::format_directory(App::Config)}"
             puts
             puts "You probably won't have this file so the program will create it for you."
             puts "\n"
-            unless Brightpearl::Terminal::prompt_yes_no('Create configuration file?')
-                Brightpearl::Terminal::abort
+            unless App::Terminal::prompt_yes_no('Create configuration file?')
+                App::Terminal::abort
             end
         end
 
-        def self.config_file_create
-            File.open("#{File.expand_path(CONFIG_FILE)}", 'w') { |file|
-                file.write("# CONFIGURATION FILE -- Use this file to configure brightpearl-cli\n")
-                file.write("\n")
-                file.write("#{WORKSTATION_IP}=172.27.X.X\n")
-                file.write("#{WORKSTATION_OS}=linux\n")
-                file.write("#{WORKSTATION_PATH_TO_BP_CODE}=/brightpearl-source/brightpearl-code\n")
-                file.write("#{WORKSTATION_PATH_TO_BP_DB}=/brightpearl-source/brightpearl-db\n")
-                file.write("\n")
-                file.write("#{VM_IP}=172.27.X.X\n")
-                file.write("#{VM_USER}=\n")
-                file.write("#{VM_USER_PASSWORD}=\n")
-                file.write("#{VM_ROOT}=root\n")
-                file.write("#{VM_ROOT_PASSWORD}=peXXXXXXXre\n")
-                file.write("#{VM_MYSQL_USER}=root\n")
-                file.write("#{VM_MYSQL_PASSWORD}=peXXXXXXXre\n")
-                file.write("\n")
-                file.write("# Usually vi, vim or nano\n")
-                file.write("#{PREFERRED_TEXT_EDITOR}=\n")
-                file.write("\n")
-                file.write("# Found by running $ git config user.name\n")
-                file.write("#{GIT_USERNAME}=\n")
-                file.write("\n")
-                file.write("#{CRYPT_KEY}=\n")
-                file.write("#{CRYPT_HEX}=\n")
-                file.write("#{EC2_HOST}=\n")
-                file.write("#{EC2_USER}=\n")
-                file.write("#{EC2_PASS}=\n")
-                file.write("\n")
-                file.write("# BETA FEATURES -- Set to TRUE to enable beta features -- NOT RECOMMENDED!\n")
-                file.write("#{BETA}=false\n")
-            }
-        end
-
         def self.config_file_edit
             system("nano #{File.expand_path(CONFIG_FILE)}")
         end
@@ -138,32 +73,17 @@ module Brightpearl
                 end
                 error_text = error_text[0..-2]
             end
-            workstation_os = Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_OS)
-            unless workstation_os.downcase == MAC || workstation_os.downcase == LINUX
-                unless error_text == ''
-                    error_text = "#{error_text}\n\n"
-                end
-                error_text = "#{error_text}\x1B[38;5;196mThe value for \x1B[38;5;240m#{WORKSTATION_OS}\x1B[38;5;196m must be either: \x1B[38;5;84m#{MAC}\x1B[38;5;196m or \x1B[38;5;84m#{LINUX}\x1B[38;5;196m\x1B[0m\n"
-            end
-            code_repo = Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_PATH_TO_BP_CODE)
-            db_repo = Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_PATH_TO_BP_DB)
-            unless File.directory?(code_repo)
-                error_text = "#{error_text}The following is NOT a valid directory: \x1B[0m#{code_repo}\x1B[90m\n"
-            end
-            unless File.directory?(db_repo)
-                error_text = "#{error_text}The following is NOT a valid directory: \x1B[0m#{db_repo}\x1B[90m\n"
-            end
             unless error_text == ''
                 show_error_message(error_text)
             end
             if show_success_message
-                Brightpearl::Terminal::success('Configuration parameters are correct.', "You are now ready to start using this utility.\nStart by typing #{Brightpearl::Terminal::format_command('brightpearl --help')} (or #{Brightpearl::Terminal::format_command('bp -h')}).")
+                App::Terminal::success('Configuration parameters are correct.', "You are now ready to start using this utility.\nStart by typing #{App::Terminal::format_command("#{GEM_NAME} --help")} (or #{App::Terminal::format_command("#{GEM_NAME} -h")}).")
                 exit
             end
         end
 
         def self.show_error_message(error_text)
-            Brightpearl::Terminal::error('Your configuration parameters are invalid.', "#{error_text}\nYou can fix this by running #{Brightpearl::Terminal::format_command('brightpearl setup')} (or #{Brightpearl::Terminal::format_command('bp x')}).")
+            App::Terminal::error('Your configuration parameters are invalid.', "#{error_text}\n\nYou can fix this by running #{App::Terminal::format_command("#{GEM_NAME} setup")} (or #{App::Terminal::format_command("#{GEM_NAME} x")}).")
             exit
         end
 
@@ -177,49 +97,6 @@ module Brightpearl
             missing_keys
         end
 
-        def self.required_config_keys
-            [
-                WORKSTATION_IP,
-                WORKSTATION_OS,
-                WORKSTATION_PATH_TO_BP_CODE,
-                WORKSTATION_PATH_TO_BP_DB,
-                VM_IP,
-                VM_USER,
-                VM_USER_PASSWORD,
-                VM_ROOT,
-                VM_ROOT_PASSWORD,
-                VM_MYSQL_USER,
-                VM_MYSQL_PASSWORD,
-                PREFERRED_TEXT_EDITOR,
-                GIT_USERNAME
-            ]
-        end
-
-        def self.all_available_config_keys
-            [
-                WORKSTATION_IP,
-                WORKSTATION_OS,
-                WORKSTATION_PATH_TO_BP_CODE,
-                WORKSTATION_PATH_TO_BP_DB,
-                VM_IP,
-                VM_USER,
-                VM_USER_PASSWORD,
-                VM_ROOT,
-                VM_ROOT_PASSWORD,
-                VM_MYSQL_USER,
-                VM_MYSQL_PASSWORD,
-                PREFERRED_TEXT_EDITOR,
-                GIT_USERNAME,
-                BETA,
-                CRYPT_KEY,
-                CRYPT_HEX,
-                EC2_HOST,
-                EC2_USER,
-                EC2_PASS
-            ]
-        end
-
     end
 
-
 end

data/lib/core/config_unique.rb

@@ -0,0 +1,113 @@
+require 'fileutils'
+require 'parseconfig'
+
+module ConfigUnique
+
+    # USED BY CONFIG CLASS
+    CONFIG_FILE = '~/.brightpearlrc'
+    GEM_NAME = 'brightpearl'
+
+    # MISC
+    MAC = 'mac'
+    LINUX = 'linux'
+
+    # STORED PARAMETERS
+    WORKSTATION_IP = 'workstation_ip'
+    WORKSTATION_OS = 'workstation_os'
+    WORKSTATION_PATH_TO_BP_CODE = 'workstation_path_to_bp_code'
+    WORKSTATION_PATH_TO_BP_DB = 'workstation_path_to_bp_db'
+    VM_IP = 'vm_ip'
+    VM_USER = 'vm_user'
+    VM_USER_PASSWORD = 'vm_user_password'
+    VM_ROOT = 'vm_root'
+    VM_ROOT_PASSWORD = 'vm_root_password'
+    VM_MYSQL_USER = 'vm_mysql_user'
+    VM_MYSQL_PASSWORD = 'vm_mysql_password'
+    PREFERRED_TEXT_EDITOR = 'preferred_text_editor'
+    GIT_USERNAME = 'git_username'
+    CRYPT_KEY = 'crypt_key'
+    CRYPT_HEX = 'crypt_hex'
+    EC2_HOST = 'ec2_host'
+    EC2_USER = 'ec2_user'
+    EC2_PASS = 'ec2_pass'
+
+    def param(param_name)
+        unless all_available_config_keys.include?(param_name)
+            App::Terminal::error("#{App::Terminal::format_highlight(param_name)} is not a valid config parameter", true)
+        end
+        @params[param_name]
+    end
+
+    def config_file_create
+        File.open("#{File.expand_path(CONFIG_FILE)}", 'w') { |file|
+            file.write("# CONFIGURATION FILE -- Use this file to configure brightpearl-cli\n")
+            file.write("\n")
+            file.write("#{WORKSTATION_IP}=172.27.X.X\n")
+            file.write("#{WORKSTATION_OS}=linux\n")
+            file.write("#{WORKSTATION_PATH_TO_BP_CODE}=/brightpearl-source/brightpearl-code\n")
+            file.write("#{WORKSTATION_PATH_TO_BP_DB}=/brightpearl-source/brightpearl-db\n")
+            file.write("\n")
+            file.write("#{VM_IP}=172.27.X.X\n")
+            file.write("#{VM_USER}=\n")
+            file.write("#{VM_USER_PASSWORD}=\n")
+            file.write("#{VM_ROOT}=root\n")
+            file.write("#{VM_ROOT_PASSWORD}=peXXXXXXXre\n")
+            file.write("#{VM_MYSQL_USER}=root\n")
+            file.write("#{VM_MYSQL_PASSWORD}=peXXXXXXXre\n")
+            file.write("\n")
+            file.write("# Usually vi, vim or nano\n")
+            file.write("#{PREFERRED_TEXT_EDITOR}=\n")
+            file.write("\n")
+            file.write("# Found by running $ git config user.name\n")
+            file.write("#{GIT_USERNAME}=\n")
+            file.write("\n")
+            file.write("#{CRYPT_KEY}=\n")
+            file.write("#{CRYPT_HEX}=\n")
+            file.write("#{EC2_HOST}=\n")
+            file.write("#{EC2_USER}=\n")
+            file.write("#{EC2_PASS}=\n")
+        }
+    end
+
+    def required_config_keys
+        [
+            WORKSTATION_IP,
+            WORKSTATION_OS,
+            WORKSTATION_PATH_TO_BP_CODE,
+            WORKSTATION_PATH_TO_BP_DB,
+            VM_IP,
+            VM_USER,
+            VM_USER_PASSWORD,
+            VM_ROOT,
+            VM_ROOT_PASSWORD,
+            VM_MYSQL_USER,
+            VM_MYSQL_PASSWORD,
+            PREFERRED_TEXT_EDITOR,
+            GIT_USERNAME
+        ]
+    end
+
+    def all_available_config_keys
+        [
+            WORKSTATION_IP,
+            WORKSTATION_OS,
+            WORKSTATION_PATH_TO_BP_CODE,
+            WORKSTATION_PATH_TO_BP_DB,
+            VM_IP,
+            VM_USER,
+            VM_USER_PASSWORD,
+            VM_ROOT,
+            VM_ROOT_PASSWORD,
+            VM_MYSQL_USER,
+            VM_MYSQL_PASSWORD,
+            PREFERRED_TEXT_EDITOR,
+            GIT_USERNAME,
+            CRYPT_KEY,
+            CRYPT_HEX,
+            EC2_HOST,
+            EC2_USER,
+            EC2_PASS
+        ]
+    end
+
+end

data/lib/core/encrypter.rb

@@ -1,7 +1,7 @@
 require 'openssl'
 require 'base64'
 
-module Brightpearl
+module App
 
     class Encrypter
 
@@ -10,11 +10,11 @@ module Brightpearl
 
         def initialize
 
-            @key = Brightpearl::Config.param(Brightpearl::Config::CRYPT_KEY)
-            @hex = Brightpearl::Config.param(Brightpearl::Config::CRYPT_HEX)
+            @key = App::Config::param(App::Config::CRYPT_KEY)
+            @hex = App::Config::param(App::Config::CRYPT_HEX)
 
             if @key.nil? || @hex.nil?
-                Brightpearl::Terminal::error('Encryption keys not found', ["The command you're trying to run probably requires access to an EC2 database (or some other advanced feature).", "In order for this to work you will need valid #{Brightpearl::Terminal::format_highlight('encryption keys')}.", "Please speak to #{Brightpearl::Terminal::format_highlight('Albert')} (or team Raptor) for more info."], true)
+                App::Terminal::error('Encryption keys not found', ["The command you're trying to run probably requires access to an EC2 database (or some other advanced feature).", "In order for this to work you will need valid #{App::Terminal::format_highlight('encryption keys')}.", "Please speak to #{App::Terminal::format_highlight('Albert')} (or team Raptor) for more info."], true)
             end
 
         end
@@ -29,7 +29,7 @@ module Brightpearl
                 e << c.final
                 return Base64.encode64(e)
             rescue
-                Brightpearl::Terminal::error('Encryption failed', "Could not encrypt string #{string == '' ? '[blank]' : Brightpearl::Terminal::format_highlight(string)} using crypt_key #{Brightpearl::Terminal::format_highlight(Brightpearl::Config.param(Brightpearl::Config::CRYPT_KEY) == '' ? '[blank]' : Brightpearl::Config.param(Brightpearl::Config::CRYPT_KEY))} and crypt_hex #{Brightpearl::Terminal::format_highlight(Brightpearl::Config.param(Brightpearl::Config::CRYPT_HEX) == '' ? '[blank]' : Brightpearl::Config.param(Brightpearl::Config::CRYPT_HEX))}")
+                App::Terminal::error('Encryption failed', "Could not encrypt string #{string == '' ? '[blank]' : App::Terminal::format_highlight(string)} using crypt_key #{App::Terminal::format_highlight(App::Config::param(App::Config::CRYPT_KEY) == '' ? '[blank]' : App::Config::param(App::Config::CRYPT_KEY))} and crypt_hex #{App::Terminal::format_highlight(App::Config::param(App::Config::CRYPT_HEX) == '' ? '[blank]' : App::Config::param(App::Config::CRYPT_HEX))}")
             end
 
         end
@@ -45,7 +45,7 @@ module Brightpearl
                 d << c.final
                 return d
             rescue
-                Brightpearl::Terminal::error('Decryption failed', "Could not decrypt string #{string == '' ? '[blank]' : Brightpearl::Terminal::format_highlight(string)} using crypt_key #{Brightpearl::Terminal::format_highlight(Brightpearl::Config.param(Brightpearl::Config::CRYPT_KEY) == '' ? '[blank]' : Brightpearl::Config.param(Brightpearl::Config::CRYPT_KEY))} and crypt_hex #{Brightpearl::Terminal::format_highlight(Brightpearl::Config.param(Brightpearl::Config::CRYPT_HEX) == '' ? '[blank]' : Brightpearl::Config.param(Brightpearl::Config::CRYPT_HEX))}")
+                App::Terminal::error('Decryption failed', "Could not decrypt string #{string == '' ? '[blank]' : App::Terminal::format_highlight(string)} using crypt_key #{App::Terminal::format_highlight(App::Config::param(App::Config::CRYPT_KEY) == '' ? '[blank]' : App::Config::param(App::Config::CRYPT_KEY))} and crypt_hex #{App::Terminal::format_highlight(App::Config::param(App::Config::CRYPT_HEX) == '' ? '[blank]' : App::Config::param(App::Config::CRYPT_HEX))}")
             end
 
         end

data/lib/core/enums.rb

@@ -1,4 +1,4 @@
-module Brightpearl
+module App
 
     class Enum