shoots_deploy 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79d13fd6c4fa3127ce86095f866d6d8324f9db76
+  data.tar.gz: 35d1408dc58021e7e1fe05ae81061f2949911336
+SHA512:
+  metadata.gz: 3f3450e8b9bce9956015dd4736fe7b4a1e8628e0755f80f2b4db7fe614b037e4ce3822842c1afb34f4b001582e50ac419db8b3303baa5be38660de61f70ffb6d
+  data.tar.gz: efc64f14c2b23fe56bc443a042585b97bd871dc125ebecb64cd80b2de7659a5742d231f4024d48a3f21b57f6e1bfb36467188433b25a131b7fd95b7c5c1fae5d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shoots_deploy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Josh Teng
+
+MIT License
+
+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,31 @@
+# Shoots Deploy
+
+##Deploying websites the sucky old ways
+The amount of work it takes to deploy static websites these days just isn't as fast and simple as it should be. You either use FTP or SCP or some paid hosted service such as the excellent `Brace.io`.
+
+I personally love hosting my static websites on Amazon S3 because it's ridiculously cheap and flexible. It's not slow and it allows for multiple regions.
+
+##ShootsDeploy - The quick and simple way
+This gem allows you to deploy static websites to your Amazon S3 by simply typing in command line in the root directory of your site.
+
+```
+shoots
+```
+
+Bam! In 30 seconds your site is live and/or updated!
+
+Scenarios
+  - Deployed before √
+  - custom domain with r53 with root domain √
+  - custom domain with r53 with no root domain √
+  - custom domain with no r53 √
+  - no custom domain √
+
+Edge cases not accounted for
+  - Bucket name taken
+
+##To do:
+1. Test `http://www.smashingmagazine.com/2014/04/08/how-to-build-a-ruby-gem-with-bundler-test-driven-development-travis-ci-and-coveralls-oh-my/`
+2. Documentation `http://guides.rubygems.org/make-your-own-gem/#documenting-code`
+3. Refactor
+4. Rename to `ShootDeploy`?

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/shoots

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'shoots_deploy'
+ShootsDeploy.deploy

data/lib/shoots_deploy/bucket.rb

@@ -0,0 +1,69 @@
+require 'aws-sdk'
+
+class ShootsDeploy::Bucket
+  attr_accessor :configuration
+
+  def initialize(bucket_name)
+    @name = bucket_name
+    s3 = AWS::S3.new
+    @s3_bucket = s3.buckets[bucket_name]
+  end
+
+  def self.initialize_with_name(bucket_name)
+    puts "\nCreating bucket with name #{bucket_name}"
+    s3 = AWS::S3.new
+    s3.buckets.create(bucket_name)
+    new(bucket_name)
+  end
+
+  def configure_policy
+    @s3_bucket.policy = AWS::S3::Policy.from_json("{\"Version\":\"2008-10-17\",\"Id\":\"d1b38dd800704a01924bef9a0b40f05f\",\"Statement\":[{\"Sid\":\"Allow Public Access to All Objects\",\"Effect\":\"Allow\",\"Principal\":{\"AWS\":[\"*\"]},\"Resource\":[\"arn:aws:s3:::#{@name}/*\"],\"Action\":[\"s3:GetObject\"]}]}")
+  end
+
+  def configure_to_serve_website
+    print "\nWhat is your index document? eg. index.html or home.html: "
+    index_document = gets.chomp
+    index_document = index_document.empty? ? 'index.html' : index_document
+
+    print "\nWhat is your error document? eg. 404.html or error.html: "
+    error_document = gets.chomp
+    error_document = error_document.empty? ? '404.html' : error_document
+
+    @s3_bucket.configure_website do |cfg|
+      cfg.index_document_suffix = index_document
+      cfg.error_document_key = error_document
+    end
+  end
+
+  #for secondary buckets
+  def redirect_traffic
+    puts "\nRedirecting secondary bucket's traffic to #{configuration.root_domain}"
+    @s3_bucket.website_configuration = AWS::S3::WebsiteConfiguration.new(redirect_all_requests_to: { host_name: configuration.root_domain })
+  end
+
+  def upload_files_from(folder_absolute_path)
+    puts "\nUploading all files in #{folder_absolute_path}"
+    Dir.glob(folder_absolute_path + '/**/**') do |file|
+      next if File.directory?(file)
+      configuration_file_regex = "#{ShootsDeploy::Configuration::CONFIG_FILE}"
+      configuration_file_regex = Regexp.new(configuration_file_regex)
+      next if file.match(configuration_file_regex)
+
+      folder_absolute_path_regex = folder_absolute_path + "/"
+      file_relative_path = file.gsub(folder_absolute_path_regex, '')
+      puts "Uploading #{file_relative_path}....."
+      obj = @s3_bucket.objects[file_relative_path]
+      obj.write(Pathname.new(file))
+    end
+
+    puts "\nFinish uploading!"
+  end
+
+  def sync_site_with(folder_absolute_path)
+    puts "\nDeleting old files..."
+    @s3_bucket.clear!
+    puts "\nUploading new files..."
+    upload_files_from(folder_absolute_path)
+    puts "\nSite updated!"
+  end
+end

data/lib/shoots_deploy/configuration.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+class ShootsDeploy::Configuration
+  attr_accessor :main_bucket_name, :secondary_bucket_name, :region, :root_domain, :subdomain, :subdomain_url, :secret_key, :access_key
+
+  CONFIG_FILE = "shoots.yml"
+
+  def initialize(options = {})
+    @main_bucket_name = options[:main_bucket_name]
+    @region = options[:region]
+    @secret_key = options[:secret_key]
+    @access_key = options[:access_key]
+  end
+
+  def self.initialize_from_file
+    configs = YAML.load_file(CONFIG_FILE)
+    new({
+      main_bucket_name: configs['bucket_name'],
+      region: configs['bucket_region'],
+      secret_key: configs['secret_key'],
+      access_key: configs['access_key']
+      })
+  end
+
+  def create_config_file
+    config_file = File.new(CONFIG_FILE, "w")
+    config_file.puts("bucket_name: '#{main_bucket_name}'\nbucket_region: '#{region}'\naccess_key: '#{access_key}'\nsecret_key: '#{secret_key}'\n")
+  end
+
+  def s3_website_endpoint
+    "#{main_bucket_name}.s3-website-#{region}.amazonaws.com"
+  end
+end

data/lib/shoots_deploy/hosted_zone.rb

@@ -0,0 +1,32 @@
+require 'aws-sdk'
+
+class ShootsDeploy::HostedZone
+  attr_accessor :configuration
+
+  def initialize(configuration)
+    r53 = AWS::Route53.new
+    @configuration = configuration
+    @hosted_zone = r53.hosted_zones.create(configuration.root_domain)
+  end
+
+  def configure_alias_record
+    @hosted_zone.rrsets.create(configuration.root_domain, 'A', alias_target: {
+      dns_name: "s3-website-#{configuration.region}.amazonaws.com",
+      evaluate_target_health: false,
+      hosted_zone_id: AWS::Route53::HostedZone::S3_HOSTED_ZONE_IDS[configuration.region]
+    })
+  end
+
+  def configure_cname_record
+    @hosted_zone.rrsets.create(configuration.subdomain_url, 'CNAME', :ttl => 300, :resource_records => [{:value => "#{configuration.subdomain_url}.s3-website-#{configuration.region}.amazonaws.com"}])
+
+  end
+
+  def transfer_existing_dns_settings
+    puts "pending implementation"
+  end
+
+  def ns_resource_records
+    @hosted_zone.resource_record_sets.to_a.reject { |r| r.type != 'NS' }[0].resource_records.map { |v| v[:value].gsub(/[.]$/, '') }
+  end
+end

data/lib/shoots_deploy/version.rb

@@ -0,0 +1,3 @@
+module ShootsDeploy
+  VERSION = "0.9.0"
+end

data/lib/shoots_deploy.rb

@@ -0,0 +1,188 @@
+require "shoots_deploy/version"
+require "shoots_deploy/configuration"
+require "shoots_deploy/hosted_zone"
+require "shoots_deploy/bucket"
+
+module ShootsDeploy
+  def self.deploy
+    if deployed_before?
+      configuration = Configuration.initialize_from_file
+      initialize_aws(region: configuration.region, secret_key: configuration.secret_key, access_key: configuration.access_key)
+      bucket = Bucket.new(configuration.main_bucket_name)
+      bucket.sync_site_with(Dir.pwd)
+    else
+      access_key = get_access_key
+      secret_key = get_secret_key
+      region = select_region
+
+      configuration = Configuration.new(region: region, access_key: access_key, secret_key: secret_key)
+
+      initialize_aws(region: configuration.region, secret_key: configuration.secret_key, access_key: configuration.access_key)
+
+      if use_custom_domain? && use_route_53?
+        configuration.root_domain = get_root_domain
+        configuration.subdomain = get_subdomain
+        hosted_zone = HostedZone.new(configuration)
+
+        if use_root_domain_with_route_53?(configuration) #this also makes the root domain as the primary url to the site
+          configuration.main_bucket_name = configuration.root_domain
+          configuration.secondary_bucket_name = configuration.subdomain + '.' +configuration.root_domain
+          configuration.subdomain_url = configuration.secondary_bucket_name
+
+          create_configure_populate_main_bucket(configuration)
+
+          secondary_bucket = Bucket.initialize_with_name(configuration.secondary_bucket_name)
+          secondary_bucket.configuration = configuration
+          secondary_bucket.redirect_traffic
+
+          hosted_zone.configure_alias_record
+          hosted_zone.configure_cname_record
+
+        else #no root domain
+          configuration.main_bucket_name = configuration.subdomain + '.' + configuration.root_domain
+          configuration.subdomain_url = configuration.main_bucket_name
+
+          create_configure_populate_main_bucket(configuration)
+
+          hosted_zone.configure_cname_record
+        end
+
+        #prompt user to set up Route 53 as their DNS
+        puts "\nSet up your domain to use the Amazon Route 53 as your DNS by changing to the following nameservers:"
+        puts hosted_zone.ns_resource_records
+
+        notify_user_of_temporary_s3_url(configuration)
+
+      elsif use_custom_domain? #no Amazon Route 53, own DNS like cloudflare
+        configuration.subdomain_url = configuration.main_bucket_name = get_url
+
+        create_configure_populate_main_bucket(configuration)
+
+        #prompt user to set up DNS server
+        puts "\nSet up your DNS with the corresponding CNAME and point it to `#{configuration.s3_website_endpoint}`.\nIf you want your root domain to be redirected to this website, set up the necessary redirection rules."
+
+        notify_user_of_temporary_s3_url(configuration)
+
+      else #no custom domain
+        configuration.main_bucket_name = get_site_name
+
+        create_configure_populate_main_bucket(configuration)
+
+        puts "\nYou can see your website at #{configuration.s3_website_endpoint}"
+      end
+      configuration.create_config_file
+    end
+  end
+
+  #ancilliary methods
+  def self.deployed_before?
+    File.exist?(Dir.pwd + '/' + Configuration::CONFIG_FILE)
+  end
+
+  def self.initialize_aws(region: nil, access_key: nil, secret_key: nil)
+    AWS.config(access_key_id: access_key, secret_access_key: secret_key, region: region)
+  end
+
+  def self.create_configure_populate_main_bucket(configuration, directory: Dir.pwd)
+    main_bucket = Bucket.initialize_with_name(configuration.main_bucket_name)
+    main_bucket.upload_files_from(directory)
+    main_bucket.configure_policy
+    main_bucket.configure_to_serve_website
+  end
+
+  def self.select_region
+    while true
+      puts "\nSelect your region eg."
+      AWS.regions.to_a.each_with_index { |r, i| puts "#{i+1}. #{r.name}" }
+      print "\nType the number of the region: "
+      region_index = gets.chomp.to_i - 1
+      selected_region = AWS.regions.map { |r| r.name }[region_index]
+      print "\nYou have selected #{selected_region}.\nIs that right? (y/n): "
+      confirmation = gets.chomp
+      break selected_region if confirmation == 'y' #must have break because while loop returns nil with a break it returns selected_region
+    end
+  end
+
+  def self.get_access_key
+    print "\nWhat's your AWS access key? "
+
+    while access_key.empty?
+      access_key = gets.chomp
+    end
+
+    access_key
+  end
+
+  def self.get_secret_key
+    print "\nWhat's your AWS secret key? "
+
+    while secret_key.empty?
+      secret_key = gets.chomp
+    end
+
+    secret_key
+  end
+
+  def self.use_custom_domain?
+    @custom_domain = @custom_domain || get_user_confirmation("Do you want to use a custom domain for your site? (type y/n)")
+    @custom_domain == 'y'
+  end
+
+  def self.use_route_53?
+    use_route_53 = get_user_confirmation("Do you want to use AWS Route 53 as your DNS provider? (type y/n)")
+    use_route_53 == 'y'
+  end
+
+  def self.use_root_domain_with_route_53?(configuration)
+    use_root_domain = get_user_confirmation("Do you want to use your root domain, #{configuration.root_domain} for this site? (type y/n)")
+    use_root_domain == 'y'
+  end
+
+  def self.get_root_domain
+    prompt = "What is your root domain? eg. example.com"
+    confirmation_message = "You root domain is"
+    get_user_input_with_prompt(prompt, confirmation_message: confirmation_message)
+  end
+
+  def self.get_subdomain
+    prompt = "What is your preferred subdomain? eg. www or hello"
+    confirmation_message = "Your preferred subdomain is"
+    get_user_input_with_prompt(prompt, confirmation_message: confirmation_message)
+  end
+
+  def self.get_url
+    prompt = "What will your website URL be? eg. www.example.com"
+    confirmation_message = "Your website's url will be"
+    get_user_input_with_prompt(prompt, confirmation_message: confirmation_message)
+  end
+
+  def self.get_site_name
+    prompt = "What is the name of your site? (something unique to prevent S3 bucket name clashing)"
+    confirmation_message = "Your site name is"
+    get_user_input_with_prompt(prompt, confirmation_message: confirmation_message)
+  end
+
+  def self.get_user_input_with_prompt(prompt, confirmation_message: "You entered")
+    while true
+      print "\n#{prompt}: "
+      input = gets.chomp
+      print "\n#{confirmation_message} #{input}. Is that right? (y/n): "
+      confirmation = gets.chomp
+      break input if confirmation == 'y'
+    end
+  end
+
+  def self.get_user_confirmation(prompt)
+    while true
+      print "\n#{prompt}: "
+      input = gets.chomp
+      print "\nAre you sure? (y/n): "
+      confirmation = gets.chomp
+      break input if confirmation == 'y'
+    end
+  end
+
+  def self.notify_user_of_temporary_s3_url(configuration)
+    puts "\nIn the meantime, you can see your website at #{configuration.s3_website_endpoint}"
+  end
+end

data/shoots_deploy.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shoots_deploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shoots_deploy"
+  spec.version       = ShootsDeploy::VERSION
+  spec.authors       = ["Josh Teng"]
+  spec.email         = ["joshteng@webermize.com"]
+  spec.summary       = %q{Deploy static websites to Amazon S3}
+  spec.description   = %q{Deploy your website to Amazon S3 within seconds easily and simply from your command line.}
+  spec.homepage      = "http://joshteng.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency 'aws-sdk', '~> 1.50.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: shoots_deploy
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Josh Teng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.50.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.50.0
+description: Deploy your website to Amazon S3 within seconds easily and simply from
+  your command line.
+email:
+- joshteng@webermize.com
+executables:
+- shoots
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/shoots
+- lib/shoots_deploy.rb
+- lib/shoots_deploy/bucket.rb
+- lib/shoots_deploy/configuration.rb
+- lib/shoots_deploy/hosted_zone.rb
+- lib/shoots_deploy/version.rb
+- shoots_deploy.gemspec
+homepage: http://joshteng.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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Deploy static websites to Amazon S3
+test_files: []