firespring_dev_commands 2.1.33.pre.alpha.1 → 2.1.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c45c76d9855e9cdf1d7366ace69704734d74672fff36ca7f29fb067dbb20b9d1
-  data.tar.gz: 48846c3bda2a4bb1bc6da5572c2cbd3d1736c0348a04f092783b39d1f87e18c7
+  metadata.gz: aa188df0b1a042594409df9d0c288298a1c2899ccf0a420f213f34f6bd463950
+  data.tar.gz: 474383072092cf5be3bbbcc5c92dcb5b0fbfc426a55ce93dd46e174e6a3b9217
 SHA512:
-  metadata.gz: ca56922554bce95dcccd9853c8395e887d7957e2c30480998ca1bb24739fab1aef9a6b83c9d12f3eff6f3800480b103e8d603ec88b11bf4c593a86153632ca5c
-  data.tar.gz: 3f509eb7bb98710a2cab435d4d05d75b6da1fda5b75d609a1988535e2a82af0ad6e49eec97a5d406b1e53a31d10be6732f4c6b1d5e070e829feeab335f33423d
+  metadata.gz: 1d21358d2fcd8fe2dfed28327c553b6795e7095433ff6667d41bcca6d89268ab03367a0a166535d53d1623368716aadb15bcda65f24eb18e40efd895e7147d20
+  data.tar.gz: 20a2bedaed3177859237c8d3cf4e7ab36c4d8382906068bd489456617de50cfd430a4c145afe917b4acb1963bd76435dd51fde2898ae5ed5190c1ba6b4af89a3

data/README.md

@@ -28,7 +28,7 @@ Dev::Template::Docker::Node::Application.new('foo')
 ```
 * If you run `rake -T` now, you should have base rake commands and application rake commands for an app called `foo`
 
-* (optinoal) Add AWS login template commands
+* (optional) Add AWS login template commands
 ```
 # Configure AWS accounts and create tasks
 Dev::Aws::Account::configure do |c|

data/lib/firespring_dev_commands/aws/route53.rb

@@ -0,0 +1,107 @@
+module Dev
+  class Aws
+    # Class for performing Route53 functions
+    class Route53
+      attr_reader :client
+
+      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
+
+      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
+        end
+      end
+
+      private def zones_by_domain_names(domains)
+        [].tap do |ary|
+          domains.each do |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
+
+            ary << target
+          end
+        end
+      end
+
+      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
+      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|
+          response = client.create_query_logging_config(
+            hosted_zone_id: zone.id,
+            cloud_watch_logs_log_group_arn: log_group
+          )
+          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.id] = e.message
+        end
+        pretty_puts(output)
+      end
+
+      def deactivate_query_logging
+        output = {}
+        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.id] = 'Query logging config removed.'.colorize(:green)
+          else
+            output[zone.id] = 'No query logging config assigned.'.colorize(:red)
+          end
+        end
+        pretty_puts(output)
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/eol/aws.rb

@@ -72,19 +72,23 @@ module Dev
       # Queries and returns product versions for rds instance products
       def rds_instance_products
         aws_engines = %w(mysql postgresql)
+        aws_sqlserver_engines = %w(sqlserver-ee sqlserver-ex sqlserver-se sqlserver-web)
         client = ::Aws::RDS::Client.new
 
         [].tap do |ary|
           Dev::Aws.each_page(client, :describe_db_instances) do |response|
             response.db_instances.each do |instance|
               name = instance.db_instance_identifier
-              engine = instance.engine.tr('aurora-', '')
+              engine = instance.engine.gsub('aurora-', '')
               product = if aws_engines.include?(engine)
                           "amazon-rds-#{engine}"
+                        elsif aws_sqlserver_engines.include?(engine)
+                          'mssqlserver'
                         else
                           engine
                         end
               version = instance.engine_version.reverse.split('.')[-2..].join('.').reverse
+              version.chop! if version.end_with?('.00')
               ary << Dev::EndOfLife::ProductVersion.new(product, version, name)
             end
           end
@@ -94,19 +98,23 @@ module Dev
       # Queries and returns product versions for rds cluster products
       def rds_cluster_products
         aws_engines = %w(mysql postgresql)
+        aws_sqlserver_engines = %w(sqlserver-ee sqlserver-ex sqlserver-se sqlserver-web)
         client = ::Aws::RDS::Client.new
 
         [].tap do |ary|
           Dev::Aws.each_page(client, :describe_db_clusters) do |response|
             response.db_clusters.each do |cluster|
               name = cluster.db_cluster_identifier
-              engine = cluster.engine.tr('aurora-', '')
+              engine = cluster.engine.gsub('aurora-', '')
               product = if aws_engines.include?(engine)
                           "amazon-rds-#{engine}"
+                        elsif aws_sqlserver_engines.include?(engine)
+                          'mssqlserver'
                         else
                           engine
                         end
               version = cluster.engine_version.reverse.split('.')[-2..].join('.').reverse
+              version.chop! if version.end_with?('.00')
               ary << Dev::EndOfLife::ProductVersion.new(product, version, name)
             end
           end

data/lib/firespring_dev_commands/target_process/release.rb

@@ -24,7 +24,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        Time.at(string.slice(6, 10).to_i)
+        ::Time.at(string.slice(6, 10).to_i)
       end
     end
   end

data/lib/firespring_dev_commands/target_process/team_assignment.rb

@@ -24,7 +24,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        Time.at(string.slice(6, 10).to_i)
+        ::Time.at(string.slice(6, 10).to_i)
       end
 
       # Calculate the cycle time as the amount of time the story was open

data/lib/firespring_dev_commands/target_process/time.rb

@@ -0,0 +1,32 @@
+module Dev
+  class TargetProcess
+    # The class to query time information from Target Process
+    class Time
+      # The resource type for the api endpoint
+      RESOURCE_TYPE = 'Time'.freeze
+
+      # The api path for time requests
+      PATH = '/Time'.freeze
+
+      attr_accessor :data, :id, :type, :description, :hours, :date, :story, :user
+
+      def initialize(data)
+        @data = data
+        @id = data['Id']
+        @type = data['ResourceType']
+        @description = data['Description']
+        @hours = data['Spent']
+        @date = parse_time(data['Date'])
+        @story = UserStory.new(data['Assignable']) if data['Assignable']
+        @user = User.new(data['User']) if data['User']
+      end
+
+      # Parse the dot net time representation into something that ruby can use
+      def parse_time(string)
+        return nil unless string && !string.empty?
+
+        ::Time.at(string.slice(6, 10).to_i)
+      end
+    end
+  end
+end

data/lib/firespring_dev_commands/target_process/user.rb

@@ -2,7 +2,13 @@ module Dev
   class TargetProcess
     # Class containing user information
     class User
-      attr_accessor :data, :id, :type, :name, :login
+      # The resource type for the api endpoint
+      RESOURCE_TYPE = 'User'.freeze
+
+      # The api path for user requests
+      PATH = '/User'.freeze
+
+      attr_accessor :data, :id, :type, :name, :login, :email
 
       def initialize(data)
         @data = data
@@ -10,6 +16,12 @@ module Dev
         @type = data['ResourceType']
         @name = data['FullName']
         @login = data['Login']
+        @email = data['Email']
+      end
+
+      # Get the user with the given id and return that object
+      def self.get(id)
+        new(TargetProcess.new.get("#{User::PATH}/#{id}", Query.new))
       end
     end
   end

data/lib/firespring_dev_commands/target_process/user_story.rb

@@ -37,7 +37,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        Time.at(string.slice(6, 10).to_i)
+        ::Time.at(string.slice(6, 10).to_i)
       end
 
       # Calculate the cycle time as the amount of time the story was open

data/lib/firespring_dev_commands/target_process/user_story_history.rb

@@ -38,7 +38,7 @@ module Dev
       def parse_time(string)
         return nil unless string && !string.empty?
 
-        Time.at(string.slice(6, 10).to_i)
+        ::Time.at(string.slice(6, 10).to_i)
       end
     end
   end

data/lib/firespring_dev_commands/target_process.rb

@@ -72,8 +72,8 @@ module Dev
       [].tap do |ary|
         get(Release::PATH, query) do |result|
           ary << Release.new(result)
+          yield ary.last if block_given?
         end
-        ary.each(&)
       end
     end
 
@@ -84,8 +84,8 @@ module Dev
       [].tap do |ary|
         get(UserStory::PATH, query) do |result|
           ary << UserStory.new(result)
+          yield ary.last if block_given?
         end
-        ary.each(&)
       end
     end
 
@@ -96,8 +96,8 @@ module Dev
       [].tap do |ary|
         get(UserStoryHistory::PATH, query) do |result|
           ary << UserStoryHistory.new(result)
+          yield ary.last if block_given?
         end
-        ary.each(&)
       end
     end
 
@@ -108,8 +108,20 @@ module Dev
       [].tap do |ary|
         get(TeamAssignment::PATH, query) do |result|
           ary << TeamAssignment.new(result)
+          yield ary.last if block_given?
+        end
+      end
+    end
+
+    # Perform a query to the time api path
+    # Call the given block (if present) with each time
+    # Return all times
+    def times(query, &)
+      [].tap do |ary|
+        get(Time::PATH, query) do |result|
+          ary << Time.new(result)
+          yield ary.last if block_given?
         end
-        ary.each(&)
       end
     end
 
@@ -132,8 +144,11 @@ module Dev
       parsed_response['Items'].each(&)
 
       while parsed_response['Next']
-        response = client.request_get(parsed_response['Next'], headers)
-        raise "Error querying #{parsed_response['Next']} [#{query_string}]: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
+        next_query_string = URI(parsed_response['Next']).query
+        next_url = "/api/v1/#{path}"
+        next_url << "?#{next_query_string}" unless query_string.empty?
+        response = client.request_get(next_url, headers)
+        raise "Error querying #{next_url} [#{next_query_string}]: #{response.inspect}" unless response.response.is_a?(Net::HTTPSuccess)
 
         parsed_response = JSON.parse(response.body)
         return parsed_response unless parsed_response.key?('Items')

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/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.33.pre.alpha.1'.freeze
+    VERSION = '2.1.34'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firespring_dev_commands
 version: !ruby/object:Gem::Version
-  version: 2.1.33.pre.alpha.1
+  version: 2.1.34
 platform: ruby
 authors:
 - Firespring
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-18 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.208.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-route53
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.87.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.87.0
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
   requirement: !ruby/object:Gem::Requirement
@@ -326,6 +340,7 @@ files:
 - lib/firespring_dev_commands/aws/login.rb
 - lib/firespring_dev_commands/aws/parameter.rb
 - lib/firespring_dev_commands/aws/profile.rb
+- lib/firespring_dev_commands/aws/route53.rb
 - lib/firespring_dev_commands/aws/s3.rb
 - lib/firespring_dev_commands/bloom_growth.rb
 - lib/firespring_dev_commands/bloom_growth/rock.rb
@@ -380,10 +395,12 @@ files:
 - lib/firespring_dev_commands/target_process/release.rb
 - lib/firespring_dev_commands/target_process/team.rb
 - lib/firespring_dev_commands/target_process/team_assignment.rb
+- lib/firespring_dev_commands/target_process/time.rb
 - lib/firespring_dev_commands/target_process/user.rb
 - 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
@@ -412,9 +429,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.10
 signing_key: