firespring_dev_commands 2.1.26 → 2.1.27.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14012894728c84550e3d2b59fad8fda3792ed8c6a548115b3a95dd0580420cd1
-  data.tar.gz: 77315bb5bbcfc940253870fc070911f8f23aeb6536dc38f9b768b8749676f3a4
+  metadata.gz: 1f810ca7ab797bb1ec56674b67d42de056d5f88cd95a8e9c45b67d26a3570d19
+  data.tar.gz: 487bdc8a74717f11bb48b5b81a33093fde87ddb2b44d97cdf84a0372e3b93627
 SHA512:
-  metadata.gz: 576bdab4cbf3e569fef9114a1e5d413e8b9495da3b6ef546d0121e8aaa68af1e3d3232e85e5ec9c2ef1cc47e7ffb089c5badade94c5f4edce24e63c2b9cf091c
-  data.tar.gz: 4d6c01abd25e937f02c8629b10ce1380eb8a2d65ce7cf1afc86be0fd58311fb88d76d437754e4155bea3bbbe85983c482479b76356a8e99e00e5ee87e224f1f2
+  metadata.gz: 212273f4a640214bf8001c12419f33bb6dc621dc37a29b95e75d06c5b5e4bd3f7b7231c003cd032ed1be1c2dc0667d3474fb74892a7577ddd57eca248d96ab09
+  data.tar.gz: 480720fd9de858a1ce969644958e61238e866fef1126fb91909992eca3301275d04fd42df45c1f34a7c5126758172a4c89f7bfc0ea3c1b8e2528816de97dbfba

data/lib/firespring_dev_commands/certificate.rb

@@ -0,0 +1,59 @@
+module Dev
+  # Class contains methods for requesting a certificate from route53.
+  # You must have a hosted zone defined for the desired domain
+  class Certificate
+    attr_accessor :domains, :email
+
+    def initialize(domains, email)
+      @domains = Array(domains)
+      @email = email
+      raise 'No certificate domains specified' if domains.empty?
+    end
+
+    # Request the certificate using the route53 docker image
+    # Certificate is stored in /etc/letsencrypt
+    def request
+      puts
+      puts 'Getting SSL Certs For:'
+      puts domains.join("\n")
+      puts
+      puts 'This process can take up to 10 minutes'
+      puts
+      puts Time.now
+
+      # TODO: Really should use the docker api for this
+      cmd = %w(docker run -it --rm --name certbot)
+      cmd << '-e' << 'AWS_ACCESS_KEY_ID'
+      cmd << '-e' << 'AWS_SECRET_ACCESS_KEY'
+      cmd << '-e' << 'AWS_SESSION_TOKEN'
+      cmd << '-v' << '/etc/letsencrypt:/etc/letsencrypt'
+      cmd << 'certbot/dns-route53:latest'
+      cmd << 'certonly'
+      cmd << '-n'
+      cmd << '--agree-tos'
+      cmd << '--dns-route53'
+      cmd << '-d' << domains.join(',')
+      cmd << '--email' << email
+      cmd << '--server' << 'https://acme-v02.api.letsencrypt.org/directory'
+      puts cmd.join(' ')
+      Dev::Common.new.run_command(cmd)
+    end
+
+    # Saves the latest version of the certificate into the given dest_dir
+    def save(dest_dir)
+      raise "directory #{dest_dir} must be an existing directory" unless File.directory?(dest_dir)
+
+      domain = domains.first.sub(/^\*\./, '')
+      directories = Dir.glob("/etc/letsencrypt/live/#{domain}*/")
+      no_suffix = directories.delete("/etc/letsencrypt/live/#{domain}/")
+      biggest_suffix = directories.max
+      source_dir = biggest_suffix || no_suffix
+      raise "unable to determine certificate directory for #{domain}" unless source_dir
+
+      FileUtils.cp("#{source_dir}privkey.pem", dest_dir, verbose: true)
+      FileUtils.cp("#{source_dir}cert.pem", dest_dir, verbose: true)
+      FileUtils.cp("#{source_dir}chain.pem", dest_dir, verbose: true)
+      FileUtils.cp("#{source_dir}fullchain.pem", dest_dir, verbose: true)
+    end
+  end
+end

data/lib/firespring_dev_commands/common.rb

@@ -187,14 +187,5 @@ module Dev
         return false
       end
     end
-
-    # Center the string and pad on either side with the given padding character
-    def center_pad(string = '', pad: '-', len: 80)
-      string = " #{string} " unless string.strip.empty?
-      center_dash = len / 2
-      string = string.to_s
-      center_str = string.length / 2
-      string.rjust(center_dash + center_str - 1, pad).ljust(len - 1, pad)
-    end
   end
 end

data/lib/firespring_dev_commands/docker/status.rb

@@ -33,6 +33,26 @@ module Dev
         EXITED,
         DEAD
       ].freeze
+
+      # TODO: Can we use 'curses' here and overwrite the correct line?
+      def response_callback(response)
+        response.split("\n").each do |line|
+          data = JSON.parse(line)
+          if data.include?('status')
+            if data['id']
+              LOG.info "#{data['id']}: #{data['status']}"
+            else
+              LOG.info (data['status']).to_s
+            end
+          elsif data.include?('errorDetail')
+            raise data['errorDetail']['message']
+          elsif data.include?('aux')
+            next
+          else
+            raise "Unrecognized message from docker: #{data}"
+          end
+        end
+      end
     end
   end
 end

data/lib/firespring_dev_commands/docker.rb

@@ -117,6 +117,44 @@ module Dev
       format('%.1f %s', size.to_f / (1024**exp), units[exp])
     end
 
+    # Push the local version of the docker image to the defined remote repository
+    def push_image(image, name, tag = nil)
+      unless tag
+        if name.include?(':')
+          name, tag = name.split(':')
+        else
+          tag = 'latest'
+        end
+      end
+
+      puts "Pushing to #{name}:#{tag}"
+      image.push(::Docker.creds, repo_tag: "#{name}:#{tag}") { |response| Dev::Docker::Status.new.response_callback(response) }
+    end
+
+    # Push the remote version of the docker image from the defined remote repository
+    def pull_image(name, tag = nil)
+      unless tag
+        if name.include?(':')
+          name, tag = name.split(':')
+        else
+          tag = 'latest'
+        end
+      end
+
+      puts "\nPulling #{name}:#{tag}"
+      opts = {
+        fromImage: "#{name}:#{tag}",
+        platform: Dev::Common::Platform.new.architecture
+      }
+      ::Docker::Image.create(**opts) { |response| Dev::Docker::Status.new.response_callback(response) }
+    end
+
+    # Remove the local version of the given docker image
+    def untag_image(image, name, tag)
+      puts "Untagging #{name}:#{tag}"
+      image.remove(name: "#{name}:#{tag}")
+    end
+
     # Remove docker images with the "force" option set to true
     # This will remove the images even if they are currently in use and cause unintended side effects.
     def force_remove_images(name_and_tag)

data/lib/firespring_dev_commands/eol.rb

@@ -46,23 +46,13 @@ module Dev
       @products
     end
 
-    # Prints all of the product version statuses
-    def status
-      product_versions.sort_by(&:name).each(&:print_status)
-    end
-
-    # Returns true if any of the products are EOL
-    def eol?
-      product_versions.any?(&:eol)
-    end
-
     # Prints all of the product version statuses
     # Raises an error if any products are EOL
     def check
       puts
-      status
+      product_versions.sort_by(&:name).each(&:print_status)
       puts
-      raise 'found EOL versions' if eol?
+      raise 'found EOL versions' if product_versions.any?(&:eol)
     end
   end
 end

data/lib/firespring_dev_commands/git.rb

@@ -113,10 +113,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        header = "#{repo_basename} (#{original_branches[project_dir]})"
-        puts Dev::Common.new.center_pad(header).light_green
+        header = " #{repo_basename} (#{original_branches[project_dir]}) "
+        puts center_pad(header).light_green
         @success &= status(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -165,10 +165,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        header = "#{repo_basename} (#{original_branches[project_dir]})"
-        puts Dev::Common.new.center_pad(header).light_green
+        header = " #{repo_basename} (#{original_branches[project_dir]}) "
+        puts center_pad(header).light_green
         reset(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
     end
@@ -191,9 +191,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= checkout(branch, dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -284,9 +285,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= merge(branch, dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -332,9 +334,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= pull(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -370,9 +373,10 @@ module Dev
         next unless File.exist?(project_dir)
 
         repo_basename = File.basename(File.realpath(project_dir))
-        puts Dev::Common.new.center_pad(repo_basename).light_green
+        header = " #{repo_basename} "
+        puts center_pad(header).light_green
         @success &= push(dir: project_dir)
-        puts Dev::Common.new.center_pad.light_green
+        puts center_pad.light_green
       end
       puts
 
@@ -435,10 +439,11 @@ module Dev
     end
 
     # Center the string and pad on either side with the given padding character
-    # @deprecated Please use {Dev::Common#center_pad} instead
     def center_pad(string = '', pad: '-', len: 80)
-      warn '[DEPRECATION] `Dev::Git#center_pad` is deprecated. Please use `Dev::Common#center_pad` instead.'
-      Dev::Common.new.center_pad(string, pad:, len:)
+      center_dash = len / 2
+      string = string.to_s
+      center_str = string.length / 2
+      string.rjust(center_dash + center_str - 1, pad).ljust(len - 1, pad)
     end
 
     # Exclude the command from the message and print all error lines

data/lib/firespring_dev_commands/ruby.rb

@@ -90,16 +90,14 @@ module Dev
 
     # Build the bundle lint command
     def lint_command
-      lint = base_command
-      lint << 'exec' << 'rubocop'
+      lint = ['rubocop']
       lint.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint
     end
 
     # Build the bundle lint fix command
     def lint_fix_command
-      lint_fix = base_command
-      lint_fix << 'exec' << 'rubocop'
+      lint_fix = ['rubocop']
       lint_fix << '-A'
       lint_fix.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       lint_fix
@@ -107,8 +105,7 @@ module Dev
 
     # Build the bundle test command
     def test_command
-      test = base_command
-      test << 'exec' << 'rspec'
+      test = ['rspec']
       test.concat(Dev::Common.new.tokenize(ENV['OPTS'].to_s))
       test
     end

data/lib/firespring_dev_commands/templates/aws.rb

@@ -101,22 +101,14 @@ module Dev
 
         DEV_COMMANDS_TOP_LEVEL.instance_eval do
           return if exclude.include?(:eol)
-          return if ENV.fetch('CHECK_AWS', nil).to_s.strip == 'false'
 
-          task eol: [:'eol:aws'] do
-            # This is just a placeholder to execute the dependencies
-          end
+          desc 'Compares the current date to the EOL date for supported resources'
+          task eol: %w(init ensure_aws_credentials) do
+            account_id = Dev::Aws::Profile.new.current
+            account_name = Dev::Aws::Account.new.name_by_account(account_id)
+            LOG.info "  Current AWS Account is #{account_name} (#{account_id})".light_yellow
 
-          namespace :eol do
-            desc 'Compares the current date to the EOL date for supported aws resources'
-            task aws: %w(init ensure_aws_credentials) do
-              account_id = Dev::Aws::Profile.new.current
-              account_name = Dev::Aws::Account.new.name_by_account(account_id)
-              LOG.info "  Current AWS Account is #{account_name} (#{account_id})".light_yellow
-              puts
-              Dev::EndOfLife.new(product_versions: Dev::EndOfLife::Aws.new.default_products).status
-              puts
-            end
+            Dev::EndOfLife.new(product_versions: Dev::EndOfLife::Aws.new.default_products).check
           end
         end
       end

data/lib/firespring_dev_commands/templates/certificate.rb

@@ -0,0 +1,41 @@
+require_relative 'base_interface'
+
+module Dev
+  module Template
+    # Class contains rake templates for managing configured certificates
+    class Certificate < Dev::Template::BaseInterface
+      attr_reader :names, :email, :paths
+
+      def initialize(names, email:, paths:, exclude: [])
+        @names = names
+        @email = email
+        @paths = Array(paths)
+
+        super(exclude:)
+      end
+
+      # Create the rake task for the generate method
+      def create_generate_task!
+        # Have to set a local variable to be accessible inside of the instance_eval block
+        names = @names
+        email = @email
+        paths = @paths
+        exclude = @exclude
+
+        DEV_COMMANDS_TOP_LEVEL.instance_eval do
+          return if exclude.include?(:generate)
+
+          namespace :certificate do
+            desc 'Requests a new certificate for the configured domain using the route53 validation and deposits it in the configured paths'
+            task generate: %w(init_docker ensure_aws_credentials) do
+              Dev::Docker.new.pull_image('certbot/dns-route53', 'latest')
+              c = Dev::Certificate.new(names, email)
+              c.request
+              paths.each { |path| c.save(path) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/templates/docker/node/application.rb

@@ -29,7 +29,6 @@ module Dev
           end
 
           # Create the rake task which runs linting for the application name
-          # rubocop:disable Metrics/MethodLength
           def create_lint_task!
             application = @name
             node = @node
@@ -43,13 +42,6 @@ module Dev
                   # This is just a placeholder to execute the dependencies
                 end
 
-                namespace :lint do
-                  desc 'Run all linting software and apply all available fixes'
-                  task fix: %w(node:lint:fix) do
-                    # This is just a placeholder to execute the dependencies
-                  end
-                end
-
                 namespace :node do
                   desc "Run the node linting software against the #{application}'s codebase"
                   task lint: %w(init_docker up_no_deps) do
@@ -74,7 +66,6 @@ module Dev
               end
             end
           end
-          # rubocop:enable Metrics/MethodLength
 
           # Create the rake task which runs all tests for the application name
           def create_test_task!

data/lib/firespring_dev_commands/templates/docker/php/application.rb

@@ -74,7 +74,6 @@ module Dev
           end
 
           # Create the rake task which runs linting for the application name
-          # rubocop:disable Metrics/MethodLength
           def create_lint_task!
             application = @name
             php = @php
@@ -88,13 +87,6 @@ module Dev
                   # This is just a placeholder to execute the dependencies
                 end
 
-                namespace :lint do
-                  desc 'Run all linting software and apply all available fixes'
-                  task fix: %w(php:lint:fix) do
-                    # This is just a placeholder to execute the dependencies
-                  end
-                end
-
                 namespace :php do
                   desc "Run the php linting software against the #{application}'s codebase"
                   task lint: %w(init_docker up_no_deps) do
@@ -119,7 +111,6 @@ module Dev
               end
             end
           end
-          # rubocop:enable Metrics/MethodLength
 
           # Create the rake task which runs all tests for the application name
           def create_test_task!

data/lib/firespring_dev_commands/templates/docker/ruby/application.rb

@@ -28,7 +28,6 @@ module Dev
           end
 
           # Create the rake task which runs linting for the application name
-          # rubocop:disable Metrics/MethodLength
           def create_lint_task!
             application = @name
             ruby = @ruby
@@ -42,13 +41,6 @@ module Dev
                   # This is just a placeholder to execute the dependencies
                 end
 
-                namespace :lint do
-                  desc 'Run all linting software and apply all available fixes'
-                  task fix: %w(ruby:lint:fix) do
-                    # This is just a placeholder to execute the dependencies
-                  end
-                end
-
                 namespace :ruby do
                   desc "Run the ruby linting software against the #{application}'s codebase"
                   task lint: %w(init_docker up_no_deps) do
@@ -73,7 +65,6 @@ module Dev
               end
             end
           end
-          # rubocop:enable Metrics/MethodLength
 
           # Create the rake task which runs all tests for the application name
           def create_test_task!

data/lib/firespring_dev_commands/templates/eol.rb

@@ -12,10 +12,9 @@ module Dev
         DEV_COMMANDS_TOP_LEVEL.instance_eval do
           return if exclude.include?(:eol)
 
-          desc 'Compares the current date to the EOL date for all configured projects' \
-               "\n\toptionally specify CHECK_AWS=<true/false> to toggle whether AWS resources are checked for EOL (defaults to true)"
+          desc 'Compares the current date to the EOL date for all configured projects'
           task eol: %w(init) do
-            Dev::EndOfLife.new.status
+            Dev::EndOfLife.new.check
           end
         end
       end

data/lib/firespring_dev_commands/templates/git.rb

@@ -4,23 +4,6 @@ module Dev
   module Template
     # Class contains rake templates for managing your git project
     class Git < Dev::Template::BaseInterface
-      # Create the rake task for cloning all defined repos
-      def create_clone_task!
-        # Have to set a local variable to be accessible inside of the instance_eval block
-        exclude = @exclude
-
-        DEV_COMMANDS_TOP_LEVEL.instance_eval do
-          namespace :git do
-            return if exclude.include?(:clone)
-
-            desc 'Make sure all repos are cloned'
-            task :clone do
-              Dev::Git.new.clone_repos
-            end
-          end
-        end
-      end
-
       # Create the rake task for the git checkout method
       def create_checkout_task!
         # Have to set a local variable to be accessible inside of the instance_eval block

data/lib/firespring_dev_commands/version.rb

@@ -6,6 +6,6 @@ module Dev
     # Use 'v.v.v.pre.alpha.v' for pre-release vesions
     # Use 'v.v.v.beta.v for beta versions
     # Use semantic versioning for any releases (https://semver.org/)
-    VERSION = '2.1.26'.freeze
+    VERSION = '2.1.27.pre.alpha.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.26
+  version: 2.1.27.pre.alpha.1
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -332,6 +332,7 @@ files:
 - lib/firespring_dev_commands/bloom_growth/seat.rb
 - lib/firespring_dev_commands/bloom_growth/user.rb
 - lib/firespring_dev_commands/boolean.rb
+- lib/firespring_dev_commands/certificate.rb
 - lib/firespring_dev_commands/common.rb
 - lib/firespring_dev_commands/coverage/base.rb
 - lib/firespring_dev_commands/coverage/cobertura.rb
@@ -383,6 +384,7 @@ files:
 - lib/firespring_dev_commands/target_process/user_story_history.rb
 - lib/firespring_dev_commands/templates/aws.rb
 - lib/firespring_dev_commands/templates/base_interface.rb
+- lib/firespring_dev_commands/templates/certificate.rb
 - lib/firespring_dev_commands/templates/ci.rb
 - lib/firespring_dev_commands/templates/config.rb
 - lib/firespring_dev_commands/templates/docker/application.rb
@@ -409,9 +411,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.4.10
 signing_key: