jsl-hashpipe 0.0.3 → 0.0.4

data/hashpipe.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name     = "hashpipe"
-  s.version  = "0.0.3"
+  s.version  = "0.0.4"
   s.date     = "2009-05-12"
   s.summary  = "ActiveRecord plugin to save content to a pluggable, hash-style backend"
   s.email    = "justin@phq.org"
@@ -16,18 +16,14 @@ Gem::Specification.new do |s|
     "lib/hashpipe.rb",
     "lib/hashpipe/archived_attribute.rb",
     "lib/hashpipe/global_configuration.rb",
-    "lib/hashpipe/backends/s3.rb",
-    "lib/hashpipe/backends/memcache.rb",
-    "lib/hashpipe/backends/filesystem.rb"
+    "lib/hashpipe/moneta_backend.rb"
   ]
   s.test_files = [
     "spec/hashpipe/global_configuration_spec.rb",
     "spec/hashpipe/archived_attribute_spec.rb",
-    "spec/hashpipe/backends/filesystem_spec.rb",
-    "spec/hashpipe/backends/s3_spec.rb",
-    "spec/hashpipe/backends/memcache_spec.rb"
+    "spec/hashpipe/moneta_backend_spec.rb"
   ]
+  s.add_dependency("wycats-moneta", ["> 0.0.0"])
   s.add_dependency("activesupport", ["> 0.0.0"])
-  s.add_dependency("right_aws", ["> 0.0.0"])
   s.add_dependency("assaf-uuid", ["> 0.0.0"])
 end

data/lib/hashpipe/archived_attribute.rb

@@ -1,8 +1,7 @@
 require 'activesupport'
+require 'moneta'
 
-require File.expand_path(File.join(File.dirname(__FILE__),  %w[ backends filesystem ]))
-require File.expand_path(File.join(File.dirname(__FILE__),  %w[ backends s3 ]))
-require File.expand_path(File.join(File.dirname(__FILE__),  %w[ backends memcache ]))
+require File.expand_path(File.join(File.dirname(__FILE__),  'moneta_backend'))
 
 module HashPipe
   
@@ -13,11 +12,8 @@ module HashPipe
       @name     = name
       @instance = instance
       @dirty    = false
-
-      @_options = HashPipe::GlobalConfiguration.instance.to_hash.
-        merge(opts)
-
-      @backend = instantiate_backend_from(options)
+      @_options = HashPipe::GlobalConfiguration.instance.to_hash.merge(opts)
+      @backend  = instantiate_backend_from(options)
     end
     
     def value
@@ -51,8 +47,7 @@ module HashPipe
     # Returns a backend object based on the options given (e.g., filesystem,
     # s3).
     def instantiate_backend_from(options)
-      "HashPipe::Backends::#{options[:storage].to_s.camelize}".
-        constantize.new(self)
+      HashPipe::MonetaBackend.new(self)
     end
 
     def options

data/lib/hashpipe/global_configuration.rb

@@ -6,19 +6,9 @@ module HashPipe
     include Singleton
 
     DEFAULTS = HashWithIndifferentAccess.new({
-      :storage    => 'filesystem',
-      :marshal    => false,
-      :compress   => false,
-      :s3 => {
-        :protocol => 'https'
-      },
-      :filesystem => {
-        :archive_root => nil
-      },
-      :memcache => {
-        :port   => 1978,
-        :server => 'localhost'
-      }
+      :moneta_klass => 'Moneta::Memory',
+      :marshal      => false,
+      :compress     => false
     })
     
     def [](val)

data/lib/hashpipe/moneta_backend.rb

@@ -0,0 +1,44 @@
+module HashPipe
+  class MonetaBackend
+    
+    def initialize(archived_attribute)
+      @archived_attribute = archived_attribute
+      @options            = HashPipe::GlobalConfiguration.instance[:moneta_options]
+      @cache              = initialize_cache_klass(HashPipe::GlobalConfiguration.instance[:moneta_klass])
+    end
+
+    def save(content)
+      @cache[key_name] = content
+    end
+
+    def destroy
+      @cache.delete(key_name)
+    end
+
+    def load
+      @cache[key_name]
+    end
+
+    private
+
+    def initialize_cache_klass(cache_klass)
+      require_moneta_library_for(cache_klass)
+      klass_const = cache_klass.respond_to?(:constantize) ? cache_klass.constantize : cache_klass      
+      klass_const.new(@options)
+    end
+    
+    def require_moneta_library_for(cache_klass)
+      require cache_klass.to_s.gsub(/::/, '/').downcase
+    end
+
+    def key_name
+      [ table_name_from(@archived_attribute),
+        @archived_attribute.name,
+        @archived_attribute.instance.uuid ].join('/')
+    end
+    
+    def table_name_from(archived_attribute)
+      archived_attribute.instance.class.table_name
+    end
+  end
+end

data/spec/hashpipe/archived_attribute_spec.rb

@@ -2,9 +2,9 @@ require File.join(File.dirname(__FILE__), %w[ .. spec_helper ])
 
 describe HashPipe::ArchivedAttribute do
   before do
-    options = { :storage => 'filesystem' }
     stub_model = stub(:uuid => '43')
-    @aa = HashPipe::ArchivedAttribute.new(:glorp, stub_model, options)
+    @aa = HashPipe::ArchivedAttribute.new(:glorp, stub_model)
+    HashPipe::MonetaBackend.any_instance.stubs(:table_name_from).returns('foo_table')
   end
 
   describe "#dirty?" do

data/spec/hashpipe/moneta_backend_spec.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), %w[ .. spec_helper ])
+
+describe HashPipe::MonetaBackend do
+  it "should have specs written"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsl-hashpipe
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Justin Leitgeb
@@ -13,7 +13,7 @@ date: 2009-05-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: wycats-moneta
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -23,7 +23,7 @@ dependencies:
         version: 0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: right_aws
+  name: activesupport
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -58,9 +58,7 @@ files:
 - lib/hashpipe.rb
 - lib/hashpipe/archived_attribute.rb
 - lib/hashpipe/global_configuration.rb
-- lib/hashpipe/backends/s3.rb
-- lib/hashpipe/backends/memcache.rb
-- lib/hashpipe/backends/filesystem.rb
+- lib/hashpipe/moneta_backend.rb
 has_rdoc: true
 homepage: http://github.com/jsl/hashpipe
 post_install_message: 
@@ -90,6 +88,4 @@ summary: ActiveRecord plugin to save content to a pluggable, hash-style backend
 test_files: 
 - spec/hashpipe/global_configuration_spec.rb
 - spec/hashpipe/archived_attribute_spec.rb
-- spec/hashpipe/backends/filesystem_spec.rb
-- spec/hashpipe/backends/s3_spec.rb
-- spec/hashpipe/backends/memcache_spec.rb
+- spec/hashpipe/moneta_backend_spec.rb

data/lib/hashpipe/backends/filesystem.rb

@@ -1,60 +0,0 @@
-module HashPipe
-  module Backends
-    
-    # The filesystem backend is mostly useful for development or test work.  It's not currently sharded
-    # in any way, so would probably have serious issues for production use.  You have been warned.
-    class Filesystem
-
-      def initialize(archived_attribute)
-        @archived_attribute = archived_attribute
-      end
-
-      def save(content)
-        create_filesystem_path unless File.exist?(filepath)
-        write_to_disk(content)
-      end
-
-      def destroy
-        FileUtils.rm_f(filename)
-      end
-
-      def load
-        File.read( filename ) if File.exist?( filename )
-      end
-
-      # Returns the full file path + name of this archived attribute
-      def filename
-        File.join(filepath, @archived_attribute.name.to_s)
-      end
-
-      private
-
-      # Writes content to disk, or raises an error if the content is unable to
-      # be saved
-      def write_to_disk(content)
-        File.open(filename, 'w') { |f| f.write(content) }
-      end
-
-      def create_filesystem_path
-        FileUtils.mkdir_p(filepath)
-      end
-
-      # The file path used for archiving this attribute.  Includes either the
-      # options[:filesystem][:archive_root] attribute, if available, or the
-      # RAILS_ROOT/tmp/archived_attribute_archive/attribute_name.
-      def filepath
-        config_path = @archived_attribute.options[:filesystem][:archive_root]
-
-        base_path =  config_path || File.join(
-          %W[#{RAILS_ROOT} tmp hashpipe_stash]
-        )
-
-        File.expand_path( File.join(base_path,
-            @archived_attribute.name.to_s,
-            @archived_attribute.instance.uuid ))
-      end
-
-    end
-    
-  end
-end

data/lib/hashpipe/backends/memcache.rb

@@ -1,42 +0,0 @@
-module HashPipe
-  module Backends
-
-    class Memcache
-
-      def initialize(archived_attribute)
-        @archived_attribute = archived_attribute
-        @config = HashPipe::GlobalConfiguration.instance[:memcache]
-      end
-
-      def save(content)
-        cache.write( key_name, content ) unless content.nil?
-      end
-
-      def destroy
-        cache.delete(key_name)
-      end
-
-      def load
-        cache.read(key_name)
-      end
-
-      private
-
-      def cache
-        @cache ||= ActiveSupport::Cache::MemCacheStore.new(server)
-      end
-
-      def key_name
-        [ @archived_attribute.instance.class.table_name,
-          @archived_attribute.name,
-          @archived_attribute.instance.uuid ].join('/')
-      end
-
-      def server
-        "#{@config[:server]}:#{@config[:port]}" 
-      end
-      
-    end
-
-  end
-end

data/lib/hashpipe/backends/s3.rb

@@ -1,58 +0,0 @@
-require 'right_aws'
-
-module HashPipe
-  module Backends
-
-    class S3
-
-      def initialize(archived_attribute)
-        @archived_attribute = archived_attribute
-        @config = HashPipe::GlobalConfiguration.instance[:s3]
-      end
-
-      def save(content)
-        bucket.put( key_name, StringIO.new( content ) ) unless content.nil?
-      end
-
-      def destroy
-        bucket.key(key_name).delete
-      end
-
-      def load
-        bucket.get(key_name)
-      end
-
-      private
-
-      def bucket
-        @bucket ||= right_aws_s3.bucket(bucket_name)
-      end
-
-      def right_aws_s3        
-        @s3 ||= RightAws::S3.new(
-          @config[:access_key],
-          @config[:secret_key]
-        )
-      end
-
-      # Returns the bucket name to be used based on attributes of the archived
-      # attribute.
-      def bucket_name
-        @config[:bucket]
-      end
-
-      def key_name
-        [ @archived_attribute.instance.class.table_name,
-          @archived_attribute.name,
-          @archived_attribute.instance.uuid ].join('/')
-      end
-
-      # Returns a string representing whether we use http or https for this
-      # connection.
-      def protocol
-        @config[:protocol] || 'https'
-      end
-    end
-
-  end
-end

data/spec/hashpipe/backends/filesystem_spec.rb

@@ -1,82 +0,0 @@
-require File.join(File.dirname(__FILE__), %w[ .. .. spec_helper ])
-
-require 'tmpdir'
-
-describe HashPipe::Backends::Filesystem do
-
-  before do
-    @unique_path_part = 'archived_attributes_test'
-    @path = File.join(Dir.tmpdir, @unique_path_part)
-    
-    
-    @instance = stub('http_retrieval',
-      :uuid => '63d3a120-caca-012b-d468-002332d4f91e',
-      :name => :foo
-    )
-
-    aa = HashPipe::ArchivedAttribute.new(:content, @instance,
-      :filesystem => { :archive_root => @path } )
-    
-    @fs = HashPipe::Backends::Filesystem.new(aa)
-  end
-
-  it "should write to the correct path" do
-    @fs.__send__(:filepath).should ==
-      File.expand_path(File.join(@path, 'content', @instance.uuid))
-  end
-
-  describe "#save" do    
-    before do
-      if File.exist?(@path)
-        err = <<-EOS
-          Test directory #{@path} already exists.  Please remove it and run the
-          test suite again.
-        EOS
-        raise RuntimeError, err
-      else
-        @remove_path = true
-        FileUtils.mkdir(@path)
-      end
-    end
-
-    it "should call methods to create path and save file to disk" do
-      @fs.save('test')
-      File.exist?(@fs.filename).should be_true
-    end
-    
-    after(:all) do
-      FileUtils.rm_rf(@path) if @remove_path
-    end
-    
-  end
-
-  describe "#destroy" do
-    before do
-      if File.exist?(@path)
-        err = <<-EOS
-          Test directory #{@path} already exists.  Please remove it and run the
-          test suite again.
-        EOS
-        raise RuntimeError, err
-      else
-        @remove_path = true
-        FileUtils.mkdir(@path)
-      end
-    end
-
-    it "should call methods to remove path and file" do
-      @fs.save('test')
-      File.exist?(@fs.filename).should be_true
-
-      @fs.destroy
-      File.exist?(@fs.filename).should be_false
-    end
-
-    after(:all) do
-      FileUtils.rm_rf(@path) if @remove_path
-    end
-
-  end
-
-
-end

data/spec/hashpipe/backends/memcache_spec.rb

@@ -1,56 +0,0 @@
-require File.join(File.dirname(__FILE__), %w[ .. .. spec_helper ])
-
-describe HashPipe::Backends::Memcache do
-
-  before do
-    @instance = stub('ar_instance', 
-      :uuid => '63d3a120-caca-012b-d468-002332d4f91e',
-      :table_name => 'glorps'
-    )
-    
-    @aa = HashPipe::ArchivedAttribute.new(:stuff, @instance)
-    @mc = HashPipe::Backends::Memcache.new(@aa)
-    @mc.stubs(:key_name).returns('foo-key')
-
-    @mock_store = mock('memcache_store')
-    @mc.stubs(:cache).returns(@mock_store)
-  end
-
-  describe "#initialize" do
-    it "should initialize a memcached object without error" do
-      lambda { HashPipe::Backends::Memcache.new(@aa) }.should_not raise_error
-    end
-  end
-
-  describe "#load" do
-    it "should call method to load data from memcached" do
-      @mock_store.expects(:read)
-      @mc.load
-    end
-  end
-
-  describe "#save" do
-    it "should call method to store data in memcached" do
-      @mock_store.expects(:write)
-      @mc.save('content')
-    end
-  end
-
-  describe "#destroy" do
-    it "should call method to delete key" do
-      @mock_store.expects(:delete)
-      @mc.destroy
-    end
-  end
-  
-  describe  "#server" do
-    before do
-      @backend = HashPipe::Backends::Memcache.new(:foo)
-    end
-    
-    it "should return server:port" do
-      @backend.instance_variable_set(:@config, :memcache => {:server => 'foo', :port => 1978})
-      @backend.__send__(:server).should == "foo:1978"
-    end
-  end
-end

data/spec/hashpipe/backends/s3_spec.rb

@@ -1,79 +0,0 @@
-require File.join(File.dirname(__FILE__), %w[ .. .. spec_helper ])
-
-describe HashPipe::Backends::S3 do
-
-  before do
-    @instance = stub('ar_instance', 
-      :uuid => '63d3a120-caca-012b-d468-002332d4f91e',
-      :table_name => 'glorps'
-    )
-    
-    @aa = HashPipe::ArchivedAttribute.new(:stuff, @instance)
-    @s3 = HashPipe::Backends::S3.new(@aa)
-    @config = HashPipe::GlobalConfiguration.instance
-  end
-
-  describe "#initialize" do
-    it "should initialize an s3 object without error" do
-      lambda { HashPipe::Backends::S3.new(@aa) }.should_not raise_error
-    end
-  end
-
-  describe "#protocol" do
-    it "should be https by default" do
-      @s3.__send__(:protocol).should == "https"
-    end
-
-    it "should use http if specified in the configuration object" do
-      config = { :protocol => 'http' }
-      @s3.instance_variable_set(:"@config", config)
-      
-      @s3.__send__(:protocol).should == "http"
-    end
-
-  end
-
-  describe "#load" do
-    it "should call method to load data from s3" do
-      bucket = mock('bucket')
-      bucket.expects(:get).once
-      aws_s3 = mock('aws_s3')
-      aws_s3.expects(:bucket).returns(bucket)
-      @s3.expects(:key_name).returns('some-key')
-      @s3.expects(:right_aws_s3).returns(aws_s3)
-      @s3.load
-    end
-  end
-
-  describe "#save" do
-    it "should call method to store data in s3" do
-      bucket = mock('bucket')
-      content = 'hey'
-      key = 'fookey'
-      @s3.expects(:key_name).returns(key)
-      bucket.expects(:put).once
-      aws_s3 = mock('aws_s3')
-      aws_s3.expects(:bucket).returns(bucket)
-      @s3.expects(:right_aws_s3).returns(aws_s3)
-      @s3.save(content)
-    end
-  end
-
-  describe "#destroy" do
-    it "should call method to delete key" do
-      key = mock('key', :delete => true)
-      bucket = mock('bucket', :key => key)
-      aws_s3 = mock('aws_s3')
-      aws_s3.expects(:bucket).returns(bucket)
-      @s3.expects(:right_aws_s3).returns(aws_s3)
-      @s3.expects(:key_name).returns('foo-key')
-      @s3.destroy
-    end
-  end
-
-  describe "#bucket_name" do
-    it "should be based on the attribute class and model" do
-      @s3.__send__(:bucket_name).should == @config[:s3]['bucket']
-    end
-  end
-end