defog 0.5.0 → 0.6.0

data/README.rdoc

@@ -43,6 +43,8 @@ object, which proxies files in a specific remote location, e.g.:
         defog = Defog::Proxy.new(:provider => :Local,
                                  :local_root => "/path/to/directory")
 
+For complete options, see Defog::Proxy.new RDOC
+
 === Proxy a file
 
 Open a proxy to a remote file by creating a <code>Defog::File</code> object:

data/lib/defog/fog_wrapper.rb

@@ -9,6 +9,7 @@ module Defog #:nodoc: all
     attr_reader :location
     attr_reader :fog_connection
     attr_reader :fog_directory
+    attr_accessor :logger
 
     def self.connect(opts={})
       opts = opts.keyword_args(:provider => :required, :OTHERS => :optional)
@@ -24,6 +25,7 @@ module Defog #:nodoc: all
     def get_file(key, path, encoding)
       raise Error::NoCloudFile, "No such file in #{provider} #{location}: #{key}" unless fog_head(key)
       return if path.exist? and Digest::MD5.hexdigest(path.read) == get_md5(key)
+      log :download, key, path
       path.open("w#{encoding}") do |f|
         f.write(fog_head(key).body)
       end
@@ -31,13 +33,14 @@ module Defog #:nodoc: all
 
     def put_file(key, path, encoding)
       return if path.exist? and fog_head(key) and Digest::MD5.hexdigest(path.read) == get_md5(key)
+      log :upload, key, path
       path.open("r#{encoding}") do |file|
         fog_directory.files.create(:key => @prefix.to_s + key, :body => file)
       end
     end
 
     def fog_head(key)
-      fog_directory.files.head(@prefix.to_s + key)
+      @heads[key] ||= fog_directory.files.head(@prefix.to_s + key)
     end
 
     def each
@@ -51,17 +54,22 @@ module Defog #:nodoc: all
     private
 
     def initialize(opts={})
-      opts = opts.keyword_args(:prefix => :optional)
-      @prefix = opts.prefix
+      opts.replace(opts.keyword_args(:prefix => :optional, :logger => :optional, :OTHERS => :optional))
+      @prefix = opts.delete(:prefix)
+      @logger = opts.delete(:logger)
+      @heads = {}
     end
 
+    def log(action, key, path)
+      @logger.info "Defog[#{provider}:#{location}] #{action.to_s.capitalize} #{@prefix}#{key} #{action==:download ? "=>" : "<="} #{path}" if @logger
+    end
 
     class Local < FogWrapper
       def provider ; :local ; end
 
       def initialize(opts={})
-        opts = opts.keyword_args(:local_root => :required, :prefix => :optional)
-        super(:prefix => opts.delete(:prefix))
+        super(opts)
+        opts = opts.keyword_args(:local_root => :required)
         @local_root = Pathname.new(opts.local_root)
         @local_root.mkpath unless @local_root.exist?
         @local_root = @local_root.realpath
@@ -89,8 +97,8 @@ module Defog #:nodoc: all
       def provider ; :AWS ; end
 
       def initialize(opts={})
-        opts = opts.keyword_args(:aws_access_key_id => :required, :aws_secret_access_key => :required, :region => :optional, :bucket => :required, :prefix => :optional)
-        super(:prefix => opts.delete(:prefix))
+        super(opts)
+        opts = opts.keyword_args(:aws_access_key_id => :required, :aws_secret_access_key => :required, :region => :optional, :bucket => :required)
         @location = opts.delete(:bucket)
         @fog_connection = (@@aws_connection_cache||={})[opts] ||= Fog::Storage.new(opts.merge(:provider => provider))
         @fog_connection.directories.create :key => @location unless @fog_connection.directories.map(&:key).include? @location

data/lib/defog/proxy.rb

@@ -10,6 +10,7 @@ module Defog
     attr_reader :persist
     attr_reader :synchronize
     attr_reader :max_cache_size
+
     attr_reader :fog_wrapper    # :nodoc:
 
     # Opens a <code>Fog</code> cloud storage connection to map to a corresponding proxy
@@ -68,6 +69,11 @@ module Defog
     # Defog::File#close).  Note that this applies only to upload of changes to
     # proxy files that are opened as writeable; the download of data to
     # readable proxy files always happens synchronously.
+    #
+    # If you specify
+    #      :logger => an-instance-of-Logger
+    # (or provide a logger via #logger=), Defog will log downloads and
+    # upload using Logger#info.
     def initialize(opts={})
       opts = opts.keyword_args(:provider => :required,
                                :proxy_root => :optional,
@@ -124,6 +130,14 @@ module Defog
       @fog_wrapper.prefix
     end
 
+    def logger
+      @fog_wrapper.logger
+    end
+
+    def logger=(log)
+      @fog_wrapper.logger= log
+    end
+
     # Proxy a remote cloud file.  Returns or yields a Defog::Handle object that
     # represents the file. 
     #

data/lib/defog/version.rb

@@ -1,3 +1,3 @@
 module Defog
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/file_spec.rb

@@ -4,6 +4,7 @@ shared_examples "get proxy" do
 
   it "should create proxy if remote exists" do
     create_remote("hello")
+    should_log /download/
     file = @proxy.file(key, @mode)
     File.exist?(file.path).should be_true
     file.close
@@ -17,6 +18,7 @@ shared_examples "get proxy" do
     create_remote("hello")
     create_proxy("goodbye")
     proxy_path.read.should == "goodbye"
+    should_log /download/
     @proxy.file(key, @mode)
     proxy_path.read.should == "hello"
   end
@@ -26,6 +28,7 @@ shared_examples "get proxy" do
     create_proxy("hello")
     handle = @proxy.file(key)
     handle.proxy_path.should_not_receive(:open).with(/^w/)
+    should_not_log /download/
     handle.open(@mode)
   end
 end
@@ -81,6 +84,7 @@ shared_examples "append" do
     create_remote("hello")
     @proxy.file(key, @mode, :persist => true) do |file|
       file.write "goodbye"
+      should_log /upload/
     end
     proxy_path.read.should == "hellogoodbye"
   end
@@ -89,6 +93,7 @@ end
 shared_examples "create" do
 
   it "should create remote" do
+    should_log /upload/
     file = @proxy.file(key, @mode)
     create_proxy("upload me")
     file.close
@@ -96,6 +101,7 @@ shared_examples "create" do
   end
 
   it "should not create remote if proxy is deleted" do
+    should_not_log /upload/
     @proxy.file(key, @mode) do |file|
       file.write("ignore me")
       proxy_path.unlink
@@ -104,6 +110,7 @@ shared_examples "create" do
   end
 
   it "should not create remote if :synchronize => false" do
+    should_not_log /upload/
     file = @proxy.file(key, @mode)
     create_proxy("ignore me")
     file.close(:synchronize => false)
@@ -111,6 +118,7 @@ shared_examples "create" do
   end
 
   it "should create remote asynchronously if :synchronize => async" do
+    should_log /upload/
     file = @proxy.file(key, @mode)
     create_proxy("upload me in thread")
     Thread.should_receive(:new) { |&block|
@@ -130,6 +138,7 @@ shared_examples "update" do
     remote_body.should == "overwrite me"
     file = @proxy.file(key, @mode)
     create_proxy("upload me")
+    should_log /upload/
     file.close
     remote_body.should == "upload me"
   end
@@ -142,11 +151,13 @@ shared_examples "update" do
       remote_body.should == "overwrite me"
       block.call
     }
+    should_log /upload/
     file.close(:synchronize => :async)
     remote_body.should == "upload me"
   end
 
   it "should not overwrite remote if proxy is deleted" do
+    should_not_log /upload/
     create_remote("keep me")
     @proxy.file(key, @mode) do |file|
       file.write("ignore me")
@@ -156,6 +167,7 @@ shared_examples "update" do
   end
 
   it "should not overwrite remote if :synchronize => false" do
+    should_not_log /upload/
     create_remote("keep me")
     file = @proxy.file(key, @mode)
     create_proxy("ignore me")
@@ -208,11 +220,16 @@ shared_examples "persistence" do
 
 end
 
+class MockLogger
+  def info(arg)
+  end
+end
 
 shared_examples "a proxy file" do |proxyargs|
 
   before(:all) do
-    @proxy = Defog::Proxy.new(proxyargs) 
+    @proxy = Defog::Proxy.new(proxyargs)
+    @proxy.logger = MockLogger.new
   end
 
   %W[r r+ w w+ a a+].each do |mode|

data/spec/support/helpers.rb

@@ -39,4 +39,13 @@ module Helpers
     end
   end
 
+  def should_log(arg)
+    @proxy.logger.should_receive(:info).with(arg)
+  end
+
+  def should_not_log(arg)
+    @proxy.logger.should_not_receive(:info).with(arg)
+  end
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defog
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70210590342260 !ruby/object:Gem::Requirement
+  requirement: &70349591699120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70210590342260
+  version_requirements: *70349591699120
 - !ruby/object:Gem::Dependency
   name: hash_keyword_args
-  requirement: &70210590338240 !ruby/object:Gem::Requirement
+  requirement: &70349591698520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70210590338240
+  version_requirements: *70349591698520
 - !ruby/object:Gem::Dependency
   name: fastandand
-  requirement: &70210590325960 !ruby/object:Gem::Requirement
+  requirement: &70349591698100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70210590325960
+  version_requirements: *70349591698100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70210590316820 !ruby/object:Gem::Requirement
+  requirement: &70349591697640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70210590316820
+  version_requirements: *70349591697640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70210590308480 !ruby/object:Gem::Requirement
+  requirement: &70349591697160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70210590308480
+  version_requirements: *70349591697160
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70210590303920 !ruby/object:Gem::Requirement
+  requirement: &70349591696700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70210590303920
+  version_requirements: *70349591696700
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
-  requirement: &70210590295300 !ruby/object:Gem::Requirement
+  requirement: &70349591696200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70210590295300
+  version_requirements: *70349591696200
 description: Wrapper to fog gem, proxying access to cloud files as local files.
 email:
 - ronen@barzel.org