microstatic 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd08335347e315687188e922153132a78b0dce44
-  data.tar.gz: 39531c9c3c43b9f69cebd090f734a46b47e4b226
+  metadata.gz: bcf8c5bbedce6a7899b24a04130c39935b24840f
+  data.tar.gz: 826eed6be7585f64afea10a9a19bf6239b52965d
 SHA512:
-  metadata.gz: 9512a0b05ee9cdea6e8d1905342a02119d7f70ca63f6480ad285b8c1486afdc87bdbd1b7aca9d4bc2cfab8ffcbaf220cc33c5e4d3f421da61610cf0fd0791ac5
-  data.tar.gz: 489f2e1b4f06d22648645b2a776b957af6f198dc6b088078e850c233e481ee2c3390e02502184f38cc568b9a39953bdc976a3d39767434aedc0c851bbb48e24d
+  metadata.gz: e2a0fbcf3b82e2187c0bee9cefe81002c9a783ef6246bd5eecaafe551dd8aaeeaa04e8b0b89c2645c65946d967a8a31c5c09c19061b38e7c87ea9e8cd4a3f0c9
+  data.tar.gz: 5987e6f0547ffec0093f29d5549aa5a76b7e0317f6a5f27aa63d48e9aa2c231b3f185cc9c178a6bd62cdb50719787ba933acfd63de809e3a98ce03db1df25ff5

data/Rakefile

@@ -1,2 +1,33 @@
 #!/usr/bin/env rake
+
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+$LOAD_PATH.unshift File.expand_path("../lib",__FILE__)
+
+namespace :spec do
+  desc "run unit specs"
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.pattern = "spec/unit/**/*_spec.rb"
+  end
+
+  desc "run integration specs (requires AWS creds)"
+  RSpec::Core::RakeTask.new(:integration) do |task|
+    task.pattern = "spec/integration/**/*_spec.rb"
+  end
+
+  require 'microstatic/rake'
+  desc "do a test s3 deploy to a hard-coded test bucket"
+  Microstatic::Rake.s3_deploy_task(:test_s3_deploy) do |task|
+    task.bucket_name = '1.microstatic-test-bucket.thepete.net'
+    task.source_dir = 'spec/integration/fixtures'
+    task.exclude = %r|subdir|
+  end
+
+  desc "setup a new AWS site [here for manual testing purposes]"
+  Microstatic::Rake.aws_site_setup_task do |task|
+  end
+
+end
+
+task :default => 'spec:unit'

data/lib/microstatic/rake.rb

@@ -1,51 +1,5 @@
 require 'rake'
 require 'rake/tasklib'
 
-module Microstatic module Rake
-
-class S3DeployTask < ::Rake::TaskLib
-  attr_accessor :name, :bucket_name, :source_dir, :exclude, :aws_access_key_id, :aws_secret_access_key
-
-  def initialize( opts = {} )
-    if opts.is_a?(String) || opts.is_a?(Symbol)
-      opts = { name: opts }
-    end
-
-    @name = opts.fetch( :name ) { :s3deploy }
-    @aws_access_key_id = opts.fetch( :aws_access_key_id ) { ENV.fetch('AWS_ACCESS_KEY_ID',false) }
-    @aws_secret_access_key = opts.fetch( :aws_secret_access_key ) { ENV.fetch('AWS_SECRET_ACCESS_KEY',false) }
-    @bucket_name = opts.fetch( :bucket_name, false )
-    @source_dir = opts.fetch( :source_dir, false )
-    @exclude = opts.fetch( :exclude, false )
-  end
-
-  def define
-    require 'microstatic'
-
-    raise 'must specify bucket_name' unless bucket_name
-    raise 'must specify source_dir' unless source_dir
-
-    desc "deploy to the '#{bucket_name}' S3 bucket" unless ::Rake.application.last_comment
-    task name do
-
-      raise 'must specify aws_access_key_id' unless aws_access_key_id
-      raise 'must specify aws_secret_access_key' unless aws_secret_access_key
-      aws_creds = {
-        :access_key_id => aws_access_key_id,
-        :secret_access_key => aws_secret_access_key
-      }
-
-      deployer = Microstatic::S3Deployer.build( source_dir, bucket_name, aws_creds )
-      deployer.exclude_files(@exclude) if @exclude
-      deployer.upload
-    end
-  end
-end
-
-def self.s3_deploy_task(opts = {})
-  task = S3DeployTask.new( opts )
-  yield task if block_given?
-  task.define
-end
-
-end end
+require "microstatic/rake/s3_deployer_task"
+require "microstatic/rake/aws_site_setup_task"

data/lib/microstatic/rake/aws_site_setup_task.rb

@@ -0,0 +1,42 @@
+require 'microstatic/rake/task_environment'
+
+module Microstatic module Rake
+
+class AwsSiteSetupTask < ::Rake::TaskLib
+  def initialize(task_env)
+    @task_env = task_env
+  end
+
+  def define
+    require 'microstatic'
+
+    te = @task_env
+
+    desc "set up S3 bucket and Route53 DNS entry for a new site" unless ::Rake.application.last_comment
+    task te.task_name_or('aws_site_setup'), :site_name, :hosted_zone do |t,args|
+      site_name = args[:site_name]
+      hosted_zone = args.with_defaults(:hosted_zone => false)[:hosted_zone]
+
+      # TODO: check site_name looks like a site name (e.g. foo.thepete.net, not just foo)
+      site_name or raise "you must provide a site_name parameter to this rake task"
+
+      te.check_for_aws_creds!
+      
+
+      # TODO: check it doesn't already exist for you
+      # TODO: handle the bucket name already being taken by someone else
+      S3BucketCreator.new( te.aws_creds ).create( site_name )
+      
+      # TODO: handle DNS record already existing
+      Route53Dns.new( te.aws_creds ).add_s3_record_for_bucket( site_name, hosted_zone )
+    end
+  end
+end
+
+def self.aws_site_setup_task(opts = {})
+  task_env = TaskEnvironment.new(opts)
+  yield task_env if block_given?
+  AwsSiteSetupTask.new( task_env ).define
+end
+
+end end

data/lib/microstatic/rake/s3_deployer_task.rb

@@ -0,0 +1,33 @@
+require 'microstatic/rake/task_environment'
+
+module Microstatic module Rake
+
+class S3DeployTask < ::Rake::TaskLib
+  def initialize(task_env)
+    @task_env = task_env
+  end
+
+  def define
+    require 'microstatic'
+
+    te = @task_env
+    te.check_for_mandatory_opts!
+
+    desc "deploy to the '#{te.bucket_name}' S3 bucket" unless ::Rake.application.last_comment
+    task te.task_name_or('s3deploy') do
+
+      te.check_for_aws_creds!
+      deployer = Microstatic::S3Deployer.build( te.source_dir, te.bucket_name, te.aws_creds )
+      deployer.exclude_files(te.exclude) if te.exclude
+      deployer.upload
+    end
+  end
+end
+
+def self.s3_deploy_task(opts = {})
+  task_env = TaskEnvironment.new(opts)
+  yield task_env if block_given?
+  S3DeployTask.new( task_env ).define
+end
+
+end end

data/lib/microstatic/rake/task_environment.rb

@@ -0,0 +1,65 @@
+module Microstatic module Rake
+
+class TaskEnvironment
+  def initialize( opts, env = ENV )
+    if opts.is_a?(String) || opts.is_a?(Symbol)
+      opts = { name: opts }
+    end
+
+    @opts = opts
+    @env = env
+  end
+
+  def task_name_or(default)
+    @opts.fetch(:name,default)
+  end
+
+  def bucket_name
+    @opts.fetch(:bucket_name)
+  end
+  def bucket_name=(bn)
+    @opts[:bucket_name] = bn
+  end
+
+  def source_dir
+    @opts.fetch(:source_dir)
+  end
+  def source_dir=(sd)
+    @opts[:source_dir] = sd
+  end
+
+  def exclude
+    @opts.fetch( :exclude, false )
+  end
+  def exclude=(e)
+    @opts[:exclude] = e
+  end
+
+  def aws_access_key_id
+    @opts.fetch(:aws_access_key_id) { @env.fetch("AWS_ACCESS_KEY_ID") }
+  end
+
+  def aws_secret_access_key
+    @opts.fetch(:aws_secret_access_key) { @env.fetch("AWS_SECRET_ACCESS_KEY") }
+  end
+
+  def aws_creds
+    {
+      access_key_id: aws_access_key_id,
+      secret_access_key: aws_secret_access_key
+    }
+  end
+
+  def check_for_mandatory_opts!
+    bucket_name rescue raise "must provide a bucket_name"
+    source_dir rescue raise "must provide a source_dir"
+    true
+  end
+
+  def check_for_aws_creds! 
+    aws_access_key_id rescue raise "must provide an aws access key id either via an :aws_access_key_id opt or an AWS_ACCESS_KEY_ID environment variable"
+    aws_secret_access_key rescue raise "must provide an aws secret access key either via an :aws_secret_access_key opt or an AWS_SECRET_ACCESS_KEY environment variable"
+  end
+end
+
+end end

data/lib/microstatic/route53_dns.rb

@@ -7,10 +7,10 @@ class Route53Dns
     check_and_store_aws_creds(aws_creds)
   end
 
-  def add_s3_record_for_bucket( bucket_name, hostname = false )
-    subdomain ||= bucket_name
+  def add_s3_record_for_bucket( bucket_name, zone_name = false )
+    subdomain = bucket_name
+    zone = lookup_zone(zone_name || guess_zone_from_subdomain(subdomain) )
 
-    zone = parent_zone_for_subdomain( subdomain )
     cname_value = website_endpoint_for_bucket_named( bucket_name )
 
     record = zone.records.create(
@@ -32,11 +32,15 @@ class Route53Dns
     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(".")
+  def lookup_zone( zone_name )
+    zone_name << "." unless zone_name.end_with?(".")
     dns.zones.find{ |x| x.domain == zone_name }
   end
 
+  def guess_zone_from_subdomain( subdomain )
+    subdomain.split(".")[1..-1].join(".")
+  end
+
 end
 
 end

data/lib/microstatic/version.rb

@@ -1,3 +1,3 @@
 module Microstatic
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/spec/integration/fixtures/index.html

@@ -0,0 +1 @@
+<h3>Hello world</h3>

data/spec/unit/rake_task_environment_spec.rb

@@ -0,0 +1,107 @@
+require_relative '../../lib/microstatic/rake/task_environment'
+
+module Microstatic module Rake
+
+describe TaskEnvironment do
+  let(:some_aws_access_key_id){ "SOME AWS ACCESS KEY ID" }
+  let(:some_aws_secret_access_key){ "SOME AWS SECRET ACCESS KEY" }
+  let(:valid_task_env) { TaskEnvironment.new(valid_opts,valid_env) }
+
+  let(:valid_env) { {
+    'AWS_ACCESS_KEY_ID' => some_aws_access_key_id,
+    'AWS_SECRET_ACCESS_KEY' => some_aws_secret_access_key
+  } }
+
+  let(:valid_opts) { {
+    bucket_name: 'some bucket name',
+    source_dir: 'some source dir',
+  } }
+
+  def hash_except(hash,key_to_remove)
+    hash.dup.tap{ |h| h.delete(key_to_remove) }
+  end
+  def valid_opts_except(key_to_remove)
+    hash_except(valid_opts,key_to_remove)
+  end
+  def valid_env_except(key_to_remove)
+    hash_except(valid_env,key_to_remove)
+  end
+
+  it 'exposes the bucket name' do
+    expect( valid_task_env.bucket_name ).to eq('some bucket name')
+  end
+
+  it 'allows updating the bucket name' do
+    valid_task_env.bucket_name = 'new bucket name'
+    expect(valid_task_env.bucket_name).to eq('new bucket name')
+  end
+
+  it 'exposes the source dir' do
+    expect( valid_task_env.source_dir ).to eq('some source dir')
+  end
+
+  describe 'check_for_mandatory_opts!' do
+    it 'does nothing when everything is legit' do
+      expect{ valid_task_env.check_for_mandatory_opts! }.to_not raise_error
+    end
+
+    it 'reports missing bucket_name' do
+      task_env = TaskEnvironment.new( valid_opts_except(:bucket_name), valid_env )
+      expect{ task_env.check_for_mandatory_opts! }.to raise_error('must provide a bucket_name')
+    end
+
+    it 'reports missing source_dir' do
+      task_env = TaskEnvironment.new( valid_opts_except(:source_dir), valid_env )
+      expect{ task_env.check_for_mandatory_opts! }.to raise_error('must provide a source_dir')
+    end
+
+    it 'does not check for aws creds in env' do
+    end
+  end
+
+  describe 'check_for_aws_creds!' do
+    it 'reports missing aws access key id' do
+      task_env = TaskEnvironment.new( valid_opts,valid_env_except("AWS_ACCESS_KEY_ID") )
+      expect{ task_env.check_for_aws_creds! }.to raise_error('must provide an aws access key id either via an :aws_access_key_id opt or an AWS_ACCESS_KEY_ID environment variable')
+    end
+    it 'reports missing aws secret access key' do
+      task_env = TaskEnvironment.new( valid_opts,valid_env_except("AWS_SECRET_ACCESS_KEY") )
+      expect{ task_env.check_for_aws_creds! }.to raise_error('must provide an aws secret access key either via an :aws_secret_access_key opt or an AWS_SECRET_ACCESS_KEY environment variable')
+    end
+  end
+
+  it 'exposes aws creds from env' do
+    expect( valid_task_env.aws_access_key_id ).to eq(some_aws_access_key_id)
+    expect( valid_task_env.aws_secret_access_key ).to eq(some_aws_secret_access_key)
+  end
+
+  it 'exposes combined aws creds' do
+    expect(valid_task_env.aws_creds).to eq({
+      access_key_id: some_aws_access_key_id,
+      secret_access_key: some_aws_secret_access_key
+    })
+  end
+
+  describe 'when aws creds specified in opts' do
+    let( :opts_with_access_key ) { valid_opts.merge( aws_access_key_id: 'overridden access key id', aws_secret_access_key: 'overridden secret access key' ) }
+    let( :task_env ) { TaskEnvironment.new(opts_with_access_key,valid_env) }
+
+    it 'exposes aws creds from opts, not to env' do
+      expect(task_env.aws_access_key_id).to eq('overridden access key id')
+      expect(task_env.aws_secret_access_key).to eq('overridden secret access key')
+    end
+  end
+
+  describe '#task_name' do
+    it 'exposes what was in opts' do
+      task_env = TaskEnvironment.new(valid_opts.merge(name:'specified task name'),valid_env)
+      expect(task_env.task_name_or('default name')).to eq('specified task name')
+    end
+
+    it 'uses default if nothing in opts' do
+      expect( valid_task_env.task_name_or('default name') ).to eq('default name')
+    end
+  end
+end
+
+end end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: microstatic
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Pete Hodgson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
@@ -127,6 +127,9 @@ files:
 - lib/microstatic/cli.rb
 - lib/microstatic/config.rb
 - lib/microstatic/rake.rb
+- lib/microstatic/rake/aws_site_setup_task.rb
+- lib/microstatic/rake/s3_deployer_task.rb
+- lib/microstatic/rake/task_environment.rb
 - lib/microstatic/route53_dns.rb
 - lib/microstatic/s3_bucket_creator.rb
 - lib/microstatic/s3_deployer.rb
@@ -135,6 +138,7 @@ files:
 - lib/microstatic/version.rb
 - microstatic.gemspec
 - spec/integration/fixtures/example_file.txt
+- spec/integration/fixtures/index.html
 - spec/integration/fixtures/subdir/another_file.txt
 - spec/integration/fixtures/subdir/foo.txt
 - spec/integration/fixtures/subdir/ignored/ignored-file.txt
@@ -142,6 +146,7 @@ files:
 - spec/integration/fixtures/symlink.txt
 - spec/integration/spec_helper.rb
 - spec/integration/upload_to_test_bucket_spec.rb
+- spec/unit/rake_task_environment_spec.rb
 - templates/Rakefile.erb
 homepage: https://github.com/moredip/microstatic
 licenses: []
@@ -168,6 +173,7 @@ specification_version: 4
 summary: Generate static sites from git and deploy them to an S3 bucket.
 test_files:
 - spec/integration/fixtures/example_file.txt
+- spec/integration/fixtures/index.html
 - spec/integration/fixtures/subdir/another_file.txt
 - spec/integration/fixtures/subdir/foo.txt
 - spec/integration/fixtures/subdir/ignored/ignored-file.txt
@@ -175,3 +181,4 @@ test_files:
 - spec/integration/fixtures/symlink.txt
 - spec/integration/spec_helper.rb
 - spec/integration/upload_to_test_bucket_spec.rb
+- spec/unit/rake_task_environment_spec.rb