cloud_encrypted_sync 0.3.0 → 0.3.1

data/Gemfile.lock

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

data/README.md

@@ -23,11 +23,14 @@ preferred cloud.
 CES runs as a command line tool and takes options as CLI arguments and/or from a config file.
 Arguments passed at the command line take precedence over those in the config file.
 
-### Example
+### Example (assuming CES S3 Adapter gem is installed)
 
-    ces --adapter=s3 --bucket=my-backup-bucket \
-      --s3-credentials=ACCESS_KEY_ID,SECRET_ACCESS_KEY \
-      --encryption-key=MYENCRYPTIONKEY /path/to/source/folder
+    ces --adapter s3 \
+      --s3-bucket my-backup-bucket \
+      --s3-access-key-id ACCESS_KEY_ID \
+      --s3-access-id SECRET_ACCESS_KEY \
+      --encryption-key MYENCRYPTIONKEY \
+      /path/to/source/folder
 
 ## Configuration
 
@@ -37,13 +40,13 @@ The default location for the config file is `~/.cloud_encrypted_sync/config.rc.y
 
 ### Available Settings
 
-CES requires the following configuration settings. Any of thse may alternatively be placed in
-the `config.rc.yml` execpt for `--data-dir` (which tells CES which folder contains the config
+CES requires the following configuration settings. Any of these may alternatively be placed in
+the `config.rc.yml` except for `--data-dir` (which tells CES which folder contains the config
 file to use).
 
-* `--adapter=ADAPTERNAME` The name of the adapter to use. See instructions for your preferred
+* `--adapter ADAPTERNAME` The name of the adapter to use. See instructions for your preferred
 adapter for instructions of what to place here.
-* `--encryption-key=XXX`  The encryption key (shocking, I know).
+* `--encryption-key XXX`  The encryption key (shocking, I know).
 
 In addition to these settings, your chosen adapter will probably also have additional adapter
 specific settings as well, such as credentials to log into your cloud storage account. Adapter
@@ -53,6 +56,33 @@ tries to do something weird).
 
 ## Creating your own adapter
 
-TODO
+To create your own adapter to a cloud storage service, you'll need to do the following.
+
+* Create a Ruby Gem named `cloud_encrypted_sync_*_adapter` where `*` is the name of your adapter.
+  It is recommended that you name your adapter after the cloud service that it interfaces to.
+  (eg. cloud_encrypted_sync_s3_adapter ). CES will not be able to find and load your adapter
+  unless it precisely matches this naming convention.
+* Your gem needs to provide a class within the `CloudEncryptedSync::Adapters` namespace that
+  inherites from `Template`. The name of this class will determine the value that users pass with
+  `--adaper` on the command line to select your adapter.  For instance, if you name your class
+  `MySuperDooperAdapter`, then users will need to pass `--adapter my_super_dooper_adapter` at the
+  command line to select your adapter.
+* See the [Baseline](https://github.com/jsgarvin/cloud_encrypted_sync_baseline_adapter/blob/master/lib/baseline/adapter.rb)
+  class in [cloud_encrypted_sync_baseline_adapter](https://github.com/jsgarvin/cloud_encrypted_sync_baseline_adapter "Cloud Encrypted Sync Baseline Adapter")
+  for a list of methods that your adapter class needs to respond to, what arguments they need to
+  accept, and what values they're expected to return.
+
+Note: [cloud_encrypted_sync_baseline_adapter](https://github.com/jsgarvin/cloud_encrypted_sync_baseline_adapter "Cloud Encrypted Sync Baseline Adapter")
+is a forkable repository that should make the above steps easier. Simply fork it, rename it,
+update it as necessary, and push it to rubygems.org.
+
+### Testing your adapter locally before publishing to rubygems.org
+
+It is likely that, before publishing your new adapter to rubygems.org, you'll want to build and
+install your gem locally to test it with CES. When you do this you'll also want to have the CES
+gem itself built and installed locally, rather than installed from rubygems.org. It has been found
+that when CES has been installed from rubygems.org, it is unable to find and load locally built
+adapters, and visa-versa. The CES author is very interested in any patches that provide an elegant
+solution to this annoyance.
 
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jsgarvin/cloud_encrypted_sync)

data/lib/cloud_encrypted_sync/configuration.rb

@@ -73,7 +73,7 @@ module CloudEncryptedSync
           end
           parser.on('--adapter ADAPTERNAME', 'Name of cloud adapter to use.') do |adapter_name|
             clo[:adapter_name] = adapter_name
-            AdapterLiaison.instance.adapters[adapter_name.to_sym].parse_command_line_options(parser)
+            fetch_selected_adapter_or_raise(adapter_name).parse_command_line_options(parser)
           end
           parser.on('--encryption-key KEY') do |key|
             clo[:encryption_key] = key
@@ -84,6 +84,12 @@ module CloudEncryptedSync
         return clo
       end
 
+      def fetch_selected_adapter_or_raise(adapter_name)
+        if AdapterLiaison.instance.adapters[adapter_name.to_sym]
+          return AdapterLiaison.instance.adapters[adapter_name.to_sym]
+        end
+        raise Errors::IncompleteConfigurationError.new("Unrecognized adapter. Available choices are: #{AdapterLiaison.instance.adapters.keys.join(', ')}.")
+      end
     end
   end
 end

data/lib/cloud_encrypted_sync/synchronizer.rb

@@ -74,7 +74,7 @@ module CloudEncryptedSync
 
       def delete_remote_files
         remote_files_to_delete.each_pair do |key,path|
-          puts "Deleting Remote: #{path}"
+          print "\nDeleting Remote: #{path}"
           liaison.delete(key)
           self.finalize_required = true
         end
@@ -84,9 +84,9 @@ module CloudEncryptedSync
         local_files_to_delete.each_pair do |key,relative_path|
           full_path = Index.full_file_path(relative_path)
           if !File.exist?(full_path)
-            puts "Not Deleting Local: #{relative_path}"
+            print "\nNot Deleting Local: #{relative_path}"
           else
-            puts "Deleting Local: #{relative_path}"
+            print "\nDeleting Local: #{relative_path}"
             File.delete(full_path)
             self.finalize_required = true
           end

data/lib/cloud_encrypted_sync/version.rb

@@ -1,3 +1,3 @@
 module CloudEncryptedSync
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/test/unit/configuration_test.rb

@@ -30,6 +30,11 @@ module CloudEncryptedSync
       assert_raise(Errors::IncompleteConfigurationError) { Configuration.settings }
     end
 
+    test 'should gracefully fail with invalid adapter provided' do
+      ::ARGV = '--adapter nonexistent --bucket foobar'.split(/\s/)
+      assert_raise(Errors::IncompleteConfigurationError) { Configuration.settings }
+    end
+
     test 'should create data folder if it does not exist' do
       ::ARGV = '--adapter dummy --bucket foobar --data-dir /test --encryption-key somestringofcharacters /some/path'.split(/\s/)
       assert ! File.exist?('/test')

metadata

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