aws_s3_website_sync 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6cd1d01e70b5021bee1b491605cd4c72d7df85b472890badff176f4068cdf454
+  data.tar.gz: 24054c0ea3833aff89c15282fa5f332becf75a8fde0e56574b379d77e2e41adf
+SHA512:
+  metadata.gz: 8ad2ac55bdcf593ee3c3c71bb0ba2d937416b4c6363b0c9ca78ba0c02c5a0df2d951368a29ffbd59e8c0a9c845da54fb21a9c2fbc551e752eb88df9131e371e1
+  data.tar.gz: 3a139b7ae10d01762285a6444a89e67a68d98d9b899882147663153cb0bc42705aba6b946d956b8d92f799391c9473d0ae5d8faa7d74c1c7ed0a22c678add5c3

data/lib/aws_s3_website_sync/apply.rb

@@ -0,0 +1,117 @@
+module AwsS3WebsiteSync
+  class Apply
+    # path to changeset file
+    def self.run(
+      changeset_path:,
+      aws_access_key_id:,
+      aws_secret_access_key:,
+      s3_bucket:,
+      distribution_id:,
+      caller_reference:,
+      aws_default_region:,
+      build_dir:
+    )
+      json = File.read(changeset_path)
+      data = JSON.parse(json)
+
+      puts "---[ Apply ]------------------------------------------------------------"
+      puts "ChangeSet: #{File.basename(changeset_path,'.json')}"
+      puts ""
+      puts "WebSync is performing operations:"
+
+      items_delete = data.select{|t| t["action"] == "delete" }
+      keys_delete  = items_delete.map{|t|t["path"]}
+
+      items_create_or_update = data.select{|t| %{create update}.include?(t["action"]) }
+
+      s3 = Aws::S3::Resource.new({
+       region: aws_default_region,
+       credentials: Aws::Credentials.new(
+         aws_access_key_id,
+         aws_secret_access_key
+        )
+      })
+      bucket = s3.bucket s3_bucket
+      AwsS3WebsiteSync::Apply.delete bucket, keys_delete
+      AwsS3WebsiteSync::Apply.create_or_update bucket, items_create_or_update, build_dir
+      AwsS3WebsiteSync::Apply.invalidate aws_access_key_id, aws_secret_access_key, aws_default_region, distribution_id, caller_reference, data
+    end
+
+    def self.delete bucket, keys
+      $logger.info "Apply.delete"
+      return if keys.empty?
+      puts "\t#{keys}"
+      bucket.delete_objects({
+        delete: { # required
+          objects: keys.map{|t|{key: t}},
+          quiet: false,
+        }
+      })
+    end
+
+    # files: [{key: '', path: ''}]
+    def self.create_or_update bucket, files, build_dir
+      files.each do |data|
+        puts "\t#{data["path"]}"
+
+        file_path = build_dir + "/" + data["path"]
+        file_path = file_path + ".html" if !!(data["path"] =~ /\./) == false
+
+        file = File.open file_path
+        md5 = Digest::MD5.hexdigest file.read
+        md5 = Base64.encode64([md5].pack("H*")).strip
+
+        attrs = {
+          key: data["path"],
+          body: IO.read(file),
+          content_md5: md5
+        }
+        # If it doee not have an extension assume its an html file
+        # and explicty set content type to html.
+        if !!(data["path"] =~ /\./) == false
+          attrs[:content_type] = 'text/html'
+        elsif !!(data["path"] =~ /\.html/)
+          attrs[:content_type] = 'text/html'
+        elsif !!(data["path"] =~ /\.css/)
+          attrs[:content_type] = 'text/css'
+        elsif !!(data["path"] =~ /\.js/)
+          attrs[:content_type] = 'application/x-javascript'
+        elsif !!(data["path"] =~ /\.svg/)
+          attrs[:content_type] = "image/svg+xml"
+        end
+        # TEMP
+        puts "Content Type Detected: #{attrs[:content_type]}"
+        resp = bucket.put_object(attrs)
+      end
+    end
+
+    def self.invalidate aws_access_key_id, aws_secret_access_key, aws_default_region, distribution_id, caller_reference, files
+      $logger.info "Apply.invalidate"
+      items = files.select{|t| %w{create update delete}.include?(t["action"]) }
+      items.map!{|t| "/" + t["path"] }
+
+      cloudfront = Aws::CloudFront::Client.new(
+       region: aws_default_region,
+       credentials: Aws::Credentials.new(
+         aws_access_key_id,
+         aws_secret_access_key
+        )
+      )
+      resp = cloudfront.create_invalidation({
+        distribution_id: distribution_id, # required
+        invalidation_batch: { # required
+          paths: { # required
+            quantity: items.count, # required
+            items: items
+          },
+          caller_reference: caller_reference + "-#{Time.now.to_i}" # required
+        }
+      })
+      if resp.is_a?(Seahorse::Client::Response)
+        puts "Invalidation #{resp.invalidation.id} has been created. Please wait about 60 seconds for it to finish."
+      else
+        puts "ERROR"
+      end
+    end
+  end
+end

data/lib/aws_s3_website_sync/color.rb

@@ -0,0 +1,23 @@
+module AwsS3WebsiteSync
+  class Color
+    def self.cyan str
+      "\e[36m#{str}\e[0m"
+    end
+
+    def self.red str
+      "\e[31m#{str}\e[0m"
+    end
+
+    def self.green str
+      "\e[32m#{str}\e[0m"
+    end
+
+    def self.yellow str
+      "\e[33m#{str}\e[0m"
+    end
+
+    def self.grey str
+      "\e[37m#{str}\e[0m"
+    end
+  end
+end

data/lib/aws_s3_website_sync/list.rb

@@ -0,0 +1,37 @@
+module AwsS3WebsiteSync
+  class List
+    def self.local build_dir
+      $logger.info "List.local"
+      paths = Dir.glob build_dir +  "/**/*"
+      paths = paths.reject { |f| File.directory?(f) }
+      paths.map! do |path|
+        md5  = Digest::MD5.hexdigest File.read(path)
+        path = path.sub build_dir + '/', ''
+        path =
+        if path == 'index.html'
+          path
+        else
+          path.sub('.html','')
+        end
+        {path: path, md5: md5}
+      end
+      paths
+    end
+
+    def self.remote aws_access_key_id, aws_secret_access_key, s3_bucket, aws_default_region
+      $logger.info "List.remote"
+      s3 ||= Aws::S3::Resource.new({
+       region: aws_default_region,
+       credentials: Aws::Credentials.new(
+         aws_access_key_id,
+         aws_secret_access_key
+        )
+      })
+      bucket = s3.bucket s3_bucket
+      keys = bucket.objects.map do |object_summary|
+        {path: object_summary.key, md5: object_summary.etag.gsub('"','')}
+      end
+      keys
+    end
+  end
+end

data/lib/aws_s3_website_sync/plan.rb

@@ -0,0 +1,69 @@
+module AwsS3WebsiteSync
+  class Plan
+    def self.run(
+        output_changeset_path:,
+        build_dir:,
+        aws_access_key_id:,
+        aws_secret_access_key:,
+        s3_bucket:,
+        aws_default_region:,
+        ignore_files:
+      )
+      paths = AwsS3WebsiteSync::List.local build_dir
+      keys  = AwsS3WebsiteSync::List.remote aws_access_key_id, aws_secret_access_key, s3_bucket, aws_default_region
+
+      # Files we should delete
+      diff_delete = AwsS3WebsiteSync::Plan.delete paths, keys
+
+      # Ignore files we plan to delete for create_or_update
+      create_or_update_keys = keys.reject{|t| diff_delete.any?(t[:path]) }
+
+      # Files we should create or update
+      diff_create_or_update = AwsS3WebsiteSync::Plan.create_or_update paths, create_or_update_keys
+
+      AwsS3WebsiteSync::Plan.create_changeset output_changeset_path, diff_delete, diff_create_or_update, ignore_files
+    end
+
+    def self.create_changeset output_changeset_path, diff_delete_keys, diff_create_or_update, ignore_files
+      diff_delete = diff_delete_keys.map{|t| {path: t, action: 'delete'} }
+      data = diff_delete + diff_create_or_update
+
+      data.each do |t|
+        if ignore_files.include?(t[:path])
+          t[:action] = 'ignore'
+        end
+      end
+
+      formatted_data = JSON.pretty_generate data
+
+      FileUtils.mkdir_p File.dirname(output_changeset_path)
+      File.write output_changeset_path, formatted_data
+    end
+
+    # Get the differece between the local build directory and S3 bucket
+    # return: [Array] a list of keys that should be deleted
+    def self.delete paths, keys
+      $logger.info "Plan.delete"
+      keys.map{|t|t[:path]} - paths.map{|t|t[:path]}
+    end
+
+    # Get the difference of files changed
+    def self.create_or_update paths, keys
+      $logger.info "Plan.create_update"
+      results = []
+      paths.each do |p|
+        if k = keys.find{|t|t[:path] == p[:path] }
+          # existing entry
+          if k[:md5] == p[:md5]
+            results.push p.merge(action: 'no_change')
+          else
+            results.push p.merge(action: 'update')
+          end
+        else
+          results.push p.merge(action: 'create')
+        end
+      end
+      results
+    end
+  end
+end

data/lib/aws_s3_website_sync/preview.rb

@@ -0,0 +1,56 @@
+module AwsS3WebsiteSync
+  class Preview
+    def self.run changeset_path:, silent:
+      silent_actions = silent.split(',')
+      json = File.read changeset_path
+      data = JSON.parse json
+      puts "---[ Plan ]------------------------------------------------------------"
+      puts "ChangeSet: #{File.basename(changeset_path,'.json')}"
+      puts ""
+      puts "WebSync will perform the following operations:"
+      puts ""
+      data = data.sort_by { |t| t["path"] }
+
+      summary = {
+        ignore: 0,
+        delete: 0,
+        create: 0,
+        update: 0,
+        no_change: 0
+      }
+      data.each do |item|
+        action =
+        case item['action']
+        when 'ignore'
+          summary[:ignore] += 1
+          AwsS3WebsiteSync::Color.grey item['action']
+        when 'delete'
+          summary[:delete] += 1
+          AwsS3WebsiteSync::Color.red item['action']
+        when 'create'
+          summary[:create] += 1
+          AwsS3WebsiteSync::Color.green item['action']
+        when 'update'
+          summary[:update] += 1
+          AwsS3WebsiteSync::Color.cyan item['action']
+        when 'no_change'
+          summary[:no_change] += 1
+          AwsS3WebsiteSync::Color.yellow item['action']
+        end
+
+        unless silent_actions.include?(item["action"])
+          puts "\t#{action} #{item["path"]}"
+        end
+      end # data.each
+      puts "--------------------------------------------------------------------"
+      puts [
+        AwsS3WebsiteSync::Color.grey("ignore: #{summary[:ignore]}"),
+        AwsS3WebsiteSync::Color.red("delete: #{summary[:delete]}"),
+        AwsS3WebsiteSync::Color.green("create: #{summary[:create]}"),
+        AwsS3WebsiteSync::Color.cyan("update: #{summary[:update]}"),
+        AwsS3WebsiteSync::Color.yellow("no_change: #{summary[:no_change]}")
+      ].join('   ')
+      puts ""
+    end
+  end
+end

data/lib/aws_s3_website_sync/runner.rb

@@ -0,0 +1,70 @@
+module AwsS3WebsiteSync
+  class Runner
+    def self.run(
+      aws_access_key_id:,
+      aws_secret_access_key:,
+      aws_default_region:,
+      s3_bucket:,
+      auto_approve:,
+      distribution_id:,
+      build_dir:,
+      output_changset_path:,
+      ignore_files:,
+      silent:
+    )
+      $logger.info "Runner.run"
+      AwsS3WebsiteSync::Plan.run(
+        output_changeset_path: output_changset_path,
+        build_dir: build_dir,
+        aws_access_key_id: aws_access_key_id,
+        aws_secret_access_key: aws_secret_access_key,
+        s3_bucket: s3_bucket,
+        aws_default_region: aws_default_region,
+        ignore_files: ignore_files
+      )
+      AwsS3WebsiteSync::Preview.run(
+        changeset_path: output_changset_path,
+        silent: silent
+      )
+
+      json = File.read output_changset_path
+      data = JSON.parse json
+      items = data.select{|t| %w{create update delete}.include?(t["action"]) }
+
+      if items.count.zero?
+        puts "no changes to apply, quitting....."
+      else
+        puts "Execute the plan? Type: yes or no"
+        if auto_approve == "true"
+          AwsS3WebsiteSync::Apply.run(
+            changeset_path: output_changset_path,
+            build_dir: build_dir,
+            aws_access_key_id: aws_access_key_id,
+            aws_secret_access_key: aws_secret_access_key,
+            s3_bucket: s3_bucket,
+            aws_default_region: aws_default_region,
+            distribution_id: distribution_id,
+            caller_reference:  File.basename(output_changset_path,'.json')
+          )
+        else
+          print "> "
+          case (STDIN.gets.chomp)
+          when 'yes'
+            AwsS3WebsiteSync::Apply.run(
+              changeset_path: output_changset_path,
+              build_dir: build_dir,
+              aws_access_key_id: aws_access_key_id,
+              aws_secret_access_key: aws_secret_access_key,
+              s3_bucket: s3_bucket,
+              aws_default_region: aws_default_region,
+              distribution_id: distribution_id,
+              caller_reference:  File.basename(output_changset_path,'.json')
+            )
+          when 'no'
+            puts "quitting...."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws_s3_website_sync/version.rb

@@ -0,0 +1,3 @@
+module AwsS3WebsiteSync
+  VERSION = "1.0.1"
+end

data/lib/aws_s3_website_sync.rb

@@ -0,0 +1,14 @@
+require 'aws-sdk-cloudfront'
+require 'aws-sdk-s3'
+require 'digest/md5'
+require 'logger'
+require 'fileutils'
+
+require_relative 'aws_s3_website_sync/color'
+require_relative 'aws_s3_website_sync/runner'
+require_relative 'aws_s3_website_sync/list'
+require_relative 'aws_s3_website_sync/preview'
+require_relative 'aws_s3_website_sync/plan'
+require_relative 'aws_s3_website_sync/apply'
+
+$logger = Logger.new(STDOUT)

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: aws_s3_website_sync
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- TeacherSeat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudfront
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: AWS S3 Website Sync
+email:
+- andrew@teachersaet.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/aws_s3_website_sync.rb
+- lib/aws_s3_website_sync/apply.rb
+- lib/aws_s3_website_sync/color.rb
+- lib/aws_s3_website_sync/list.rb
+- lib/aws_s3_website_sync/plan.rb
+- lib/aws_s3_website_sync/preview.rb
+- lib/aws_s3_website_sync/runner.rb
+- lib/aws_s3_website_sync/version.rb
+homepage: https://www.teacherseat.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: AWS S3 Website Sync
+test_files: []