plan_my_stuff 0.1.0 → 1.0.0

data/lib/plan_my_stuff/aws_sns_simulator.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'securerandom'
+require 'time'
+require 'uri'
+
+module PlanMyStuff
+  # Dev helper: build a fake SNS notification wrapping an ECS Deployment
+  # State Change event and POST it to a local +/webhooks/aws+ endpoint.
+  # Used by +plan_my_stuff:webhooks:simulate_aws+ so deployment flows
+  # can be exercised without waiting for a real AWS deployment.
+  #
+  # The consuming app must be configured with a no-op SNS verifier
+  # (see +PlanMyStuff::NullSnsVerifier+) or signature verification will
+  # reject the simulated envelope. Never enable that verifier in
+  # production.
+  #
+  module AwsSnsSimulator
+    DEFAULT_EVENT = 'SERVICE_DEPLOYMENT_COMPLETED'
+
+    module_function
+
+    # POSTs a simulated SNS envelope to the endpoint. Pulls
+    # +sns_topic_arn+, +aws_service_identifier+, and
+    # +production_commit_sha+ from +PlanMyStuff.configuration+ (this
+    # task is dev-only, so there's no reason to parameterize them).
+    #
+    # @raise [PlanMyStuff::ConfigurationError] if sns details are missing
+    #
+    # @param endpoint_url [String] full URL including path
+    # @param event_name [String] ECS eventName (default completed)
+    #
+    # @return [Net::HTTPResponse]
+    #
+    def post!(endpoint_url:, event_name: DEFAULT_EVENT)
+      config = PlanMyStuff.configuration
+      if config.sns_topic_arn.blank?
+        raise(PlanMyStuff::ConfigurationError, 'PlanMyStuff.configuration.sns_topic_arn is blank')
+      end
+      if config.aws_service_identifier.blank?
+        raise(PlanMyStuff::ConfigurationError, 'PlanMyStuff.configuration.aws_service_identifier is blank')
+      end
+
+      topic_arn = config.sns_topic_arn
+      service_arn = "arn:aws:ecs:us-east-1:000000000000:service/simulated-cluster/#{config.aws_service_identifier}"
+      commit_sha = config.production_commit_sha
+
+      message = build_ecs_message(event_name: event_name, service_arn: service_arn, commit_sha: commit_sha)
+      envelope = build_sns_envelope(message: message, topic_arn: topic_arn)
+      raw_body = JSON.generate(envelope)
+
+      uri = URI(endpoint_url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request['Content-Type'] = 'application/json'
+      request['x-amz-sns-message-type'] = 'Notification'
+      request.body = raw_body
+
+      $stdout.puts("POST #{endpoint_url}")
+      $stdout.puts("  event:     #{event_name}")
+      $stdout.puts("  topic:     #{topic_arn}")
+      $stdout.puts("  resources: #{service_arn}")
+      $stdout.puts("  commit:    #{commit_sha || '(none)'}")
+      $stdout.puts('---')
+
+      response = http.request(request)
+      $stdout.puts("HTTP #{response.code} #{response.message}")
+      $stdout.puts(response.body) if response.body.present?
+      response
+    end
+
+    # @return [Hash]
+    def build_ecs_message(event_name:, service_arn:, commit_sha:)
+      detail = {
+        'eventType' => 'INFO',
+        'eventName' => event_name,
+        'deploymentId' => "ecs-svc/#{SecureRandom.hex(8)}",
+        'updatedAt' => PlanMyStuff.format_time(Time.now.utc),
+      }
+      detail['commitSha'] = commit_sha if commit_sha
+
+      {
+        'version' => '0',
+        'id' => SecureRandom.uuid,
+        'detail-type' => 'ECS Deployment State Change',
+        'source' => 'aws.ecs',
+        'account' => '000000000000',
+        'time' => PlanMyStuff.format_time(Time.now.utc),
+        'region' => 'us-east-1',
+        'resources' => [service_arn],
+        'detail' => detail,
+      }
+    end
+
+    # @return [Hash]
+    def build_sns_envelope(message:, topic_arn:)
+      now = PlanMyStuff.format_time(Time.now.utc)
+      {
+        'Type' => 'Notification',
+        'MessageId' => SecureRandom.uuid,
+        'TopicArn' => topic_arn,
+        'Subject' => 'ECS Deployment State Change',
+        'Message' => JSON.generate(message),
+        'Timestamp' => now,
+        'SignatureVersion' => '1',
+        'Signature' => 'simulated',
+        'SigningCertURL' => 'https://example.com/cert.pem',
+        'UnsubscribeURL' => 'https://example.com/unsubscribe',
+      }
+    end
+  end
+end

data/lib/plan_my_stuff/base_metadata.rb

@@ -15,10 +15,6 @@ module PlanMyStuff
     attr_accessor :rails_env
     # @return [String, nil] consuming app name from config
     attr_accessor :app_name
-    # @return [Time, nil] timestamp of creation
-    attr_accessor :created_at
-    # @return [Time, nil] timestamp of last update
-    attr_accessor :updated_at
     # @return [Integer, nil] consuming app's user ID of the creator
     attr_accessor :created_by
     # @return [String] "public" or "internal"
@@ -33,20 +29,19 @@ module PlanMyStuff
         #
         # @param metadata [BaseMetadata]
         # @param hash [Hash]
+        # @param custom_fields_schema [Hash{Symbol => Hash}] merged schema for this context
         #
         # @return [void]
         #
-        def apply_common_from_hash(metadata, hash)
+        def apply_common_from_hash(metadata, hash, custom_fields_schema)
           metadata.schema_version = hash[:schema_version]
           metadata.gem_version = hash[:gem_version]
           metadata.rails_env = hash[:rails_env]
           metadata.app_name = hash[:app_name]
-          metadata.created_at = parse_time(hash[:created_at])
-          metadata.updated_at = parse_time(hash[:updated_at])
           metadata.created_by = hash[:created_by]
           metadata.visibility = hash.fetch(:visibility, 'internal')
-          metadata.custom_fields = CustomFields.new(
-            PlanMyStuff.configuration.custom_fields,
+          metadata.custom_fields = PlanMyStuff::CustomFields.new(
+            custom_fields_schema,
             hash[:custom_fields] || {},
           )
         end
@@ -57,24 +52,28 @@ module PlanMyStuff
         # @param user [Object, Integer] user object or user_id
         # @param visibility [String] "public" or "internal"
         # @param custom_fields_data [Hash]
+        # @param custom_fields_schema [Hash{Symbol => Hash}] merged schema for this context
         #
         # @return [void]
         #
-        def apply_common_build(metadata, user:, visibility: 'internal', custom_fields_data: {})
+        def apply_common_build(
+          metadata,
+          user:,
+          visibility: 'internal',
+          custom_fields_data: {},
+          custom_fields_schema: {}
+        )
           config = PlanMyStuff.configuration
-          now = Time.now.utc
 
           metadata.schema_version = self::SCHEMA_VERSION
           metadata.gem_version = PlanMyStuff::VERSION::STRING
           metadata.rails_env = (defined?(Rails) && Rails.respond_to?(:env)) ? Rails.env.to_s : nil
           metadata.app_name = config.app_name
-          metadata.created_at = now
-          metadata.updated_at = now
-          resolved = UserResolver.resolve(user)
-          metadata.created_by = resolved.present? ? UserResolver.user_id(resolved) : nil
+          resolved = PlanMyStuff::UserResolver.resolve(user)
+          metadata.created_by = resolved.present? ? PlanMyStuff::UserResolver.user_id(resolved) : nil
           metadata.visibility = visibility
-          metadata.custom_fields = CustomFields.new(
-            config.custom_fields,
+          metadata.custom_fields = PlanMyStuff::CustomFields.new(
+            custom_fields_schema,
             custom_fields_data,
           )
         end
@@ -92,6 +91,7 @@ module PlanMyStuff
 
     def initialize
       @visibility = 'internal'
+      @custom_fields = {}
     end
 
     # @return [Hash]
@@ -101,8 +101,6 @@ module PlanMyStuff
         gem_version: gem_version,
         rails_env: rails_env,
         app_name: app_name,
-        created_at: format_time(created_at),
-        updated_at: format_time(updated_at),
         created_by: created_by,
         visibility: visibility,
         custom_fields: custom_fields.to_h,
@@ -119,18 +117,17 @@ module PlanMyStuff
       visibility == 'public'
     end
 
+    # Validates custom fields against the schema.
+    #
+    # @return [true]
+    #
+    def validate_custom_fields!
+      custom_fields.validate! if custom_fields.is_a?(PlanMyStuff::CustomFields)
+    end
+
     # @return [String]
     def to_json(...)
       to_h.to_json(...)
     end
-
-    private
-
-      # @return [String, nil]
-      def format_time(time)
-        return if time.nil?
-
-        time.utc.iso8601
-      end
   end
 end