ssync 0.3.3 → 0.4.0

data/Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     ssync (0.3.3)
       aws-s3 (~> 0.6.2)
+      thor (~> 0.14.4)
 
 GEM
   remote: http://rubygems.org/
@@ -13,6 +14,7 @@ GEM
       xml-simple
     builder (2.1.2)
     mime-types (1.16)
+    thor (0.14.4)
     xml-simple (1.0.12)
 
 PLATFORMS
@@ -21,3 +23,4 @@ PLATFORMS
 DEPENDENCIES
   aws-s3 (~> 0.6.2)
   ssync!
+  thor (~> 0.14.4)

data/README.md

@@ -31,14 +31,20 @@ or `ssync sync --force` to force a checksum comparison.
 
 If you would like to sync to more than one S3 buckets, you may do so by:
 
-    ssync setup my-s3-bucket
-    ssync sync my-s3-bucket
+    ssync setup -b my-s3-bucket
+    ssync sync -b my-s3-bucket
 
-    ssync setup another-s3-bucket
-    ssync sync another-s3-bucket
+    ssync setup -b another-s3-bucket
+    ssync sync -b another-s3-bucket
 
 Running `ssync setup` and `ssync sync` without any bucket names defaults to using the last bucket you used.
 
+## Need Help?
+
+Use the command below to get to the help screen.
+
+    ssync help
+
 ## Why?
 
 This library was written because we needed to be able to back up loads of

data/bin/ssync

@@ -3,4 +3,4 @@
 $:.unshift File.dirname(__FILE__) + "/../lib"
 require "ssync/command"
 
-Ssync::Command.run!(*ARGV)
+Ssync::Command.start

data/lib/ssync/command.rb

@@ -1,64 +1,52 @@
 require "ssync"
+require "thor"
 
 module Ssync
-  class Command
+  class Command < ::Thor
     include Helpers
 
-    def self.action
-      @@action
-    end
+    default_task :sync
 
-    def self.args
-      @@args
-    end
+    desc "setup", "Sets up a configuration file for syncing"
+    method_option "bucket", :aliases => "-b", :type => :string,
+      :banner => "The S3 bucket (configurated with Ssync) to sync to"
+    def setup
+      %w{find xargs openssl}.each do |util|
+        e! "You do not have '#{util}' installed on your operating system." if `which #{util}`.empty?
+      end
 
-    def self.run!(*args)
-      new(*args).run!
+      if options.bucket?
+        e! "The S3 bucket config for '#{options.bucket}' does not exist." unless config_exists?(config_path(options.bucket))
+        write_default_config(options.bucket)
+      end
+      aquire_lock! { Ssync::Setup.run! }
     end
 
-    def initialize(action = :sync, *args)
-      @@action = action.to_sym
-      @@args   = args
-
-      if @@args[0] && @@args[0][0, 1] != "-"
-        Setup.default_config[:last_used_bucket] = @@args[0]
-        write_default_config!(Setup.default_config)
+    desc "sync", "Syncs to Amazon S3"
+    method_option "bucket", :aliases => "-b", :type => :string,
+      :banner => "The S3 bucket (configurated with Ssync) to sync to"
+    method_option "force", :aliases => "-f", :type => :boolean,
+      :banner => "Forces a recalculate of the checksum, useful when the previous sync was incomplete or corrupted"
+    def sync
+      unless config_exists?(default_config_path) || config_exists?
+        e! "Cannot run the sync, there is no Ssync configuration, try 'ssync setup' to create one first."
       end
-    end
 
-    def run!
-      util_check!
-      pre_run_check!
-      perform_action!
+      write_default_config(options.bucket) if options.bucket?
+      aquire_lock! { Ssync::Sync.run!(options) }
     end
 
-    private
-
-    def util_check!
-      %w{find xargs openssl}.each do |util|
-        e! "You do not have '#{util}' installed on your operating system." if `which #{util}`.empty?
-      end
+    desc "version", "Prints Ssync's version information"
+    def version
+      puts "Ssync #{Ssync::VERSION}"
     end
+    map %w{-v --version} => :version
 
-    def pre_run_check!
-      if action_eq?(:sync) && !config_exists?(default_config_path) && !config_exists?
-        e! "Cannot run the sync, there is no Ssync configuration, try 'ssync setup' to create one first."
-      end
-    end
+    private
 
-    def perform_action!
-      case @@action
-      when :setup
-        Ssync::Setup.run!
-      when :sync
-        aquire_lock! { Ssync::Sync.run! }
-      when :help, :"--help", :"-h"
-        display_help!
-      when :version, :"--version", :"-v"
-        puts Ssync::VERSION
-      else
-        e! "Cannot perform action '#{@action}', try 'ssync help' for usage."
-      end
+    def write_default_config(bucket)
+      Setup.default_config[:last_used_bucket] = bucket
+      write_default_config!(Setup.default_config)
     end
   end
 end

data/lib/ssync/helpers.rb

@@ -1,9 +1,5 @@
 module Ssync
   module Helpers
-    def display_help!
-      display("Not implemented yet.")
-    end
-
     def display(message)
       puts("[#{Time.now}] #{message}")
     end
@@ -26,10 +22,6 @@ module Ssync
       a.empty? ? config_item : a
     end
 
-    def action_eq?(action)
-      Ssync::Command.action == action.to_sym
-    end
-
     def config_exists?(path = config_path)
       File.exist?(path)
     end
@@ -46,8 +38,8 @@ module Ssync
       "#{ssync_homedir}/defaults.yml"
     end
 
-    def config_path
-      "#{ssync_homedir}/#{ssync_filename}.yml"
+    def config_path(filename = nil)
+      "#{ssync_homedir}/#{filename || ssync_filename}.yml"
     end
 
     def lock_path
@@ -55,14 +47,15 @@ module Ssync
     end
 
     def aquire_lock!
+      return unless lock_path
       # better way is to write out the pid ($$) and read it back in, to make sure it's the same
       e! "Found a lock at #{lock_path}, is another instance of Ssync running?" if File.exist?(lock_path)
 
       begin
-        system "touch #{lock_path}"
+        system "touch #{lock_path}" unless ssync_filename.empty?
         yield
       ensure
-        system "rm #{lock_path}"
+        system "rm -f #{lock_path}"
       end
     end
 
@@ -94,12 +87,5 @@ module Ssync
     def create_homedir!
       `mkdir #{ssync_homedir}` unless File.exists?(ssync_homedir)
     end
-
-    def options_set?(*options)
-      false
-      [options].flatten.each do |option|
-        return true if Command.args.include?("#{option.to_s}")
-      end
-    end
   end
 end

data/lib/ssync/sync.rb

@@ -3,14 +3,14 @@ module Ssync
     class << self
       include Helpers
 
-      def run!
+      def run!(options)
         display "Initialising Ssync, performing pre-sync checks ..."
 
         e! "Couldn't connect to AWS with the credentials specified in '#{config_path}'." unless Setup.aws_credentials_is_valid?
         e! "Couldn't find the S3 bucket specified in '#{config_path}'." unless Setup.bucket_exists?
         e! "The local path specified in '#{config_path}' does not exist." unless Setup.local_file_path_exists?
 
-        if options_set?("-f", "--force")
+        if options.force?
           display "Clearing previous sync state ..."
           clear_sync_state
         end

data/lib/ssync/version.rb

@@ -1,3 +1,3 @@
 module Ssync
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/ssync.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency(%q<aws-s3>, ["~> 0.6.2"])
+  s.add_runtime_dependency(%q<thor>, ["~> 0.14.4"])
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Fred Wu
@@ -33,6 +33,21 @@ dependencies:
         version: 0.6.2
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 14
+        - 4
+        version: 0.14.4
+  type: :runtime
+  version_requirements: *id002
 description: Ssync, an optimised S3 sync tool using the power of *nix!
 email: 
 - fred@envato.com