microstatic 0.5.0 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae9e8c819afc46577034785b6ddd5d5a92630c3f
+  data.tar.gz: 500fff96e94b01479e8f0940ef2cbe6aded8a332
+SHA512:
+  metadata.gz: cc991b82b2aa63a200e9e228294c5849f49dd78e884fed0ab212a7027db8ff342db17061ed8c411dde22eb4e1c6b8c492e229ae57cbd6e4684ed8d87a8500dcf
+  data.tar.gz: db96cf7cacc0bfb239491e7580d2707e78cba806b52eb0af7b5d1cb392f06653fd65cbeb69fed14df08ced646ba6d01423ee3c075fe9cfe1f05183e7d6012dbf

data/.gitignore

@@ -16,4 +16,6 @@ test/tmp
 test/version_tmp
 tmp
 
+/vendor/bundle
+
 /.creds

data/README.md

@@ -1,11 +1,26 @@
 # Microstatic
 
-The microstatic gem turns generating your static site and deploying it to S3 into a one-liner.
+The microstatic gem turns generating your static site and deploying it to S3 into a one-liner. There's [a blog post](http://blog.thepete.net/blog/2014/01/17/microstatic-radically-simple-static-microsites/) with more details on the what and the why.
+
+Microstatic does two things. Firstly it provides a command-line tool that makes it ridiculously simple to create a new microsite. Secondly it provides a rake task that makes it ridiculously simple to push new content to the microsite.
+
+## Creating a new microsite
+
+`microstatic setup` and you’re done. This will create a new S3 bucket to hold your microsite, and then add a Route 53 entry to wire that S3 bucket up to a subdomain.
+
+## Deploying content to your microsite
+
+`rake deploy` and you’re done. Microstatic ships with a rake task that will sync your local contents with the S3 bucket hosting your site.
+
+## Demo time!
+
+<iframe src="//player.vimeo.com/video/84530116" width="500" height="375" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe> <p><a href="http://vimeo.com/84530116">Microstatic: setup a static subdomain microsite in < 30 seconds</a> from <a href="http://vimeo.com/user5163505">Pete Hodgson</a> on <a href="https://vimeo.com">Vimeo</a>.</p>
+
+
 
 ## Credits
 
 The s3 deployment code was originally written by [Giles Alexander](http://twitter.com/gga)
 
 ## TODO
-- specify MICROSTATIC_SITE_NAME and cloud creds using dot file
-- 
+* specify MICROSTATIC_SITE_NAME and cloud creds using dot file

data/lib/microstatic.rb

@@ -3,6 +3,7 @@ require "microstatic/version"
 require 'microstatic/config'
 require 'microstatic/uses_fog'
 
+require "microstatic/uploader"
 require "microstatic/s3_deployer"
 require "microstatic/s3_bucket_creator"
 require "microstatic/route53_dns"

data/lib/microstatic/rake.rb

@@ -12,8 +12,8 @@ class S3DeployTask < ::Rake::TaskLib
     end
 
     @name = opts.fetch( :name ) { :s3deploy }
-    @aws_access_key_id = opts.fetch( :aws_access_key_id ) { ENV.fetch('AWS_ACCESS_KEY_ID') }
-    @aws_secret_access_key = opts.fetch( :aws_secret_access_key ) { ENV.fetch('AWS_SECRET_ACCESS_KEY') }
+    @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 )
@@ -24,18 +24,19 @@ class S3DeployTask < ::Rake::TaskLib
 
     raise 'must specify bucket_name' unless bucket_name
     raise 'must specify source_dir' unless source_dir
-    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
-    }
 
     desc "deploy to the '#{bucket_name}' S3 bucket" unless ::Rake.application.last_comment
     task name do
-      deployer = Microstatic::S3Deployer.new( source_dir, bucket_name, aws_creds )
-      deployer.file_list.exclude(@exclude) if @exclude
+
+      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

data/lib/microstatic/s3_deployer.rb

@@ -3,64 +3,29 @@ require 'pathname'
 require 'rake/file_list'
 
 module Microstatic
-
-# The following is based on code generously 
-# shared by Giles Alexander (@gga)
 class S3Deployer
-  include UsesFog
-
-  attr_reader :file_list # TODO: don't expose this directly
 
-  def initialize( local_dir, bucket, aws_creds )
-    check_and_store_aws_creds(aws_creds)
+  def self.build( local_dir, bucket, aws_creds )
+    uploader = Uploader.new( local_dir, bucket, aws_creds )
+    new( local_dir, uploader )
+  end
 
+  def initialize( local_dir, uploader )
     @local_dir = Pathname.new(local_dir)
     @file_list = ::Rake::FileList.new( (@local_dir+"**/*").to_s )
-    @bucket = bucket
+    @uploader = uploader
+  end
+
+  def exclude_files(*args)
+    @file_list.exclude(*args)
   end
 
   def upload
     @file_list.each do |entry|
       entry = Pathname.new(entry)
-      upload_file(entry) unless entry.directory?
+      @uploader.upsert_filepath(entry) unless entry.directory?
     end
   end
 
-  def upload_file( file )
-    s3_key = file.relative_path_from(@local_dir).to_s
-
-    begin
-      s3_object = connection.head_object(@bucket,s3_key)
-    rescue Excon::Errors::NotFound
-      s3_object = false
-    end
-
-    if !s3_object
-      log_action('CREATE', s3_key)
-      put_file( s3_key, file )
-    else
-      s3_md5 = s3_object.headers['ETag'].sub(/"(.*)"/,'\1')
-      local_md5 = Digest::MD5.hexdigest( file.read )
-
-      if( s3_md5 == local_md5 )
-        log_action('NO CHANGE', s3_key)
-      else
-        log_action('UPDATE', s3_key)
-        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
-  end
 end
-
 end

data/lib/microstatic/uploader.rb

@@ -0,0 +1,64 @@
+require 'pathname'
+
+module Microstatic
+
+class Uploader
+  include UsesFog
+
+  def initialize( base_dir, bucket, aws_creds )
+    check_and_store_aws_creds(aws_creds)
+    @bucket = bucket
+    @base_dir = Pathname.new(base_dir)
+  end
+
+  def upsert_filepath( filepath )
+    pathname = Pathname.new(filepath) 
+    s3_key = relative_path_for(pathname)
+
+    begin
+      s3_object = connection.head_object(@bucket,s3_key)
+    rescue Excon::Errors::NotFound
+      s3_object = false
+    end
+
+    if s3_object
+      update_object_if_changed(s3_key, pathname,s3_object)
+    else
+      create_object(s3_key, pathname)
+    end
+  end
+
+  private
+
+  def create_object(s3_key, pathname)
+    log_action('CREATE', s3_key)
+    put_file( s3_key, pathname )
+  end
+
+  def update_object_if_changed(s3_key, pathname,s3_object)
+    s3_md5 = s3_object.headers['ETag'].sub(/"(.*)"/,'\1')
+    local_md5 = Digest::MD5.hexdigest( pathname.read )
+
+    if( s3_md5 == local_md5 )
+      log_action('NO CHANGE', s3_key)
+    else
+      log_action('UPDATE', s3_key)
+      put_file( s3_key, pathname )
+    end
+  end
+
+  def relative_path_for(pathname)
+    pathname.relative_path_from(@base_dir).to_s
+  end
+
+  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
+  end
+end
+
+end

data/lib/microstatic/version.rb

@@ -1,3 +1,3 @@
 module Microstatic
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/integration/upload_to_test_bucket_spec.rb

@@ -19,8 +19,8 @@ describe 'uploading to a test bucket' do
   end
 
   it 'succeeds' do
-    deployer = S3Deployer.new( test_dir, test_bucket, aws_creds )
-    deployer.file_list.exclude(%r|ignored/|)
+    deployer = S3Deployer.build( test_dir, test_bucket, aws_creds )
+    deployer.exclude_files(%r|ignored/|)
     deployer.upload
   end
   

metadata

@@ -1,126 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: microstatic
 version: !ruby/object:Gem::Version
-  version: 0.5.0
-  prerelease: 
+  version: 0.5.1
 platform: ruby
 authors:
 - Pete Hodgson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-24 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !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: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.3
 description: The microstatic gem turns generating your static site and deploying it
@@ -132,9 +117,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .ruby-gemset
-- .ruby-version
+- ".gitignore"
 - Gemfile
 - LICENSE
 - README.md
@@ -147,6 +130,7 @@ files:
 - lib/microstatic/route53_dns.rb
 - lib/microstatic/s3_bucket_creator.rb
 - lib/microstatic/s3_deployer.rb
+- lib/microstatic/uploader.rb
 - lib/microstatic/uses_fog.rb
 - lib/microstatic/version.rb
 - microstatic.gemspec
@@ -155,38 +139,32 @@ files:
 - spec/integration/fixtures/subdir/foo.txt
 - spec/integration/fixtures/subdir/ignored/ignored-file.txt
 - spec/integration/fixtures/subdir/subsubdir/deep.txt
+- spec/integration/fixtures/symlink.txt
 - spec/integration/spec_helper.rb
 - spec/integration/upload_to_test_bucket_spec.rb
 - templates/Rakefile.erb
 homepage: https://github.com/moredip/microstatic
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1270358842069851857
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1270358842069851857
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.4.4
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generate static sites from git and deploy them to an S3 bucket.
 test_files:
 - spec/integration/fixtures/example_file.txt
@@ -194,5 +172,6 @@ test_files:
 - spec/integration/fixtures/subdir/foo.txt
 - spec/integration/fixtures/subdir/ignored/ignored-file.txt
 - spec/integration/fixtures/subdir/subsubdir/deep.txt
+- spec/integration/fixtures/symlink.txt
 - spec/integration/spec_helper.rb
 - spec/integration/upload_to_test_bucket_spec.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-microstatic

data/.ruby-version

@@ -1 +0,0 @@
-default