odania-static-pages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7daf33ae327e89440d7c6c34a5f9617b84eadc8
+  data.tar.gz: 79a77a816c345f184dd89b81da735a56dbdd233c
+SHA512:
+  metadata.gz: 81d3320c164d9cada2fe2d532347252b8ff1059267391209226071c3f8985bca2da0c76a383c54f0943c9d65cc4b692418771a7c43bc5262002509d23b631f09
+  data.tar.gz: d2c5390105a055afb7757a2354f45c6d1a2de600831a7e7feac2d394313d03a53c4558c657859bfa48ef0a9a3428869c56f3780a54b57dbbe73d0fe13b48c8f9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+*.iml

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mike@odania-it.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}"}
+
+# Specify your gem's dependencies in odania-static-pages.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mike Petersen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Odania::Static::Pages
+
+This is a helper for managing static pages for multiple domains.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'odania-static-pages'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install odania-static-pages
+
+## Usage
+
+	odania-static-pages new DIRECTORY <- Create a new project under the given directory
+	odania-static-pages deploy init -e live <- Initialize deploy state
+	odania-static-pages deploy publish -e live <- Publishes the project in the live environment
+	odania-static-pages generate init <- Initialize the generator
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/OdaniaIT/odania-static-pages. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Odania::Static::Pages project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/odania-static-pages/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+	t.libs << "test"
+	t.libs << "lib"
+	t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'odania/static/pages'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cf-templates/s3-http.yml

@@ -0,0 +1,50 @@
+---
+AWSTemplateFormatVersion: '2010-09-09'
+
+Description: Stack for preparing http serving bucket.
+Parameters:
+  LoggingStackName:
+    Type: String
+  BucketNameGreen:
+    Type: String
+  BucketNameBlue:
+    Type: String
+
+Resources:
+  HttpBucketGreen:
+    Type: AWS::S3::Bucket
+    Properties:
+      AccessControl: PublicRead
+      BucketName: !Sub "${BucketNameGreen}"
+      WebsiteConfiguration:
+        IndexDocument: index.html
+        ErrorDocument: 404.html
+      LoggingConfiguration:
+        DestinationBucketName: !ImportValue {"Fn::Sub": "${LoggingStackName}-LoggingBucketName"}
+        LogFilePrefix: logs
+      Tags:
+        - Key: Test1
+          Value: val-1
+    DeletionPolicy: Retain
+  HttpBucketBlue:
+    Type: AWS::S3::Bucket
+    Properties:
+      AccessControl: PublicRead
+      BucketName: !Sub "${BucketNameBlue}"
+      WebsiteConfiguration:
+        IndexDocument: index.html
+        ErrorDocument: 404.html
+      LoggingConfiguration:
+        DestinationBucketName: !ImportValue {"Fn::Sub": "${LoggingStackName}-LoggingBucketName"}
+        LogFilePrefix: logs
+    DeletionPolicy: Retain
+
+Outputs:
+  HttpBucketGreen:
+    Value: !Ref HttpBucketGreen
+    Export:
+      Name: !Sub ${AWS::StackName}-HttpBucketNameGreen
+  HttpBucketBlue:
+    Value: !Ref HttpBucketBlue
+    Export:
+      Name: !Sub ${AWS::StackName}-HttpBucketNameBlue

data/cf-templates/s3-logging.yml

@@ -0,0 +1,21 @@
+---
+AWSTemplateFormatVersion: '2010-09-09'
+
+Description: Stack for preparing log bucket.
+Parameters:
+  BucketName:
+    Type: String
+
+Resources:
+  LoggingBucket:
+    Type: AWS::S3::Bucket
+    Properties:
+      AccessControl: LogDeliveryWrite
+      BucketName: !Sub "${BucketName}"
+    DeletionPolicy: Retain
+
+Outputs:
+  LoggingBucketName:
+    Value: !Ref LoggingBucket
+    Export:
+      Name: !Sub ${AWS::StackName}-LoggingBucketName

data/cf-templates/s3-state.yml

@@ -0,0 +1,21 @@
+---
+AWSTemplateFormatVersion: '2010-09-09'
+
+Description: Stack for preparing state bucket.
+Parameters:
+  BucketName:
+    Type: String
+
+Resources:
+  StateBucket:
+    Type: AWS::S3::Bucket
+    Properties:
+      AccessControl: BucketOwnerFullControl
+      BucketName: !Sub "${BucketName}"
+    DeletionPolicy: Retain
+
+Outputs:
+  StateBucketName:
+    Value: !Ref StateBucket
+    Export:
+      Name: !Sub ${AWS::StackName}-StateBucketName

data/exe/odania-static-pages

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/odania_static_pages'
+
+OdaniaStaticPages::Cli.start(ARGV)

data/lib/odania_static_pages/cli/deploy_cli.rb

@@ -0,0 +1,17 @@
+module OdaniaStaticPages
+	class DeployCli < Thor
+		desc 'init', 'Initialize'
+		def init
+			config = OdaniaStaticPages.config
+			deploy_module = "OdaniaStaticPages::Deploy::#{config.current_environment.deploy_type}".constantize.new
+			deploy_module.prepare
+		end
+
+		desc 'publish <color> <do_rebuild>', 'Publish website. Color is optional and can be used to force a publish of a specific color'
+		def publish(color=nil, do_rebuild=false)
+			config = OdaniaStaticPages.config
+			deploy_module = "OdaniaStaticPages::Deploy::#{config.current_environment.deploy_type}".constantize.new
+			deploy_module.publish(color, do_rebuild)
+		end
+	end
+end

data/lib/odania_static_pages/cli/generator_cli.rb

@@ -0,0 +1,17 @@
+module OdaniaStaticPages
+	class GeneratorCli < Thor
+		desc 'init', 'Initialize'
+		def init
+			config = OdaniaStaticPages.config
+			deploy_module = "OdaniaStaticPages::Generator::#{config.generator_type}".constantize.new
+			deploy_module.init
+		end
+
+		desc 'build', 'Build websites'
+		def build
+			config = OdaniaStaticPages.config
+			deploy_module = "OdaniaStaticPages::Generator::#{config.generator_type}".constantize.new
+			deploy_module.build options[:environment]
+		end
+	end
+end

data/lib/odania_static_pages/cli.rb

@@ -0,0 +1,30 @@
+require_relative 'cli/deploy_cli'
+require_relative 'cli/generator_cli'
+
+module OdaniaStaticPages
+	class Cli < Thor
+		class_option :environment, default: 'develop', aliases: '-e', desc: 'Environment'
+
+		def initialize(*args)
+			super
+
+			OdaniaStaticPages.config.environment = options[:environment]
+		end
+
+		desc 'new <path>', 'creates a new project'
+		def new(path='.')
+			path = File.absolute_path path
+			puts "Generating project under #{path}"
+
+			FileUtils.mkdir_p path unless File.exist? path
+			config = OdaniaStaticPages.config path
+			config.save!
+		end
+
+		desc 'deploy', 'Deploy subcommand'
+		subcommand 'deploy', OdaniaStaticPages::DeployCli
+
+		desc 'generate', 'Generate subcommand'
+		subcommand 'generate', OdaniaStaticPages::GeneratorCli
+	end
+end

data/lib/odania_static_pages/config/docker_compose.rb

@@ -0,0 +1,24 @@
+module OdaniaStaticPages
+	class Config
+		module Deploy
+			class DockerCompose
+				attr_reader :state_file, :compose_images, :expires, :varnish_secret
+
+				def initialize(state_file: 'docker_compose_state.yml', compose_images: [], expires: '-1', varnish_secret: nil)
+					@state_file = state_file
+					@compose_images = compose_images
+					@expires = expires
+					@varnish_secret = varnish_secret.nil? ? SecureRandom.hex : varnish_secret
+				end
+
+				def to_h
+					{
+						state_file: @state_file,
+						compose_images: @compose_images,
+						expires: @expires
+					}.stringify_keys!
+				end
+			end
+		end
+	end
+end

data/lib/odania_static_pages/config/generator/jekyll.rb

@@ -0,0 +1,126 @@
+module OdaniaStaticPages
+	class Config
+		module Generator
+			class Jekyll
+				attr_reader :plugins, :encoding, :common_folder, :extra_options, :gem_extra
+
+				def initialize(project_dir, options)
+					@plugins = options['plugins'] || %w(jekyll-feed octopress-image-tag octopress-gist)
+					@encoding = options['encoding'] || 'utf-8'
+					@common_folder = options['common_folder'] || 'common'
+					@extra_options = options['extra_options'] || {}
+					@gem_extra = options['gem_extra'] || ''
+					@project_dir = project_dir
+				end
+
+				def to_h
+					{
+						plugins: @plugins,
+						encoding: @encoding,
+						common_folder: @common_folder,
+						extra_options: @extra_options,
+						gem_extra: @gem_extra
+					}.stringify_keys!
+				end
+
+				def self.from_hash(project_dir, data)
+					Jekyll.new project_dir, data
+				end
+
+				def prepare_config(cfg)
+					page_config = cfg.clone
+					page_config['plugins'] = @plugins
+					page_config['encoding'] = @encoding
+					@extra_options.merge page_config
+				end
+
+				def link(base_dir, page_path, page)
+					common_subfolders.each do |folder|
+						create_link_if_required page_path, folder
+					end
+
+					puts ' -> Linking plugins'
+					plugins_dir = File.join(page_path, '_plugins')
+					FileUtils.mkdir_p plugins_dir
+
+					Dir.glob(File.join(full_common_folder, '_plugins', '*')).each do |plugin_file|
+						puts "   -> Linking plugin #{File.basename(plugin_file)}"
+						FileUtils.ln_s plugin_file, plugins_dir, force: true
+					end
+
+					puts ' -> Linking Gemfile*'
+					FileUtils.ln_s File.join(full_common_folder, 'Gemfile'), File.join(page_path, 'Gemfile'), force: true
+					FileUtils.ln_s File.join(full_common_folder, 'Gemfile.lock'), File.join(page_path, 'Gemfile.lock'), force: true
+
+					puts ' -> Linking common pages'
+					FileUtils.mkdir_p template_pages_dir
+					link_common_pages template_pages_dir, page_path, template_pages_dir, page['lang']
+				end
+
+				def full_common_folder
+					File.join(@project_dir, @common_folder)
+				end
+
+				def template_pages_dir
+					File.join(full_common_folder, '_pages')
+				end
+
+				def pages_dir
+					File.join(@project_dir, 'pages')
+				end
+
+				def page_path(page_config)
+					uri = URI.parse(page_config['url'])
+					uri.host
+				end
+
+				def jekyll_config_file
+					File.join(@project_dir, '_jekyll_config.yml')
+				end
+
+				def jekyll_config
+					return YAML.load_file jekyll_config_file if File.exist? jekyll_config_file
+					{}
+				end
+
+				private
+
+				def create_link_if_required(page_path, name)
+					puts " -> Linking #{name}"
+					file = File.join(full_common_folder, name)
+					FileUtils.mkdir_p file unless File.exist? file
+					FileUtils.ln_s file, page_path, force: true
+				end
+
+				def common_subfolders
+					%w(_affiliate _i18n _layouts _themes)
+				end
+
+				def link_common_pages(src_folder, target_folder, pages_dir, lang)
+					Dir.glob(File.join(src_folder, '*')).each do |common_page_file|
+						if File.directory? common_page_file
+							link_common_pages common_page_file, target_folder, pages_dir, lang
+						else
+							short_file = common_page_file.gsub("#{pages_dir}/", '')
+							target_file = File.join target_folder, short_file
+
+							basename = File.basename(short_file)
+							if basename.start_with? 'lang-'
+								cleaned_name = basename.split('-')
+								cleaned_name.shift
+								file_lang = cleaned_name.shift
+								next unless lang.eql? file_lang
+
+								target_file = File.join target_folder, File.dirname(short_file), cleaned_name.join('-')
+							end
+
+							puts "   -> Linking common page #{short_file} => #{target_file.gsub(target_folder, '')}"
+							FileUtils.mkdir_p File.dirname target_file
+							FileUtils.ln_s common_page_file, target_file, force: true
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/odania_static_pages/config/rsync.rb

@@ -0,0 +1,24 @@
+module OdaniaStaticPages
+	class Config
+		module Deploy
+			class Rsync
+				attr_reader :targets, :rsync_options, :state_file
+
+				def initialize(targets: {green: '/tmp/rsync-deploy-test/blue', blue: '/tmp/rsync-deploy-test/blue'},
+											 rsync_options: '-a --delete', state_file: '_current_state.yml')
+					@targets = targets
+					@rsync_options = rsync_options
+					@state_file = state_file
+				end
+
+				def to_h
+					{
+						targets: @targets,
+						rsync_options: @rsync_options,
+						state_file: @state_file
+					}.stringify_keys!
+				end
+			end
+		end
+	end
+end

data/lib/odania_static_pages/config/s3.rb

@@ -0,0 +1,41 @@
+module OdaniaStaticPages
+	class Config
+		module Deploy
+			class S3
+				attr_reader :bucket_name_green, :bucket_name_blue, :logging_bucket, :state_bucket, :region, :profile
+
+				def initialize(bucket_name_green: 'odania-http-green', bucket_name_blue: 'odania-http-blue',
+											 logging_bucket: 'odania-logging', region: 'eu-central-1', state_bucket: 'odania-state',
+											 profile: nil, tags: {deployed_by: 'odania-static-pages'})
+					@bucket_name_green = bucket_name_green
+					@bucket_name_blue = bucket_name_blue
+					@logging_bucket = logging_bucket
+					@state_bucket = state_bucket
+					@region = region
+					@profile = profile
+					@tags = tags
+				end
+
+				def to_h
+					{
+						bucket_name_green: @bucket_name_green,
+						bucket_name_blue: @bucket_name_blue,
+						logging_bucket: @logging_bucket,
+						state_bucket: @state_bucket,
+						region: @region,
+						profile: @profile,
+						tags: @tags.stringify_keys!
+					}.stringify_keys!
+				end
+
+				def tags
+					result = []
+					@tags.each_pair do |key, val|
+						result << {key: key, value: val}
+					end
+					result
+				end
+			end
+		end
+	end
+end