blufin 0.1.0

data/lib/core/site/site_embedded.rb

@@ -0,0 +1,27 @@
+module Blufin
+
+    class SiteEmbedded
+
+        @@embedded_data = nil
+
+        # Only needs to be initialized once.
+        # @return void
+        def self.init(embedded_data)
+
+            return unless @@embedded_data.nil?
+
+            raise RuntimeError, "Expected Hash, instead got: #{embedded_data.class}" unless embedded_data.is_a?(Hash)
+
+            @@embedded_data = embedded_data
+
+        end
+
+        # Gets the Data Hash
+        # @return Hash
+        def self.get_data
+            @@embedded_data
+        end
+
+    end
+
+end

data/lib/core/site/site_ports.rb

@@ -0,0 +1,9 @@
+module Blufin
+
+    class SitePorts
+
+        attr_accessor :api, :api_admin, :cron, :cron_admin, :worker, :worker_admin, :port_range_raw, :port_numbers_used
+
+    end
+
+end

data/lib/core/site/site_resolver.rb

@@ -0,0 +1,276 @@
+module Blufin
+
+    class SiteResolver
+
+        SITE = 'site'
+        SITE_NAME = 'name'
+        SITE_TITLE = 'title'
+        SITE_ALIAS = 'alias'
+        SITE_PORTS = 'ports'
+
+        PORT_RANGE_CRITERIA_ARRAY = ["\xe2\x80\x94 Consist of two 4-digit numbers separated by a '-' hyphen", "\xe2\x80\x94 Have a numerical difference of exactly 19.", "\xe2\x80\x94 The first number in the set must be divisible by 10.", nil, "An example of a valid #{Blufin::Terminal::format_highlight('port-range')} would be \xe2\x86\x92 #{Blufin::Terminal::format_action('6000-6019')}"]
+
+        @sitemap = nil
+        @site_valid = {}
+
+        # Gets the PATH to the site repository.
+        # @return String
+        def self.get_site_location(site)
+            validate_site(site)
+            get_sitemap[site][:site_location]
+        end
+
+        # Gets the site domain.
+        # @return String
+        def self.get_site_domain(site)
+            validate_site(site)
+            get_sitemap[site][:site_domain]
+        end
+
+        # Gets the (repository) name of the site.
+        # @return String
+        def self.get_site_name(site)
+            validate_site(site)
+            get_sitemap[site][:site_name]
+        end
+
+        # Gets the (repository) name of the site in camel-cased version.
+        # @return String
+        def self.get_site_name_camel_cased(site)
+            validate_site(site)
+            get_sitemap[site][:site_name_camel_cased]
+        end
+
+        # Gets the full name of the site.
+        # @return String
+        def self.get_site_title(site)
+            validate_site(site)
+            get_sitemap[site][:site_title]
+        end
+
+        # Gets an object containing all the site ports.
+        # @return Blufin::SitePorts
+        def self.get_site_ports(site)
+            validate_site(site)
+            get_sitemap[site][:site_ports]
+        end
+
+        # Checks if the site exists and takes 'aliases' into account.
+        # Throws ERROR if site doesn'ts exist.
+        # @return String
+        def self.validate_site(site, location = true)
+            if @site_valid[site].nil?
+                sitemap = get_sitemap
+                if !sitemap.keys.include?(site) || site.nil?
+                    Blufin::Terminal::error("An API by the name \"#{Blufin::Terminal::format_highlight(site.nil? ? '[nil]' : site)}\" cannot be found \xe2\x80\x94 available APIs are:", get_available_apis, true)
+                else
+                    validate_location(get_sitemap[site][:site_location]) if location
+                    validate_ports_internal(get_sitemap[site][:site_ports].port_range_raw)
+                    @site_valid[site] = true
+                    site
+                end
+            else
+                site
+            end
+        end
+
+        # Get an array of available APIs (for use in Blufin::Terminal messages).
+        # @return Array
+        def self.get_available_apis
+            apis_names = []
+            apis_output = []
+            apis = Blufin::Projects::get_apis
+            apis.each { |api| apis_names << api[1][Blufin::Projects::PROJECT_NAME] }
+            api_max_text = apis_names.max_by(&:length).length
+            apis.each do |api|
+                api = api[1]
+                apis_output << "\x1B[38;5;154m#{api[Blufin::Projects::PROJECT_NAME].rjust(api_max_text, ' ')}\x1B[0m\x1B[38;5;240m \xe2\x86\x92 #{get_path_sites}/#{api[Blufin::Projects::PROJECT_NAME]} \x1B[38;5;67m[#{api[Blufin::Projects::PORT_RANGE]}] \x1B[38;5;154m#{api[Blufin::Projects::ALIAS]}"
+            end
+            apis_output
+        end
+
+        # Get an Array of Hashes used for validation, listing purposes.
+        # @return Array (of Hash)
+        def self.get_site_details_for_validation
+            validation_details = {
+                :existing_locations => [],
+                :existing_titles => [],
+                :existing_aliases => [],
+                :existing_names => [],
+                :existing_ports => []
+            }
+            get_sitemap(false).each do |key, site|
+                nil if key
+                validation_details[:existing_locations] << site[:site_location].to_s
+                validation_details[:existing_titles] << site[:site_title]
+                validation_details[:existing_aliases] << site[:site_alias]
+                validation_details[:existing_names] << site[:site_name]
+                validation_details[:existing_names_camel_cased] << site[:site_name_camel_cased]
+                validation_details[:existing_ports] << site[:site_ports].port_range_raw
+            end
+            validation_details[:existing_locations].uniq!
+            validation_details[:existing_titles].uniq!
+            validation_details[:existing_aliases].uniq!
+            validation_details[:existing_names].uniq!
+            validation_details[:existing_ports].uniq!
+            validation_details
+        end
+
+        # Validates ports. Needs to be in form of -> 6000-6019
+        # @return boolean
+        def self.validate_ports(site_ports)
+            return false unless site_ports.is_a?(String) && site_ports.include?('-')
+            valid = true
+            site_ports_split = site_ports.split('-')
+            if site_ports_split.length == 2
+                site_ports_split.each { |site_port| valid = false unless site_port =~ /\d{4}/ }
+                valid = false unless site_ports_split[1].to_i - site_ports_split[0].to_i == 19
+                valid = false unless site_ports_split[0].to_i % 10 == 0
+            else
+                valid = false
+            end
+            valid
+        end
+
+        # Invalidates the sitemap so data will have to be re-retrieved.
+        # @return void
+        def self.invalidate_sitemap
+            @sitemap = nil
+        end
+
+        private
+
+        # Generates the sitemap (only once during each script-run).
+        # If 'with_aliases' == TRUE, returns aliases as keys with identical data to original site-name.
+        # @return void
+        def self.get_sitemap(with_aliases = true)
+            if @sitemap.nil?
+                @sitemap = {}
+                Blufin::Projects::get_apis.each do |project|
+                    project = project[1]
+                    sl = "#{get_path_sites}/#{project[Blufin::Projects::PROJECT_NAME]}"
+                    @sitemap[project[Blufin::Projects::PROJECT_NAME]] = {
+                        :site_location => sl,
+                        :site_title => project[Blufin::Projects::TITLE],
+                        :site_alias => project[Blufin::Projects::ALIAS],
+                        :site_name => project[Blufin::Projects::PROJECT_NAME],
+                        :site_name_camel_cased => project[Blufin::Projects::PROJECT_NAME_PASCAL_CASE],
+                        :site_domain => project[Blufin::Projects::DOMAIN],
+                        :site_ports => convert_site_ports_to_object(project[Blufin::Projects::PORT_RANGE])
+                    }
+                    @sitemap[project[Blufin::Projects::ALIAS]] = @sitemap[project[Blufin::Projects::PROJECT_NAME]] if with_aliases
+                end
+            end
+            @sitemap
+        end
+
+        # Converts 6000-6019 to a Blufin::SitePorts object.
+        # @return Blufin::SitePorts
+        def self.convert_site_ports_to_object(site_ports)
+            raise RuntimeError, "Expected a String (port-range), instead got:#{site_ports.class}" unless site_ports.is_a?(String)
+            site_ports_split = site_ports.split('-')
+            base_port = site_ports_split[0].to_i
+            spo = Blufin::SitePorts.new
+            spo.port_range_raw = site_ports
+            spo.port_numbers_used = (site_ports_split[0]..site_ports_split[1]).to_a
+            spo.api = base_port + 0
+            spo.cron = base_port + 1
+            spo.worker = base_port + 3
+            spo.api_admin = base_port + 10
+            spo.cron_admin = base_port + 11
+            spo.worker_admin = base_port + 13
+            spo
+        end
+
+        # Checks that the site repo path exists.
+        # @return void
+        def self.validate_location(site_location)
+            unless Blufin::Files::path_exists(File.expand_path(site_location))
+                Blufin::Terminal::error("Location not found: #{Blufin::Terminal::format_directory(site_location)}", "Please check the #{Blufin::Terminal::format_highlight('path_sites')} value defined in your configuration file \xe2\x86\x92 #{Blufin::Terminal::format_command("#{App::GEM_NAME} x")}")
+            end
+        end
+
+        # Checks that the ports have a range of 20 and start on a number divisible by 10.
+        # @return void
+        def self.validate_ports_internal(site_ports)
+            raise RuntimeError, "Expected a String (port-range), instead got:#{site_ports.class}" unless site_ports.is_a?(String)
+            unless validate_ports(site_ports)
+                Blufin::Terminal::error("#{Blufin::Terminal::format_highlight('Port-range')} is in wrong format: #{Blufin::Terminal::format_invalid(site_ports)}. A valid #{Blufin::Terminal::format_highlight('port-range')} must meet the following criteria:", PORT_RANGE_CRITERIA_ARRAY, true)
+            end
+        end
+
+        # Returns the path to Java Api from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-api
+        # @return String
+        def self.path_to_java_api(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::API}"
+        end
+
+        # Returns the path to Java Cron from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-cron
+        # @return String
+        def self.path_to_java_cron(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::CRON}"
+        end
+
+        # Returns the path to Java Lib from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-lib
+        # @return String
+        def self.path_to_java_lib(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::LIB}"
+        end
+
+        # Returns the path to Java SDK from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-sdk
+        # @return String
+        def self.path_to_java_sdk(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::SDK}"
+        end
+
+        # Returns the path to Java SDK from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-sdk/<site-name>-sdk-core
+        # @return String
+        def self.path_to_java_sdk_core(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::SDK}/#{get_site_name(site)}-#{Blufin::SiteServices::SDK}-core"
+        end
+
+        # Returns the path to Java SDK from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-sdk/<site-name>-sdk-internal
+        # @return String
+        def self.path_to_java_sdk_internal(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::SDK}/#{get_site_name(site)}-#{Blufin::SiteServices::SDK}-internal"
+        end
+
+        # Returns the path to Java SDK from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-sdk/<site-name>-sdk-oauth
+        # @return String
+        def self.path_to_java_sdk_oauth(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::SDK}/#{get_site_name(site)}-#{Blufin::SiteServices::SDK}-oauth"
+        end
+
+        # Returns the path to Java Worker from root -> IE: /Users/<your-name>/.../app-infrastructure/<site-name>-worker
+        # @return String
+        def self.path_to_java_worker(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_APP_INFRASTRUCTURE}/#{get_site_name(site)}-#{Blufin::SiteServices::WORKER}"
+        end
+
+        # Returns the path to the Blufin Java library from root -> IE: /Users/<your-name>/.../blufin-java
+        # @return String
+        def self.path_to_blufin_java
+            File.expand_path(Blufin::Config::get_path('Paths', 'BlufinJava'))
+        end
+
+        # Returns the path to SQL files from root -> IE: /Users/<your-name>/.../sql/
+        # @return String
+        def self.path_to_sql(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_TO_SQL}"
+        end
+
+        # Returns the path to YML files from root -> IE: /Users/<your-name>/.../yml/
+        # @return String
+        def self.path_to_yml(site)
+            "#{get_site_location(site)}/#{Blufin::Site::PATH_TO_YML}"
+        end
+
+        # Gets path to sites.
+        # @return String
+        def self.get_path_sites
+            Blufin::Config::get_path('Paths', 'Sites')
+        end
+
+    end
+
+end

data/lib/core/site/site_services.rb

@@ -0,0 +1,162 @@
+module Blufin
+
+    class SiteServices
+
+        API          = 'api'
+        CRON         = 'cron'
+        LIB          = 'lib'
+        SDK          = 'sdk'
+        SDK_CORE     = 'sdk-core'
+        SDK_INTERNAL = 'sdk-internal'
+        SDK_OAUTH    = 'sdk-oauth'
+        WORKER       = 'worker'
+
+        PACKAGE_SYSTEM_ENUMS   = 'org.blufin.base.enums'
+        PACKAGE_AUTO_GENERATED = 'system'
+
+        ANNOTATION_TEST_REQUIRED             = '@TestRequired'
+        ANNOTATION_TEST_NOT_REQUIRED         = '@TestNotRequired'
+        ANNOTATION_TEST_NOT_RELATED_TO_CLASS = '@TestNotRelatedToClass'
+
+        REGEX_SERVICES             = "#{Blufin::SiteServices::API}|#{Blufin::SiteServices::CRON}|#{Blufin::SiteServices::WORKER}"
+        REGEX_SERVICES_CAPITALIZED = "#{Blufin::SiteServices::API.capitalize}|#{Blufin::SiteServices::CRON.capitalize}|#{Blufin::SiteServices::WORKER.capitalize}"
+        REGEX_JAVA                 = "#{REGEX_SERVICES}|#{Blufin::SiteServices::LIB}|#{Blufin::SiteServices::SDK}-core|#{Blufin::SiteServices::SDK}-internal|#{Blufin::SiteServices::SDK}-core"
+
+        @@services_core = nil
+
+        # Build blufin-core-lib.
+        # @return void
+        def self.build_core_service(service, skip_tests = false)
+            validate_core_service(service)
+            result = Blufin::Terminal.command("mvn clean install#{get_skip_tests_param(skip_tests)}", "#{Blufin::SiteResolver::path_to_blufin_java}/blufin-#{service}")
+            Blufin::Terminal::error("#{Blufin::Terminal::format_highlight("blufin-#{service}")} failed to compile.") unless result[0]
+        end
+
+        # Build a service.
+        # @return void
+        def self.build_site_service(site, service, skip_tests = false)
+            Blufin::SiteResolver::validate_site(site)
+            service = validate_site_service(site, service)
+            result  = Blufin::Terminal.command("mvn clean package#{get_skip_tests_param(skip_tests)}", get_available_site_services(site)[service][0])
+            Blufin::Terminal::error("#{Blufin::Terminal::format_highlight("#{Blufin::SiteResolver::get_site_name(site)}-#{service}")} failed to compile.") unless result[0]
+        end
+
+        # Build a site lib.
+        # NOTE: Cannot use 'build_site_services' because the lib is not maven packaged.
+        # @return void
+        def self.build_site_lib(site, skip_tests = false)
+            Blufin::SiteResolver::validate_site(site)
+            result = Blufin::Terminal.command("mvn clean install#{get_skip_tests_param(skip_tests)}", "#{Blufin::SiteResolver::path_to_java_lib(site)}")
+            Blufin::Terminal::error("#{Blufin::Terminal::format_highlight("#{Blufin::SiteResolver::get_site_name(site)}-lib")} failed to compile.") unless result[0]
+        end
+
+        # Deploy a service.
+        # @return void
+        def self.deploy(site, service)
+
+            Blufin::SiteResolver::validate_site(site)
+            service = validate_site_service(site, service, true)
+
+            # TODO - Re-program this when we need it.
+            raise RuntimeError, 'Needs to be re-written to generate YML file from DB values.' if true
+
+            yml_file = nil
+
+            # If YML file not found, stop script.
+            Blufin::Terminal::error('File not found', yml_file, true) unless Blufin::Files::file_exists(yml_file)
+
+            # TODO - CURRENTLY LOOKS FOR TO 1.0.0-SNAPSHOT. THIS MUST BE DYNAMIC.
+            # TODO - CURRENTLY HAWAII TIMEZONE IS HARD-CODED. SHOULD DYNAMICALLY GRAB TIMEZONE FROM YML FILE.
+            Blufin::Terminal.command("java -Duser.timezone=\"US/Hawaii\" -Xms128M -Xmx256M -XX:+UseParallelGC -jar #{get_available_site_services(site)[service][0]}/target/#{Blufin::SiteResolver::get_site_name(site)}-#{service}-1.0.0-SNAPSHOT.jar server #{yml_file}", get_available_site_services(site)[service][0])
+
+        end
+
+        # Validate core service.
+        # @return String
+        def self.validate_core_service(service)
+            Blufin::Terminal::error("Non-existent service: #{Blufin::Terminal::format_invalid(service)} \xe2\x80\x94 available services are:", Blufin::SiteServices::get_available_services_output, true) unless get_available_core_services.include?(service)
+            service
+        end
+
+        # Validate site service.
+        # @return String
+        def self.validate_site_service(site, service, for_deploy = false)
+            Blufin::SiteResolver::validate_site(site)
+            @error_message = ['Valid services are:', nil]
+            get_available_site_services(site).keys.each do |service_inner|
+                next if for_deploy && service_inner == LIB
+                @error_message << "  \x1B[38;5;154m#{service_inner}\x1B[0m"
+            end
+            if for_deploy == true && service == LIB
+                Blufin::Terminal::error("You cannot deploy: #{Blufin::Terminal::format_highlight('lib')}", @error_message, true)
+            elsif !get_available_site_services(site).keys.include?(service)
+                Blufin::Terminal::error("You must specify a valid #{Blufin::Terminal::format_highlight('service')}.", @error_message, true)
+            end
+            service
+        end
+
+        # Returns Array of services (without the "blufin-" prefix).
+        # @return Array
+        def self.get_available_core_services
+            if @@services_core.nil?
+                @@services_core = []
+                Blufin::Files::get_dirs_in_dir(Blufin::Config::get_path('Paths', 'BlufinJava')).each do |dir|
+                    service = dir.split('/')
+                    service = service[service.length - 1].gsub('blufin-', '')
+                    @@services_core << service unless service.downcase == 'target'
+                end
+            end
+            @@services_core
+        end
+
+        # Creates clean terminal output of available services in 2 columns with colors.
+        # @return Array
+        def self.get_available_services_output(services = [], color_selected = false)
+            output      = []
+            half_first  = []
+            half_second = []
+            half        = (get_available_core_services.length / 2).to_i
+            (0..half).each { |n| half_first << get_available_core_services[n] }
+            ((half + 1)..(get_available_core_services.length - 1)).each { |n| half_second << get_available_core_services[n] }
+            hfm = half_first.max_by(&:length).length + 4
+            hsm = half_second.max_by(&:length).length+4
+            (0..[half_first.length, half_second.length].max).each do |n|
+                if color_selected
+                    left  = half_first[n].nil? ? '' : half_first[n].ljust(hfm, ' ')
+                    right = half_second[n].nil? ? '' : half_second[n].ljust(hsm, ' ')
+                    left  = services.include?(half_first[n]) ? "\x1B[38;5;154m#{left}\x1B[38;5;240m" : "\x1B[38;5;240m#{left}"
+                    right = services.include?(half_second[n]) ? "\x1B[38;5;154m#{right}\x1B[38;5;240m" : "\x1B[38;5;240m#{right}"
+                else
+                    left  = half_first[n].nil? ? '' : "\x1B[38;5;154m#{half_first[n].ljust(hfm, ' ')}\x1B[0m"
+                    right = half_second[n].nil? ? '' : "\x1B[38;5;154m#{ half_second[n].ljust(hsm, ' ')}\x1B[0m"
+                end
+                output << "#{left}#{right}"
+            end
+            output
+        end
+
+        # Returns service(s) hash for site.
+        # @return Hash
+        def self.get_available_site_services(site)
+            Blufin::SiteResolver::validate_site(site)
+            valid_sites = {
+                API    => %W(#{Blufin::SiteResolver::path_to_java_api(site)} #{Blufin::SiteResolver::path_to_blufin_java}#{Blufin::Site::PATH_TO_BLUFIN_API}),
+                CRON   => %W(#{Blufin::SiteResolver::path_to_java_cron(site)} #{Blufin::SiteResolver::path_to_blufin_java}#{Blufin::Site::PATH_TO_BLUFIN_CRON}),
+                LIB    => %W(#{Blufin::SiteResolver::path_to_java_lib(site)} #{Blufin::SiteResolver::path_to_blufin_java}#{Blufin::Site::PATH_TO_BLUFIN_CORE_LIB}),
+                SDK    => %W(#{Blufin::SiteResolver::path_to_java_sdk(site)} #{Blufin::SiteResolver::path_to_blufin_java}#{Blufin::Site::PATH_TO_BLUFIN_SDK}),
+                WORKER => %W(#{Blufin::SiteResolver::path_to_java_worker(site)} #{Blufin::SiteResolver::path_to_blufin_java}#{Blufin::Site::PATH_TO_BLUFIN_WORKER})
+            }
+            valid_sites
+        end
+
+        private
+
+        # Returns MVN skipTests string if input is TRUE, blank-string if FALSE.
+        # @return String
+        def self.get_skip_tests_param(skip_tests)
+            skip_tests ? ' -Dmaven.test.skip=true -Dfindbugs.skip=true' : ''
+        end
+
+    end
+
+end