zine 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd799d0d16019f2d33ecaf9b60bb5a9c13d8d3b8b82b03f4ff7d8781d5fbcfde
-  data.tar.gz: bc32bc64300c4b8327c6426335533970656ab9a33e06fe5e3976ac51c8b14bc6
+  metadata.gz: 83a6d732e0f716bf2df642356304e6e80622736f778ff6367e3bf742a3d55f04
+  data.tar.gz: 75c284e7e74f8594372c2be764590de57a2a1072b70e989136c09130948478ea
 SHA512:
-  metadata.gz: 91d373f480d5282ddaf6a08d08bb69528cf62e7d5cb7532aa4cfb98e5f40cc5ef7f4a9723c41ce2d9961f7650524ac2d4f69cc2da84b3237ebf5c9e11b43fc91
-  data.tar.gz: 1325ebca737a5f0bc73641e745bf3466d78a5f2f5f14914c0e8c41953c441ae47c4cf55a7e4527c30079512c45808d6ad63204486c1b52c3ccfc9b14a3e33063
+  metadata.gz: 95a3b894f4d3cc1c03bce1509990de4185f5f7c503d694c440dd3c730bc45e49b9e01a65f60a94d5976e5cef4da77c802fdd6bc7133c3028618d8f1dc3485376
+  data.tar.gz: 5aaa407679487a1e807722e79d02f523ac0b75fa73b595e8fb2a2ece08157b1d3d6bbcca678256b40bc7327662886b48a419d7e2b377d750043a1d7a3e1bccda

data/CHANGELOG.md

@@ -126,11 +126,11 @@
 
 - fixed a bug where String#split would break apart markdown files on tables as well as at the metadata/markdown boundary
 
-# 0.12.0 - never pushed, used up until 25 April 2019
+# 0.12.0 - never pushed, used up until April 25, 2019
 
 - added (then removed) Mastodon from the list of contacts, changed the styling a few times, neglected to publish
 
-# 0.13.0 - lucky 13 - 
+# 0.13.0 - lucky 13 - May 26, 2019
 
 - added some of the style changes that survived from v12, eg moved social media to the footer
 - added a (permissive as they come) robots.txt file
@@ -140,11 +140,15 @@
 - minor readme updates
 - placeholder site, mostly in case there's ever an app: https://zine.dev
 
+# 0.14.0 - May 27, 2019
+- added an AWS S3 uploader
+- added AWS CloudFront invalidation
+- added zine.dev to the footer template
+- bug fix - catch carriage returns as default yes answers to the upload? question
+
 TO DO
 - add canonical links to page headers, means the build order needs to change...
 - generate sitemap.xml
-- add an AWS S3 uploader
-- add AWS CloudFront invalidation
 - fix the SFTP error from 0.7/0.8, also likely applies to S3
 - make sure the server's killed on errors (eg if no credentials) so can run it again later without a port conflict
 - tests, lots of tests
@@ -153,5 +157,5 @@ MAY DO
 - concurrent-ruby gem
 - migration scripts from eg Jekyll?
 - Apple News
-- much refactoring
-- an app
+- much refactoring, frozen_string_literal, split monster classes, etc
+- an app... maybe

data/README.md

@@ -6,14 +6,14 @@ Yet another blog aware static site generator.
 
 ## Why yet another static blog engine?
 
-Despite the [proliferation in these things][engine_list] (!) I still find it more comfortable to use my own tools.
+Despite the [proliferation in these things][engine_list] (!) I still find it more comfortable to use my own tools, changing them to suit my changing needs, for example here as I've moved between GitHub, EC2 & S3 hosts.
 
 Distinguishing features include:
 
 - ERB templates
 - Sass stylesheets
 - fast incremental builds
-- GitHub & SFTP file uploads
+- a choice of AWS S3, GitHub & SFTP file uploads
 
 Presented here in the hope it's of use to someone else too.
 

data/lib/zine/query.rb

@@ -3,7 +3,8 @@ module Zine
   class Query
     def call(question)
       puts question
-      $stdin.gets.chomp
+      result = $stdin.gets.chomp
+      result == '' ? 'Y' : result
     end
   end
-end
+end

data/lib/zine/skeleton/source/templates/footer_partial.erb

@@ -17,7 +17,7 @@
   <div class="column">
     <h3>The fine print</h3>
     <ul>
-      <li>Built with <a href="https://github.com/mikekreuzer/zine">Zine</a></li>
+      <li>Built with <a href="https://zine.dev">Zine</a></li>
       <li>&copy; 2019<span> <%= page[:site_author] %></span></li>
     </ul>
   </div>

data/lib/zine/skeleton/zine.yaml

@@ -33,8 +33,9 @@ templates:
   tag: tag
   tag_index: tag_index
 upload:
+  cloudfront_distrib: ID or ''
   credentials: /local/absolute/path/to/yaml/file/with/username/password/or/access_token
-  host: 127.0.0.1
-  method: none|github|sftp
+  host: eg 127.0.0.1, or for AWS region:bucket_name
+  method: none|aws|github|sftp
   path_or_repo: /remote/absolute/path/to/html|fullname/repo
   verbose: true

data/lib/zine/upload.rb

@@ -1,11 +1,12 @@
 require 'rainbow'
 require 'set'
 require 'zine'
+require 'zine/uploader_aws'
 require 'zine/uploader_github'
 require 'zine/uploader_sftp'
 
 module Zine
-  # Deploy changes to a remote host, via SFTP or using the GitHub Rest API
+  # Deploy changes to a remote host, via SFTP or using the AWS or GitHub API
   class Upload
     def initialize(build_dir, options, delete_file_array, upload_file_array)
       if options['method'] == 'none'
@@ -45,6 +46,15 @@ module Zine
       exit
     end
 
+    def aws_upload
+      uploader = Zine::UploaderAWS.new(@build_dir,
+                                       @options,
+                                       @credentials,
+                                       @delete_file_array,
+                                       @upload_file_array)
+      uploader.upload
+    end
+
     def github_upload
       uploader = Zine::UploaderGitHub.new(@build_dir,
                                           @options,
@@ -64,7 +74,9 @@ module Zine
     end
 
     def upload
-      if @options['method'] == 'sftp'
+      if @options['method'] == 'aws'
+        aws_upload
+      elsif @options['method'] == 'sftp'
         sftp_upload
       elsif @options['method'] == 'github'
         github_upload

data/lib/zine/uploader_aws.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-cloudfront'
+require 'aws-sdk-s3'
+require 'rack/mime'
+require 'rainbow'
+require 'set'
+
+module Zine
+  # Deploy changes to an AWS S3 bucket and invalidate the Cloudfront cache
+  class UploaderAWS
+    def initialize(build_dir, options, credentials, delete_file_array,
+                   upload_file_array)
+      return unless options['method'] == 'aws'
+
+      @build_dir = build_dir
+      ENV['AWS_REGION'], @bucket_name = options['host'].split(':')
+      @path = options['path_or_repo']
+      @cf_distribution_id = options['cloudfront_distrib']
+
+      @verbose = options['verbose']
+      store_credentials credentials
+      @delete_file_array = Set.new(delete_file_array).to_a
+      @upload_file_array = Set.new(upload_file_array).to_a
+
+      @s3 = Aws::S3::Client.new
+      @cf = Aws::CloudFront::Client.new
+    end
+
+    def upload
+      delete
+      deploy
+      invalidate
+    rescue Aws::S3::Errors::ServiceError => err
+      puts Rainbow("S3 error: #{err}").red
+    end
+
+    private
+
+    def clean_path(path)
+      path.to_s
+          .delete_prefix('/')
+          .delete_suffix('/')
+    end
+
+    def delete
+      @delete_file_array.each do |rel_path|
+        remote_path = clean_path(rel_path)
+        @s3.delete_object(bucket: @bucket_name, key: remote_path)
+        puts "Delete: #{remote_path}" if @verbose
+      end
+    end
+
+    def deploy
+      @upload_file_array.each do |rel_path|
+        deploy_one_file(File.join(@build_dir, rel_path),
+                        clean_path(rel_path))
+      end
+    end
+
+    def deploy_one_file(local_path, remote_path)
+      File.open(local_path, 'rb') do |file|
+        content_type = Rack::Mime.mime_type(File.extname(local_path))
+        @s3.put_object(bucket: @bucket_name,
+                       key: remote_path,
+                       content_type: content_type,
+                       body: file)
+        puts "Add: #{remote_path}" if @verbose
+      end
+    end
+
+    def invalidate
+      changes = Set.new(@upload_file_array + @delete_file_array).to_a
+      return unless changes.count.positive?
+
+      puts 'Invalidating cache' if @verbose
+      string_changes = changes.map do |path|
+        path.to_s
+            .delete_prefix('/')
+            .prepend('/')
+      end
+      string_changes << '/'
+      @cf.create_invalidation(
+        distribution_id: @cf_distribution_id,
+        invalidation_batch: { paths: { quantity: string_changes.count,
+                                       items: string_changes },
+                              caller_reference: Time.now.to_i.to_s }
+      )
+    end
+
+    def store_credentials(creds)
+      ENV['AWS_ACCESS_KEY_ID'] = creds['username']
+      ENV['AWS_SECRET_ACCESS_KEY'] = creds['password']
+    end
+  end
+end

data/lib/zine/version.rb

@@ -1,4 +1,4 @@
 module Zine
   # The version
-  VERSION = '0.13.0'.freeze
+  VERSION = '0.14.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zine
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Mike Kreuzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-25 00:00:00.000000000 Z
+date: 2019-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudfront
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.40'
 - !ruby/object:Gem::Dependency
   name: htmlcompressor
   requirement: !ruby/object:Gem::Requirement
@@ -304,6 +332,7 @@ files:
 - lib/zine/tag.rb
 - lib/zine/templates.rb
 - lib/zine/upload.rb
+- lib/zine/uploader_aws.rb
 - lib/zine/uploader_github.rb
 - lib/zine/uploader_sftp.rb
 - lib/zine/version.rb