s3cp 1.1.17 → 1.1.18

data/History.txt

@@ -1,3 +1,27 @@
+=== 1.1.18 (2013-02-05)
+
+* Fixed:    Add new `s3lifecycle` command to manage object transtion rules.
+
+    A few examples:
+
+    # Show lifecycle rules for bucket
+    % s3lifecycle s3://bucket
+
+    # Add expiration rule (expire after 180 days)
+    % s3lifecycle --name "Optional name" --expire 180 s3://bucket/below/some/path/
+
+    # Transition objects to Glacier after 180 days
+    % s3lifecycle --glacier 180 s3://bucket/below/some/path/
+
+    # Transition objects to Glacier after 2013-03-29
+    % s3lifecycle --glacier 2013-03-29 s3://bucket/below/some/path/
+
+    # Enable rule by path (you can use --name to enable by name)
+    % s3lifecycle --enable s3://bucket/below/some/path/
+
+    # Disable rule by name
+    % s3lifecycle --disable --name "Some rule" s3://bucket
+
 === 1.1.17 (2013-02-05)
 
 * Fixed:    Speed-up `s3du` (same dealio as s3ls -l from version 1.1.14)

data/bin/s3lifecycle

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 's3cp/s3lifecycle'
+
+

data/lib/s3cp/s3lifecycle.rb

@@ -0,0 +1,168 @@
+# Copyright (C) 2010-2012 Alex Boisvert and Bizo Inc. / All rights reserved.
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more contributor
+# license agreements.  See the NOTICE file  distributed with this work for
+# additional information regarding copyright ownership.  The ASF licenses this
+# file to you under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License.  You may obtain a copy of
+# the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+require 's3cp/utils'
+
+# Default options
+options = { :verbose => false }
+
+# Setup cli params
+op = OptionParser.new do |opts|
+  opts.banner = <<-BANNER
+    s3lifecycle [COMMANDS] prefix
+  BANNER
+  opts.separator ''
+
+  opts.on("--verbose", "Verbose mode") do
+    options[:verbose] = true
+  end
+
+  opts.on("--name NAME", "Rule identifier optionally used in combination with --expire/glacier/enable/disable/remove") do |name|
+    options[:name] = name
+  end
+
+  opts.on("--expire DAYS_OR_DATE", "Expire object(s) after given number of days or specific date (YYYY-MM-DD)") do |time|
+    options[:expire] = S3CP.parse_days_or_date(time)
+  end
+
+  opts.on("--glacier DAYS_OR_DATE", "Transition objects to Glacier after given number of days or specific date (YYYY-MM-DD)") do |time|
+    options[:glacier] = S3CP.parse_days_or_date(time)
+  end
+
+  opts.on("--enable", "Enable rule(s) for expiration/glacier object transition") do
+    options[:enable] = true
+  end
+
+  opts.on("--disable", "Disable rule(s) for expiration/glacier object transition") do
+    options[:disable] = true
+  end
+
+  opts.on("--delete", "Delete rule(s) for expiration/glacier object transition") do
+    options[:delete] = true
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts op
+    exit
+  end
+end
+
+p options.inspect if options[:verbose]
+
+op.parse!(ARGV)
+paths = ARGV
+
+if ARGV.size == 0
+  puts op
+  exit
+end
+
+S3CP.load_config()
+@s3 = S3CP.connect()
+
+def time_or_date_str(msg, t)
+  if t.is_a?(Fixnum) || t.to_s =~ /^\d+$/
+    "%s after %d days" % [msg, t.to_i]
+  else
+    "%s on %s" % [msg, t]
+  end
+end
+
+def rule_to_str(r)
+  if r.expiration_time
+    [ r.prefix, r.id, r.status, time_or_date_str("Expire", r.expiration_time)]
+  elsif r.glacier_transition_time
+    [ r.prefix, r.id, r.status, time_or_date_str("Glacier", r.glacier_transition_time)]
+  else
+    [ r.prefix, r.id, r.status, "???"]
+  end
+end
+
+paths.each do |path|
+  bucket,key = S3CP.bucket_and_key(path)
+  fail "Invalid bucket/key: #{path}" unless key
+
+  case
+
+    when options[:expire]
+      @s3.buckets[bucket].lifecycle_configuration.update do
+        rule_options = {}
+        rule_options[:id] = options[:name] if options[:name]
+        rule_options[:expiration_time] = S3CP.parse_days_or_date(options[:expire])
+        add_rule(key, rule_options)
+      end
+
+    when options[:glacier]
+      @s3.buckets[bucket].lifecycle_configuration.update do
+        rule_options = {}
+        rule_options[:id] = options[:name] if options[:name]
+        rule_options[:glacier_transition_time] = S3CP.parse_days_or_date(options[:glacier])
+        add_rule(key, rule_options)
+      end
+
+    when options[:enable]
+      success = false
+      @s3.buckets[bucket].lifecycle_configuration.update do
+        self.rules.each do |r|
+          if (r.prefix == key) || (r.id == options[:name])
+            r.enable!
+            puts "Enabled rule: "
+            puts S3CP.tableify([rule_to_str(r)])
+            success = true
+          end
+        end
+      end
+      fail "Rule or prefix not found" unless success
+
+    when options[:disable]
+      success = false
+      @s3.buckets[bucket].lifecycle_configuration.update do
+        self.rules.each do |r|
+          if (r.prefix == key) || (r.id == options[:name])
+            r.disabled!
+            puts "Disabled rule: "
+            puts S3CP.tableify([rule_to_str(r)])
+            success = true
+          end
+        end
+      end
+      fail "Rule or prefix not found" unless success
+
+    when options[:delete]
+      success = false
+      @s3.buckets[bucket].lifecycle_configuration.update do
+        self.rules.each do |r|
+          if (r.prefix == key) || (r.id == options[:name])
+            remove_rule(r)
+            puts "Deleted rule: "
+            puts S3CP.tableify([rule_to_str(r)])
+            success = true
+          end
+        end
+      end
+      fail "Rule or prefix not found" unless success
+
+    else
+      puts "Lifecycle rules:"
+      rules = @s3.buckets[bucket].lifecycle_configuration.rules.to_a
+      if rules.empty?
+        puts "No lifecycle rules"
+      else
+        puts S3CP.tableify(rules.map { |r| rule_to_str(r) })
+      end
+  end
+end

data/lib/s3cp/utils.rb

@@ -91,6 +91,24 @@ module S3CP
     headers
   end
 
+  # Convert a series of rows [["one", "two", "three3"], ["foo", "bar", "baz"], ...]
+  # into a table-format.
+  def tableify(rows)
+    return "" if rows.nil? || rows.empty?
+    cols = rows[0].size
+    widths = (1..cols).map { |c| rows.map { |r| r[c-1].length }.max }
+    format = widths[0..-2].map { |w| "%-#{w}s" }.join("    ") + "    %s"
+    rows.map { |r| format % r }.join("\n")
+  end
+
+  def parse_days_or_date(d)
+    if d.to_s =~ /^\d+$/
+      d.to_i
+    else
+      Date.parse(d)
+    end
+  end
+
   # Round a number at some `decimals` level of precision.
   def round(n, decimals = 0)
     (n * (10.0 ** decimals)).round * (10.0 ** (-decimals))

data/lib/s3cp/version.rb

@@ -16,5 +16,5 @@
 # the License.
 
 module S3CP
-  VERSION = "1.1.17"
+  VERSION = "1.1.18"
 end

data/lib/s3cp.rb

@@ -0,0 +1 @@
+require 's3cp/utils'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: s3cp
 version: !ruby/object:Gem::Version 
-  hash: 49
+  hash: 55
   prerelease: 
   segments: 
   - 1
   - 1
-  - 17
-  version: 1.1.17
+  - 18
+  version: 1.1.18
 platform: ruby
 authors: 
 - Alex Boisvert
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-05 00:00:00 Z
+date: 2013-02-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   version_requirements: &id001 !ruby/object:Gem::Requirement 
@@ -54,12 +54,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 53
         segments: 
         - 1
-        - 6
-        - 3
-        version: 1.6.3
+        - 8
+        - 1
+        version: 1.8.1
   requirement: *id003
   type: :runtime
   prerelease: false
@@ -123,6 +123,7 @@ executables:
 - s3dir
 - s3du
 - s3edit
+- s3lifecycle
 - s3ls
 - s3mod
 - s3mv
@@ -136,6 +137,7 @@ extra_rdoc_files:
 - README.md
 - History.txt
 files: 
+- lib/s3cp.rb
 - lib/s3cp/s3cat.rb
 - lib/s3cp/s3tree.rb
 - lib/s3cp/#Untitled-5#
@@ -148,6 +150,7 @@ files:
 - lib/s3cp/s3cp.rb
 - lib/s3cp/s3stat.rb
 - lib/s3cp/utils.rb
+- lib/s3cp/s3lifecycle.rb
 - lib/s3cp/s3rm.rb
 - lib/s3cp/s3up.rb
 - History.txt
@@ -165,6 +168,7 @@ files:
 - bin/s3cp_complete
 - bin/s3du
 - bin/s3cp
+- bin/s3lifecycle
 - bin/s3rm
 - bin/s3stat
 homepage: