cache-aws-s3 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cache-aws-s3.gemspec
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+#cache-aws-s3
+
+This gem adds local file caching for the AWS::S3 library. The best use case is if you use S3 to store the readonly/library copy of some object that you need occasionally transform (resize, retouch, etc).
+
+Usage is simple, just add the gem to your bundle
+
+    require 'cache-aws-s3'
+
+From there on, all (supported) calls to AWS::S3::S3Object will be first checked against the cache
+
+    S3FileCache.enable true
+    S3FileCache.cache_dir /var/s3filecache
+
+    AWS::S3::S3Object.value 'key', 'bucket'
+
+    AWS::S3::S3Object.cached_local? 'key', 'bucket'
+    AWS::S3::S3Object.perge_local! 'key', 'bucket'
+
+
+##Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add spec for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+##Copyright
+
+Copyright (c) 2011 Kyle Fritz
+
+This gem was heavily inspired by [mock-aws-s3](https://github.com/jkrall/mock-aws-s3)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/cache-aws-s3.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cache/aws/s3/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cache-aws-s3"
+  s.version     = Cache::AWS::S3::VERSION
+  s.authors     = ["Kyle Fritz"]
+  s.email       = ["kyle.p.fritz@gmail.com"]
+  s.homepage    = "https://github.com/kylefritz/cache-aws-s3"
+  s.summary     = %q{local cache for s3 data}
+  s.description = %q{speed up repeated access to s3 data with a local cache}
+
+  s.rubyforge_project = "cache-aws-s3"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "aws-s3"
+
+  s.add_development_dependency "rspec"
+  #s.add_development_dependency "cucumber"
+end

data/lib/cache-aws-s3.rb

@@ -0,0 +1,2 @@
+require 'aws/s3'
+require 'cache/aws/s3/object'

data/lib/cache/aws/s3/object.rb

@@ -0,0 +1,78 @@
+require 'fileutils'
+require 'ostruct'
+
+class S3FileCache
+  class << self
+    attr_accessor :enabled, :cache_dir
+    def enabled?
+      self.enabled
+    end
+  end
+  @enabled=true
+  @cache_dir = "./tmp"
+end
+
+module AWS
+  module S3
+
+    class S3Object
+      class << self
+
+        #save old value method
+        alias s3_value value
+
+        #TODO: ignoring the &block for the moment
+        def value(key, bucket = nil, options = {}, &block)
+
+          return s3_value(key,bucket,options,&block) if not S3FileCache.enabled?
+
+          if cached_local? key, bucket
+            #return cached object
+            read_cache(key,bucket,options)
+          else
+            #1. open normal S3 file
+            value = s3_value(key,bucket,options) #omitting the block for now
+
+            #2. save local to file_path! (make parent directories)
+            cache_local(value,key,bucket,options)
+
+            #3. return the value object
+            value
+          end
+        end
+
+        def read_cache(key,bucket,options={})
+            data = File.open(file_path!(key,bucket, options)) {|f| f.read}
+            Value.new OpenStruct.new(:body=>data)
+        end
+
+        def cache_local(value,key,bucket,options={})
+            fp=file_path!(key,bucket,options)
+            FileUtils.mkdir_p File.dirname fp
+            File.open(fp,'w') {|io| io.write value.response}
+        end
+
+        def file_path!(key,bucket, options = {}) #:nodoc:
+          # We're using the second argument for options
+          if bucket.is_a?(Hash)
+            options.replace(bucket)
+            bucket = nil
+          end
+          File.join(S3FileCache.cache_dir, bucket_name(bucket), key)
+        end
+
+        def perge_local!(key,bucket)
+          #return delete file at file_path!(bucket,name)
+          file_path= file_path!(key,bucket)
+          File.unlink file_path if File.exists? file_path
+        end
+
+        def cached_local?(key,bucket)
+          #return file exists? at file_path!(bucket,name)
+          File.exists? file_path!(key,bucket)
+        end
+
+      end
+    end
+  end
+end

data/lib/cache/aws/s3/version.rb

@@ -0,0 +1,7 @@
+module Cache
+  module AWS
+    module S3
+      VERSION = "0.1.0"
+    end
+  end
+end

data/spec/cache-aws-s3_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Cache::AWS::S3" do
+
+  describe 'when using S3Object' do
+    before (:each){
+      S3FileCache.enabled=true
+      @bucket="mittens"
+      @key="these/are/our/vista.txt"
+      @fp=AWS::S3::S3Object.file_path! @key,@bucket
+      FileUtils.mkdir_p File.dirname @fp
+      File.open(@fp, 'w') {|f| f.write 'test data'}
+    }
+    after (:each){
+      File.unlink @fp
+    }
+
+    it 'resolves files locally' do
+      @fp.should == "#{S3FileCache.cache_dir}/#{@bucket}/#{@key}"
+    end
+    it 'should hit local cache first' do
+        AWS::S3::S3Object.should_not_receive(:get)
+        AWS::S3::S3Object.should_receive(:read_cache)
+        AWS::S3::S3Object.value @key, @bucket
+    end
+    it 'passes through to regular aws when disabled' do
+        S3FileCache.enabled=false
+        lambda { AWS::S3::S3Object.value( @key, @bucket)}.should raise_error(AWS::S3::NoConnectionEstablished)
+    end
+    it 'reads data out of local cache' do
+      val=AWS::S3::S3Object.read_cache @key, @bucket
+      val.should == 'test data'
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'cache-aws-s3'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: cache-aws-s3
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Fritz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-s3
+  requirement: &2211214360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2211214360
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2211209740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2211209740
+description: speed up repeated access to s3 data with a local cache
+email:
+- kyle.p.fritz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- cache-aws-s3.gemspec
+- lib/cache-aws-s3.rb
+- lib/cache/aws/s3/object.rb
+- lib/cache/aws/s3/version.rb
+- spec/cache-aws-s3_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/kylefritz/cache-aws-s3
+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: cache-aws-s3
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: local cache for s3 data
+test_files:
+- spec/cache-aws-s3_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb