cf-s3-invalidator 0.3.0 → 0.3.1

data/README.md

@@ -6,8 +6,23 @@ this library may be useful to you.
 This library fetches all the object keys of a particular S3 bucket and then
 calls on them the invalidation REST API of Cloudfront.
 
-## Usage
+## Install
 
 `gem install cf-s3-invalidator`
 
-`cf-s3-inv <AWS-KEY> <AWS-SECRET> <S3-BUCKET-NAME> <CLOUDFRONT-DISTRIBUTION-ID>`
+## Usage
+
+You can specify the configuration as CLI parameters:
+
+`cf-s3-inv --key <AWS-KEY> --secret <AWS-SECRET> --bucket <S3-BUCKET-NAME> --distribution <CLOUDFRONT-DISTRIBUTION-ID>`
+
+Or you can store them into the file *_cf_s3_invalidator.yml*:
+
+    s3_key: YOUR_AWS_S3_ACCESS_KEY_ID
+    s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
+    s3_bucket: your.blog.bucket.com
+    cloudfront_distribution_id: YOUR_CLOUDFRONT_DISTRIBUTION_ID
+
+Then you can just run:
+
+`cf-s3-inv`

data/bin/cf-s3-inv

@@ -4,105 +4,118 @@ require 'yaml'
 require File.dirname(__FILE__)+'/../lib/cloudfront_invalidator'
 require File.dirname(__FILE__)+'/../lib/s3_loader'
 
-class CLIOptParser
+class UI
   def initialize
-    @optparse = OptionParser.new do |opts|
-      options = {}
-      opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
-      opts.separator ""
-      opts.separator "Invalidate an S3-based Cloudfront distribution"
-      opts.separator ""
-      opts.separator "Options:"
-      opts.on("-k", "--key AWS KEY",
-              "Amazon Web Services API key that has access to your S3 and Cloudfront") do |val|
-        options[:key] = val
-      end
-      opts.on("-s", "--secret AWS SECRET",
-              "Amazon Web Services API secret key") do |val|
-        options[:secret] = val
-      end
-      opts.on("-b", "--bucket BUCKET NAME",
-              "S3 bucket name") do |val|
-        options[:bucket] = val
+    @file_parser = FileOptionParser.new
+    @cli_parser = CLIOptParser.new
+  end
+
+  def parse_or_print_help
+    if ARGV.length == 0
+      unless @file_parser.conf_file_exists
+        print_help_and_exit
       end
-      opts.on("-d", "--distribution CLOUDFRONT ID",
-              "Cloudfront distribution id") do |val|
-        options[:distribution] = val
+      @file_parser.parse
+    else
+      args_original = ARGV.dup # Optparse removes the valid arguments from ARGV
+      options = @cli_parser.parse
+      if args_original.length == 0
+        print_help_and_exit
       end
-      @options = options
+      options
     end
   end
 
-  def parse
-    @optparse.parse!
-    @options
+  def print_help_and_exit
+    @cli_parser.print_help
+    puts ""
+    puts "ALTERNATIVELY, you can use a configuration file:"
+    puts ""
+    @file_parser.print_help
+    exit
   end
 
-  def print_help
-    puts @optparse.help
-  end
-end
+  class FileOptionParser
+    def parse
+      yml = YAML.load_file(get_conf_file_path)
+      {
+        :key => yml['s3_key'],
+        :secret => yml['s3_secret'],
+        :bucket => yml['s3_bucket'],
+        :distribution => yml['cloudfront_distribution_id']
+      }
+    end
 
-class FileOptionParser
-  def parse
-    yml = YAML.load_file(get_conf_file_path)
-    {
-      :key => yml['s3_key'],
-      :secret => yml['s3_secret'],
-      :bucket => yml['s3_bucket'],
-      :distribution => yml['cloudfront_distribution_id']
-    }
-  end
+    def print_help
+      puts "Add the rows below into file '#{get_conf_file_name}' and then run the program without arguments"
+      puts ""
+      puts sample_conf_file
+      puts ""
+    end
 
-  def get_conf_file_name
-    "_cf_s3_invalidator.yml"
-  end
+    def get_conf_file_name
+      "_cf_s3_invalidator.yml"
+    end
 
-  def get_conf_file_path
-    Dir.pwd + "/#{get_conf_file_name}"
-  end
+    def get_conf_file_path
+      Dir.pwd + "/#{get_conf_file_name}"
+    end
 
-  def conf_file_exists
-    File.exists?(get_conf_file_path)
-  end
+    def conf_file_exists
+      File.exists?(get_conf_file_path)
+    end
 
-  def sample_conf_file
-    sample = <<-EOF
-s3_key: YOUR_AWS_S3_ACCESS_KEY_ID
-s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
-s3_bucket: your.blog.bucket.com
-cloudfront_distribution_id: YOUR_CLOUDFRONT_DISTRIBUTION_ID
-    EOF
+    def sample_conf_file
+      sample = <<-EOF
+    s3_key: YOUR_AWS_S3_ACCESS_KEY_ID
+    s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
+    s3_bucket: your.blog.bucket.com
+    cloudfront_distribution_id: YOUR_CLOUDFRONT_DISTRIBUTION_ID
+      EOF
+    end
   end
-end
 
-class OptionParser
-  def self.parse
-    if ARGV.length == 0
-      file_parser = FileOptionParser.new
-      unless file_parser.conf_file_exists
-        puts "The configuration file '#{file_parser.get_conf_file_name}' is missing"
-        puts "Here is a sample:"
-        puts ""
-        puts file_parser.sample_conf_file
-        puts ""
-        exit
+  class CLIOptParser
+    def initialize
+      @optparse = OptionParser.new do |opts|
+        options = {}
+        opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
+        opts.separator ""
+        opts.separator "Invalidate an S3-based Cloudfront distribution"
+        opts.separator ""
+        opts.separator "Options:"
+        opts.on("-k", "--key AWS KEY",
+                "Amazon Web Services API key that has access to your S3 and Cloudfront") do |val|
+          options[:key] = val
+        end
+        opts.on("-s", "--secret AWS SECRET",
+                "Amazon Web Services API secret key") do |val|
+          options[:secret] = val
+        end
+        opts.on("-b", "--bucket BUCKET NAME",
+                "S3 bucket name") do |val|
+          options[:bucket] = val
+        end
+        opts.on("-d", "--distribution CLOUDFRONT ID",
+                "Cloudfront distribution id") do |val|
+          options[:distribution] = val
+        end
+        @options = options
       end
-      file_parser.parse
-    else
-      args_original = ARGV.dup
-      cli_parser = CLIOptParser.new
-      options = cli_parser.parse
-      if args_original.length == 0
-        cli_parser.print_help
-        exit
-      end
-      options
+    end
+
+    def parse
+      @optparse.parse!
+      @options
+    end
+
+    def print_help
+      puts @optparse.help
     end
   end
 end
 
-options = OptionParser.parse
+options = UI.new.parse_or_print_help
 
 s3_object_keys = S3Loader.new(
   options[:key], options[:secret]).list_keys(options[:bucket])

data/cf-s3-invalidator.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'cf-s3-invalidator'
-  s.version       = '0.3.0'
-  s.date          = '2012-07-03'
+  s.version       = '0.3.1'
   s.summary       = 'A tool for invalidating AWS S3-based Cloudfront distributions'
   s.description   =
     'This lib fetches the names of all objects on an Amazon Web

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cf-s3-invalidator
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Lauri Lehmijoki
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-03 00:00:00 Z
+date: 2012-07-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws-sdk