defog 0.4.0 → 0.5.0

data/README.rdoc

@@ -41,7 +41,7 @@ object, which proxies files in a specific remote location, e.g.:
                                  :bucket => "s3-bucket-name")
 
         defog = Defog::Proxy.new(:provider => :Local,
-                                 :directory => "/path/to/directory")
+                                 :local_root => "/path/to/directory")
 
 === Proxy a file
 

data/lib/defog/file.rb

@@ -51,13 +51,14 @@ module Defog
       @handle = opts.handle
       @persist = opts.persist
       @synchronize = opts.synchronize
+      @mode = opts.mode
 
       key = @handle.key
       proxy_path = @handle.proxy_path
       proxy_path.dirname.mkpath
       re_encoding = /(b|:.*)$/
-      @encoding = opts.mode.match(re_encoding).to_s
-      case opts.mode.sub(re_encoding,'')
+      @encoding = @mode.match(re_encoding).to_s
+      case @mode.sub(re_encoding,'')
       when "r"
         download = true
         @upload = false
@@ -71,13 +72,17 @@ module Defog
         @upload = true
         cache_size = [opts.size_hint, @handle.size].compact.max
       else
-        raise ArgumentError, "Invalid mode #{opts.mode.inspect}"
+        raise ArgumentError, "Invalid mode #{@mode.inspect}"
       end
 
       @handle.proxy.manage_cache(cache_size, proxy_path)
       @handle.proxy.reserve_proxy_path(proxy_path)
       download_proxy if download
-      super(proxy_path, opts.mode, &block)
+      super(proxy_path, @mode, &block)
+    end
+
+    def to_s
+      "<#{self.class}: proxy=#{@handle.proxy_path} mode=#{@mode}>"
     end
 
     # Closes the proxy file and synchronizes the cloud storage (if it was

data/lib/defog/fog_wrapper.rb

@@ -5,6 +5,7 @@ require "pathname"
 module Defog #:nodoc: all
   class FogWrapper #:nodoc: all
 
+    attr_reader :prefix
     attr_reader :location
     attr_reader :fog_connection
     attr_reader :fog_directory
@@ -31,22 +32,39 @@ 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)
       path.open("r#{encoding}") do |file|
-        fog_directory.files.create(:key => key, :body => file)
+        fog_directory.files.create(:key => @prefix.to_s + key, :body => file)
       end
     end
 
     def fog_head(key)
-      fog_directory.files.head(key)
+      fog_directory.files.head(@prefix.to_s + key)
+    end
+
+    def each
+      prefix = @prefix.to_s
+      off = prefix.size
+      @fog_directory.files.all.each do |fog_model|
+        yield fog_model.key[off .. -1] if fog_model.key.start_with? prefix
+      end
     end
 
     private
 
+    def initialize(opts={})
+      opts = opts.keyword_args(:prefix => :optional)
+      @prefix = opts.prefix
+    end
+
+
     class Local < FogWrapper
       def provider ; :local ; end
 
       def initialize(opts={})
-        opts = opts.keyword_args(:local_root => :required)
-        @local_root = Pathname.new(opts.local_root).realpath
+        opts = opts.keyword_args(:local_root => :required, :prefix => :optional)
+        super(:prefix => opts.delete(:prefix))
+        @local_root = Pathname.new(opts.local_root)
+        @local_root.mkpath unless @local_root.exist?
+        @local_root = @local_root.realpath
         @location = @local_root.to_s.gsub(%r{/},'-')
         @fog_connection = Fog::Storage.new(:provider => provider, :local_root => @local_root)
         @fog_directory = @fog_connection.directories.get('.')
@@ -57,7 +75,7 @@ module Defog #:nodoc: all
       end
 
       def url(key, expiry)
-        localpath = Pathname.new("#{@local_root}/#{key}").expand_path
+        localpath = Pathname.new("#{@local_root}/#{@prefix}#{key}").expand_path
         if defined?(Rails)
           relative = localpath.relative_path_from Rails.root + "public" rescue nil
           return "/" + relative.to_s if relative and not relative.to_s.start_with? "../"
@@ -71,15 +89,16 @@ 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)
+        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))
         @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
-        @fog_directory = @fog_connection.directories.get(@location)
+        @fog_directory = @fog_connection.directories.get(@location, :prefix => @prefix)
       end
 
       def get_md5(key)
-        fog_head(key).content_md5
+        fog_head(key).etag
       end
 
       def url(key, expiry)

data/lib/defog/handle.rb

@@ -35,6 +35,10 @@ module Defog
       @proxy_path = Pathname.new("#{@proxy.proxy_root}/#{@key}").expand_path
     end
 
+    def to_s
+      "<#{self.class}: key=#{key}>"
+    end
+
     # Returns true if the remote cloud file exists 
     def exist?
       !!fog_model
@@ -72,6 +76,11 @@ module Defog
     end
 
     # Returns the underlying Fog::Model, should you need it for something.
+    # Returns nil if the model doesn't exist.
+    #
+    # If Defog::Proxy.new was passed a :prefix, the Fog::Model key and
+    # Defog::Handle key are related by:
+    #   handle.fog_model.key == defog.prefix + handle.key
     def fog_model
       @proxy.fog_wrapper.fog_head(@key)
     end

data/lib/defog/proxy.rb

@@ -26,12 +26,19 @@ module Defog
     # the same access info but different buckets; they will internally
     # share a single Fog::Storage isntance hence AWS connection.)
     #
-    # By default, each proxy's root directory is placed in a reasonable
-    # safe place, under <code>Rails.root/tmp</code> if Rails is defined
-    # otherwise under <code>Dir.tmpdir</code>.  (More details: within that
-    # directory, the root directory is disambiguated by #provider and
-    # #location, so that multiple Defog::Proxy instances can be
-    # created without collision.)
+    # To further restrict the remote files acted on by this proxy, you
+    # can specify
+    #   defog = Defog::Proxy.new(:provider => ..., :prefix => "my-prefix-string/")
+    # and all keys that you pass to Defog will be prefixed with the given
+    # string before being passed along to Fog.  (Notice that it's up to you to
+    # have a trailing "/" in the prefix if that's what you want.)
+    #
+    # By default, each proxy's cache root directory is placed in a
+    # reasonable safe place, under <code>Rails.root/tmp</code> if Rails is
+    # defined otherwise under <code>Dir.tmpdir</code>.  (More details:
+    # within that directory, the root directory is disambiguated by
+    # #provider and #location, so that multiple Defog::Proxy instances can
+    # be created without collision.)
     #
     # The upshot is that if you have no special constraints you don't need
     # to worry about it.  But if you do care, you can specify the option:
@@ -84,6 +91,10 @@ module Defog
 
     end
 
+    def to_s
+      "<#{self.class} provider=#{provider} location=#{location}>"
+    end
+
     # Returns the provider for this proxy.  I.e., <code>:local</code> or
     # <code>:AWS</code>
     def provider
@@ -108,6 +119,11 @@ module Defog
       @fog_wrapper.fog_directory
     end
 
+    # Returns the prefix that was passed
+    def prefix
+      @fog_wrapper.prefix
+    end
+
     # Proxy a remote cloud file.  Returns or yields a Defog::Handle object that
     # represents the file. 
     #
@@ -134,10 +150,10 @@ module Defog
     # remote file.
     #
     # If no block is given, an enumerator is returned.
-    def each
+    def each(&block)
       if block_given?
-        @fog_wrapper.fog_directory.files.all.each do |fog_model|
-          yield file(fog_model.key)
+        @fog_wrapper.each do |key|
+          yield file(key)
         end
       else
         to_enum(:each)

data/lib/defog/version.rb

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

data/spec/file_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 shared_examples "get proxy" do
+
   it "should create proxy if remote exists" do
     create_remote("hello")
     file = @proxy.file(key, @mode)
@@ -23,14 +24,9 @@ shared_examples "get proxy" do
   it "should use existing proxy if it's valid" do
     create_remote("hello")
     create_proxy("hello")
-    Pathname.any_instance.should_not_receive(:open).with(/^w/)
-    @proxy.file(key, @mode)
-
-    # doublecheck that should_not_receive was the right
-    # thing to test.  will it be received for an invalid proxy?
-    create_proxy("goodbye")
-    Pathname.any_instance.should_receive(:open).with(/^w/)
-    @proxy.file(key, @mode)
+    handle = @proxy.file(key)
+    handle.proxy_path.should_not_receive(:open).with(/^w/)
+    handle.open(@mode)
   end
 end
 
@@ -240,6 +236,12 @@ shared_examples "a proxy file" do |proxyargs|
     expect { @proxy.file(key, "xyz") }.should raise_error(ArgumentError)
   end
 
+  it "should have a nice to_s" do
+    @proxy.file(key, "w") {|f|
+      f.to_s.should include f.path
+    }
+  end
+
 
 end
 

data/spec/handle_spec.rb

@@ -10,6 +10,10 @@ shared_examples "a handle" do |proxyargs|
     @handle = @proxy.file(key)
   end
 
+  it "should have a nice to_s" do
+    @handle.to_s.should include key
+  end
+
   it "should report exist? true if remote cloud file exists" do
     create_remote("i exist")
     @handle.should be_exist
@@ -80,7 +84,7 @@ describe Defog::Handle do
 
       it "should return a path relative to public if in public" do
         with_rails_defined do
-          @proxy = Defog::Proxy.new(:provider => :local, :local_root => (Rails.root + "public/defog").tap(&:mkpath))
+          @proxy = Defog::Proxy.new(:provider => :local, :local_root => Rails.root + "public/defog")
           @proxy.file(key).url.should == "/defog/#{key}"
         end
       end

data/spec/proxy_spec.rb

@@ -7,6 +7,11 @@ shared_examples "a proxy" do |args|
       @proxy = Defog::Proxy.new(args)
     end
 
+    it "should have a nice to_s" do
+      @proxy.to_s.should include @proxy.provider.to_s
+      @proxy.to_s.should include @proxy.location
+    end
+
     it "file should return a handle" do
       handle = @proxy.file(key)
       handle.proxy.should == @proxy
@@ -58,9 +63,9 @@ shared_examples "a proxy" do |args|
     before(:each) do
       @proxy = Defog::Proxy.new(args)
       @proxy.fog_directory.files.all.each do |model| model.destroy end
-      create_other_remote("i0", 10)
-      create_other_remote("i1", 10)
-      create_other_remote("i2", 10)
+      create_other_remote("i0")
+      create_other_remote("i1")
+      create_other_remote("i2")
     end
 
     it "should iterate through remotes" do
@@ -77,6 +82,33 @@ shared_examples "a proxy" do |args|
 
   end
 
+  context "prefix" do
+    it "should return its prefix" do
+      prefix = "me-first"
+      @proxy = Defog::Proxy.new(args.merge(:prefix => prefix))
+      @proxy.prefix.should == prefix
+    end
+
+    it "should use a prefix" do
+      prefix = "me-first"
+      @proxy = Defog::Proxy.new(args.merge(:prefix => prefix))
+      @proxy.file(key, "w") { |f| f.puts "hello" }
+      @proxy.file(key).fog_model.key.should == prefix + key
+    end
+
+    it "should iterate only matches to prefix" do
+      @proxy = Defog::Proxy.new(args.merge(:prefix => "yes-"))
+      @proxy.fog_directory.files.all.each do |model| model.destroy end
+      create_other_remote("no-n1")
+      create_other_remote("no-n2")
+      create_other_remote("no-n3")
+      create_other_remote("yes-y1")
+      create_other_remote("yes-y2")
+      create_other_remote("yes-y3")
+      @proxy.each.map(&:key).should =~[other_key("y1"), other_key("y2"), other_key("y3")]
+    end
+
+  end
 
   context "proxy root location" do
     it "should default proxy root to tmpdir/defog" do
@@ -197,7 +229,7 @@ shared_examples "a proxy" do |args|
   private
 
   def other_key(okey)
-    "#{key}-#{okey}"
+    "#{okey}-#{key}"
   end
 
   def create_other_proxy(okey, size)
@@ -212,7 +244,7 @@ shared_examples "a proxy" do |args|
     @proxy.file(other_key(okey)).proxy_path
   end
 
-  def create_other_remote(okey, size)
+  def create_other_remote(okey, size=10)
     @proxy.fog_directory.files.create(:key => other_key(okey), :body => "x" * size)
   end
 

data/spec/support/helpers.rb

@@ -23,11 +23,11 @@ module Helpers
   end
 
   def remote_body
-    @proxy.fog_directory.files.get(key).body
+    @proxy.file(key).fog_model.body
   end
 
   def remote_exist?
-    !!@proxy.fog_directory.files.head(key)
+    @proxy.file(key).exist?
   end
 
   def with_rails_defined

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: defog
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-30 00:00:00.000000000 Z
+date: 2012-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70345231086320 !ruby/object:Gem::Requirement
+  requirement: &70210590342260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70345231086320
+  version_requirements: *70210590342260
 - !ruby/object:Gem::Dependency
   name: hash_keyword_args
-  requirement: &70345231085600 !ruby/object:Gem::Requirement
+  requirement: &70210590338240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70345231085600
+  version_requirements: *70210590338240
 - !ruby/object:Gem::Dependency
   name: fastandand
-  requirement: &70345231084580 !ruby/object:Gem::Requirement
+  requirement: &70210590325960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70345231084580
+  version_requirements: *70210590325960
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70345231082860 !ruby/object:Gem::Requirement
+  requirement: &70210590316820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345231082860
+  version_requirements: *70210590316820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70345231005400 !ruby/object:Gem::Requirement
+  requirement: &70210590308480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345231005400
+  version_requirements: *70210590308480
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70345231001760 !ruby/object:Gem::Requirement
+  requirement: &70210590303920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345231001760
+  version_requirements: *70210590303920
 - !ruby/object:Gem::Dependency
   name: simplecov-gem-adapter
-  requirement: &70345231000720 !ruby/object:Gem::Requirement
+  requirement: &70210590295300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70345231000720
+  version_requirements: *70210590295300
 description: Wrapper to fog gem, proxying access to cloud files as local files.
 email:
 - ronen@barzel.org