firespring_dev_commands 2.1.32.pre.alpha.3 → 2.1.32.pre.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87dcece3099e1aec9bfb5f6572371479e6c5cd2dae608d126fc1f5a124a84f7e
-  data.tar.gz: b1204325e48a239995de507fc320331aa6a4dd353338085e9512aefd46f82dcb
+  metadata.gz: 79a1a2ae3dec85f284124b6b7148ada390d1b1761d051470a5c05157c22873ae
+  data.tar.gz: d0754a57c361e5532e48ecf5025f38c7ee3e63f1ee67b8ed33cc80f542562d2d
 SHA512:
-  metadata.gz: 4331459a1711d98a385e3babbaac972f72c01010fb41e5fe535934427a0a804690ae24ebfd4f33c1f59818a3ac520fd0aa3afe369739a5d86d5b80fd0e8676b1
-  data.tar.gz: bdfb0873f8ad0da53076a979fd60010af02d97894edf538dc3e72ffd97379fadc93a0623f3040d15a820005acd93232df11641b9f12b9a6957a5f8b43cba63e8
+  metadata.gz: 90133369d6cb5eb63925f4b9e3223a7ca51cd8235ef8d945d9a12223fc5594ccb91faf4dcdf15d77e849e4b662a97e02a831e9bc338745c536c1d41110f7af17
+  data.tar.gz: c4ee82f9c701470b1f2624b30c6d906155f269d9900a5742dc63fb1f33dec1c91b117e6cd1c48cbd9618e0dc74827741c0db19473942bd6134c52c62bdbbf500

data/lib/firespring_dev_commands/aws/route53.rb

@@ -1,75 +1,106 @@
-require 'aws-sdk-route53'
-
 module Dev
   class Aws
     # Class for performing Route53 functions
     class Route53
-      attr_reader :client, :zones
+      attr_reader :client, :zones, :domains
 
-      def initialize
+      def initialize(domains)
         @client = ::Aws::Route53::Client.new
+        @domains = domains
+      end
+
+      private def zones
+        if @domains.empty?
+          all_zones
+        else
+          zones_by_domain_names(@domains)
+        end
       end
 
-      def hosted_zones(domains)
-        @zones = []
-        if domains.empty?
-          @zones = [].tap do |ary|
-            Dev::Aws.each_page(client, :list_hosted_zones, {max_items: 2}) do |response|
-              response.hosted_zones.each do |hosted_zone|
-                ary << hosted_zone.id unless hosted_zone.config.private_zone
-              end
+      private def all_zones
+        [].tap do |ary|
+          Dev::Aws.each_page(client, :list_hosted_zones) do |response|
+            response.hosted_zones&.each do |hosted_zone|
+              ary << hosted_zone unless hosted_zone.config.private_zone
             end
           end
-        else
+        end
+      end
+
+      private def zones_by_domain_names(domains)
+        [].tap do |ary|
           domains.each do |domain_name|
-            zone = client.list_hosted_zones_by_name({dns_name: domain_name, max_items: 1})
-            target_name = zone.hosted_zones.first.name.chomp!('.')
-            raise "The #{domain_name} hosted zone not found." if target_name != domain_name
+            response = client.list_hosted_zones_by_name({dns_name: domain_name})
+            target = response.hosted_zones.find { |it| it.name.chomp('.') == domain_name }
+            raise "The #{domain_name} hosted zone not found." unless target
 
-            @zones << zone.hosted_zones.first.id
+            ary << target
           end
         end
-        raise 'Hosted zone(s) not found.' if @zones.empty?
       end
 
-      def get_target_config_id(zone_id)
+      private def target_config_id(zone_id)
         client.list_query_logging_configs(
           hosted_zone_id: zone_id,
           max_results: '1'
-        ).query_logging_configs.first.id
+        ).query_logging_configs&.first&.id
+      end
+
+      private def pretty_puts(output)
+        # Find the maximum length of the keys
+        max_key_length = output.keys.map(&:to_s).max_by(&:length).length
+
+        output.each do |key, value|
+          puts "#{key.to_s.ljust(max_key_length)}\t=>\t#{value}"
+        end
+      end
+
+      def list_query_configs
+        output = {}
+        zones.each do |zone|
+          target_config_id = target_config_id(zone.id)
+
+          output[zone.name] = if target_config_id
+                                "Config\t=>\t#{target_config_id}".colorize(:green)
+                              else
+                                'No query logging config assigned.'.colorize(:red)
+                              end
+        end
+
+        pretty_puts(output)
       end
 
       def activate_query_logging(log_group)
         output = {}
 
-        @zones.each do |zone|
+        zones.each do |zone|
           response = client.create_query_logging_config(
-            hosted_zone_id: zone,
+            hosted_zone_id: zone.id,
             cloud_watch_logs_log_group_arn: log_group
           )
-          output[zone] = response.location
+          output[zone.id] = response.location
         rescue ::Aws::Route53::Errors::ServiceError => e
           raise "Error: #{e.message}" unless e.instance_of?(::Aws::Route53::Errors::QueryLoggingConfigAlreadyExists)
 
-          output[zone] = e.message
+          output[zone.id] = e.message
         end
-        pp output
+        pretty_puts(output)
       end
 
       def deactivate_query_logging
         output = {}
-        @zones.each do |zone|
-          target_config_id = get_target_config_id(zone)
+        zones.each do |zone|
+          target_config_id = target_config_id(zone.id)
           if target_config_id
             client.delete_query_logging_config(
               id: target_config_id
             )
-            output[zone] = 'Query logging config removed.'
+            output[zone.id] = 'Query logging config removed.'.colorize(:green)
           else
-            output[zone] = 'No query logging config assigned.'
+            output[zone.id] = 'No query logging config assigned.'.colorize(:red)
           end
         end
-        pp output
+        pretty_puts(output)
       end
     end
   end

data/lib/firespring_dev_commands/templates/aws/services/route53.rb

@@ -0,0 +1,106 @@
+require_relative '../../base_interface'
+
+module Dev
+  module Template
+    class Aws
+      module Services
+        # Class contains rake templates for managing your AWS settings and logging in
+        class Route53 < Dev::Template::BaseInterface
+          # Create the rake task which ensures active credentials are present
+          def create_ensure_credentials_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
+              return if exclude.include?(:ensure_aws_credentials)
+
+              task ensure_aws_credentials: %w(init) do
+                raise 'AWS Credentials not found / expired' unless Dev::Aws::Credentials.new.active?
+              end
+            end
+          end
+
+          # Create the rake task for the hosted zone method
+          def create_dns_logging_activate_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 :aws do
+                return if exclude.include?(:dns_logging)
+
+                namespace :hosted_zone do
+                  namespace :dns_logging do
+                    desc 'Activates query logging for all hosted zones by default.' \
+                         'This command should be run from the account the hosted zone(s) reside.' \
+                         "\n\t(Required) Specify LOG_GROUP_ARN='arn:aws:logs:REGION:ACCOUNT_ID:' to specify the ARN of the target log group." \
+                         "\n\toptionally specify DOMAINS='foo.com,foobar.com' to specify the hosted zones to activate." \
+                         "\n\t\tComma delimited list."
+                    task activate: %w(ensure_aws_credentials) do
+                      route53 = Dev::Aws::Route53.new(ENV['DOMAINS'].to_s.strip.split(','))
+                      # Use user defined log group.
+                      log_group = ENV.fetch('LOG_GROUP_ARN', nil)
+                      raise 'The Hosted Zone Log Group ARN, LOG_GROUP_ARN, is required' unless log_group
+
+                      route53.activate_query_logging(log_group)
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          # Create the rake task for the hosted zone method
+          def create_dns_logging_deactivate_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 :aws do
+                return if exclude.include?(:dns_logging)
+
+                namespace :hosted_zone do
+                  namespace :dns_logging do
+                    desc 'Deactivates query logging for all hosted zones by default. ' \
+                         'This command should be run from the account the hosted zone(s) reside.' \
+                         "\n\toptionally specify DOMAINS='foo.com,foobar.com' to specify the hosted zones to activate." \
+                         "\n\t\tComma delimited list."
+                    task deactivate: %w(ensure_aws_credentials) do
+                      route53 = Dev::Aws::Route53.new(ENV['DOMAINS'].to_s.strip.split(','))
+                      route53.deactivate_query_logging
+                    end
+                  end
+                end
+              end
+            end
+          end
+
+          # Create the rake task for the hosted zone method
+          def create_list_query_config_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 :aws do
+                return if exclude.include?(:dns_logging)
+
+                namespace :hosted_zone do
+                  namespace :dns_logging do
+                    desc 'Lists the current config for domain(s). ' \
+                         'This command should be run from the account the hosted zone(s) reside.' \
+                         "\n\toptionally specify DOMAINS='foo.com,foobar.com' to specify the hosted zones to activate." \
+                         "\n\t\tComma delimited list."
+                    task list_query_configs: %w(ensure_aws_credentials) do
+                      route53 = Dev::Aws::Route53.new(ENV['DOMAINS'].to_s.strip.split(','))
+                      route53.list_query_configs
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/templates/aws.rb

@@ -120,61 +120,6 @@ module Dev
           end
         end
       end
-
-      # Create the rake task for the hosted zone method
-      def create_dns_logging_activate_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 :aws do
-            return if exclude.include?(:dns_logging)
-
-            namespace :hosted_zone do
-              namespace :dns_logging do
-                desc 'Activates query logging for all hosted zones by default.' \
-                     'This command should be run from the account the hosted zone(s) reside.' \
-                     "\n\toptionally specify HOSTED_ZONE_GROUP='arn:aws:logs:REGION:ACCOUNT_ID:' to specify the ARN of the target log group." \
-                     "\n\toptionally specify DOMAINS='foo.com,foobar.com' to specify the hosted zones to activate." \
-                     "\n\t\tComma delimited list."
-                task :activate do
-                  route53 = Dev::Aws::Route53.new
-                  route53.hosted_zones(ENV['DOMAINS'].to_s.strip.split(','))
-                  # Use user defined log group. Otherwise, go get the default.
-                  log_group = (ENV['HOSTED_ZONE_GROUP'] || Dev::Aws::Parameter.new.get_value('/Firespring/Internal/Route53/hosted-zone/log-group-arn'))
-                  route53.activate_query_logging(log_group)
-                end
-              end
-            end
-          end
-        end
-      end
-
-      # Create the rake task for the hosted zone method
-      def create_dns_logging_deactivate_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 :aws do
-            return if exclude.include?(:dns_logging_de)
-
-            namespace :hosted_zone do
-              namespace :dns_logging do
-                desc 'Deactivates query logging for all hosted zones by default. ' \
-                     'This command should be run from the account the hosted zone(s) reside.' \
-                     "\n\toptionally specify DOMAINS='foo.com,foobar.com' to specify the hosted zones to activate." \
-                     "\n\t\tComma delimited list."
-                task :deactivate do
-                  route53 = Dev::Aws::Route53.new
-                  route53.hosted_zones(ENV['DOMAINS'].to_s.strip.split(','))
-                  route53.deactivate_query_logging
-                end
-              end
-            end
-          end
-        end
-      end
     end
   end
 end

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.32.pre.alpha.3'.freeze
+    VERSION = '2.1.32.pre.alpha.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.32.pre.alpha.3
+  version: 2.1.32.pre.alpha.5
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-22 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -399,6 +399,7 @@ files:
 - lib/firespring_dev_commands/target_process/user_story.rb
 - lib/firespring_dev_commands/target_process/user_story_history.rb
 - lib/firespring_dev_commands/templates/aws.rb
+- lib/firespring_dev_commands/templates/aws/services/route53.rb
 - lib/firespring_dev_commands/templates/base_interface.rb
 - lib/firespring_dev_commands/templates/certificate.rb
 - lib/firespring_dev_commands/templates/ci.rb