microstatic 0.3.0 → 0.4.0

data/README.md

@@ -5,3 +5,6 @@ The microstatic gem turns generating your static site and deploying it to S3 int
 ## Credits
 
 The s3 deployment code was originally written by [Giles Alexander](http://twitter.com/gga)
+
+## TODO
+- DONE! create Route 53 subdomain on demand

data/bin/microstatic

@@ -1,17 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'microstatic'
+require 'microstatic/cli'
 
-if ARGV.empty?
-  puts 'please specify a bucket name'
-  exit 1
-end
+require 'pry' if ENV.has_key? 'PRY_PLEASE'
 
-bucket_name = ARGV[0]
-
-bucket_creator = Microstatic::S3BucketCreator.new( Microstatic.aws_creds_from_env )
-
-puts "creating bucket #{bucket_name} ..."
-bucket_creator.create( bucket_name )
-
-puts "done"
+Microstatic::CLI.start(ARGV)

data/lib/microstatic.rb

@@ -1,9 +1,11 @@
 require "microstatic/version"
 
+require 'microstatic/config'
 require 'microstatic/uses_fog'
 
 require "microstatic/s3_deployer"
 require "microstatic/s3_bucket_creator"
+require "microstatic/route53_dns"
 
 module Microstatic
   def self.aws_creds_from_env

data/lib/microstatic/cli.rb

@@ -0,0 +1,72 @@
+require 'thor'
+require 'rainbow'
+
+module Microstatic
+  class CLI < Thor
+    desc "setup <APP_NAME>", "do the needful to get started hosting your static site. S3, Route 53, whatever it takes."
+    def setup( app_name = false )
+      app_name ||= inferred_app_name
+      bucket_name = subdomain_for(app_name)
+
+      bucket = bucket( bucket_name )
+      # TODO: pass bucket through to dns setup so we don't have to look it up again
+      dns( app_name )
+
+      # TODO: add Rakefile, Gemfile, etc for doing a rake deploy using this gem
+    end
+
+    desc "bucket <BUCKET_NAME>", "create an S3 bucket which can host your static site"
+    def bucket( bucket_name = false )
+      bucket_name ||= guess_bucket_name
+      # TODO: check it doesn't already exist for you
+      # TODO: check bucket_name looks like a site name (e.g. foo.thepete.net, not just foo)
+      # TODO: handle the bucket name already being taken by someone else
+      # TODO: fail gracefully if aws creds not available
+      
+      describe_operation( "create S3 bucket '#{bucket_name}'" ) do
+        S3BucketCreator.new( config.aws_creds ).create( bucket_name )
+      end
+    end
+
+    desc "dns <APP_NAME>", "create a Route 53 entry pointing to the S3 bucket containing your static site"
+    def dns( app_name = false )
+      app_name ||= inferred_app_name
+      bucket_name = subdomain_for(app_name)
+
+      describe_operation( "create Route 53 entry '#{bucket_name}'" ) do
+        Route53Dns.new( config.aws_creds ).add_s3_record_for_bucket( bucket_name )
+      end
+    end
+
+    private 
+
+    def guess_bucket_name
+      subdomain_for( inferred_app_name )
+    end
+
+    def subdomain_for( app_name )
+      "#{app_name}.#{config.site_name}"
+    end
+
+    def inferred_app_name
+      File.basename(Dir.pwd)
+    end
+
+    def config
+      Config.automagic
+    end
+
+    def describe_operation( operation_desc )
+      STDOUT.print "  #{operation_desc} ..."
+      yield
+      STDOUT.puts "\r- #{operation_desc}   "+CHECKMARK
+    rescue
+      STDOUT.puts "\r- #{operation_desc}   "+SADMARK
+      raise
+    end
+
+    CHECKMARK="\u2713".color(:green)
+    SADMARK="\u2718".color(:red)
+
+  end
+end

data/lib/microstatic/config.rb

@@ -0,0 +1,28 @@
+module Microstatic
+  class Config
+    def self.automagic
+      #in the future this'll try to create a config based on 
+      #various diff. files, in priority order?
+      self.new 
+    end
+
+    def site_name
+      ENV.fetch('MICROSTATIC_SITE_NAME')
+    end
+
+    def aws_creds
+      {
+        :access_key_id => aws_access_key_id,
+        :secret_access_key => aws_secret_access_key
+      }
+    end
+
+    def aws_access_key_id
+      ENV.fetch('AWS_ACCESS_KEY_ID')
+    end
+
+    def aws_secret_access_key
+      ENV.fetch('AWS_SECRET_ACCESS_KEY')
+    end
+  end
+end

data/lib/microstatic/rake.rb

@@ -39,7 +39,7 @@ class S3DeployTask < ::Rake::TaskLib
   end
 end
 
-def self.s3_deploy_task(opts)
+def self.s3_deploy_task(opts = {})
   task = S3DeployTask.new( opts )
   yield task if block_given?
   task.define

data/lib/microstatic/route53_dns.rb

@@ -0,0 +1,42 @@
+module Microstatic
+
+class Route53Dns
+  include UsesFog
+
+  def initialize( aws_creds )
+    check_and_store_aws_creds(aws_creds)
+  end
+
+  def add_s3_record_for_bucket( bucket_name, hostname = false )
+    subdomain ||= bucket_name
+
+    zone = parent_zone_for_subdomain( subdomain )
+    cname_value = website_endpoint_for_bucket_named( bucket_name )
+
+    record = zone.records.create(
+      :name => subdomain,
+      :value => cname_value,
+      :type => 'CNAME',
+      :ttl => 86400
+    )
+    record
+  end
+
+  private
+
+  def website_endpoint_for_bucket_named( bucket_name )
+    bucket = connection.directories.get(bucket_name)
+
+    # per http://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteEndpoints.html
+    #TODO: get endpoint from API, or get this logic merged into fog
+    bucket_website_endpoint = "#{bucket.key}.s3-website-#{bucket.location}.amazonaws.com"
+  end
+
+  def parent_zone_for_subdomain( subdomain )
+    zone_name = subdomain.split(".")[1..-1].push("").join(".")
+    dns.zones.find{ |x| x.domain == zone_name }
+  end
+
+end
+
+end

data/lib/microstatic/s3_bucket_creator.rb

@@ -8,9 +8,12 @@ class S3BucketCreator
   end
 
   def create( bucket_name )
-    connection.put_bucket( bucket_name )
-    connection.put_bucket_acl( bucket_name, 'public-read' )
-    connection.put_bucket_website( bucket_name, 'index.html', :key => '404.html' )
+    # TODO: can we create a new directory without eagerly fetch the list of all dirs?
+    directory = connection.directories.create( :key => bucket_name, :public => true )
+    # TODO: can I do this by calling a method on directory? 
+    connection.put_bucket_website( directory.key, 'index.html', :key => '404.html' )
+
+    directory
   end
 end
 

data/lib/microstatic/s3_deployer.rb

@@ -31,7 +31,7 @@ class S3Deployer
 
     if !s3_object
       log_action('CREATE', s3_key)
-      connection.put_object( @bucket, s3_key, file.open, 'x-amz-acl' => 'public-read' )
+      put_file( s3_key, file )
     else
       s3_md5 = s3_object.headers['ETag'].sub(/"(.*)"/,'\1')
       local_md5 = Digest::MD5.hexdigest( file.read )
@@ -40,11 +40,17 @@ class S3Deployer
         log_action('NO CHANGE', s3_key)
       else
         log_action('UPDATE', s3_key)
-        connection.put_object( @bucket, s3_key, file.open )
+        put_file( s3_key, file )
       end
     end
   end
 
+  private
+
+  def put_file( s3_key, file )
+    connection.put_object( @bucket, s3_key, file.open, 'x-amz-acl' => 'public-read', 'x-amz-storage-class' => 'REDUCED_REDUNDANCY' )
+  end
+
   def log_action(action,file)
     message = action.to_s.rjust(10) + "  " + file
     puts message

data/lib/microstatic/uses_fog.rb

@@ -10,8 +10,18 @@ module Microstatic
       @aws_creds = aws_creds
     end
 
+    # TODO: rename connection to storage
     def connection
       @_connection ||= Fog::Storage.new({
+        :provider => 'AWS',
+        :aws_access_key_id => @aws_creds.fetch(:access_key_id),
+        :aws_secret_access_key => @aws_creds.fetch(:secret_access_key),
+        :path_style => true
+      })
+    end
+    
+    def dns
+      @_dns ||= Fog::DNS.new({
         :provider => 'AWS',
         :aws_access_key_id => @aws_creds.fetch(:access_key_id),
         :aws_secret_access_key => @aws_creds.fetch(:secret_access_key)

data/lib/microstatic/version.rb

@@ -1,3 +1,3 @@
 module Microstatic
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/microstatic.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |gem|
   gem.version       = Microstatic::VERSION
 
   gem.add_runtime_dependency "fog", ">=1"
+  gem.add_runtime_dependency "thor", ">=0.15" # 0.15 is an arbitrary guess at what might be API-compatible
+  gem.add_runtime_dependency "rainbow", ">= 1.1"
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "bundler"

data/spec/integration/spec_helper.rb

@@ -1,3 +1,10 @@
 require_relative '../../lib/microstatic'
+# require_relative '../../lib/microstatic/uses_fog'
 
+if ENV['FOG_MOCK']
+  Fog.mock!
+  include Microstatic::UsesFog
+  check_and_store_aws_creds(Microstatic.aws_creds_from_env)
+  connection.directories.create(:key => 'microstatic-test-bucket')
+end
 require 'pry'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: microstatic
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2013-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +141,10 @@ files:
 - Rakefile
 - bin/microstatic
 - lib/microstatic.rb
+- lib/microstatic/cli.rb
+- lib/microstatic/config.rb
 - lib/microstatic/rake.rb
+- lib/microstatic/route53_dns.rb
 - lib/microstatic/s3_bucket_creator.rb
 - lib/microstatic/s3_deployer.rb
 - lib/microstatic/uses_fog.rb
@@ -135,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2953068700068104113
+      hash: 3071074031925254256
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -144,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2953068700068104113
+      hash: 3071074031925254256
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25