s3rsync 0.1.5 → 0.1.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDUyOTRiOWFhOWJjNmY4ZjVkZWI0NzFkY2IwNWFlM2EzNjU5Yzk2Zg==
+    YjEyMWZhMDA1MDdmNTRkYWI4MjllMjhkMmQxZmFkMGRjMzVmOWQ1ZQ==
   data.tar.gz: !binary |-
-    MTg4ZjgzMDA0YzgxMDM5NmQ4YjIzZDdhMmRhZmYzNzRmYjhjMGY5OA==
+    OTcyYzAyMjg1YWRhYTFhYzI3NjYwMTdjNmRiMTA4YTAyMjVlN2M5Zg==
 SHA512:
   metadata.gz: !binary |-
-    ZTM3OGY2NWQzMTVmM2RjN2U2NGZhYmM3Njc1YjIwODM4ZGI4MmNlZDc4YTQw
-    YWVlMjBlOTcwYjdhYzI1NzY3ZDY4OGQ1YWRkZTRiMzI0NDYxNDQ2OWY2YmM4
-    NDEwMGZiNDQ2OGFjN2I5NTE2MTc4Mjg1ZWExYzg4NDVhY2QwMWM=
+    MzM5OGE1MGRiYjhkYjZhOWU4OTk2MGE1MDBlMWU5YWM5ZTNkNTg3NmQzM2E3
+    OGM5OWZlZGIxN2U3ZGE4ZGNkN2FiNGI5ZmZiMjJhMjRkNzM5NjBmZWUwMzMz
+    NTUwZTc1NjU0NWVmY2M0MjYzYTc5ZGZiYzAwYmY3ODkxMzY1NDM=
   data.tar.gz: !binary |-
-    YmIzZGEwMzZiZmU1NmE4ZmMzNTBmMWE4ZWIxYjFjZWE3MTg3ZmQ1YTBhNjhk
-    ZGJlOGZkMjkxM2EzYzU5ZWM5YTNlNmMwNjBjNTNhMzJkNDU3N2RlNjA0NWRl
-    M2UyZmEzOTEwOTlmZjVlMmVhMTAyNjNlNGU2ZjcyZWY0YzZiZWU=
+    YzZjMmFhNTE5OTI2NzdlNjdkMjg4MTZhMTcxZDhmNzFlMTYxZWQ3OGNmODc3
+    M2VhZTgwYTUyOGY4ZGU0MzI0NzMwYTdhODcxNGM1NzIxNmMxMWJkNGE1MDk3
+    ODk3YmQzM2FmMDA1MGE1YTllY2M5MWY4NTY4MTI1OWM3MTRkYTU=

data/README.md

@@ -8,12 +8,12 @@ s3rsync
 [travis]: http://travis-ci.org/idevops/s3rsync
 [coveralls]: https://coveralls.io/r/idevops/s3rsync
 
-Wrapper gem to sync files with s3cmd tool.
+Wrapper gem used to sync files with s3cmd tool.
 Remote update protocol between local set of files and S3 storage.
 
 Prerequisites
 -------------
-Omnibus is designed to run with a minimal set of prerequisites. You will need the following:
+You will need the following:
 
 - Ruby 1.9+
 - Bundler
@@ -35,14 +35,17 @@ Or install it yourself as:
 
 ## Usage
 
-    $ s3rsync help [COMMAND]                                        # Describe available commands or one specific command
-    $ s3rsync upload -c, --config-path=CONFIG_PATH -d, --dir=DIR    # Sync local dir to s3 location
-    $ s3rsync download -c, --config-path=CONFIG_PATH -d, --dir=DIR  # Sync from s3 location to local dir
+    $ s3rsync help [COMMAND]                                          # Describe expanded available commands or one specific command
+    $ s3rsync upload -c, --config-path=CONFIG_PATH -p, --path=PATH    # Sync local path to s3 location
+    $ s3rsync download -c, --config-path=CONFIG_PATH -p, --path=PATH  # Sync from s3 to local path
+    
+## Configuration
 
+json config [s3rsync.json.example](https://github.com/idevops/s3rsync/blob/master/s3rsync.json.example)
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/s3rsync/fork )
+1. [Fork it]( https://github.com/idevops/s3rsync/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/s3rsync/base.rb

@@ -23,14 +23,9 @@ module S3Rsync
       statsd
     end
     
-    def error_exit(msg)
+    def error_exit(msg, exit_code = 1)
       @log.error msg
-      return 1
-    end
-    
-    def error_exit(msg)
-      @log.error msg
-      return 1
+      exit exit_code
     end
     
     def pass_cli(cmd, valid_out_pattern = nil)

data/lib/s3rsync/cli.rb

@@ -2,13 +2,14 @@ require 'thor'
 
 module S3Rsync
   class CLI < Thor
-    
+      
     def self.common_opts
       method_option :path, :aliases => "-p", :required => true
       method_option :'config-path', :aliases => "-c", :required => true
       method_option :'s3-prefix', :aliases => "-s", :default => 's3rsync'
       method_option :'log-path', :aliases => "-l"
       method_option :'dry-run', :aliases => "-d", :type => :boolean, :default => false
+      method_option :'make-public', :aliases => "-m", :type => :boolean, :default => false
     end
     
     desc "upload", "sync from local to s3"

data/lib/s3rsync/sync.rb

@@ -14,14 +14,13 @@ module S3Rsync
       @params[:s3_prefix]   = opt['s3-prefix']
       @params[:config_path] = opt['config-path']
       @params[:s3cmd_conf]  = @params[:config_path].sub('.json', '_s3rsync.conf')
+      @params[:dry_run]     = opt['dry-run']
+      @params[:make_public] = opt['make-public']
       @log.debug "@params[:config_path]: #{@params[:config_path]}"
       begin
         conf = JSON.parse File.read(@params[:config_path])
       rescue Exception => e
-        mgs = "ERROR: opening or parsing config file failed: #{e.inspect}"
-        @log.error mgs
-        raise mgs
-        exit 1
+        error_exit "ERROR: opening or parsing config file failed: #{e.inspect}"
       end
       
       @log.debug "conf: #{conf}"
@@ -35,7 +34,7 @@ module S3Rsync
       @log.debug "@statsd: #{@statsd.inspect}"
       
       init_s3cmd_conf
-      @s3cmd = "s3cmd -c #{@params[:s3cmd_conf]}"
+      @s3cmd = "s3cmd"
     end
     
     def get_lock(name = 'common')
@@ -60,8 +59,7 @@ module S3Rsync
           @log.debug "rendered_template: #{rendered_template}"
           File.write @params[:s3cmd_conf], rendered_template
         rescue Exception => e
-          @log.error "generating s3cmd config failed: #{e.inspect}"
-          exit 1
+          error_exit "generating s3cmd config failed: #{e.inspect}"
         end
         @log.info "Dynamic s3cfg generated: #{@params[:s3cmd_conf]}"
       end
@@ -94,10 +92,17 @@ module S3Rsync
       sync_output = 1
       begin
         lockfile.lock
-        cmd = "#{@s3cmd} sync #{sync_locations}"
+        s3cmd_args = {}
+        s3cmd_args['-c']            = @params[:s3cmd_conf]
+        s3cmd_args['--dry-run']     = '' if @params[:dry_run]
+        s3cmd_args['--acl-public']  = '' if @params[:make_public]
+        @log.debug "s3cmd_args: #{s3cmd_args.inspect}"
+        compiled_args = s3cmd_args.to_a.flatten.reject { |v| v.empty? }.join(' ')
+        @log.debug "compiled_args: #{compiled_args.inspect}"
+        cmd = "#{@s3cmd} #{compiled_args} sync #{sync_locations}"
         @log.debug "cmd: #{cmd}"
         sync_output = pass_cli cmd
-        @log.debug "sync_output: #{sync_output}"
+        @log.debug "sync_output: #{sync_output.inspect}"
       rescue Exception => e
         sync_output = 1
         @log.error "something wrong while trying to run the sync: #{e.inspect}"

data/lib/s3rsync/version.rb

@@ -1,3 +1,3 @@
 module S3rsync
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/s3rsync.json.example

@@ -0,0 +1,7 @@
+{
+  "env.static.s3.key.user": "ACCESS_KEY",
+  "env.static.s3.key.secret": "SECRET_KEY",
+  "env.static.s3.bucket": "S3_BUCKET_NAME",
+  "env.metrics.host": "STATSD_HOST",
+  "env.metrics.port": 8125
+}

data/spec/sync_spec.rb

@@ -10,6 +10,8 @@ describe S3Rsync::Sync do
         'path'        => '/parent_test_dir/test_dir',
         's3-prefix'   => 's3rsync',
         'config-path' => 'test_json_conf_path.json',
+        'dry-run'     => false,
+        'make-public' => false,
       }
     }
     
@@ -23,6 +25,7 @@ describe S3Rsync::Sync do
       
     let(:s3_conf_path) { opt['config-path'].sub('.json', '_s3rsync.conf') }
     let(:base_sync_path) { opt['path'].split('/').last }
+    let(:common_args) { ['-c', s3_conf_path].join(' ') }
     
     before do
       allow(File).to receive(:read).and_return(nil)
@@ -45,7 +48,7 @@ describe S3Rsync::Sync do
     end
     
     it "uploads dir" do
-      cmd = "s3cmd -c #{s3_conf_path} sync #{opt['path']}/ s3://#{json_conf['env.static.s3.bucket']}/#{opt['s3-prefix']}/#{base_sync_path}/"
+      cmd = "s3cmd #{common_args} sync #{opt['path']}/ s3://#{json_conf['env.static.s3.bucket']}/#{opt['s3-prefix']}/#{base_sync_path}/"
       allow_any_instance_of(S3Rsync::Sync).to receive(:pass_cli).with(cmd).and_return('Success')
       
       sync = S3Rsync::Sync.new(opt)
@@ -53,7 +56,7 @@ describe S3Rsync::Sync do
     end
     
     it "downloads dir" do
-      cmd = "s3cmd -c #{s3_conf_path} sync s3://#{json_conf['env.static.s3.bucket']}/#{opt['s3-prefix']}/#{base_sync_path}/ #{opt['path']}/"
+      cmd = "s3cmd #{common_args} sync s3://#{json_conf['env.static.s3.bucket']}/#{opt['s3-prefix']}/#{base_sync_path}/ #{opt['path']}/"
       allow_any_instance_of(S3Rsync::Sync).to receive(:pass_cli).with(cmd).and_return('Success')
       
       sync = S3Rsync::Sync.new(opt)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: s3rsync
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - idevops
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-04 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -203,6 +203,7 @@ files:
 - lib/s3rsync/templates/s3cmd_conf.erb
 - lib/s3rsync/version.rb
 - s3rsync.gemspec
+- s3rsync.json.example
 - spec/spec_helper.rb
 - spec/sync_spec.rb
 homepage: ''