s3_website 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abf40795dc9d2a58f7c49cdca9aa4afe08719c83
-  data.tar.gz: 49ece41b838b6ca727f0f7f801633c732c4cf414
+  metadata.gz: a9306932139b739b36781d1d9adabc156bf77071
+  data.tar.gz: 8f7ab21fa137972d9e57319d537612d6ce925bed
 SHA512:
-  metadata.gz: dce2b656e14459f9cdc879ef1a37035ba97b33f9627c3b5404bc2e1a7945d79d3af9a5e5f32b532f9725488e010d76073e74d3a9d7ca70e108d3c27f5d1bfb8f
-  data.tar.gz: b494dc93e43b2c6656c7bc5495320fdd275d1ba803deb593250795e5f20a845ba32b227b8e0eec8197c1d07611ec26c810c9812c6bc548a3cf2bb5a111a48c83
+  metadata.gz: f8d6a5fc7492d1528db84043a3c565c5f637274aac5557cddf5d264dd0f62c7f5386ae48c75f067e0e108f249ee75ec9e67a5b61190ae6f1eb8d2d5d6b32feae
+  data.tar.gz: 3ffe1003b8e80128e4919434a38d1854203b2fec73702c53e1565daf06f563a886e4d9d782c870f4608a67978ed53401a3c2d3567b3bfcb2e0a9fd6bb2e83978

data/README.md

@@ -1,40 +1,40 @@
-# s3_website – Deploy your website to S3.
+# Deploy your website to S3
 
-[![Build Status](https://secure.travis-ci.org/laurilehmijoki/s3_website.png)] (http://travis-ci.org/laurilehmijoki/s3_website)
+[![Build Status](https://travis-ci.org/laurilehmijoki/s3_website.png?branch=master)](https://travis-ci.org/laurilehmijoki/s3_website)
 [![Gem Version](https://fury-badge.herokuapp.com/rb/s3_website.png)](http://badge.fury.io/rb/s3_website)
 
-## What s3_website can do for you
+## What `s3_website` can do for you
 
-* Upload your site to AWS S3
+* Create and configure an S3 website for you
+* Upload your static website to AWS S3
 * Help you use AWS Cloudfront to distribute your website
-* Create an S3 website for you
 * Improve page speed with HTTP cache control and gzipping
 * Set HTTP redirects for your website
 * (for other features, see the documentation below)
 
 ## Install
 
+<span style="color: yellow">This project is still on beta level. Expect backward
+incompatible changes.</span>
+
     gem install s3_website
 
 ## Usage
 
+Here's how you can get started:
+
 * Go to your website directory
-* Run `s3_website cfg create`. It generates a configuration file called `s3_website.yml` that looks like this:
-<pre>
-s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
-s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
-s3_bucket: your.blog.bucket.com
-</pre>
+* Run `s3_website cfg create`. It generates a configuration file called `s3_website.yml`
 * Edit it with your details (you can use [ERB](http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html) in the file)
-* Run `configure-s3-website --config-file s3_website.yml` This will configure
+* Run `s3_website cfg apply` This will configure
   your bucket to function as an S3 website. If the bucket does not exist,
-  `configure-s3-website` will create it for you.
-
+  `s3_website cfg apply` will create it for you.
 * Run `s3_website push` to push your website to S3. Congratulations! You are live.
 
-(If you are using `s3_website` on an [EC2 instance with IAM
-roles](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingIAM.html#UsingIAMrolesWithAmazonEC2Instances),
-you can omit the `s3_id` and `s3_secret` keys in the config file.)
+`s3_website` attempts to be a command-line interface tool that is easy to
+understand and use. For example, `s3_website --help` should print you all the
+things it can perform. Please create an issue if you think the tool is
+incomprehensible or inconsistent.
 
 ### Using environment variables
 
@@ -46,9 +46,15 @@ s3_secret: <%= ENV['S3_SECRET'] %>
 s3_bucket: blog.example.com
 ```
 
+(If you are using `s3_website` on an [EC2 instance with IAM
+roles](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingIAM.html#UsingIAMrolesWithAmazonEC2Instances),
+you can omit the `s3_id` and `s3_secret` keys in the config file.)
+
 ## Project goals
 
 * Provide a command-line interface tool for deploying and managing S3 websites
+ * Create commands such as `s3_website push`, `s3_website cfg create` and
+   `s3_website cfg apply`
 * Let the user have all the S3 website configurations in a file
 * Minimise or remove the need to use the AWS Console
 * Allow the user to deliver the website via CloudFront
@@ -148,13 +154,9 @@ It is easy to deliver your S3-based web site via Cloudfront, the CDN of Amazon.
 
 #### Creating a new CloudFront distribution
 
-When you run the command `configure-s3-website`, it will ask you whether you
-want to deliver your website via CloudFront. If you answer yes,
-`configure-s3-website` will create a CloudFront distribution for you.
-
-This feature was added into the version 1.3.0 of the `configure-s3-website` gem.
-For more information, see the [gem's
-documentation](https://github.com/laurilehmijoki/configure-s3-website).
+When you run the command `s3_website cfg apply`, it will ask you whether you
+want to deliver your website via CloudFront. If you answer yes, command will
+create a CloudFront distribution for you.
 
 #### Using your existing CloudFront distribution
 
@@ -168,8 +170,7 @@ thus force the CDN system to reload the changes from your website S3 bucket.
 
 #### Specifying custom settings for your CloudFront distribution
 
-The gem `configure-s3-website`, which is a dependency of `s3_website`, lets you
-define custom settings for your CloudFront distribution.
+`s3_website` lets you define custom settings for your CloudFront distribution.
 
 For example, like this you can define a your own TTL and CNAME:
 
@@ -183,9 +184,8 @@ cloudfront_distribution_config:
       CNAME: your.website.com
 ```
 
-See the [gem's
-documentation](https://github.com/laurilehmijoki/configure-s3-website) for more
-info.
+Once you've saved the configuration into `s3_website.yml`, you can apply them by
+running `s3_website cfg apply`.
 
 ### The headless mode
 
@@ -194,8 +194,7 @@ s3_website has a headless mode, where human interactions are disabled.
 In the headless mode, `s3_website` will automatically delete the files on the S3
 bucket that are not on your local computer.
 
-Enable the headless mode by adding the `--headless` or `-h` argument after
-`s3_website`.
+Enable the headless mode by adding the `--headless` argument after `s3_website`.
 
 ### Configuring redirects on your S3 website
 
@@ -235,13 +234,13 @@ routing_rules:
       http_redirect_code: 301
 ```
 
-After adding the configuration, run the command `configure-s3-website --config
-s3_website.yml` on your command-line interface. This will apply the routing
-rules on your S3 bucket.
+After adding the configuration, run the command `s3_website cfg apply` on your
+command-line interface. This will apply the routing rules on your S3 bucket.
 
 For more information on configuring redirects, see the documentation of the
 [configure-s3-website](https://github.com/laurilehmijoki/configure-s3-website#configuring-redirects)
-gem, which comes as a transitive dependency of the `s3_website` gem.
+gem, which comes as a transitive dependency of the `s3_website` gem. (The
+command `s3_website cfg apply` internally calls the `configure-s3-website` gem.)
 
 ### Using `s3_website` as a library
 

data/bin/s3_website

@@ -5,12 +5,26 @@ require File.dirname(__FILE__) + '/../lib/s3_website'
 class Cfg < Thor
   desc 'create', 'Create a config file with placeholder values'
   def create
-    S3Website::Tasks.config_create parent_options[:site]
+    S3Website::Tasks.config_create Dir.pwd
+  end
+
+  desc 'apply', 'Apply the configuration on the AWS services'
+  long_desc <<-LONGDESC
+    `s3_website cfg apply` will apply the configuration the S3 bucket.
+
+    In addition, if you CloudFront related settings, this command will apply them on the CloudFront distribution.
+
+    If the S3 bucket does not exist, this command will create it
+    and configure it to function as a website.
+  LONGDESC
+  def apply
+    puts 'Applying the configurations in s3_website.yml on the AWS services ...'
+    puts `configure-s3-website --config-file s3_website.yml`
   end
 end
 
 class Cli < Thor
-  class_option(
+  option(
     :site,
     :type => :string,
     :default => '_site',

data/changelog.md

@@ -2,6 +2,15 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
-## HEAD
+## 0.2.1
 
-* TBA
+* Remove Gemfile.lock
+* Rename gemspec file
+
+## 0.2.0
+
+* Add command `s3_website cfg apply`
+
+## 0.1.0
+
+* First version

data/lib/s3_website/config_loader.rb

@@ -12,13 +12,18 @@ s3_bucket: your.blog.bucket.com
     end
 
     # Raise NoConfigurationFileError if the configuration file does not exists
-    def self.check_s3_configuration(site_dir)
-      unless File.exists?(get_configuration_file(site_dir))
-        create_template_configuration_file site_dir
+    def self.check_s3_configuration(dir)
+      config_file = dir + '/' + CONFIGURATION_FILE
+      unless File.exists?(config_file)
+        create_template_configuration_file config_file
         raise NoConfigurationFileError
       end
     end
 
+    def self.get_configuration_file(site_dir)
+      "#{site_dir}/../#{CONFIGURATION_FILE}"
+    end
+
     private
 
     # Load configuration from s3_website.yml
@@ -28,8 +33,8 @@ s3_bucket: your.blog.bucket.com
       return config
     end
 
-    def self.create_template_configuration_file(site_dir)
-      File.open(get_configuration_file(site_dir), 'w') { |f|
+    def self.create_template_configuration_file(file)
+      File.open(file, 'w') { |f|
         f.write(CONFIGURATION_FILE_TEMPLATE)
       }
     end
@@ -48,9 +53,5 @@ s3_bucket: your.blog.bucket.com
         }
       config
     end
-
-    def self.get_configuration_file(site_dir)
-      "#{site_dir}/../#{CONFIGURATION_FILE}"
-    end
   end
 end

data/lib/s3_website/tasks.rb

@@ -2,7 +2,7 @@ module S3Website
   class Tasks
     def self.push(site_dir, in_headless_mode = false)
       ConfigLoader.check_project site_dir
-      ConfigLoader.check_s3_configuration site_dir
+      ConfigLoader.check_s3_configuration site_dir + '/../'
       config = S3Website::ConfigLoader.load_configuration site_dir
       new_files_count, changed_files_count, deleted_files_count, changed_files, changed_redirects =
         Uploader.run(site_dir, config, in_headless_mode)
@@ -20,8 +20,8 @@ module S3Website
       exit 1
     end
 
-    def self.config_create(site_dir)
-      ConfigLoader.check_s3_configuration site_dir
+    def self.config_create(dir)
+      ConfigLoader.check_s3_configuration dir
     rescue S3WebsiteError => e
       puts e.message
       exit 1

data/{s3-website.gemspec → s3_website.gemspec}

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "s3_website"
-  s.version     = "0.1.0"
+  s.version     = "0.2.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Lauri Lehmijoki"]
   s.email       = ["lauri.lehmijoki@iki.fi"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3_website
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -218,7 +218,6 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -297,7 +296,7 @@ files:
 - lib/s3_website/tasks.rb
 - lib/s3_website/upload.rb
 - lib/s3_website/uploader.rb
-- s3-website.gemspec
+- s3_website.gemspec
 - spec/lib/config_loader_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/keyboard_spec.rb

data/Gemfile.lock

@@ -1,81 +0,0 @@
-PATH
-  remote: .
-  specs:
-    s3_website (0.1.0)
-      aws-sdk (~> 1.8.5)
-      configure-s3-website (~> 1)
-      erubis (~> 2.7.0)
-      filey-diff (~> 1)
-      mime-types (= 1.19)
-      simple-cloudfront-invalidator (~> 1)
-      thor (= 0.18.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    addressable (2.3.4)
-    aruba (0.5.3)
-      childprocess (>= 0.3.6)
-      cucumber (>= 1.1.1)
-      rspec-expectations (>= 2.7.0)
-    aws-sdk (1.8.5)
-      json (~> 1.4)
-      nokogiri (>= 1.4.4)
-      uuidtools (~> 2.1)
-    builder (3.2.2)
-    childprocess (0.3.9)
-      ffi (~> 1.0, >= 1.0.11)
-    colored (1.2)
-    configure-s3-website (1.4.0)
-      deep_merge (= 1.0.0)
-    crack (0.4.0)
-      safe_yaml (~> 0.9.0)
-    cucumber (1.3.2)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12.0)
-      multi_json (~> 1.3)
-    deep_merge (1.0.0)
-    diff-lcs (1.2.4)
-    erubis (2.7.0)
-    ffi (1.9.0)
-    filey-diff (1.2.1)
-    gherkin (2.12.0)
-      multi_json (~> 1.3)
-    json (1.8.0)
-    mime-types (1.19)
-    mini_portile (0.5.0)
-    multi_json (1.7.7)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
-    rake (10.1.0)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    safe_yaml (0.9.3)
-    simple-cloudfront-invalidator (1.0.0)
-      colored (= 1.2)
-    thor (0.18.1)
-    uuidtools (2.1.4)
-    vcr (2.5.0)
-    webmock (1.8.11)
-      addressable (>= 2.2.7)
-      crack (>= 0.1.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  aruba (~> 0.5.1)
-  cucumber
-  rake
-  rspec
-  rspec-expectations
-  s3_website!
-  vcr (~> 2.5.0)
-  webmock (~> 1.8.0)