brightpearl-cli 1.1.0

data/lib/core/jira.rb

@@ -0,0 +1,43 @@
+module Brightpearl
+
+    class Jira
+
+        # Initialise credentials
+        # @return void
+        def initialize
+        end
+
+        # Gets jira number from an argument. Displays error if invalid.
+        # @return int
+        def get_jira_number_from_arg(argument)
+            jira_number = nil
+            jira_number_possible = argument
+            jira_number_possible.split('-').each do |pjn|
+                if validate_jira_number(pjn)
+                    jira_number = pjn
+                    break
+                end
+            end
+            if jira_number.nil?
+                Brightpearl::Terminal::error('Invalid Jira Number', "The Jira Number must be a 4-5 digit number. You tried to pass: #{Brightpearl::Terminal::format_invalid(argument)}", true)
+            end
+            jira_number
+        end
+
+        # Validates that string is a number between 1 - 20,0000
+        # @return boolean
+        def validate_jira_number(value)
+            begin
+                value = Integer value
+                if value < 0 || value > 20000
+                    return false
+                end
+                return true
+            rescue
+                return false
+            end
+        end
+
+    end
+
+end

data/lib/core/mysql.rb

@@ -0,0 +1,48 @@
+require 'mysql'
+
+module Brightpearl
+
+    class MySQL
+
+        DEFAULT_SCHEMA = 'app'
+
+        @database_connection = nil
+
+        @ids_customers = []
+        @ids_shipping = []
+
+        def self.get_database_connection(schema = DEFAULT_SCHEMA)
+            if @database_connection == nil
+                @database_connection = Mysql.new(
+                    Brightpearl::Config.param(Brightpearl::Config::VM_IP),
+                    Brightpearl::Config.param(Brightpearl::Config::VM_MYSQL_USER),
+                    Brightpearl::Config.param(Brightpearl::Config::VM_MYSQL_PASSWORD),
+                    schema
+                )
+            end
+            @database_connection
+        end
+
+        def self.get_random_customer_id
+            unless @ids_customers.any?
+                customers = Brightpearl::MySQL::get_database_connection.query('SELECT customers_id FROM customers ORDER BY customers_id DESC LIMIT 100')
+                customers.each_hash do |row|
+                    @ids_customers << row['customers_id']
+                end
+            end
+            @ids_customers.sample
+        end
+
+        def self.get_random_shipping_id
+            unless @ids_shipping.any?
+                ship_methods = Brightpearl::MySQL::get_database_connection.query('SELECT ship_method_id FROM ship_methods ORDER BY ship_method_id DESC LIMIT 100')
+                ship_methods.each_hash do |row|
+                    @ids_shipping << row['ship_method_id']
+                end
+            end
+            @ids_shipping.sample
+        end
+
+    end
+
+end

data/lib/core/terminal.rb

@@ -0,0 +1,389 @@
+require 'highline/import'
+require 'columnist'
+
+module Brightpearl
+
+    class Terminal
+
+        extend Columnist
+
+        MSG_INFO = 'info'
+        MSG_WARNING = 'warning'
+        MSG_ERROR = 'error'
+
+        # Runs a series of commands in the terminal.
+        # @return void
+        def self.command(commands, location = nil, verbose = true, verbose_cd = true, capture_real_output = false)
+            unless commands.is_a?(Array)
+                commands = [commands]
+            end
+            unless location.nil?
+                unless File.directory?(location)
+                    error('Directory not found.', "Cannot find the following directory: \x1B[38;5;205m#{location}\x1B[0m", true)
+                end
+            end
+            output = []
+            if verbose_cd && verbose && commands.any?
+                puts "\x1B[42m Executing \x1B[0m \x1B[32m\xe2\x86\x92\x1B[0m #{Brightpearl::Terminal::format_command("cd #{location}")}"
+            end
+            if commands.any?
+                commands.each do |command|
+                    if verbose
+                        puts "\x1B[42m Executing \x1B[0m \x1B[32m\xe2\x86\x92\x1B[0m #{Brightpearl::Terminal::format_command("#{command}")}"
+                    end
+                    if location.nil?
+                        if capture_real_output
+                            output << `#{command}`
+                        else
+                            output << system("#{command}")
+                        end
+                    else
+                        if capture_real_output
+                            output << `cd #{location} && #{command}`
+                        else
+                            output << system("cd #{location} && #{command}")
+                        end
+                    end
+                end
+            end
+            if capture_real_output
+                output.map! { |v| v.gsub('\n', "\n") }
+            end
+            output
+        end
+
+        # Runs a series of commands in the terminal (and captures the output).
+        # @return void
+        def self.command_capture(commands, location = nil, verbose = true, verbose_cd = true)
+            command(commands, location, verbose, verbose_cd, true)
+        end
+
+        # Outputs messages to the terminal.
+        # @return void
+        def self.output(message = 'No message', type = MSG_INFO)
+            case type
+                when MSG_INFO
+                    puts "\x1B[48;5;2m Executing \x1B[0m \x1B[32m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m"
+                when MSG_WARNING
+                    puts "\x1B[48;5;2m Vigilance \x1B[0m \x1B[33m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m"
+                when MSG_ERROR
+                    puts "  \x1B[48;5;2m Failure \x1B[0m \x1B[33m\xe2\x86\x92\x1B[0m \x1B[0m#{message}\x1B[0m"
+                else
+                    raise RuntimeError "'#{type}' is not a valid type."
+            end
+        end
+
+        # Displays error and exits script by default.
+        # @return void
+        def self.abort(title = nil, message = nil, exit_script = true, preceding_blank_line = true)
+            if title.nil?
+                title = 'Abandon ship!'
+            end
+            if message.nil?
+                message = "You have chosen to \x1B[38;5;9mABORT\x1B[38;5;240m the script."
+            end
+            Brightpearl::Terminal::error(title, message, exit_script, preceding_blank_line, 'ABORT')
+        end
+
+        # Displays error and exits script by default.
+        # @return void
+        def self.error(title = nil, message = nil, exit_script = true, preceding_blank_line = true, error_text = 'ERROR')
+            if title.nil?
+                title = "It seems you're trying to do something silly."
+            end
+            if preceding_blank_line
+                puts
+            end
+            puts "    \x1B[48;5;196m #{error_text.upcase} \x1B[0m \xe2\x86\x92 #{title}"
+            puts
+            unless message.nil?
+                if message.is_a?(Array)
+                    messages = message
+                else
+                    messages = message.split("\n")
+                end
+                table(:border => false) do
+                    messages.each do |line|
+                        row do
+                            column('', :align => 'left', :width => 4)
+                            column("\x1B[38;5;240m#{line}\x1B[0m", :align => 'left', :width => 180)
+                        end
+                    end
+                end
+                puts
+            end
+            if exit_script
+                exit
+            end
+        end
+
+        # Displays info message.
+        # @return void
+        def self.info(title = nil, message = nil, preceding_blank_line = true)
+            if title.nil?
+                title = 'Whatever you did, worked.'
+            end
+            if preceding_blank_line
+                puts
+            end
+            puts "  \x1B[48;5;27m MESSAGE \x1B[0m \xe2\x86\x92 #{title}"
+            puts
+            unless message.nil?
+                if message.is_a?(Array)
+                    messages = message
+                else
+                    messages = message.split("\n")
+                end
+                table(:border => false) do
+                    messages.each do |line|
+                        row do
+                            column('', :align => 'left', :width => 4)
+                            column("\x1B[38;5;240m#{line}\x1B[0m", :align => 'left', :width => 180)
+                        end
+                    end
+                end
+                puts
+            end
+        end
+
+        # Displays success message.
+        # @return void
+        def self.success(title = nil, message = nil, preceding_blank_line = true)
+            if title.nil?
+                title = 'Whatever you did, worked.'
+            end
+            if preceding_blank_line
+                puts
+            end
+            puts "  \x1B[48;5;34m SUCCESS \x1B[0m \xe2\x86\x92 #{title}"
+            puts
+            unless message.nil?
+                if message.is_a?(Array)
+                    messages = message
+                else
+                    messages = message.split("\n")
+                end
+                table(:border => false) do
+                    messages.each do |line|
+                        row do
+                            column('', :align => 'left', :width => 4)
+                            column("\x1B[38;5;240m#{line}\x1B[0m", :align => 'left', :width => 180)
+                        end
+                    end
+                end
+                puts
+            end
+        end
+
+        # Displays warning message.
+        # @return void
+        def self.warning(title = nil, message = nil, preceding_blank_line = true)
+            if title.nil?
+                title = 'Whatever you did, generated a warning.'
+            end
+            if preceding_blank_line
+                puts
+            end
+            puts "  \x1B[48;5;202m WARNING \x1B[0m \xe2\x86\x92 #{title}"
+            puts
+            unless message.nil?
+                if message.is_a?(Array)
+                    messages = message
+                else
+                    messages = message.split("\n")
+                end
+                table(:border => false) do
+                    messages.each do |line|
+                        row do
+                            column('', :align => 'left', :width => 4)
+                            column("\x1B[38;5;240m#{line}\x1B[0m", :align => 'left', :width => 180)
+                        end
+                    end
+                end
+                puts
+            end
+        end
+
+        # Returns action text in consistent, uniform manner.
+        # @return String
+        def self.format_action(action_text)
+            "\x1B[38;5;170m#{action_text.upcase}\x1B[0m"
+        end
+
+        # Returns branch name in consistent, uniform manner.
+        # @return String
+        def self.format_branch(branch_name)
+            "\x1B[38;5;40m[#{branch_name}]\x1B[0m"
+        end
+
+        # Returns branch name in consistent, uniform manner.
+        # @return String
+        def self.format_command(command_name)
+            "\x1B[38;5;220m#{command_name}\x1B[0m"
+        end
+
+        # Returns directory name in consistent, uniform manner.
+        # @return String
+        def self.format_directory(directory_name)
+            "\x1B[38;5;48m#{directory_name}\x1B[0m"
+        end
+
+        # Returns branch name in consistent, uniform manner.
+        # @return String
+        def self.format_flag(flag_letter)
+            "\x1B[38;5;117m-#{flag_letter} flag\x1B[0m"
+        end
+
+        # Returns branch name in consistent, uniform manner.
+        # @return String
+        def self.format_invalid(invalid_string)
+            "\x1B[38;5;9m#{invalid_string}\x1B[0m"
+        end
+
+        # Generates 'filler' string.
+        # @return String
+        def self.fill(length = 0, string = ' ')
+            fill_string = ''
+            (0..length - 1).each {
+                fill_string = "#{fill_string}#{string}"
+            }
+            fill_string
+        end
+
+        # Gives a prompt where 'y/Y' will return TRUE, 'n/N' will return false, and ANY other key will do nothing.
+        # @return void
+        def self.prompt_yes_no(title = nil, message = nil, confirmation_message = nil, preceding_blank_line = true)
+            if title.nil?
+                title = 'Please confirm YES or NO.'
+            end
+            if confirmation_message.nil?
+                confirmation_message = 'Would you like to continue?';
+            end
+            if preceding_blank_line
+                puts
+            end
+            puts "  \x1B[48;5;56m CONFIRM \x1B[0m \xe2\x86\x92 #{title}"
+            puts
+            unless message.nil?
+                if message.is_a?(Array)
+                    messages = message
+                else
+                    messages = message.split("\n")
+                end
+                table(:border => false) do
+                    messages.each do |line|
+                        row do
+                            column('', :align => 'left', :width => 4)
+                            column("\x1B[38;5;240m#{line}\x1B[0m", :align => 'left', :width => 180)
+                        end
+                    end
+                end
+                puts
+            end
+            response = ''
+            until %w[y Y n N x X a A].include? response
+                response = ask("     \x1B[38;5;89m#{confirmation_message} \x1B[0m[y/n]\x1B[90m => \x1B[0m")
+            end
+            case response.downcase
+                when 'y'
+                    puts "\n"
+                    return true
+                when 'n'
+                    puts "\n"
+                    return false
+                when 'a'
+                    Brightpearl::Terminal::error('Abandon ship!', ["You have chosen to \x1B[38;5;9mABORT\x1B[38;5;240m the script.", nil, 'Please note that whenever you do this, any scripted tasks which were running', 'will have been interrupted mid-script. This may (or may not) cause problems.'], true)
+                when 'x'
+                    Brightpearl::Terminal::error('Abandon ship!', ["You have chosen to \x1B[38;5;9mABORT\x1B[38;5;240m the script.", nil, 'Please note that whenever you do this, any scripted tasks which were running', 'will have been interrupted mid-script. This may (or may not) cause problems.'], true)
+                else
+            end
+        end
+
+        # Used to display what is about to happen. Prompts for ENTER key before continuing.
+        # @return void
+        def self.prompt_enter(text)
+            puts
+            if text.is_a?(Array)
+                text.each do |line|
+                    puts line
+                end
+            else
+                puts text
+            end
+            enter_to_continue
+        end
+
+        # Used to confirm what is about to happen. Prompts for [y/n] key before continuing.
+        # @return void
+        def self.prompt_yes(text)
+            puts
+            if text.is_a?(Array)
+                text.each do |line|
+                    puts line
+                end
+            else
+                puts text
+            end
+            yes_to_continue
+        end
+
+        # Shows a prompt waiting for user input.
+        # @return string
+        def self.prompt_for_input(text)
+            response = Readline.readline(text, true)
+            exit if %w(quit exit q x).include?(response)
+            response
+        end
+
+        # Gives a prompt where ANY KEY will continue executing the script.
+        # @return void
+        # @deprecated
+        def self.any_key_to_continue(text = "\n\x1B[90mPress any key to continue\x1B[0m => ")
+            STDOUT.flush
+            print "#{text}"
+            STDIN.gets
+            nil
+        end
+
+        # Gives a prompt where ONLY 'Enter' will continue the script, any other key will abort.
+        # @return void
+        # @deprecated
+        def self.enter_to_continue
+            print "\n\x1B[90mPress \x1B[32mENTER\x1B[90m to continue, any other key to abort\x1B[0m => "
+            begin
+                system('stty raw -echo')
+                response = STDIN.getc
+            ensure
+                system('stty -raw echo')
+            end
+            if response.chr == "\r"
+                puts "\n\n"
+            else
+                abort("\nScript aborted.\n\n")
+            end
+        end
+
+        # Gives a prompt where ONLY 'Y' or 'y' will continue the script, any other key will abort.
+        # @return void
+        # @deprecated
+        def self.yes_to_continue
+            puts "\n"
+            response = ''
+            until %w[y n].include? response
+                response = ask("\x1B[90mWould you like to continue? \x1B[0m[y/n]\x1B[90m => \x1B[0m") { |q| q.limit = 1; q.case = :downcase }
+            end
+            case response
+                when 'y'
+                    puts
+                    return
+                else
+                    puts
+                    output('Aborting script', MSG_ERROR)
+                    puts
+                    exit
+            end
+        end
+
+    end
+
+end

data/lib/core/tools.rb

@@ -0,0 +1,78 @@
+require 'open-uri'
+
+module Brightpearl
+
+    class Tools
+
+        REPORT_WIDTH = 188
+
+        # Check for internet access. Dies if not connected.
+        # @return boolean|void
+        def self.verify_internet_access
+            begin
+                return true if open('http://www.google.com')
+            rescue
+                abort('No internet connection. You must be online to run this command.')
+            end
+        end
+
+        # Returns time ago in human readable format.
+        # @string
+        def self.time_passed_since(time_stamp)
+            unless time_stamp.is_a?(DateTime)
+                raise RuntimeError, "Expected DateTime, got: #{time_stamp.class}"
+            end
+            seconds_ago = seconds_since(time_stamp.strftime('%Y-%m-%dT%H:%M:%S%z'))
+            seconds_ago = seconds_ago.to_i
+            case seconds_ago
+                when 1..119
+                    return 'A minute ago'
+                when 120..2999
+                    return "#{(seconds_ago / 60).round} minutes ago"
+                when 3000..5399
+                    return 'About an hour ago'
+                when 5399..86399
+                    return "#{((seconds_ago / 60) / 60).round} hours ago"
+                when 86400..169999
+                    return 'A day ago'
+                when 170000..2505599
+                    return "#{(((seconds_ago / 24) / 60) / 60).round} days ago"
+                when 2506000..4000000
+                    return 'A month ago'
+                when 4000001..31535999
+                    return "#{((((seconds_ago / 30.4368) / 24) / 60) / 60).round} months ago"
+                when 31536000..47303999
+                    return 'A year ago'
+                when 47304000..9999999999999
+                    return "#{((((seconds_ago / 365) / 24) / 60) / 60).round} years ago"
+                else
+                    return "Out of range (#{seconds_ago})"
+            end
+        end
+
+        # Returns the number of seconds that have elapsed between a timestamp (0000-00-00T00:00:00+00:00) and now
+        # @return integer
+        def self.seconds_since(time_stamp)
+            time_stamp = DateTime.strptime(time_stamp, '%Y-%m-%dT%H:%M:%S%z')
+            time_now = DateTime.now
+            ((time_now - time_stamp) * 24 * 60 * 60).to_i
+        end
+
+        # Used to make sure all reports are the same width (for consistency).
+        # @return void
+        def self.validate_report_width(array)
+            unless array.is_a?(Array)
+                raise RuntimeError, "Expected Array, got: #{array.class}"
+            end
+            report_width = 0
+            array.each do |pixels|
+                report_width = report_width + pixels.to_i
+            end
+            unless report_width == REPORT_WIDTH
+                raise RuntimeError, "Report needs to be #{REPORT_WIDTH} pixels wide, calculated #{report_width} pixels."
+            end
+        end
+
+    end
+
+end

data/lib/core/validate.rb

@@ -0,0 +1,7 @@
+module Brightpearl
+
+    class Validate
+
+    end
+
+end

data/lib/routes/build.rb

@@ -0,0 +1,83 @@
+module BrightpearlCommand
+
+    class Build < ::Convoy::ActionCommand::Base
+
+        def execute
+
+            @opts = command_options
+            @args = arguments
+            @service_dir = nil
+            opts_validate
+            opts_routing
+
+        end
+
+        def opts_validate
+
+            if @args[0].nil?
+                Brightpearl::Terminal::error('Must specify service name', "The script cannot build your service because you haven't told it what service to build.", true)
+            end
+
+            service_dir = Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_PATH_TO_BP_CODE)
+            dir_dev_support = "#{service_dir}/services/dev-support/#{@args[0]}/#{@args[0]}-service"
+            dir_functional = "#{service_dir}/services/functional/#{@args[0]}/#{@args[0]}-service"
+            dir_infrastructure = "#{service_dir}/services/infrastructure/#{@args[0]}/#{@args[0]}-service"
+            dir_integration = "#{service_dir}/services/integration/#{@args[0]}/#{@args[0]}-service"
+            dir_lib = "#{service_dir}/services/lib/#{@args[0]}"
+
+            if File.directory?(dir_dev_support)
+                @service_dir = dir_dev_support
+            end
+            if File.directory?(dir_functional)
+                @service_dir = dir_functional
+            end
+            if File.directory?(dir_infrastructure)
+                @service_dir = dir_infrastructure
+            end
+            if File.directory?(dir_integration)
+                @service_dir = dir_integration
+            end
+            if File.directory?(dir_lib)
+                @service_dir = dir_lib
+            end
+            if @service_dir.nil?
+                Brightpearl::Terminal::error('Cannot find service', "The script is unable to find a service called: \x1B[38;5;202m#{@args[0].downcase.capitalize}\x1B[0m\nPlease check your spelling and try again.")
+            end
+
+        end
+
+        def opts_routing
+
+            build_service
+
+        end
+
+        def build_service
+
+            commands = [
+                # 'git status'
+                'mvn clean install | grep "Building war"',
+            # 'mvn deploy'
+            ]
+            output = Brightpearl::Terminal::command_capture(commands, @service_dir)
+
+            puts output
+
+            war_file = output[0].split('war: ')
+            war_file = war_file[1].chomp
+
+            puts war_file
+
+            if Brightpearl::Config.param(Brightpearl::Config::WORKSTATION_OS) == Brightpearl::Config::MAC
+                commands = [
+                    "scp #{war_file} #{Brightpearl::Config.param(Brightpearl::Config::VM_USER)}@#{Brightpearl::Config.param(Brightpearl::Config::VM_IP)}:/tmp"
+                ]
+                puts commands
+                Brightpearl::Terminal::command(commands)
+            end
+
+        end
+
+    end
+
+end