cloud_encrypted_sync 0.1.2 → 0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cloud_encrypted_sync (0.1.1)
+    cloud_encrypted_sync (0.2.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -54,3 +54,5 @@ tries to do something weird).
 ## Creating your own adapter
 
 TODO
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jsgarvin/cloud_encrypted_sync)

data/lib/cloud_encrypted_sync.rb

@@ -1,3 +1,4 @@
+require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/string'
 require 'digest'
 require 'fileutils'

data/lib/cloud_encrypted_sync/adapter_template.rb

@@ -1,11 +1,13 @@
 module CloudEncryptedSync
   module Adapters
     class Template
+      include Singleton
 
       class << self
 
         def inherited(subclass)
-          register_subclass_with_parent(subclass)
+          register_with_parent(subclass)
+          super
         end
 
         def children
@@ -13,39 +15,60 @@ module CloudEncryptedSync
         end
 
         def parse_command_line_options(opts,command_line_options)
-          raise Errors::TemplateMethodCalled.new('parse_command_line_options')
+          instance.parse_command_line_options(opts,command_line_options)
         end
 
         def write(data, key)
-          raise Errors::TemplateMethodCalled.new('write')
+          instance.write(data, key)
         end
 
         def read(key)
-          raise Errors::TemplateMethodCalled.new('read')
+          instance.read(key)
         end
 
         def delete(key)
-          raise Errors::TemplateMethodCalled.new('delete')
+          instance.delete(key)
         end
 
         def key_exists?(key)
-          raise Errors::TemplateMethodCalled.new('key_exists?')
+          instance.key_exists?(key)
         end
 
         #######
         private
         #######
 
-        def register_subclass_with_parent(subclass)
+        def register_with_parent(subclass)
           name = formated_name_of(subclass)
           children[name] ||= subclass
         end
 
         def formated_name_of(subclass)
-          puts "Subclass: #{subclass}"
           subclass.name.match(/([^:]+)$/)[0].underscore.to_sym
         end
+
+      end
+
+      def parse_command_line_options(opts,command_line_options)
+        raise Errors::TemplateMethodCalled.new('parse_command_line_options')
+      end
+
+      def write(data, key)
+        raise Errors::TemplateMethodCalled.new('write')
+      end
+
+      def read(key)
+        raise Errors::TemplateMethodCalled.new('read')
+      end
+
+      def delete(key)
+        raise Errors::TemplateMethodCalled.new('delete')
       end
+
+      def key_exists?(key)
+        raise Errors::TemplateMethodCalled.new('key_exists?')
+      end
+
     end
   end
 end

data/lib/cloud_encrypted_sync/configuration.rb

@@ -6,7 +6,7 @@ module CloudEncryptedSync
       attr_reader :option_parser
 
       def settings
-        @settings ||= load_settings
+        @settings ||= load
       end
 
       def data_folder_path
@@ -17,17 +17,30 @@ module CloudEncryptedSync
       private
       #######
 
-      def load_settings
+      def load
         touch_data_folder
-        loaded_settings = {}
-        loaded_settings = YAML.load_file(config_file_path) if File.exist?(config_file_path)
-        loaded_settings.merge!(command_line_options)
-        loaded_settings = loaded_settings.inject({}) do |options, (key, value)|
-          options[(key.to_sym rescue key) || key] = value
-          options
-        end
+        loaded_settings = config_file_settings.merge(command_line_options).with_indifferent_access
+
         loaded_settings[:sync_path] = ARGV.shift unless ARGV.empty?
 
+        validate_settings(loaded_settings)
+
+        return loaded_settings
+      end
+
+      def config_file_settings
+        @config_file_settings ||= load_config_file_settings
+      end
+
+      def load_config_file_settings
+        if File.exist?(config_file_path)
+          YAML.load_file(config_file_path)
+        else
+          {}
+        end
+      end
+
+      def validate_settings(loaded_settings)
         if loaded_settings[:sync_path].nil?
           message = "You must supply a path to a folder to sync.\n\n#{option_parser.help}"
           raise Errors::IncompleteConfigurationError.new(message)
@@ -35,8 +48,6 @@ module CloudEncryptedSync
           message = "You must supply an encryption key.\n\n#{option_parser.help}"
           raise Errors::IncompleteConfigurationError.new(message)
         end
-
-        return loaded_settings
       end
 
       def touch_data_folder

data/lib/cloud_encrypted_sync/dummy_adapter.rb

@@ -2,45 +2,42 @@ module CloudEncryptedSync
   module Adapters
     class Dummy < Template
 
-      class << self
-
-        def write(data,key)
-          stored_data[bucket_name][key] = data
-        end
-
-        def parse_command_line_options(opts,command_line_options)
-          opts.on('--bucket BUCKETNAME', 'Name of cloud adapter to use.') do |bucket_name|
-            command_line_options[:bucket] = bucket_name
-          end
-          return command_line_options
-        end
+      def write(data,key)
+        stored_data[bucket_name][key] = data
+      end
 
-        def read(key)
-          raise Errors::NoSuchKey.new("key doesn't exist: #{key}") unless key_exists?(key)
-          stored_data[bucket_name][key]
+      def parse_command_line_options(opts,command_line_options)
+        opts.on('--bucket BUCKETNAME', 'Name of cloud adapter to use.') do |bucket_name|
+          command_line_options[:bucket] = bucket_name
         end
+        return command_line_options
+      end
 
-        def delete(key)
-          stored_data[bucket_name].delete(key)
-        end
+      def read(key)
+        raise Errors::NoSuchKey.new("key doesn't exist: #{key}") unless key_exists?(key)
+        stored_data[bucket_name][key]
+      end
 
-        def key_exists?(key)
-          stored_data[bucket_name][key] ? true : false
-        end
+      def delete(key)
+        stored_data[bucket_name].delete(key)
+      end
 
-        #######
-        private
-        #######
+      def key_exists?(key)
+        stored_data[bucket_name][key] ? true : false
+      end
 
-        def stored_data
-          @stored_data ||= { bucket_name => {} }
-        end
+      #######
+      private
+      #######
 
-        def bucket_name
-          Configuration.settings[:bucket].to_sym
-        end
+      def stored_data
+        @stored_data ||= { bucket_name => {} }
+      end
 
+      def bucket_name
+        Configuration.settings[:bucket].to_sym
       end
+
     end
   end
 end

data/lib/cloud_encrypted_sync/index.rb

@@ -43,16 +43,14 @@ module CloudEncryptedSync
 
       def compile_local_hash
         hash = {}
-        progress_meter = ProgressMeter.new(Dir["#{normalized_sync_path}/**/*"].length,:label => 'Compiling Local Index: ')
-        completed_files = 0
-        Find.find(normalized_sync_path) do |path|
-          print progress_meter.update(completed_files)
-          unless FileTest.directory?(path)
-            hash[file_key(path)] = relative_file_path(path)
+        ProgressMeter.new(Dir["#{normalized_sync_path}/**/*"].length,:label => 'Compiling Local Index: ') do |progress_meter|
+          Find.find(normalized_sync_path) do |path|
+            unless FileTest.directory?(path)
+              hash[file_key(path)] = relative_file_path(path)
+            end
+            progress_meter.increment_completed_index
           end
-          completed_files += 1
         end
-        puts #newline for progress meter
         return hash
       end
 

data/lib/cloud_encrypted_sync/progress_meter.rb

@@ -8,18 +8,11 @@ module CloudEncryptedSync
       @label = options[:label] || ''
       @completed_index = 0.0
       @start_time = Time.now
+      yield self if block_given?
     end
 
-    def to_s
-      sprintf("\r#{label}%0.1f%% Complete. Time Remaining %s", percent_completed, estimated_time_remaining.strftime('%M:%S'))
-    end
-
-    def percent_completed
-      (completed_index/max_index)*100
-    end
-
-    def time_elapsed
-      Time.now - start_time
+    def estimated_time_remaining
+      Time.at(estimated_finish_time - Time.now)
     end
 
     def estimated_finish_time
@@ -30,14 +23,25 @@ module CloudEncryptedSync
       end
     end
 
-    def estimated_time_remaining
-      Time.at(estimated_finish_time - Time.now)
+    def percent_completed
+      (completed_index/max_index)*100
+    end
+
+    def time_elapsed
+      Time.now - start_time
     end
 
-    def update(completed_index)
-      self.completed_index = completed_index
-      return self
+    def increment_completed_index(amount = 1)
+      self.completed_index += amount
+      notify
     end
 
+    #######
+    private
+    #######
+
+    def notify
+      print sprintf("\r#{label}%0.1f%% Complete. Time Remaining %s", percent_completed, estimated_time_remaining.strftime('%M:%S'))
+    end
   end
 end

data/lib/cloud_encrypted_sync/synchronizer.rb

@@ -16,45 +16,59 @@ module CloudEncryptedSync
         end
       end
 
+      #######
+      private
+      #######
+
       def push_files
-        progress_meter = ProgressMeter.new(files_to_push.keys.size,:label => 'Pushing Files: ')
-        pushed_files_counter = 0
-        files_to_push.each_pair do |key,relative_path|
-          puts #newline for progress meter
-          if liaison.key_exists?(key)
-            #already exists. probably left over from an earlier aborted push
-            puts "Not Pushing (already exists): #{relative_path}"
-          else
-            puts "Pushing: #{relative_path}"
-            liaison.push(File.read(Index.full_file_path(relative_path)),key)
-            self.finalize_required = true
+        ProgressMeter.new(files_to_push.keys.size,:label => 'Pushing Files: ') do |progress_meter|
+          pushed_files_counter = 0
+          files_to_push.each_pair do |key,relative_path|
+            push_file_if_necessary(key,relative_path)
+            progress_meter.increment_completed_index
           end
-          pushed_files_counter += 1
-          print progress_meter.update(pushed_files_counter)
+        end
+      end
+
+      def push_file_if_necessary(key,relative_path)
+        if liaison.key_exists?(key)
+          #already exists. probably left over from an earlier aborted push
+          puts "\nNot Pushing (already exists): #{relative_path}"
+        else
+          puts "\nPushing: #{relative_path}"
+          liaison.push(File.read(Index.full_file_path(relative_path)),key)
+          self.finalize_required = true
         end
       end
 
       def pull_files
-        progress_meter = ProgressMeter.new(files_to_pull.keys.size,:label => 'Pulling Files: ')
-        pulled_files_counter = 0
-        files_to_pull.each_pair do |key,relative_path|
-          full_path = Index.full_file_path(relative_path)
-          puts #newline for progress meter
-          if File.exist?(full_path) and (Index.file_key(full_path) == key)
-            #already exists. probably left over from an earlier aborted pull
-            puts "Not Pulling (already exists): #{full_path}"
-          else
-            Dir.mkdir(File.dirname(full_path)) unless File.exist?(File.dirname(full_path))
-            puts "Pulling: #{relative_path}"
-            begin
-              File.open(full_path,'w') { |file| file.write(liaison.pull(key)) }
-              self.finalize_required = true
-            rescue Errors::NoSuchKey
-              puts "Failed to pull #{relative_path}"
-            end
+        ProgressMeter.new(files_to_pull.keys.size,:label => 'Pulling Files: ') do |progress_meter|
+          files_to_pull.each_pair do |key,relative_path|
+            pull_file_if_necessary(key,relative_path)
+            progress_meter.increment_completed_index
           end
-          pulled_files_counter += 1
-          print progress_meter.update(pulled_files_counter)
+        end
+      end
+
+      def pull_file_if_necessary(key,relative_path)
+        full_path = Index.full_file_path(relative_path)
+        if File.exist?(full_path) and (Index.file_key(full_path) == key)
+          #already exists. probably left over from an earlier aborted pull
+          puts "\nNot Pulling (already exists): #{full_path}"
+        else
+          Dir.mkdir(File.dirname(full_path)) unless File.exist?(File.dirname(full_path))
+          puts "\nPulling: #{relative_path}"
+          pull_file_or_rescue(key,relative_path)
+        end
+      end
+
+      def pull_file_or_rescue(key,relative_path)
+        full_path = Index.full_file_path(relative_path)
+        begin
+          File.open(full_path,'w') { |file| file.write(liaison.pull(key)) }
+          self.finalize_required = true
+        rescue Errors::NoSuchKey
+          puts "\nFailed to pull #{relative_path}"
         end
       end
 
@@ -83,10 +97,6 @@ module CloudEncryptedSync
         Index.write if finalize_required
       end
 
-      #######
-      private
-      #######
-
       def liaison
         AdapterLiaison.instance
       end

data/lib/cloud_encrypted_sync/version.rb

@@ -1,3 +1,3 @@
 module CloudEncryptedSync
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/test/unit/adapter_template_test.rb

@@ -4,7 +4,7 @@ module CloudEncryptedSync
   class AdapterTemplateTest < ActiveSupport::TestCase
 
     test 'should register with parent class on inheritance' do
-      Adapters::Template.expects(:register_subclass_with_parent).returns(true)
+      Adapters::Template.expects(:register_with_parent).returns(true)
       Class.new(Adapters::Template)
     end
 

data/test/unit/progress_meter_test.rb

@@ -9,32 +9,36 @@ module CloudEncryptedSync
     end
 
     test 'should calculate percent completed' do
-      @progress_meter.update(1)
+      @progress_meter.increment_completed_index
       assert_equal(25,@progress_meter.percent_completed)
     end
 
     test 'should calculate time elapsed' do
-      assert_in_delta(42,@progress_meter.time_elapsed,0.01)
+      assert_in_delta(42,@progress_meter.time_elapsed,0.02)
     end
 
     test 'should estimate finish time' do
-      @progress_meter.update(1)
-      assert_in_delta(Time.now+(42*3),@progress_meter.estimated_finish_time,0.01)
+      @progress_meter.increment_completed_index
+      assert_in_delta(Time.now+(42*3),@progress_meter.estimated_finish_time,0.02)
     end
 
     test 'should estimate time remaining' do
-      @progress_meter.update(1)
-      assert_in_delta((42*3),@progress_meter.estimated_time_remaining.to_f,0.01)
+      @progress_meter.increment_completed_index
+      assert_in_delta((42*3),@progress_meter.estimated_time_remaining.to_f,0.02)
     end
 
-    test 'should update progress and return self' do
+    test 'should increment counter and write to stdout' do
+      assert_equal('',$stdout.string)
       assert_difference('@progress_meter.completed_index',2) do
-        assert_equal(@progress_meter,@progress_meter.update(2))
+        @progress_meter.increment_completed_index(2)
       end
+      assert_match(/\% Complete/,$stdout.string)
     end
 
     test 'should render string' do
-      assert_match(/0\% Complete/,@progress_meter.to_s)
+      assert_equal('',$stdout.string)
+      @progress_meter.send(:notify)
+      assert_match(/\% Complete/,$stdout.string)
     end
   end
 end

data/test/unit/synchronizer_test.rb

@@ -25,13 +25,13 @@ module CloudEncryptedSync
       Adapters::Dummy.expects(:write)
 
       assert_equal('',$stdout.string)
-      Synchronizer.push_files
+      Synchronizer.send(:push_files)
       assert_match(/\% Complete/,$stdout.string)
     end
 
     test 'should not push files that already exist' do
       AdapterLiaison.instance.stubs(:key_exists?).returns(true)
-      Synchronizer.push_files
+      Synchronizer.send(:push_files)
       assert_match(/\(already exists\)/,$stdout.string)
     end
 
@@ -40,7 +40,7 @@ module CloudEncryptedSync
       Adapters::Dummy.expects(:read).with('new_file_key').returns(Cryptographer.encrypt_data('foobar'))
       assert_equal('',$stdout.string)
       assert_difference('Dir["#{test_source_folder}/**/*"].length') do
-        Synchronizer.pull_files
+        Synchronizer.send(:pull_files)
       end
       assert_match(/\% Complete/,$stdout.string)
     end
@@ -49,14 +49,14 @@ module CloudEncryptedSync
       Synchronizer.stubs(:files_to_pull).returns({:foo => 'bar'})
       File.stubs(:exist?).returns(true)
       Index.stubs(:file_key).returns(:foo)
-      Synchronizer.pull_files
+      Synchronizer.send(:pull_files)
       assert_match(/\(already exists\)/,$stdout.string)
     end
 
     test 'should gracefully recover if pull fails' do
       Synchronizer.stubs(:files_to_pull).returns({:foo => 'bar'})
       AdapterLiaison.instance.stubs(:pull).raises(Errors::NoSuchKey)
-      Synchronizer.pull_files
+      Synchronizer.send(:pull_files)
       assert_match(/Failed to pull/,$stdout.string)
     end
 
@@ -65,7 +65,7 @@ module CloudEncryptedSync
       Index.stubs(:local).returns({'saved_file_key' => 'test_sub_folder/saved_file.txt'})
       Synchronizer.stubs(:last_sync_hash).returns({'saved_file_key' => 'test_sub_folder/saved_file.txt', 'deleted_file_key' => 'test_sub_folder/deleted_file.txt'})
       Adapters::Dummy.expects(:delete).with('deleted_file_key').returns(true)
-      Synchronizer.delete_remote_files
+      Synchronizer.send(:delete_remote_files)
       assert_match(/Deleting Remote/,$stdout.string)
     end
 
@@ -73,7 +73,7 @@ module CloudEncryptedSync
       Index.stubs(:remote).returns({'saved_file_key' => 'test_sub_folder/saved_file.txt'})
       Synchronizer.stubs(:last_sync_hash).returns({'saved_file_key' => 'test_sub_folder/saved_file.txt'}.merge(Index.local))
       assert_difference('Dir["#{test_source_folder}/**/*"].length',-1) do
-        Synchronizer.delete_local_files
+        Synchronizer.send(:delete_local_files)
       end
       assert_match(/Deleting Local/,$stdout.string)
     end
@@ -81,7 +81,7 @@ module CloudEncryptedSync
     test 'should gracefully recover if local file disappears before delete' do
       Synchronizer.stubs(:local_files_to_delete).returns({:foo => 'bar'})
       File.stubs(:exist?).returns(false)
-      Synchronizer.delete_local_files
+      Synchronizer.send(:delete_local_files)
       assert_match(/Not Deleting Local/,$stdout.string)
     end
 
@@ -89,7 +89,7 @@ module CloudEncryptedSync
       Synchronizer.instance_variable_set(:@finalize_required,true)
       Index.expects(:write)
 
-      Synchronizer.finalize
+      Synchronizer.send(:finalize)
     end
 
     test 'should want to push everything on first run with local files and empty remote' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_encrypted_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
+date: 2012-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mocha