cloud_encrypted_sync_filesystem_adapter 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+coverage/*

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    cloud_encrypted_sync_filesystem_adapter (0.1.0)
+      cloud_encrypted_sync
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    cloud_encrypted_sync (0.3.1)
+    fakefs (0.4.1)
+    i18n (0.6.0)
+    metaclass (0.0.1)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
+    multi_json (1.3.4)
+    rake (0.9.2.2)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  cloud_encrypted_sync_filesystem_adapter!
+  fakefs
+  mocha
+  rake
+  simplecov

data/README.md

@@ -0,0 +1,16 @@
+CloudEncryptedSync Filesystem Adapter
+=====================================
+
+A simple filesystem adapter for the CloudEncryptedSync gem.
+
+This gem is meant primarily to serve as a demo.  Instead of syncing files
+to a remote cloud service, this adapter writes the ecrypted files to another
+folder on your local filesystem.
+
+In addition to arguments required by CES, you must also pass
+`--storage-path /some/local/path` which tells CES where to write the encrypted
+files to.
+
+In theory, this should work just fine with a NFS mounted folder as well, but
+this has not been tested and is not officially supported.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/cloud_encrypted_sync_filesystem_adapter.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "cloud_encrypted_sync_filesystem_adapter"
+  s.version = CloudEncryptedSyncFilesystemAdapter::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Jonathan S. Garvin"]
+  s.email = ["jon@5valleys.com"]
+  s.homepage = "https://github.com/jsgarvin/cloud_encrypted_sync_filesystem_adapter"
+  s.summary = %q{Filesystem adapter plugin for CloudEncryptedSync gem.}
+  s.description = %q{Filesystem adapter plugin for CloudEncryptedSync gem.}
+
+  s.add_dependency('cloud_encrypted_sync')
+
+  s.add_development_dependency('rake')
+  s.add_development_dependency('mocha')
+  s.add_development_dependency('fakefs')
+  s.add_development_dependency('simplecov')
+  s.add_development_dependency('activesupport')
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/adapters/filesystem.rb

@@ -0,0 +1,55 @@
+module CloudEncryptedSync
+  module Adapters
+    class Filesystem < Template
+      attr_accessor :storage_path
+
+      def parse_command_line_options(parser)
+        parser.on('--storage-path PATH', 'Path to folder where encrypted files are/will be stored.') do |storage|
+          self.storage_path = storage
+        end
+      end
+
+      def write(data, key)
+        File.open(storage_path_to(key),'w') { |file| file.write(data) }
+      end
+
+      def read(key)
+        if key_exists?(key)
+          File.read(storage_path_to(key))
+        else
+          raise Errors::NoSuchKey.new(key)
+        end
+      end
+
+      def delete(key)
+        if key_exists?(key)
+          File.delete(storage_path_to(key))
+        else
+          raise Errors::NoSuchKey.new(key)
+        end
+      end
+
+      def key_exists?(key)
+        File.exist?(storage_path_to(key))
+      end
+
+      #######
+      private
+      #######
+
+      def storage_path_to(key)
+        "#{expanded_and_created_storage_path}/#{key}"
+      end
+
+      def expanded_and_created_storage_path
+        FileUtils.mkdir_p(expanded_storage_path)
+        return expanded_storage_path
+      end
+
+      def expanded_storage_path
+        File.expand_path(storage_path)
+      end
+
+    end
+  end
+end

data/lib/cloud_encrypted_sync_filesystem_adapter.rb

@@ -0,0 +1,2 @@
+require 'fileutils'
+require File.expand_path('../adapters/filesystem', __FILE__)

data/lib/version.rb

@@ -0,0 +1,3 @@
+module CloudEncryptedSyncFilesystemAdapter
+  VERSION = '0.1.0'
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+require 'fakefs/safe'
+require 'active_support/test_case'
+require 'test/unit'
+
+SimpleCov.start
+
+require 'cloud_encrypted_sync'
+require 'cloud_encrypted_sync_filesystem_adapter'
+
+module CloudEncryptedSyncFilesystemAdapter
+  class ActiveSupport::TestCase
+
+    setup :initialize_fake_fs
+    teardown :deactivate_fake_fs
+
+    #######
+    private
+    #######
+
+    def initialize_fake_fs
+      FakeFS.activate!
+      FakeFS::FileSystem.clear
+    end
+
+    def deactivate_fake_fs
+      FakeFS.deactivate!
+    end
+
+  end
+end
+require 'mocha'

data/test/unit/adapter_test.rb

@@ -0,0 +1,118 @@
+require 'test_helper'
+
+module CloudEncryptedSyncFilesystemAdapter
+  class AdapterTest < ActiveSupport::TestCase
+
+    def setup
+      stub_configuration
+    end
+
+    def teardown
+      unstub_configuration
+    end
+
+    # This is just a basic example (that will fail until you update it).
+    test 'should parse command line options' do
+      unstub_configuration
+      Object.send(:remove_const,:ARGV)
+      ::ARGV = '--storage-path /some/path'.split(/\s/)
+      @option_parser = OptionParser.new do |parser|
+        adapter.parse_command_line_options(parser)
+      end
+      @option_parser.parse!
+      assert_equal('/some/path',CloudEncryptedSync::Adapters::Filesystem.instance.send(:storage_path))
+      stub_configuration #just so that teardown unstub doesn't throw errors
+    end
+
+    test 'should write readable data to cloud and then delete it' do
+
+      test_data = 'testdata'
+      test_key = 'testkey'
+
+      assert !adapter.key_exists?(test_key)
+
+      assert_difference('number_of_files_in_storage') do
+        adapter.write(test_data,test_key)
+      end
+      assert adapter.key_exists?(test_key)
+
+      assert_equal(test_data,adapter.read(test_key))
+
+      assert_difference('number_of_files_in_storage',-1) do
+        adapter.delete(test_key)
+      end
+      assert !adapter.key_exists?(test_key)
+
+    end
+
+    # Your adapter should be written in such a way that this test passes as is.
+    test 'should raise NoSuchKey error' do
+      assert_raises(CloudEncryptedSync::Errors::NoSuchKey) { adapter.read('nonexistentkey') }
+    end
+
+    test 'should return false for non existent keys' do
+      refute adapter.key_exists?('nonexistentkey')
+    end
+
+    test 'should return true to existent keys' do
+      key = 'foobar'
+      File.open(storage_path_to(key),'w') { |file| file.write('Hello, World!') }
+      assert adapter.key_exists?(key)
+    end
+
+    test 'should write to storage' do
+      key = 'foobar'
+      refute adapter.key_exists?(key)
+      assert_difference('number_of_files_in_storage') do
+        adapter.write('this is my handle, this is my spout',key)
+      end
+      assert adapter.key_exists?(key)
+    end
+
+    test 'should read file from storage' do
+      key = 'foobar'
+      data = 'Hello, World!'
+      File.open(storage_path_to(key),'w') { |file| file.write(data) }
+      assert_equal(data,adapter.read(key))
+    end
+
+    test 'should delete file from storage' do
+      key = 'foobar'
+      data = 'Hello, World!'
+      File.open(storage_path_to(key),'w') { |file| file.write(data) }
+      assert_difference('number_of_files_in_storage',-1) do
+        adapter.delete(key)
+      end
+    end
+
+    #######
+    private
+    #######
+
+    def number_of_files_in_storage
+      Dir["#{full_storage_path}/*"].length
+    end
+
+    def storage_path_to(key)
+      adapter.send(:storage_path_to,key)
+    end
+
+    def full_storage_path
+      adapter.send(:expanded_storage_path)
+    end
+
+    def adapter
+      CloudEncryptedSync::Adapters::Filesystem.instance
+    end
+
+    # Setup test configuration values here as if they were passed in as command line arguments
+    def stub_configuration
+      CloudEncryptedSync::Adapters::Filesystem.any_instance.stubs(:storage_path).returns(File.expand_path('../test_storage_folder',  __FILE__))
+    end
+
+    # Remove stubbed settings here that were stubbed in above method.
+    def unstub_configuration
+      CloudEncryptedSync::Adapters::Filesystem.any_instance.unstub(:storage_path)
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: cloud_encrypted_sync_filesystem_adapter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan S. Garvin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cloud_encrypted_sync
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Filesystem adapter plugin for CloudEncryptedSync gem.
+email:
+- jon@5valleys.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- cloud_encrypted_sync_filesystem_adapter.gemspec
+- lib/adapters/filesystem.rb
+- lib/cloud_encrypted_sync_filesystem_adapter.rb
+- lib/version.rb
+- test/test_helper.rb
+- test/unit/adapter_test.rb
+homepage: https://github.com/jsgarvin/cloud_encrypted_sync_filesystem_adapter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Filesystem adapter plugin for CloudEncryptedSync gem.
+test_files:
+- test/test_helper.rb
+- test/unit/adapter_test.rb