octopress-deploy 1.0.0.alpha.3 → 1.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e4a09550ef9b0543cffbf51047b99ef82efa4c9
-  data.tar.gz: 8bebda9735365b81fc5bd5feb7171bd91ffec4fe
+  metadata.gz: 3335ecc6a5982dd61e353698ee6ed3521a65b62f
+  data.tar.gz: 6b5fc858d82ed0290ea6553f2950f9741718a883
 SHA512:
-  metadata.gz: 868c3859731c91f5cfefeb0507564d2c9bfda7d6c51209901aa8f6cffa7cd4099aa9a5c79074090deb395b3aad587f98a3cb92f03c62469e0184af393f5453ff
-  data.tar.gz: a887ef627c3c0f4d8e90d8594670b4bb32686a4406192b5ca19a423aede8840539912a1845c487ec6a3713592d5f84fc0e5383674be3042624737872a49294d3
+  metadata.gz: 23b4efe0fd05a85e1a68b75a04e1b3397654b6d0ab0f245d4a69fe77355d81a75ad6936496babc3764e9cf703396a61839de8056f7030a1dc43abdd11740f997
+  data.tar.gz: 5ba60aa87c352378fe530213d068e54e6e0b23db48f994cfc644cf4c258e65da58a857967d68d2d64e8a7d785e58dbd0ebf8805b7564193a2758d532f867f37c

data/README.md

@@ -2,8 +2,7 @@
 
 Deployment tools for Octopress and Jekyll blogs (or really any static site).
 
-Currently this supports deploying through S3, Git and Rsync. Requests for other
-deployment methods are welcome.
+Currently this supports deploying through S3, Git and Rsync. Pull request to support other deployment methods are welcome.
 
 ## Installation
 
@@ -21,94 +20,129 @@ Or install it yourself as:
 
 ## Set up
 
-To deploy your site run:
+First set up a configuration file for your deployment method.
 
-```bash
-$ octopress deploy
+```sh
+$ octopress deploy init git  # or rsync, s3
 ```
 
-This will read from your configuration file `_deploy.yml` and deploy your site. If your site has no configuration file, you will be asked if you want to generate one and what deployment method you want to use.
+This will generate a `_deploy.yml` file in your current
+directory which you can edit to add any necessary configuration.
+**Remember to add your configuration to `.gitignore` to be sure
+you never commit sensitive information to your repository.**
+
+## Deploying
 
-You can also generate a `./_deploy.yml` configuration file by running:
+Deployment is tailored to work with Jekyll, but it will work for
+any static site. Simply make sure your configuration points to
+the root directory of your static site (For Jekyll, that's
+probably `_site`) then tell Octopress to deploy it.
 
-```bash
-$ octopress deploy --init git # or 'rsync' or 's3'
+```sh
+$ octopress deploy
 ```
 
-Once you've deployed your site, you can also pull it back down into a local directory. This is mostly useful for checking the results of a deploy. This will create the directory if it doesn't already exist.
+This will read your `_deploy.yml` configuration and deploy your
+site. If you like, you can specify a configuration file.
 
-```ruby
-Octopress::Deploy.pull('some_directory')
+```sh
+$ octopress deploy --config _staging.yml
 ```
 
-### Configuration options
+## Pull down your site
 
-Configurations should be added to a `_deploy.yml` file in your project's root directory. You can pass options as a hash directy to the `push` method as well. Passed options will override options set in the config file.
+With the `pull` command, you can pull your site down into a local directory.
 
-| Config        | Description                                      | Default
-|:--------------|:-------------------------------------------------|:---------------|
-| `config_file` | Path to the config file.                         | _config.yml    |
-| `site_dir`    | Path to comipled site files.                     | _site          |
+```sh
+octopress deploy pull <DIRECTORY>
+```
+
+Mainly you'd do this if you're troubleshooting deployment and you want to see if it's working how you expected.
 
+## Amazon S3 Deployment Configuration
 
-#### Amazon S3
+To deploy with Amazon S3 you will need to install the [aws-sdk gem](https://rubygems.org/gems/aws-sdk).
 
-Important: when using S3, you must add your _deploy.yml to your .gitignore to prevent accidentally sharing
-account access information. Octopress Deploy will offer to do it for you. If you don't, you won't be able to deploy.`
+Important: when using S3, you must add your `_deploy.yml` to your .gitignore to prevent accidentally sharing
+account access information.
 
-| Config              | Description                              | Default
-|:--------------------|:-----------------------------------------|:-------------|
-| `bucket_name`       | S3 bucket name                           |              |
-| `access_key_id`     | AWS access key                           |              |
-| `secret_access_key` | AWS secret key                           |              |
-| `remote_path`       | Directory files should be synced to.     | /            |
-| `delete`            | Delete files to create a 1:1 file sync.  | false        |
-| `verbose`           | Display all file actions during deploy.  | true         |
-| `region`            | Region for your AWS bucket               | us-east-1    |
+| Config              | Description                                           | Default
+|:--------------------|:------------------------------------------------------|:-------------|
+| `method`            | Deployment method, in this case use 's3'              |              |
+| `site_dir`          | Path to static site files                             | _site        |
+| `bucket_name`       | S3 bucket name                                        |              |
+| `access_key_id`     | AWS access key                                        |              |
+| `secret_access_key` | AWS secret key                                        |              |
+| `remote_path`       | Directory files should be synced to.                  | /            |
+| `verbose`           | [optional] Display all file actions during deploy.    | true         |
+| `region`            | [optional] Region for your AWS bucket                 | us-east-1    |
+| `delete`            | Delete files in `remote_path` not found in `site_dir` | false        |
 
 If you choose a bucket which doesn't yet exist, Octopress Deploy will offer to create it for you, and offer to configure it as a static website.
 
-##### ENV config
+If you configure Octopress to delete files, all files found in the `remote_path` on S3 bucket will be removed unless they match local site files.
+If `remote_path` is a subdirectory, only files in that subdirectory will be evaluated for deletion.
+
+### AWS config via ENV
 
-For the following configurations you can set environment vars instead of adding items to your config file.
+If you prefer, you can store AWS access credentials in environment variables instead of a conifiguration file. 
 
 | Config              | ENV var                        |
 |:--------------------|:-------------------------------|
 | `access_key_id`     | AWS_ACCESS_KEY_ID              |
 | `secret_access_key` | AWS_SECRET_ACCESS_KEY          |
-| `region`            | AWS_DEFAULT_REGIONS            |
 
+Note: configurations in `_deploy.yml` will override environment variables so be sure to remove those if you decide to use environment variables.
 
-##### Deleting files from S3
+### Add a new bucket
 
-If the `delete` option is true, files in the `remote_path` on the bucket will be removed if they do not match local site files.
-If `remote_path` is a subdirectory, only files in that subdirectory will be evaluated for deletion.
+If your AWS credentials are properly configured, you can add a new bucket with this command.
+
+```sh
+octopress deploy add_bucket
+```
 
-#### Git
+This will connect to AWS, create a new S3 bucket, and configure it for static website hosting. This command can use the settings in your deployment configuration or you can pass options to override those settings.
+
+| Option        | Description                                      | Default
+|:--------------|:-------------------------------------------------|:---------------|
+| `--name`      | Override the `bucket_name` configuration         |                |
+| `--region`    | Override the `region` configuration              |                |
+| `--index`     | Specify an index page for your site              | index.html     |
+| `--error`     | Specify an error page for your site              | error.html     |
+| `--config`    | Use a custom configuration file                  | _deploy.yml    |
+
+You'll only need to pass options if you want to override settings in your deploy config file.
+
+## Git Deployment Configuration
 
 Only `git_url` is required. Other options will default as shown below.
 
 | Config        | Description                                      | Default
 |:--------------|:-------------------------------------------------|:---------------|
-| `git_url`     | Url for remote git repository.                   |                |
-| `git_branch`  | Deployment branch for git repository.            | master         |
-| `deploy_dir`  | Directory where deployment files are staged.     | .deploy        |
-| `remote`      | Name of git remote.                              | deploy         |
+| `method`      | Deployment method, in this case use 'git'        |                |
+| `site_dir`    | Path to static site files                        | _site          |
+| `git_url`     | Url for remote git repository                    |                |
+| `git_branch`  | Deployment branch for git repository             | master         |
+| `deploy_dir`  | Directory where deployment files are staged      | .deploy        |
+| `remote`      | Name of git remote                               | deploy         |
 
-#### Rsync
-
-Only `remote_path` is required. If `user` is not present, Rsync will sync between two locally available directories. Do this if your site root is mounted locally.
+## Rsync Deployment Configuration
 
 | Config         | Description                                       | Default
 |:---------------|:--------------------------------------------------|:---------------|
+| `method`       | Deployment method, in this case use 'rsync'       |                |
+| `site_dir`     | Path to static site files                         | _site          |
 | `user`         | ssh user, e.g user@host.com                       |                |
 | `port`         | ssh port                                          | 22             |
-| `remote_path`  | Remote destination's document root.               |                |
-| `exclude_file` | Path to a file containing rsync exclusions.       |                |
-| `exclude`      | Inline list of rsync exclusions.                  |                |
-| `include`      | Inline list of inclusions to override exclusions. |                |
+| `remote_path`  | Remote destination's document root                |                |
+| `exclude_file` | Path to a file containing rsync exclusions        |                |
+| `exclude`      | Inline list of rsync exclusions                   |                |
+| `include`      | Inline list of inclusions to override exclusions  |                |
 | `delete`       | Delete files in destination not found in source   | false          |
 
+You can rsync to a local directory by configuring `remote_path` and leaving off `user` and `port`.
+
 ## Contributing
 
 1. Fork it

data/lib/octopress-deploy.rb

@@ -1,14 +1,12 @@
 $LOAD_PATH.unshift File.expand_path("../", __FILE__)
-
-require 'octopress-deploy/version'
-require 'octopress-deploy/core_ext'
+#
 require 'colorator'
 require 'yaml'
-require 'pathname'
+require 'octopress'
 
-if defined? Octopress::Command
-  require 'octopress-deploy/commands'
-end
+require 'octopress-deploy/version'
+require 'octopress-deploy/core_ext'
+require 'octopress-deploy/commands'
 
 
 module Octopress
@@ -18,34 +16,44 @@ module Octopress
     autoload :S3,     'octopress-deploy/s3'
 
     METHODS = {
-      'git'=> Git,
-      'rsync'=> Rsync,
-      's3'=> S3
+      'git'   => Git,
+      'rsync' => Rsync,
+      's3'    => S3
     }
 
     def self.push(options={})
       init_options(options)
       if !File.exists? @options[:config_file]
-        init_config if ask_bool("Deployment config file not found. Create #{@options[:config_file]}?")
+        abort "File not found: #{@options[:config_file]}. Create a deployment config file with `octopress deploy init <METHOD>`."
       else
         parse_options
         deploy_method.new(@options).push()
       end
     end
 
-    def self.pull(dir='site-pull', options={})
+    def self.pull(options={})
       init_options(options)
       if !File.exists? @options[:config_file]
-        init_config if ask_bool("Deployment config file not found. Create #{@options[:config_file]}?")
+        abort "No deployment config found. Create one with: octopress deploy init #{@options[:config_file]}"
       else
         parse_options
-        if !File.exists? @options[:pull_dir] = dir
-          FileUtils.mkdir_p @options[:pull_dir]
+        if !File.exists? @options[:dir]
+          FileUtils.mkdir_p @options[:dir]
         end
         deploy_method.new(@options).pull()
       end
     end
 
+    def self.add_bucket(options={})
+      init_options(options)
+      if !File.exists? @options[:config_file]
+        abort "File not found: #{@options[:config_file]}. Create a deployment config file with `octopress deploy init <METHOD>`."
+      else
+        parse_options
+        deploy_method.new(@options).add_bucket()
+      end
+    end
+
     def self.parse_options
       config  = YAML.load(File.open(@options[:config_file])).to_symbol_keys
       @options = @options.to_symbol_keys
@@ -53,9 +61,9 @@ module Octopress
     end
 
     def self.init_options(options={})
-      @options = options.to_symbol_keys
+      @options                 = options.to_symbol_keys
       @options[:config_file] ||= '_deploy.yml'
-      @options[:site_dir] ||= site_dir
+      @options[:site_dir]    ||= site_dir
     end
 
     def self.deploy_method
@@ -72,26 +80,21 @@ module Octopress
 
     # Create a config file
     #
-    def self.init_config(method=nil, options=nil)
-      if options
-        options[:method] = method
-        init_options(options)
-      end
+    def self.init_config(options={})
+      options = options.to_symbol_keys
 
-      unless @options[:method]
-        @options[:method] = ask("How would you like to deploy your site?", METHODS.keys)
+      if !options[:method]
+        abort "Please provide a deployment method. e.g. #{METHODS.keys}"
       end
 
+      init_options(options)
       write_config
       check_gitignore
     end
 
     def self.write_config
-      if !@options[:force_write_config]
-        if File.exist?(@options[:config_file]) &&
-         !ask_bool("A config file already exists at #{@options[:config_file]}. Overwrite?")
-         return puts "No config file written."
-        end
+      if File.exist?(@options[:config_file]) && !@options[:force]
+        abort "A config file already exists at #{@options[:config_file]}. Use --force to overwrite."
       end
 
       config = get_config.strip
@@ -100,71 +103,31 @@ module Octopress
       puts "------------------"
       puts "#{config.yellow}"
       puts "------------------"
-      puts "Please add your configurations to this file."
+      puts "Modify these configurations as necessary."
     end
 
     def self.get_config
       <<-FILE
-method: #{@options[:method]}
-site_dir: #{@options[:site_dir]}
+#{"method: #{@options[:method]}".ljust(40)}  # How do you want to deploy? git, rsync or s3.
+#{"site_dir: #{@options[:site_dir]}".ljust(40)}  # Location of your your static site files.
+
 #{deploy_method.default_config(@options)}
 FILE
     end
 
+    # Checks the repository's .gitignore for the config file
+    #
+    # returns: Boolean - whether it is present or not.
+    #
     def self.check_gitignore
       gitignore = File.join(`git rev-parse --show-toplevel`.strip, ".gitignore")
-      if !File.exist?(gitignore) ||
-        Pathname.new(gitignore).read.match(/^#{@options[:config_file]}/i).nil?
-        if ask_bool("Do you want to add #{@options[:config_file]} to your .gitignore?")
-          git_ignore_config_file gitignore
-          return true
-        end
-      else
-        return true
-      end
-    end
-
-    def self.git_ignore_config_file(gitignore)
-      File.open(gitignore, 'a') { |f| f.write(@options[:config_file]) }
-    end
-
-    def self.ask_bool(message)
-      ask_or_default(true, message) do
-        ask(message, ['y','n']) == 'y'
-      end
-    end
 
-    def self.ask(message, valid_options)
-      ask_or_default(false, message) do
-        if valid_options
-          options = valid_options.join '/'
-          answer = get_stdin("#{message} [#{options}]: ").downcase.strip
-          if valid_options.map{|o| o.downcase}.include?(answer)
-            return answer
-          else
-            return false
-          end
-        else
-          answer = get_stdin("#{message}: ")
-        end
-        answer
-      end
-    end
-          
-    def self.get_stdin(message)
-      print message
-      STDIN.gets.chomp
-    end
-
-    def self.should_ask?
-      !ENV['NO_ASK']
-    end
-
-    def self.ask_or_default(default, message)
-      if should_ask?
-        yield
+      if !File.exist?(gitignore) ||
+        File.open(gitignore).read.match(/^#{@options[:config_file]}/i).nil?
+        puts "Remember to add #{@options[:config_file]} to your .gitignore."
+        false
       else
-        puts "Assuming '#{default}' for '#{message}'."
+        true
       end
     end
   end

data/lib/octopress-deploy/commands.rb

@@ -3,20 +3,47 @@ module Octopress
     class Commands < Octopress::Command
       def self.init_with_program(p)
         p.command(:deploy) do |c|
-          c.syntax "octopress deploy [options]"
+          c.syntax "deploy [options]"
           c.description "Deploy your Octopress site."
-          c.option "using", "--using METHOD", "Define the push method to use, overriding your configuration file's setting"
           c.option "config_file", "--config FILE", "The path to your config file (default: _deploy.yml)"
-          c.option "init", "--init METHOD", "Initialize a config file with the options for the given method."
-          c.option "pull", "--pull DIRECTORY", "Pull down the published copy of your site into a directory (default: ./site-pull)"
 
-          c.action do |_, options|
-            if options["init"] and options["init"].is_a?(String)
-              Octopress::Deploy.init_config(options["init"], options)
-            elsif options["pull"] and options["pull"].is_a?(String)
-              Octopress::Deploy.pull(options["pull"], options)
-            else
-              Octopress::Deploy.push(options)
+          c.action do |args, options|
+            Octopress::Deploy.push(options)
+          end
+
+          c.command(:pull) do |c|
+            c.syntax "pull <DIRECTORY>"
+            c.description "Pull down the published copy of your site into a directory (default: ./site-pull)"
+            c.option "config_file", "--config FILE", "The path to your config file (default: _deploy.yml)"
+
+            c.action do |args, options|
+              options['dir'] = args.first
+              Octopress::Deploy.pull(options)
+            end
+          end
+
+          c.command(:init) do |c|
+            c.syntax 'init <METHOD> [options]'
+            c.description "Create a configuration file for a deployment method (#{Deploy::METHODS.keys.join(', ')})."
+            c.option 'force', '--force', 'Initialize a config file even if it already exists.'
+
+            c.action do |args, options|
+              options['method'] = args.first
+              Octopress::Deploy.init_config(options)
+            end
+          end
+
+          c.command(:add_bucket) do |c|
+            c.syntax 'add_bucket [options]'
+            c.description "Add a new S3 bucket and configure it for static websites."
+            c.option 'bucket_name','--name NAME','Choose a bucket name. (Defaults: to bucket_name in config file)'
+            c.option 'region','--region REGION','Choose a region. (Defaults: to region in config file)'
+            c.option 'index_page','--index PAGE','Specify an index page. (Default: index.html)'
+            c.option 'error_page','--error PAGE','Specify an error page. (Default: 404.html)'
+            c.option "config_file", "--config FILE", "The path to your config file (default: _deploy.yml)"
+
+            c.action do |args, options|
+              Octopress::Deploy.add_bucket(options)
             end
           end
         end

data/lib/octopress-deploy/git.rb

@@ -5,13 +5,13 @@ module Octopress
       def initialize(options={})
         @options     = options
         @repo        = @options[:git_url]
-        @branch      = @options[:git_branch]
+        @branch      = @options[:git_branch]   || 'master'
         @remote      = @options[:remote]       || 'deploy'
         @remote_path = @options[:remote_path]  || ''
         @remote_path = @remote_path.sub(/^\//,'') #remove leading slash
-        @site_dir    = File.expand_path(@options[:site_dir])
+        @site_dir    = File.expand_path(@options[:site_dir])  || '_site'
         @deploy_dir  = File.expand_path(@options[:deploy_dir] || '.deploy')
-        @pull_dir    = @options[:pull_dir]
+        @pull_dir    = @options[:dir]
         abort "Deploy Failed: Configure a git_url in #{@options[:config_file]} before deploying.".red if @repo.nil?
       end
 
@@ -44,8 +44,14 @@ module Octopress
 
       def self.default_config(options={})
         <<-CONFIG
-git_url: #{options[:git_url]}
-git_branch: #{options[:git_branch] || 'master'}
+#{"git_url: #{options[:git_url]}".ljust(40)}  # remote repository url, e.g. git@github.com:username/repo_name
+#{"git_branch: #{options[:git_branch] || 'master'}".ljust(40)}  # Git branch where static site files are commited
+
+# Note on git_branch:
+# If using GitHub project pages, set the branch to 'gh-pages'.
+# For GitHub user/organization pages or Heroku, set the branch to 'master'.
+
+#{"# remote_path: #{options[:remote_path]}".ljust(40)}  # Destination directory
 CONFIG
       end
 

data/lib/octopress-deploy/rsync.rb

@@ -12,9 +12,11 @@ module Octopress
         @exclude_file = @options[:exclude_file]
         @exclude_file = File.expand_path(@exclude_file) if @exclude_file
         @include      = @options[:include]
-        @delete       = @options[:delete]
+        @exclude_file = @options[:include_file]
+        @exclude_file = File.expand_path(@include_file) if @include_file
+        @delete       = @options[:delete] || false
         @remote_path  = @remote_path.sub(/^\//,'') #remove leading slash
-        @pull_dir     = @options[:pull_dir]
+        @pull_dir     = @options[:dir]
       end
 
       def push
@@ -35,6 +37,7 @@ module Octopress
         cmd    << " -e "                               if @exclude_file || @exclude
         cmd    << " --exclude-from #{@exclude_file} "  if @exclude_file
         cmd    << " --exclude #{@exclude} "            if @exclude
+        cmd    << " --include-from #{@include_file} "  if @include_file
         cmd    << " --include #{@include} "            if @include
         cmd    << " --rsh='ssh -p#{@port}' "           if @user && @port
         cmd    << " --delete "                         if @delete
@@ -52,10 +55,16 @@ module Octopress
 
       def self.default_config(options={})
         <<-CONFIG
-user: #{options[:user]}
-port: #{options[:port]}
-remote_path: #{options[:remote_path]}
-delete: #{options[:delete]}
+#{"user: #{options[:user]}".ljust(40)}  # The user for your host, e.g. user@host.com
+#{"remote_path: #{options[:remote_path]}".ljust(40)}  # Destination directory
+#{"delete: #{options[:delete]}".ljust(40)}  # Remove files from destination which don't match files in source
+
+#{"# port: #{options[:port]}".ljust(40)}  # If your host requires a non standard port
+#{"# exclude: ".ljust(40)}  # Path to file containing list of files to exclude
+#{"# exclude-file: ".ljust(40)}  # Path to file containing list of files to exclude
+#{"# include: ".ljust(40)}  # Path to file containing list of files to include
+#{"# include-file: ".ljust(40)}  # Path to file containing list of files to include
+
 CONFIG
       end
       

data/lib/octopress-deploy/s3.rb

@@ -1,12 +1,17 @@
 require 'find'
 require 'fileutils'
-require 'aws-sdk'
 
 module Octopress
   module Deploy
     class S3
 
       def initialize(options)
+        begin
+          require 'aws-sdk'
+        rescue LoadError
+          abort "Please install the aws-sdk gem first."
+        end
+        @options     = options
         @local       = options[:site_dir]
         @bucket_name = options[:bucket_name]
         @access_key  = options[:access_key_id]     || ENV['AWS_ACCESS_KEY_ID']
@@ -16,40 +21,48 @@ module Octopress
         @verbose     = options[:verbose]           || true
         @delete      = options[:delete]
         @remote_path = @remote_path.sub(/^\//,'')  # remove leading slash
-        @pull_dir    = options[:pull_dir]
+        @pull_dir    = options[:dir]
         connect
       end
 
       def push
-        abort "Seriously, you should. Quitting..." unless Deploy.check_gitignore
-        puts "Syncing #{@local} files to #{@bucket_name} on S3."
-        write_files
-        delete_files if delete_files?
-        status_message
+        #abort "Seriously, you should. Quitting..." unless Deploy.check_gitignore
+        @bucket = @s3.buckets[@bucket_name]
+        if !@bucket.exists?
+          abort "Bucket not found: '#{@bucket_name}'. Check your configuration or create a bucket using: `octopress deploy add_bucket`"
+        else
+          puts "Syncing #{@local} files to #{@bucket_name} on S3."
+          write_files
+          delete_files if delete_files?
+          status_message
+        end
       end
 
       def pull
-        puts "Syncing #{@bucket_name} files to #{@pull_dir} on S3."
-        @bucket.objects.each do |object|
-          path = File.join(@pull_dir, object.key)
-          dir = File.dirname(path)
-          FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
-          File.open(path, 'w') { |f| f.write(object.read) }
+        @bucket = @s3.buckets[@bucket_name]
+        if !@bucket.exists?
+          abort "Bucket not found: '#{@bucket_name}'. Check your configuration or create a bucket using: `octopress deploy add_bucket`"
+        else
+          puts "Syncing #{@bucket_name} files to #{@pull_dir} on S3."
+          @bucket.objects.each do |object|
+            path = File.join(@pull_dir, object.key)
+            dir = File.dirname(path)
+            FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+            File.open(path, 'w') { |f| f.write(object.read) }
+          end
         end
       end
 
       # Connect to S3 using the AWS SDK
       # Retuns an aws bucket
+      #
       def connect
         AWS.config(access_key_id: @access_key, secret_access_key: @secret_key, region: @region)
-        s3 = AWS.s3
-        @bucket = s3.buckets[@bucket_name]
-        unless @bucket.exists? || create_bucket(s3.buckets)
-          abort "No bucket created. Change your config to point to an existing bucket."
-        end
+        @s3 = AWS.s3
       end
 
       # Write site files to the selected bucket
+      #
       def write_files
         puts "Writing #{pluralize('file', site_files.size)}:" if @verbose
         site_files.each do |file| 
@@ -64,6 +77,7 @@ module Octopress
       end
 
       # Delete files from the bucket, to ensure a 1:1 match with site files
+      #
       def delete_files
         if deletable_files.size > 0
           puts "Deleting #{pluralize('file', deletable_files.size)}:" if @verbose
@@ -78,30 +92,24 @@ module Octopress
         end
       end
 
-      def create_bucket(buckets)
-
-        if Deploy.ask_bool("S3 bucket '#{@bucket_name}' not found. Create one in region #{@region}?")
-          @bucket = buckets.create(@bucket_name)
-          puts "Created new bucket #{@bucket_name} in region #{@region}."
-
-          configure_bucket
-          true
-        end
+      # Create a new S3 bucket
+      #
+      def add_bucket
+        puts @bucket_name
+        @bucket = @s3.buckets.create(@bucket_name)
+        puts "Created new bucket '#{@bucket_name}' in region '#{@region}'."
+        configure_bucket
       end
 
       def configure_bucket
-        error_page = remote_path('404.html')
-        index_page = remote_path('index.html')
+        error_page = @options['error_page'] || remote_path('404.html')
+        index_page = @options['index_page'] || remote_path('index.html')
 
-        if Deploy.ask_bool("Bucket is not currently configured as a static websites. Configure it with index_page: #{index_page} and error_page: #{error_page}?")
-          config = @bucket.configure_website do |cfg|
-            cfg.index_document_suffix = index_page
-            cfg.error_document_key = error_page
-          end
-          puts "Bucket configured with index_document: #{index_page} and error_document: #{error_page}."
-        else
-          puts "You'll want to configure your new bucket using the AWS management console."
+        config = @bucket.configure_website do |cfg|
+          cfg.index_document_suffix = index_page
+          cfg.error_document_key = error_page
         end
+        puts "Bucket configured with index_document: #{index_page} and error_document: #{error_page}."
       end
 
       def delete_files?
@@ -161,13 +169,14 @@ module Octopress
       # Return default configuration options for this deployment type
       def self.default_config(options={})
         <<-CONFIG
-bucket_name: #{options[:bucket_name]}
-access_key_id: #{options[:access_key_id]}
-secret_access_key: #{options[:secret_access_key]}
-region: #{options[:region] || 'us-east-1'}
-remote_path: #{options[:remote_path] || '/'}
-delete: #{options[:delete] || 'false'}
-verbose: #{options[:verbose] || 'true'}
+#{"bucket_name: #{options[:bucket_name]}".ljust(40)}  # Name of the S3 bucket where these files will be stored.
+#{"access_key_id: #{options[:access_key_id]}".ljust(40)}  # Get this from your AWS console at aws.amazon.com.
+#{"secret_access_key: #{options[:secret_access_key]}".ljust(40)}  # Keep it safe; keep it secret. Keep this file in your .gitignore.
+#{"remote_path: #{options[:remote_path] || '/'}".ljust(40)}  # relative path on bucket where files should be copied.
+
+#{"# region: #{options[:region] || 'us-east-1'}".ljust(40)}  # Region where your bucket is located.
+#{"# delete: #{options[:delete] || 'true'}".ljust(40)}  # Remove files from destination which do not match source files.
+#{"# verbose: #{options[:verbose] || 'true'}".ljust(40)}  # Print out all file operations.
 CONFIG
       end
 

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.0.0.alpha.3"
+    VERSION = "1.0.0.rc.1"
   end
 end

data/octopress-deploy.gemspec

@@ -17,8 +17,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "octopress", "~> 3.0.0.rc.1"
   spec.add_runtime_dependency "colorator"
-  spec.add_runtime_dependency "aws-sdk"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/test/Gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-gem "octopress", '~> 3.0.0.alpha.5'
 gem "octopress-deploy", path: "../"
 gem "pry-debugger"
 gem "aws-sdk"

data/test/test.rb

@@ -67,9 +67,9 @@ def test_remote_git
   
   # Test remote git deployment
   #
-  Octopress::Deploy.init_config('git', config_file: config, force_write_config: true, git_branch: 'test_git_deploy', git_url: repo)
+  Octopress::Deploy.init_config(method: 'git', config_file: config, force: true, git_branch: 'test_git_deploy', git_url: repo)
   Octopress::Deploy.push(config_file: config)
-  Octopress::Deploy.pull('pull-git', config_file: config)
+  Octopress::Deploy.pull(dir: 'pull-git', config_file: config)
   diff_dir('_site', 'pull-git')
 end
 
@@ -86,7 +86,7 @@ def test_local_git
   # Test local git deployment
   #
   Octopress::Deploy.push(config_file: config, git_url: File.expand_path(repo), remote_path: 'site')
-  Octopress::Deploy.pull('pull-git', config_file: config, git_url: File.expand_path(repo), remote_path: 'site')
+  Octopress::Deploy.pull(dir: 'pull-git', config_file: config, git_url: File.expand_path(repo), remote_path: 'site')
   diff_dir('_site', 'pull-git/site')
 end
 
@@ -99,9 +99,9 @@ def test_remote_rsync
   
   # Test remote git deployment
   #
-  Octopress::Deploy.init_config('rsync', config_file: config, force_write_config: true, user: 'imathis@imathis.com', remote_path: '~/octopress-deploy/rsync/')
+  Octopress::Deploy.init_config(method: 'rsync', config_file: config, force: true, user: 'imathis@imathis.com', remote_path: '~/octopress-deploy/rsync/')
   Octopress::Deploy.push(config_file: config)
-  Octopress::Deploy.pull('pull-rsync', config_file: config)
+  Octopress::Deploy.pull(dir: 'pull-rsync', config_file: config)
   diff_dir('_site', 'pull-rsync')
 
 end
@@ -115,9 +115,9 @@ def test_local_rsync
 
   # Test local git deployment
   #
-  Octopress::Deploy.init_config('rsync', config_file: config, force_write_config: true, remote_path: 'local-rsync')
+  Octopress::Deploy.init_config(method: 'rsync', config_file: config, force: true, remote_path: 'local-rsync')
   Octopress::Deploy.push(config_file: config)
-  Octopress::Deploy.pull('pull-rsync', config_file: config, user: false, remote_path: 'local-rsync')
+  Octopress::Deploy.pull(dir: 'pull-rsync', config_file: config, user: false, remote_path: 'local-rsync')
   diff_dir('_site', 'pull-rsync')
 end
 
@@ -126,7 +126,7 @@ def test_s3
   config = "_s3_deploy.yml"
   `rm -rf pull-s3`
   Octopress::Deploy.push(config_file: config)
-  Octopress::Deploy.pull('pull-s3', config_file: config)
+  Octopress::Deploy.pull(dir: 'pull-s3', config_file: config)
   diff_dir('_site', 'pull-s3')
 end
 

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.3
+  version: 1.0.0.rc.1
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-20 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorator
+  name: octopress
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.rc.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0.rc.1
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: colorator
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -75,7 +75,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- History.markdown
 - LICENSE.txt
 - README.md
 - Rakefile

data/History.markdown

@@ -1,13 +0,0 @@
-## HEAD
-
-### Major Enhancements
-
-### Minor Enhancements
-
-  * Ask user if they would like to ignore the `_deploy.yml` file & automate (#7)
-
-### Bug Fixes
-
-  * Symbolize all incoming keys to `Octopress::Deploy.init_config` (#4)
-
-### Development Fixes