satorix-rails 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3949871c7a24df013f4f59c91eea2e07cc1d954c42535116b3a1c4dc6832b546
-  data.tar.gz: 6b6ea3f3229e0d5379a0781be75ca3c8215a83e5109758d512cbdb744f556c67
+  metadata.gz: 435a13aeb52a37926e1c05131e9ade2acef2a753076fd973cdcec8fc42a1dbbc
+  data.tar.gz: 5809274213b07e1bcdc4f573efabd0f2f0c3d67105f6f25e5eff09f6e80c077b
 SHA512:
-  metadata.gz: 416449f6f8f67cdee5340d9c04cff43b584a698eee6fcdacc6c3e68409d747df89bb56adbc854cef88eada785319dc38c344b0c45b958d0add3695bcb9801fd9
-  data.tar.gz: 7f23d2e504afd46918a4a6063085626a60af6a020e0a21634dafd51b32b8941d6f4d7d96a21c31e8f8cef6ad7c5fb1012bdd789d7072d556eb151955c3510235
+  metadata.gz: cc01af9987e38d189dee15d4b4d5ee89c9ef0a443beed6f23d6b2a869b381273563355dd378754615ad784f30c3574cb7e8c4b04dcd7739a3918388fb77577fd
+  data.tar.gz: 46fa05b77b27a9e5c8892aa23c8d87f052adcac05004886966d769c05c35a6152280e0b766056318c11a89ce23cdd98fd411c9e19592d5b9b3dd60d83322b804

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    satorix-rails (1.2.2)
+    satorix-rails (1.3.0)
       passenger
 
 GEM

data/lib/rails/generators/templates/custom_ci_job/satorix/CI/deploy/mock_deploy.rb

@@ -3,10 +3,8 @@ module Satorix
     module Deploy
       module MockDeploy
 
-
         include Satorix::Shared::Console
 
-
         extend self
 
 
@@ -17,19 +15,18 @@ module Satorix
         end
 
 
-        private ########################################################################################################
+        private
 
 
-        def turbines_to_speed
-          batnap
-          puts 'Roger. Ready to move out.'
-        end
+          def turbines_to_speed
+            batnap
+            puts 'Roger. Ready to move out.'
+          end
 
 
-        def batnap
-          sleep(rand(6))
-        end
-
+          def batnap
+            sleep(rand(6))
+          end
 
       end
     end

data/lib/rails/generators/templates/custom_ci_job/satorix/CI/test/bare_bones.rb

@@ -5,21 +5,16 @@ module Satorix
       # This is the simplest possible implementation of a custom job.
       module BareBones
 
-
         extend self
 
         # go() is the method that will be called during the CI run.
         # You can add your own logic to do whatever you want.
         def go
-          # Uncomment the line below if you want to execute in the context of the app's buildpack.
-          # Satorix::CI::Test::Shared::BuildpackManager.go
           puts "\n\nRunning BareBones#go..."
         end
 
-
       end
 
-
     end
   end
 end

data/lib/rails/generators/templates/custom_ci_job/satorix/CI/test/info.rb

@@ -3,17 +3,13 @@ module Satorix
     module Test
       module Info
 
-
         include Satorix::Shared::Console
 
-
         extend self
 
         # go() is the method that will be called during the CI run.
         # You can add your own logic to do whatever you want.
         def go
-          # Uncomment the line below if you want to execute in the context of the app's buildpack.
-          # Satorix::CI::Test::Shared::BuildpackManager.go
 
           log_bench('Describing logging...') do
             describe_log
@@ -22,7 +18,7 @@ module Satorix
           end
 
           log_bench('Describing console commands...') do
-            describe_run_command_string
+            describe_unsafe_run_command_string
             describe_run_command_array
             describe_run_command_filtered
             describe_run_command_quiet
@@ -33,62 +29,67 @@ module Satorix
         end
 
 
-        private ########################################################################################################
+        private
 
 
-        def describe_environment_variables
-          puts "Remember, #{ ENV['GITLAB_USER_EMAIL'] }, that you have access to all of the environment variables ",
-               ' described at https://docs.gitlab.com/ce/ci/variables/#predefined-variables-environment-variables'
-        end
+          def describe_environment_variables
+            puts "Remember, #{ ENV['GITLAB_USER_EMAIL'] }, that you have access to all of the environment variables ",
+                 ' described at https://docs.gitlab.com/ce/ci/variables/#predefined-variables-environment-variables'
+          end
 
 
-        def describe_log
-          log 'The log() method writes a message to the log'
-          colors.keys.each { |color| log "You can provide an optional color, like :#{ color }", color }
-        end
+          def describe_log
+            log 'The log() method writes a message to the log'
+            colors.keys.each { |color| log "You can provide an optional color, like :#{ color }", color }
+          end
 
 
-        def describe_log_error
-          log_error 'The log_error() method writes an error to the log'
-        end
+          def describe_log_error
+            log_error 'The log_error() method writes an error to the log'
+          end
 
 
-        def describe_log_error_and_abort
-          log_error 'The log_error_and_abort() method writes an error to the log and aborts the job'
-        rescue SystemExit => e
-          puts 'Rescuing from the error, to continue the tutorial.',
-               e.inspect
-        end
+          def describe_log_error_and_abort
+            log_error 'The log_error_and_abort() method writes an error to the log and aborts the job'
+          rescue SystemExit => e
+            puts 'Rescuing from the error, to continue the tutorial.',
+                 e.inspect
+          end
 
 
-        def describe_run_command_string
-          run_command "echo 'We can safely run string console commands with the run_command() method'"
-        end
-
+          def describe_unsafe_run_command_string
+            # It is possible to use a string command that is assumed to be already escaped and will not be escaped further.
+            # See below for safer alternate options.
+            # Please see the run_command documentation in the satorix gem for more information and examples.
+            run_command "echo 'We can run string console commands that have already been properly escaped with the run_command() method and the `string_verified_safe: true` option. This is best avoided!'",
+                        string_verified_safe: true
+          end
 
-        def describe_run_command_array
-          run_command ['echo', "'We can safely run array console commands with the run_command() method'"]
-        end
 
+          def describe_run_command_array
+            # It is preferred to use an array command, especially for anything containing dynamic input. Escaping will be taken care of for you.
+            # Please see the run_command documentation in the satorix gem for more information and examples.
+            run_command ['echo', 'We can safely run unescaped array console commands with the run_command() method. This is ideal!']
+          end
 
-        def describe_run_command_quiet
-          run_command "echo 'This will not be displayed'", quiet: true
-        end
 
+          def describe_run_command_quiet
+            run_command ['echo', 'This will not be displayed (but will return the output).'], quiet: true
+          end
 
-        def describe_run_command_filtered
-          run_command "echo 'You can filter secrets, like 1234 and 5678 (unless you explicitly display them)'", filtered_text: %w(1234 5678)
-        end
 
+          def describe_run_command_filtered
+            run_command ['echo', 'You can filter sensitive text from the logs, like 1234 and 5678 (the original output will be returned).'], filtered_text: %w(1234 5678)
+          end
 
-        def describe_run_command_with_error
-          run_command 'false'
-        rescue SystemExit
-          puts 'Commands that exit with a non-zero return code abort operation, unless rescued.',
-               'Rescuing from the error, to continue the tutorial.',
-               e.inspect
-        end
 
+          def describe_run_command_with_error
+            run_command %w[false]
+          rescue SystemExit
+            puts 'Commands that exit with a non-zero return code abort operation, unless rescued.',
+                 'Rescuing from the error, to continue the tutorial.',
+                 e.inspect
+          end
 
       end
     end

data/lib/satorix/rails/version.rb

@@ -1,7 +1,7 @@
 module Satorix
   module Rails
     module Version
-      VERSION = '1.2.2'
+      VERSION = '1.3.0'
     end
   end
 end

data/satorix/CI/deploy/rubygems.rb

@@ -3,13 +3,10 @@ module Satorix
     module Deploy
       module Rubygems
 
-
         require 'fileutils'
 
-
         include Satorix::Shared::Console
 
-
         extend self
 
 
@@ -21,113 +18,111 @@ module Satorix
         end
 
 
-        private ########################################################################################################
+        private
 
 
-        def build_gem
-          Dir.chdir(Satorix.app_dir) do
-            run_command 'bundle exec rake build'
+          def build_gem
+            Dir.chdir(Satorix.app_dir) do
+              run_command(%w[bundle exec rake build])
+            end
           end
-        end
 
 
-        def built_gems
-          Dir.glob(File.join(gem_build_directory, '*.gem')).select { |e| File.file? e }
-        end
-
-
-        def gem_build_directory
-          File.join Satorix.app_dir, 'pkg'
-        end
+          def built_gems
+            Dir.glob(File.join(gem_build_directory, '*.gem')).select { |e| File.file? e }
+          end
 
 
-        def generate_rubygems_configuration_file
-          path = File.join(Dir.home, '.gem')
-          FileUtils.mkdir_p(path) unless File.exist?(path)
+          def gem_build_directory
+            File.join Satorix.app_dir, 'pkg'
+          end
 
-          file = File.join(path, 'credentials')
-          File.open(file, 'w') { |f| f.write rubygems_configuration_file_contents }
-          FileUtils.chmod 0600, file
-        end
 
+          def generate_rubygems_configuration_file
+            path = File.join(Dir.home, '.gem')
+            FileUtils.mkdir_p(path) unless File.exist?(path)
 
-        def prepare_gem_build_directory
-          run_command "rm -rf #{ gem_build_directory }"
-          FileUtils.mkdir_p gem_build_directory
-        end
+            file = File.join(path, 'credentials')
+            File.open(file, 'w') { |f| f.write rubygems_configuration_file_contents }
+            FileUtils.chmod 0600, file
+          end
 
 
-        def publish_gem(gem)
-          run_command "gem push #{ gem } --config-file #{ File.join(Dir.home, '.gem', 'credentials') }"
-        rescue RuntimeError
-          # To prevent the display of an ugly stacktrace.
-          abort "\nGem was not published!"
-        end
+          def prepare_gem_build_directory
+            run_command(['rm', '-rf', gem_build_directory])
+            FileUtils.mkdir_p gem_build_directory
+          end
 
 
-        def rubygems_api_key
-          ENV['SATORIX_CI_RUBYGEMS_API_KEY']
-        end
+          def publish_gem(gem)
+            run_command ['gem', 'push', gem, '--config-file', File.join(Dir.home, '.gem', 'credentials')]
+          rescue RuntimeError
+            # To prevent the display of an ugly stacktrace.
+            abort "\nGem was not published!"
+          end
 
 
-        def rubygems_configuration_file_contents
-          "---\n:rubygems_api_key: #{ rubygems_api_key }"
-        end
+          def rubygems_api_key
+            ENV['SATORIX_CI_RUBYGEMS_API_KEY']
+          end
 
 
-        # To be used for rake release - START
+          def rubygems_configuration_file_contents
+            "---\n:rubygems_api_key: #{ rubygems_api_key }"
+          end
 
 
-        def configure_git
-          run_command 'git config user.name Satorix'
-          run_command 'git config user.email satorix@iexposure.com'
-          run_command 'git config push.default simple'
-        end
+          # To be used for rake release - START
 
+          def configure_git
+            run_command(%w[git config user.name Satorix])
+            run_command(%w[git config user.email satorix@iexposure.com])
+            run_command(%w[git config push.default simple])
+          end
 
-        def configure_ssh
-          run_command 'whoami'
-          run_command 'printenv'
 
-          path = File.join(Dir.home, '.ssh')
-          FileUtils.mkdir_p(path) unless File.exist?(path)
+          def configure_ssh
+            run_command(%w[whoami])
+            run_command(%w[printenv])
 
-          public_key_file = File.join(path, 'id_rsa.pub')
-          File.open(public_key_file, 'w') { |f| f.write ssh_public_key }
-          FileUtils.chmod 0600, public_key_file
-          run_command "cat #{ public_key_file }"
+            path = File.join(Dir.home, '.ssh')
+            FileUtils.mkdir_p(path) unless File.exist?(path)
 
-          private_key_file = File.join(path, 'id_rsa')
-          File.open(private_key_file, 'w') { |f| f.write ssh_private_key }
-          FileUtils.chmod 0600, private_key_file
+            public_key_file = File.join(path, 'id_rsa.pub')
+            File.open(public_key_file, 'w') { |f| f.write ssh_public_key }
+            FileUtils.chmod 0600, public_key_file
+            run_command(['cat', public_key_file])
 
-          config_file = File.join(path, 'config')
-          File.open(config_file, 'w') { |f| f.write "IdentityFile #{ private_key_file }" }
-          FileUtils.chmod 0600, config_file
-          run_command "cat #{ config_file }"
+            private_key_file = File.join(path, 'id_rsa')
+            File.open(private_key_file, 'w') { |f| f.write ssh_private_key }
+            FileUtils.chmod 0600, private_key_file
 
-          system 'eval `ssh-agent -s`'
-          run_command "ssh-add #{ private_key_file }"
-        end
+            config_file = File.join(path, 'config')
+            File.open(config_file, 'w') { |f| f.write "IdentityFile #{ private_key_file }" }
+            FileUtils.chmod 0600, config_file
+            run_command(['cat', config_file])
 
+            system 'eval `ssh-agent -s`'
+            run_command(['ssh-add', private_key_file])
+          end
 
-        def rake_release
-          run_command 'bundle exec rake release'
-        end
 
+          def rake_release
+            run_command(%w[bundle exec rake release])
+          end
 
-        def ssh_private_key
-          ENV['SATORIX_CI_SSH_PRIVATE_KEY']
-        end
 
+          def ssh_private_key
+            ENV['SATORIX_CI_SSH_PRIVATE_KEY']
+          end
 
-        def ssh_public_key
-          ENV['SATORIX_CI_SSH_PUBLIC_KEY']
-        end
 
+          def ssh_public_key
+            ENV['SATORIX_CI_SSH_PUBLIC_KEY']
+          end
 
-        # To be used for rake release - END
 
+          # To be used for rake release - END
 
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: satorix-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Satorix
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: passenger