s3cp 1.1.1 → 1.1.2

data/History.txt

@@ -1,3 +1,13 @@
+=== 1.1.2 / (2012-08-22)
+
+* Added:   All commands now execute an init script ($HOME/.s3cp by default,
+           or $S3CP_CONFIG if defined) allowing customization, such as
+           setting up the AWS.config parameters such as S3 endpoints, max retries,
+           credentials, etc.
+
+           See http://docs.amazonwebservices.com/AWSRubySDK/latest/AWS.html#config-class_method
+           for details.
+
 === 1.1.1 / (2012-08-22)
 
 * Fixed: Invalid break (SyntaxError) in s3ls.

data/README.md

@@ -9,17 +9,6 @@ Make sure you have Rubygems installed on your system then run:
 
     # gem install s3cp
 
-### Building ###
-
-If you want to hack on s3cp and build the gem yourself, you will need Bundler (http://gembundler.com/) installed.  Here is a typical development setup:
-
-    # git clone git@github.com:aboisvert/s3cp.git
-    # cd s3cp
-    (... hack on s3cp ...)
-    # bundle install
-    # bundle exec rake gem
-    # gem install s3cp-*.gem
-
 ### Examples ###
 
     export AWS_ACCESS_KEY_ID=...
@@ -39,13 +28,15 @@ All commands support both `s3://bucket/path/to/file` and the legacy `bucket:path
 
 Commands are also TTY-aware;  when run in an interactive shell, their behavior will change.  For example, `s3cat` will launch your favorite `PAGER` or `less` (the default pager) whereas `s3ls` will display N items at a time, where N is the number of display lines on your terminal and pause between pages.
 
-### Bash completion for S3 URLs ###
+### Security / Credentials ###
 
-To install Bash completion for S3 URLs, add the following to ~/.bashrc:
+Starting with v1.1.0, S3CP uses the default credential provider from the aws-sdk which makes a best effort to locate your AWS credentials.  It checks a variety of locations in the following order:
 
-    for cmd in [ s3cat s3cp s3dir s3ls s3mod s3rm s3stat ]; do
-      complete -C s3cp_complete $cmd
-    done
+* Static credentials from AWS.config (e.g. AWS.config.access_key_id, AWS.config.secret_access_key)
+
+* The environment (e.g. ENV['AWS_ACCESS_KEY_ID'] or ENV['AMAZON_ACCESS_KEY_ID'])
+
+* EC2 metadata service (checks for credentials provided by roles for instances).
 
 ### Usage ###
 
@@ -139,16 +130,36 @@ To install Bash completion for S3 URLs, add the following to ~/.bashrc:
         --verbose                    Verbose mode
     -h, --help                       Show this message
 
+### Bash completion for S3 URLs ###
+
+To install Bash completion for S3 URLs, add the following to ~/.bashrc:
+
+    for cmd in [ s3cat s3cp s3dir s3ls s3mod s3rm s3stat ]; do
+      complete -C s3cp_complete $cmd
+    done
+
 ### Dependencies ###
 
-* highline `>=1.5.1`  (console/terminal size guessing)
-* right_aws `=2.1.0`  (underlying Amazon S3 API)
-* right_http_connection `=1.3.0` (required by `right_aws`)
+* extensions '~> 0.6'     (portability between Ruby 1.8.7/1.9.2)
+* highline `>=1.5.1`      (console/terminal size guessing)
+* aws-sdk '~> 1.6.3'      (underlying Amazon S3 API)
+* progressbar '~> 0.10.0' (nice console progress output)
 
 ### Target platform ###
 
 * Ruby 1.8.7 / 1.9.2
 
+### Development ###
+
+If you want to hack on s3cp and build the gem yourself, you will need Bundler (http://gembundler.com/) installed.  Here is a typical development setup:
+
+    # git clone git@github.com:aboisvert/s3cp.git
+    # cd s3cp
+    # bundle install
+    (... hack on s3cp ...)
+    # bundle exec rake gem
+    # gem install s3cp-*.gem
+
 ### License ###
 
 S3CP is is licensed under the terms of the Apache Software License v2.0.

data/lib/s3cp/completion.rb

@@ -40,6 +40,8 @@ arg2  = ARGV[2]
 
 DEBUG = true
 
+S3CP.load_config()
+
 @s3 = S3CP.connect()
 
 if DEBUG

data/lib/s3cp/s3buckets.rb

@@ -34,6 +34,8 @@ op = OptionParser.new do |opts|
 end
 op.parse!(ARGV)
 
+S3CP.load_config()
+
 s3 = S3CP.connect()
 s3.buckets.each do |bucket|
   puts bucket.name

data/lib/s3cp/s3cat.rb

@@ -57,6 +57,8 @@ end
 @bucket, @prefix = S3CP.bucket_and_key(url)
 fail "Your URL looks funny, doesn't it?" unless @bucket
 
+S3CP.load_config()
+
 @s3 = S3CP.connect().buckets[@bucket]
 
 if options[:tty]

data/lib/s3cp/s3cp.rb

@@ -188,12 +188,7 @@ end
 @includes = options[:include_regex].map { |s| Regexp.new(s) }
 @excludes = options[:exclude_regex].map { |s| Regexp.new(s) }
 
-def match(path)
-  matching = true
-  return false if @includes.any? && !@includes.any? { |regex| regex.match(path) }
-  return false if @excludes.any? &&  @excludes.any? { |regex| regex.match(path) }
-  true
-end
+S3CP.load_config()
 
 @s3 = S3CP.connect()
 
@@ -209,6 +204,13 @@ def direction(from, to)
   end
 end
 
+def match(path)
+  matching = true
+  return false if @includes.any? && !@includes.any? { |regex| regex.match(path) }
+  return false if @excludes.any? &&  @excludes.any? { |regex| regex.match(path) }
+  true
+end
+
 def no_slash(path)
   path = path.match(/\/$/) ? path[0..-2] : path
   path.match(/^\//) ? path[1..-1] : path

data/lib/s3cp/s3du.rb

@@ -63,6 +63,8 @@ url = ARGV[0]
 @bucket, @prefix = S3CP.bucket_and_key(url)
 fail "Your URL looks funny, doesn't it?" unless @bucket
 
+S3CP.load_config()
+
 @s3 = S3CP.connect()
 
 def depth(path)

data/lib/s3cp/s3ls.rb

@@ -86,6 +86,8 @@ if options[:verbose]
   puts "key #{@key}"
 end
 
+S3CP.load_config()
+
 @s3 = S3CP.connect().buckets[@bucket]
 
 keys = 0

data/lib/s3cp/s3mod.rb

@@ -50,6 +50,8 @@ end
 source  = ARGV[0]
 permission = S3CP.validate_acl(ARGV.last)
 
+S3CP.load_config()
+
 @s3 = S3CP.connect()
 bucket,key = S3CP.bucket_and_key(source)
 update_permissions(@s3, bucket, key, permission)

data/lib/s3cp/s3rm.rb

@@ -98,6 +98,8 @@ end
 include_regex = options[:include_regex] ? Regexp.new(options[:include_regex]) : nil
 exclude_regex = options[:exclude_regex] ? Regexp.new(options[:exclude_regex]) : nil
 
+S3CP.load_config()
+
 @s3 = S3CP.connect()
 
 if options[:recursive]

data/lib/s3cp/s3stat.rb

@@ -37,6 +37,10 @@ source  = ARGV[0]
 permission = ARGV.last
 
 @bucket, @key = S3CP.bucket_and_key(source)
+fail "Your URL looks funny, doesn't it?" unless @bucket
+
+S3CP.load_config()
+
 @s3 = S3CP.connect().buckets[@bucket]
 
 metadata = @s3.objects[@key].head

data/lib/s3cp/s3up.rb

@@ -61,6 +61,8 @@ url = ARGV[0]
 bucket, key = S3CP.bucket_and_key(url)
 fail "Your URL looks funny, doesn't it?" unless bucket
 
+S3CP.load_config()
+
 @s3 = S3CP.connect()
 
 # copy all of STDIN to a temp file

data/lib/s3cp/utils.rb

@@ -21,6 +21,7 @@ require 'aws/s3'
 require 'optparse'
 require 'date'
 require 'highline/import'
+require 's3cp/version'
 
 module S3CP
   extend self
@@ -42,6 +43,15 @@ module S3CP
     ::AWS::S3.new()
   end
 
+  # Load user-defined configuration file (e.g. to initialize AWS.config object)
+  def load_config()
+    aws_config = File.join(ENV['HOME'], '.s3cp')
+    aws_config = ENV['S3CP_CONFIG'] if ENV['S3CP_CONFIG']
+    if File.exist?(aws_config)
+      load aws_config
+    end
+  end
+
   # Parse URL and return bucket and key.
   #
   # e.g. s3://bucket/path/to/key => ["bucket", "path/to/key"]

data/lib/s3cp/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: s3cp
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Alex Boisvert
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-22 00:00:00 Z
+date: 2012-08-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
@@ -116,6 +116,7 @@ description:
 email: 
 - alex.boisvert@gmail.com
 executables: 
+- s3buckets
 - s3cat
 - s3cp
 - s3cp_complete