s3_website 0.3.0 → 0.4.0

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
-- 1.9.2
 - 1.9.3
 - 2.0.0

data/README.md

@@ -308,6 +308,12 @@ If you are not sure how to test your pull request, you can ask the [gem owners
 However, by including proper tests, you increase the chances of your pull
 request being incorporated into future releases.
 
+#### Checklist for new features
+
+* Is it tested?
+* Is it documented in README?
+* Is it mentioned in `resources/configuration_file_template.yml`?
+
 ## License
 
 MIT. See the LICENSE file for more information.

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 0.4.0
+
+* Include the available configs in the sample s3_website.yml file
+
 ## 0.3.0
 
 * Add Nanoc support

data/features/command-line-help.feature

@@ -0,0 +1,55 @@
+Feature: displaying help text in the command-line interface
+
+  As a user
+  I want to see the available commands and options right on CLI
+  So that I don't have to browse the documentation on the web
+
+  @starts-new-os-process
+  Scenario: User wants to know what he can do with s3_website
+    When I run `s3_website`
+    Then the output should contain:
+      """
+      Commands:
+        s3_website cfg SUBCOMMAND ...ARGS  # Operate on the config file
+        s3_website help [COMMAND]          # Describe available commands or one spe...
+        s3_website push                    # Push local files with the S3 website
+      """
+
+  @starts-new-os-process
+  Scenario: User wants to know what the push command does
+    When I run `s3_website help push`
+    Then the output should contain:
+      """
+      Usage:
+        s3_website push
+      """
+
+  @starts-new-os-process
+  Scenario: User wants to know what the cfg command does
+    When I run `s3_website cfg`
+    Then the output should contain:
+      """
+      Commands:
+        s3_website cfg apply           # Apply the configuration on the AWS services
+        s3_website cfg create          # Create a config file with placeholder values
+        s3_website cfg help [COMMAND]  # Describe subcommands or one specific subco...
+      """
+
+  @starts-new-os-process
+  Scenario: User wants to know what the cfg apply command does
+    When I run `s3_website cfg help apply`
+    Then the output should contain:
+      """
+      Usage:
+        s3_website apply
+      """
+
+  @starts-new-os-process
+  @wip
+  Scenario: User wants to know what the cfg create command does
+    When I run `s3_website cfg help create`
+    Then the output should contain:
+      """
+      Usage:
+        s3_website create
+      """

data/features/instructions-for-new-user.feature

@@ -55,6 +55,47 @@ Feature: Instructions for a new user
       s3_bucket: your.blog.bucket.com
       """
 
+  @starts-new-os-process
+  Scenario: The user wants to know the available configurations by looking at the cfg file
+    Given a directory named "_site"
+    When I run `s3_website push`
+    Then the file "s3_website.yml" should contain:
+      """
+      # max_age:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # gzip:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # s3_endpoint:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # ignore_on_server:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # s3_reduced_redundancy:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # cloudfront_distribution_id:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # cloudfront_distribution_config:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # redirects:
+      """
+    Then the file "s3_website.yml" should contain:
+      """
+      # routing_rules:
+      """
+
   @starts-new-os-process
   Scenario: Run s3_website with a malformed configuration file
     Given a directory named "_site"

data/features/jekyll-support.feature

@@ -8,6 +8,12 @@ Feature: upload a Jekyll site
       """
       Deploying features/support/test_site_dirs/jekyllrb.com/_site/* to s3-website-test.net
       Uploading 2 new file(s)
+      """
+    And the output should contain
+      """
       Upload css/styles.css: Success!
+      """
+    And the output should contain
+      """
       Upload index.html: Success!
       """

data/features/nanoc-support.feature

@@ -8,6 +8,12 @@ Feature: upload a Nanoc site
       """
       Deploying features/support/test_site_dirs/nanoc.ws/public/output/* to s3-website-test.net
       Uploading 2 new file(s)
+      """
+    And the output should contain
+      """
       Upload css/styles.css: Success!
+      """
+    And the output should contain
+      """
       Upload index.html: Success!
       """

data/features/push.feature

@@ -12,7 +12,13 @@ Feature: upload S3 website to S3
       """
       Deploying features/support/test_site_dirs/my.blog.com/_site/* to s3-website-test.net
       Uploading 2 new file(s)
+      """
+    And the output should contain
+      """
       Upload css/styles.css: Success!
+      """
+    And the output should contain
+      """
       Upload index.html: Success!
       """
 

data/lib/s3_website/config_loader.rb

@@ -1,11 +1,6 @@
 module S3Website
   class ConfigLoader
     CONFIGURATION_FILE = 's3_website.yml'
-    CONFIGURATION_FILE_TEMPLATE = <<-EOF
-s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
-s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
-s3_bucket: your.blog.bucket.com
-    EOF
 
     def self.check_project(site_dir)
       raise NoWebsiteDirectoryFound unless File.directory?(site_dir)
@@ -20,6 +15,11 @@ s3_bucket: your.blog.bucket.com
       end
     end
 
+    def self.read_configuration_file_template
+      path = File.dirname(__FILE__) + '/../../resources/configuration_file_template.yml'
+      cfg_template = File.open(path).read
+    end
+
     private
 
     # Load configuration from s3_website.yml
@@ -31,7 +31,7 @@ s3_bucket: your.blog.bucket.com
 
     def self.create_template_configuration_file(file)
       File.open(file, 'w') { |f|
-        f.write(CONFIGURATION_FILE_TEMPLATE)
+        f.write(read_configuration_file_template)
       }
     end
 

data/lib/s3_website/errors.rb

@@ -21,7 +21,7 @@ module S3Website
   end
 
   class MalformedConfigurationFileError < S3WebsiteError
-    def initialize(message = "I can't parse the file s3_website.yml. It should look like this:\n#{ConfigLoader::CONFIGURATION_FILE_TEMPLATE}")
+    def initialize(message = "I can't parse the file s3_website.yml. It should look like this:\n#{ConfigLoader.read_configuration_file_template}")
       super(message)
     end
   end

data/lib/s3_website/paths.rb

@@ -6,27 +6,37 @@ module S3Website
 
     def self.infer_site_path(candidate_path, pwd = Dir.pwd)
       if candidate_path == 'infer automatically'
-        site_path = site_paths.
-          map do |site_path|
-            pwd + '/' + site_path
-          end.
+        infer_automatically pwd
+      else
+        candidate_path_if_exists candidate_path
+      end
+    rescue NoWebsiteDirectoryFound => e
+      puts e.message
+      exit 1
+    end
+
+    private
+
+    def self.candidate_path_if_exists(candidate_path)
+      raise NoWebsiteDirectoryFound.new(
+        "Can't find a website in " + candidate_path
+      ) unless File.exists? candidate_path
+      candidate_path
+    end
+
+    def self.infer_automatically(pwd)
+      site_path = site_paths.
+        map do |site_path|
+        pwd + '/' + site_path
+        end.
           find do |site_path|
-            File.exists? site_path
+          File.exists? site_path
           end
         if site_path
           site_path
         else
           raise NoPredefinedWebsiteDirectoryFound
         end
-      else
-        raise NoWebsiteDirectoryFound.new(
-          "Can't find a website in " + candidate_path
-        ) unless File.exists? candidate_path
-        candidate_path
-      end
-    rescue NoWebsiteDirectoryFound => e
-      puts e.message
-      exit 1
     end
   end
 end

data/resources/configuration_file_template.yml

@@ -0,0 +1,44 @@
+s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
+s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
+s3_bucket: your.blog.bucket.com
+
+# Below are examples of all the available configurations.
+# See README for more detailed info on each of them.
+
+# max_age:
+#   "assets/*": 6000
+#   "*": 300
+
+# gzip:
+#   - .html
+#   - .css
+#   - .md
+
+# s3_endpoint: ap-northeast-1
+
+# ignore_on_server: that_folder_of_stuff_i_dont_keep_locally
+
+# s3_reduced_redundancy: true
+
+# cloudfront_distribution_id: your-dist-id
+
+# cloudfront_distribution_config:
+#   default_cache_behavior:
+#     min_TTL: <%= 60 * 60 * 24 %>
+#   aliases:
+#     quantity: 1
+#     items:
+#       CNAME: your.website.com
+
+# redirects:
+#   index.php: /
+#   about.php: about.html
+#   music-files/promo.mp4: http://www.youtube.com/watch?v=dQw4w9WgXcQ
+
+# routing_rules:
+#   - condition:
+#       key_prefix_equals: blog/some_path
+#     redirect:
+#       host_name: blog.example.com
+#       replace_key_prefix_with: some_new_path/
+#       http_redirect_code: 301

data/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.3.0"
+  s.version     = "0.4.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Lauri Lehmijoki"]
   s.email       = ["lauri.lehmijoki@iki.fi"]

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: s3_website
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
+  prerelease: 
 platform: ruby
 authors:
 - Lauri Lehmijoki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: filey-diff
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-cloudfront-invalidator
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,6 +62,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,6 +70,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -69,6 +78,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -76,6 +86,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -83,6 +94,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -90,6 +102,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -97,6 +110,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: configure-s3-website
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -104,6 +118,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -111,48 +126,55 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   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-expectations
   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: cucumber
   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: aruba
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -160,6 +182,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -167,20 +190,23 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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: vcr
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -188,6 +214,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -195,6 +222,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -202,11 +230,12 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-description: "\n    Sync website files, set redirects, use HTTP performance optimisations,
+description: ! "\n    Sync website files, set redirects, use HTTP performance optimisations,
   deliver via\n    CloudFront.\n  "
 email:
 - lauri.lehmijoki@iki.fi
@@ -235,6 +264,7 @@ files:
 - features/cassettes/cucumber_tags/s3-and-cloudfront-when-updating-a-file.yml
 - features/cassettes/cucumber_tags/s3-and-cloudfront.yml
 - features/cloudfront.feature
+- features/command-line-help.feature
 - features/delete.feature
 - features/instructions-for-new-user.feature
 - features/jekyll-support.feature
@@ -307,6 +337,7 @@ files:
 - lib/s3_website/tasks.rb
 - lib/s3_website/upload.rb
 - lib/s3_website/uploader.rb
+- resources/configuration_file_template.yml
 - s3_website.gemspec
 - spec/lib/config_loader_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -327,26 +358,33 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/laurilehmijoki/s3_website
 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: 4345283461830250761
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4345283461830250761
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Manage your S3 website
 test_files:
 - features/as-library.feature
@@ -360,6 +398,7 @@ test_files:
 - features/cassettes/cucumber_tags/s3-and-cloudfront-when-updating-a-file.yml
 - features/cassettes/cucumber_tags/s3-and-cloudfront.yml
 - features/cloudfront.feature
+- features/command-line-help.feature
 - features/delete.feature
 - features/instructions-for-new-user.feature
 - features/jekyll-support.feature

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 58f0b0262858ded1fa65316ca84b921529f02302
-  data.tar.gz: 882765a34ba7e488ef2f08e2838f3c9f1d9f93f3
-SHA512:
-  metadata.gz: a209de0e13692763cf9901e8a6f8bf235e8ca90a8dee600495d738ae2992ed27c286fd7138b4ba4fd375afd565b8bbd6bdbcfd97ab149a3fac76e77c56561361
-  data.tar.gz: 0eacf9898f13c40904bd089f5f933dc173a6e955f806be1cdcb15262bc471d1bd634502cf8bf6cebcae8652b34be48444c7bfbeb08d7130a9bfa5782b4ebdbbd