cabinet 0.1.3 → 0.2.0

data/lib/cabinet/instance.rb

@@ -0,0 +1,121 @@
+module Cabinet
+  class Instance
+    attr_accessor :connection, :directory
+
+    def initialize(provider, auth={})
+      fog_config      = auth.merge({:provider => fog_provider(provider)})
+      self.connection = Fog::Storage.new(fog_config)
+    end
+
+    def directory=(name)
+      @directory = connection.directories.get(name) || connection.directories.create(:key => name)
+    end
+
+    alias :container= :directory=
+    alias :bucket=    :directory=
+
+    def get(name)
+      file(name).body
+    end
+
+    def list(regexp=/.*/)
+      directory.files.reload
+      directory.files.select{|f| f.key.match(regexp)}.to_a.map(&:key)
+    end
+
+    def put(name, content)
+      content = content.to_s
+
+      begin
+        directory.files.create(:key => name, :body => content).content_length == content.length
+      rescue
+        false
+      end
+    end
+
+    def touch(name)
+      (exists?(name) ? put(name, get(name)) : put(name, "")) and !!reload(name)
+    end
+
+    def append(name, new_content)
+      content = exists?(name) ? get(name) + new_content : new_content
+      put(name, content) and !!reload(name)
+    end
+
+    def delete(name_or_regexp)
+      @file = nil
+
+      directory.files.reload
+
+      if name_or_regexp.class == Regexp
+        directory.files.select{|f| f.key.match(name_or_regexp)}.each do |file|
+          file.destroy
+        end
+      else
+        directory.files.get(name_or_regexp).destroy
+      end
+
+      true
+    end
+
+    def copy_to(klass, name)
+      klass.put(name, get(name))
+    end
+
+    def exists?(name)
+      !!file(name)
+    end
+
+    def modified(name)
+      file(name).last_modified + 0 if exists?(name)
+    end
+
+    def compress(name, content)
+      name = name.gsub(/(.+?)(\.gz)?$/, '\1.gz')
+      tmp  = "/tmp/cabinet-tmp-#{name}-#{Time.now}"
+
+      File.open(tmp, 'w') do |f|
+        gz = Zlib::GzipWriter.new(f)
+        gz.write content
+        gz.close
+      end
+
+      put(name, File.read(tmp)) and (File.unlink(tmp) == 1)
+    end
+
+    def decompress(name)
+      Zlib::GzipReader.new(StringIO.new(get(name))).read
+    end
+
+    private
+      def file(name)
+        raise 'No directory specified' unless directory
+
+        if @file && @file.key == name
+          @file
+        else
+          reload(name)
+        end
+      end
+
+      def reload(name)
+        directory.files.reload
+        @file = directory.files.get(name)
+      end
+
+      def fog_provider(provider)
+        case provider.to_s.downcase
+          when 'aws', 's3', 'amazon'
+            'AWS'
+          when 'rackspace', 'cloudfiles', 'cloud_files'
+            'Rackspace'
+          when 'google', 'google_storage'
+            'Google'
+          when 'local', 'localhost', 'filesystem'
+            'Local'
+          else
+            raise ArgumentError, "#{provider} is not a valid provider"
+        end
+      end
+  end
+end

data/lib/cabinet/version.rb

@@ -1,3 +1,3 @@
 module Cabinet
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/cabinet.rb

@@ -1,7 +1,19 @@
 require 'pathname'
+require 'fog'
 
-module Cabinet; end
+module Cabinet
+  def self.cloud(provider, options={})
+    self.init(provider, options)
+  end
+
+  def self.local(path='/')
+    self.init(:local, {:local_root => path})
+  end
+  
+  def self.init(*args)
+    Cabinet::Instance.new(*args)
+  end
+end
 
 dir = Pathname(__FILE__).dirname.expand_path
-require dir + 'cabinet/cloud'
-require dir + 'cabinet/local'
+require dir + 'cabinet/instance'

data/spec/cabinet/instance_spec.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Cabinet::Instance do
+  before(:all) do
+    @local = Cabinet.local
+    @local.directory = '/tmp/cabinet_test'
+
+    @file_name    = Forgery(:basic).text
+    @file_content = Forgery(:lorem_ipsum).text(:paragraphs, 10)
+  end
+
+  after(:all) do
+    @local.delete(/.*/)
+  end
+
+  it "creates files" do
+    @local.put(@file_name, @file_content).should == true
+  end
+
+  it "confirms that files exists" do
+    @local.exists?(@file_name).should == true
+  end
+
+  it "confirms that files don't exist" do
+    @local.exists?(@file_content).should == false
+  end
+
+  it "reads file content" do
+    @local.get(@file_name).should == @file_content
+  end
+
+  it "fetches last modified timestamp" do
+    @local.modified(@file_name).class.should == Time
+  end
+
+  it "appends files" do
+    extra_content = Forgery(:lorem_ipsum).text(:paragraph)
+    @local.append(@file_name, extra_content).should == true
+    @local.get(@file_name).should == @file_content + extra_content
+  end
+
+  it "list files with (and without) regular expressions" do
+    @local.list.should include(@file_name)
+    @local.list(/#{@file_name}/).should include(@file_name)
+    @local.list(/#{@file_content}/).should == []
+  end
+
+  it "creates an empty file using put with empty content argument" do
+    file = Forgery(:basic).text
+
+    @local.put(file, nil).should == true
+    @local.get(file).should == ""
+  end
+
+  it "creates an empty file using touch" do
+    file = Forgery(:basic).text
+
+    @local.touch(file).should == true
+    @local.get(file).should == ""
+  end
+
+  it "copies files from one cabinet instance to another" do
+    new_local = Cabinet.local
+    new_local.directory = "/tmp/cabinet_test_2"
+
+    @local.copy_to(new_local, @file_name).should == true
+    new_local.get(@file_name).should == @local.get(@file_name)
+
+    new_local.delete(@file_name)
+  end
+
+  it "updates last_modified timestamp using touch" do
+    original_time    = @local.modified(@file_name)
+    original_content = @local.get(@file_name)
+
+    sleep(1) # to force time to pass update
+
+    @local.touch(@file_name).should == true
+    @local.modified(@file_name).should_not == original_time
+    @local.get(@file_name).should == original_content
+  end
+
+  it "compresses files using gzip" do
+    gz_file_name = @file_name + '.gz'
+
+    @local.compress(gz_file_name, @file_content).should == true
+    Zlib::GzipReader.new(StringIO.new(@local.get(gz_file_name))).read.should == @file_content
+  end
+
+  it "decompresses files using gzip" do
+    gz_file_name = @file_name + '.gz'
+    @local.decompress(gz_file_name).should == @file_content
+  end
+
+  it "deletes files" do
+    @local.delete(@file_name).should  == true
+    @local.exists?(@file_name).should == false
+  end
+  
+  it "bulk deletes files using regular expressions" do
+    (1..3).each {|n| @local.put("#{@file_name}.#{n}", @file_content)}
+    @local.delete(/#{@file_name}/)
+    (1..3).inject([]) {|arr, n| arr << @local.exists?("#{@file_name}.#{n}")}.should == [false, false, false]
+  end
+
+  it "tests cloud connection" do
+    credentials = YAML.load_file(File.expand_path(File.join(File.dirname(__FILE__), '..', 'cloud_credentials.yml')))
+    cloud = Cabinet.cloud(:rackspace, credentials)
+    cloud.container = 'cabinet_test'
+
+    cloud.put(@file_name, @file_content).should == true
+    cloud.list.should include(@file_name)
+    cloud.list(/#{@file_name}/).should include(@file_name)
+    cloud.get(@file_name).should == @file_content
+    cloud.delete(@file_name).should == true
+    cloud.list.should_not include(@file_name)
+  end
+end

data/spec/spec_helper.rb

@@ -2,8 +2,4 @@ require File.join(File.dirname(__FILE__), '..', 'lib', 'cabinet')
 require 'forgery'
 
 RSpec.configure do |config|
-  config.before(:suite) do
-    @@file_name    = 'cabinet.test'
-    @@file_content = Forgery(:lorem_ipsum).text(:paragraphs, 10)
-  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cabinet
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Sebastian von Conrad
@@ -97,11 +97,9 @@ files:
 - Rakefile
 - cabinet.gemspec
 - lib/cabinet.rb
-- lib/cabinet/cloud.rb
-- lib/cabinet/local.rb
+- lib/cabinet/instance.rb
 - lib/cabinet/version.rb
-- spec/cabinet/cloud_spec.rb
-- spec/cabinet/local_spec.rb
+- spec/cabinet/instance_spec.rb
 - spec/cloud_credentials.yml
 - spec/spec_helper.rb
 has_rdoc: true
@@ -139,7 +137,6 @@ signing_key:
 specification_version: 3
 summary: ""
 test_files: 
-- spec/cabinet/cloud_spec.rb
-- spec/cabinet/local_spec.rb
+- spec/cabinet/instance_spec.rb
 - spec/cloud_credentials.yml
 - spec/spec_helper.rb

data/lib/cabinet/cloud.rb

@@ -1,99 +0,0 @@
-require 'fog'
-
-module Cabinet
-  class Cloud
-    attr_accessor :connection, :container
-
-    def initialize(config)
-      root_dir        = config.delete(:container)
-      self.connection = Fog::Rackspace::Storage.new(config)
-      self.container  = connection.directories.get(root_dir) || connection.directories.create(:key => root_dir)
-    end
-
-    def get(name)
-      file(name).body
-    end
-
-    def list(regexp=/.*/)
-      container.files.reload
-      container.files.select{|f| f.key.match(regexp)}.to_a.map(&:key)
-    end
-
-    def put(name, content)
-      begin
-        container.files.create(:key => name, :body => content).content_length == content.length
-      rescue
-        false
-      end
-    end
-
-    def append(name, new_content)
-      content = exists?(name) ? get(name) + new_content : new_content
-      put(name, content) and !!reload(name)
-    end
-
-    def delete(name_or_regexp)
-      @file = nil
-
-      container.files.reload
-
-      if name_or_regexp.class == Regexp
-        container.files.select{|f| f.key.match(name_or_regexp)}.each do |file|
-          file.destroy
-        end
-      else
-        container.files.get(name_or_regexp).destroy
-      end
-
-      true
-    end
-
-    def copy_to(klass_or_sym, name)
-      if klass_or_sym.is_a? Symbol
-        c = case klass_or_sym
-          when :local
-            Local.new('/tmp')
-        end
-      else
-        c = klass_or_sym
-      end
-
-      c.put(name, get(name))
-    end
-
-    def exists?(name)
-      !!file(name)
-    end
-
-    def modified(name)
-      file(name).last_modified + 0 if exists?(name)
-    end
-
-    def gzip(name, content)
-      name  = name.gsub(/(.+?)(\.gz)?$/, '\1.gz')
-      local = "/tmp/#{name}"
-
-      File.open(local, 'w') do |f|
-        gz = Zlib::GzipWriter.new(f)
-        gz.write content
-        gz.close
-      end
-
-      put(name, File.read(local)) and File.unlink(local)
-    end
-
-    private
-      def file(name)
-        if @file && @file.key == name
-          @file
-        else
-          reload(name)
-        end
-      end
-
-      def reload(name)
-        container.files.reload
-        @file = container.files.get(name)
-      end
-  end
-end

data/lib/cabinet/local.rb

@@ -1,42 +0,0 @@
-module Cabinet
-  class Local
-    attr_accessor :dir
-
-    def initialize(root_dir)
-      self.dir = root_dir.chomp('/') + '/'
-    end
-
-    def get(file)
-      raise ArgumentError, "The file #{file} does not exist" unless exists?(file)
-      File.read(dir + file)
-    end
-
-    def put(file, content)
-      File.open(dir + file, 'wb') {|f| f.write(content)} == content.length
-    end
-
-    def append(file, content)
-      File.open(dir + file, 'ab') {|f| f.write(content)} == content.length
-    end
-
-    def delete(file_or_regexp)
-      File.delete *Dir.glob(dir + file_or_regexp)
-    end
-
-    def exists?(file)
-      File.exists?(dir + file)
-    end
-
-    def modified(file)
-      File.mtime(dir + file) if exists?(file)
-    end
-
-    def gzip(file, content)
-      File.open(dir + file, 'w') do |f|
-        gz = Zlib::GzipWriter.new(f)
-        gz.write content
-        gz.close
-      end
-    end
-  end
-end

data/spec/cabinet/cloud_spec.rb

@@ -1,84 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
-
-describe Cabinet::Cloud do
-  before(:all) do
-    credentials = YAML.load_file(File.expand_path(File.join(File.dirname(__FILE__), '..', 'cloud_credentials.yml')))
-    @cc         = Cabinet::Cloud.new({:container => 'cabinet_test'}.merge(credentials))
-  end
-
-  it "should create file" do
-    @cc.put(@@file_name, @@file_content).should == true
-  end
-
-  it "should confirm file exists" do
-    @cc.exists?(@@file_name).should == true
-  end
-
-  it "should confirm file does not exist" do
-    @cc.exists?(@@file_content).should == false
-  end
-
-  it "should read file" do
-    @cc.get(@@file_name).should == @@file_content
-  end
-
-  it "should get last modified" do
-    @cc.modified(@@file_name).class.should == Time
-  end
-
-  it "should append file" do
-    extra_content = Forgery(:lorem_ipsum).text(:paragraph)
-    @cc.append(@@file_name, extra_content).should == true
-    @cc.get(@@file_name).should == @@file_content + extra_content
-  end
-
-  it "should list files" do
-    @cc.list.should include(@@file_name)
-    @cc.list(/#{@@file_name}/).should include(@@file_name)
-    @cc.list(/#{@@file_content}/).should == []
-  end
-
-  it "should copy file to local filesystem using object" do
-    cl = Cabinet::Local.new('/tmp')
-    cl.delete(@@file_name) if cl.exists?(@@file_name)
-
-    @cc.copy_to(cl, @@file_name)
-    cl.exists?(@@file_name).should == true
-    cl.delete(@@file_name)
-  end
-
-  it "should copy file to local filesystem using symbol" do
-    File.unlink("/tmp/#{@@file_name}") if File.exists?("/tmp/#{@@file_name}")
-    @cc.copy_to(:local, @@file_name)
-    File.exists?("/tmp/#{@@file_name}").should == true
-    File.unlink("/tmp/#{@@file_name}")
-  end
-
-  it "should not overwrite file"
-
-  it "should overwrite file if :force => true"
-
-  it "should gzip file" do
-    gz_file_name = @@file_name + '.gz'
-    File.unlink("/tmp/#{gz_file_name}") if File.exists?("/tmp/#{gz_file_name}")
-
-    @cc.gzip(gz_file_name, @@file_content)
-    @cc.copy_to(:local, gz_file_name)
-
-    Zlib::GzipReader.open("/tmp/#{gz_file_name}") {|gz| gz.read}.should == @@file_content
-
-    @cc.delete(gz_file_name)
-    File.unlink("/tmp/#{gz_file_name}")
-  end
-
-  it "should delete file" do
-    @cc.delete(@@file_name)
-    @cc.exists?(@@file_name).should == false
-  end
-
-  it "should bulk delete files" do
-    (1..3).each {|n| @cc.put("#{@@file_name}.#{n}", @@file_content)}
-    @cc.delete(/#{@@file_name}/)
-    (1..3).inject([]) {|arr, n| arr << @cc.exists?("#{@@file_name}.#{n}")}.should == [false, false, false]
-  end
-end

data/spec/cabinet/local_spec.rb

@@ -1,57 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
-
-describe Cabinet::Local do
-  before(:all) do
-    @cl = Cabinet::Local.new('/tmp')
-  end
-
-  it "should create file" do
-    @cl.put(@@file_name, @@file_content).should == true
-  end
-
-  it "should confirm file exists" do
-    @cl.exists?(@@file_name).should == true
-  end
-
-  it "should confirm file does not exist" do
-    @cl.exists?(@@file_content).should == false
-  end
-
-  it "should read file" do
-    @cl.get(@@file_name).should == @@file_content
-  end
-
-  it "should see last modified" do
-    @cl.modified(@@file_name).class.should == Time
-  end
-
-  it "should append file" do
-    extra_content = Forgery(:lorem_ipsum).text(:paragraph)
-    @cl.append(@@file_name, extra_content).should == true
-    @cl.get(@@file_name).should == @@file_content + extra_content
-  end
-
-  it "should list files"
-
-  it "should not overwrite file"
-
-  it "should overwrite file if :force => true"
-
-  it "should gzip file" do
-    gz_file_name = @@file_name + '.gz'
-    @cl.gzip(gz_file_name, @@file_content)
-    Zlib::GzipReader.open("/tmp/#{gz_file_name}") {|gz| gz.read}.should == @@file_content
-    @cl.delete(gz_file_name)
-  end
-
-  it "should delete file" do
-    @cl.delete(@@file_name)
-    @cl.exists?(@@file_name).should == false
-  end
-
-  it "should bulk delete files" do
-    (1..3).each {|n| @cl.put("#{@@file_name}.#{n}", @@file_content)}
-    @cl.delete("#{@@file_name}*")
-    (1..3).inject([]) {|arr, n| arr << @cl.exists?("#{@@file_name}.#{n}")}.should == [false, false, false]
-  end
-end