mock-aws-s3 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joshua Krall
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,32 @@
+= mock-aws-s3
+
+This is a simple gem for mocking out the AWS::S3 library, so that no calls to the Amazon S3 service during tests.
+
+Usage is simple, just add the gem to your bundle, and require it in your spec_helper.rb:
+
+    require 'mock-aws-s3'
+
+From there on, all (supported) calls to AWS::S3::S3Object will be proxied to file operations in a temp directory on your disk.  So these commands:
+
+    AWS::S3::S3Object.store 'key', 'some data', 'bucket'
+    AWS::S3::S3Object.exists?('key', 'bucket')
+    AWS::S3::S3Object.delete('key', 'bucket')
+
+... will result in a file being created on disk at <tt>./tmp/mock-aws-s3/bucket/key</tt>, with contents: <tt>"some data"</tt>.  A <tt>File.exists?()</tt> check will be performed on that file, and then it will be deleted.
+
+If you are using Rails, the <tt>Rails.root</tt> directory will be used: <tt>Rails.root.join('tmp')</tt>.
+
+
+== 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) 2010 Joshua Krall. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mock-aws-s3"
+    gem.summary = %Q{A Mock AWS::S3 so you can use it in your tests without hitting the network}
+    gem.description = %Q{A Mock AWS::S3 so you can use it in your tests without hitting the network.}
+    gem.email = "joshuakrall@pobox.com"
+    gem.homepage = "http://github.com/jkrall/mock-aws-s3"
+    gem.authors = ["Joshua Krall"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mock-aws-s3 #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mock-aws-s3.rb

@@ -0,0 +1,3 @@
+require 'aws/s3'
+
+require 'mock/aws/s3/object'

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

@@ -0,0 +1,100 @@
+require 'ftools'
+require 'ostruct'
+
+module AWS
+  module S3
+
+    class S3Object
+      class << self
+
+        def value(key, bucket = nil, options = {}, &block)
+          data = File.open(path!(bucket, key, options)) {|f| f.read}
+          Value.new OpenStruct.new(:body=>data)
+        end
+
+        # def stream(key, bucket = nil, options = {}, &block)
+        #   data = File.open(path!(bucket, key, options)) {|f| f.read}
+        #   Value.new Response.new(:body=>data)
+        #   value(key, bucket, options) do |response|
+        #     response.read_body(&block)
+        #   end
+        # end
+
+        # # Returns the object whose key is <tt>name</tt> in the specified bucket. If the specified key does not
+        # # exist, a NoSuchKey exception will be raised.
+        # def find(key, bucket = nil)
+        #   key    = key.remove_extended unless key.valid_utf8?
+        #   bucket = Bucket.find(bucket_name(bucket), :marker => key.previous, :max_keys => 1)
+        #   # If our heuristic failed, trigger a NoSuchKey exception
+        #   if (object = bucket.objects.first) && object.key == key
+        #     object
+        #   else
+        #     raise NoSuchKey.new("No such key `#{key}'", bucket)
+        #   end
+        # end
+
+
+        # Makes a copy of the object with <tt>key</tt> to <tt>copy_key</tt>, preserving the ACL of the existing object if the <tt>:copy_acl</tt> option is true (default false).
+        def copy(key, copy_key, bucket = nil, options = {})
+          bucket          = bucket_name(bucket)
+          source_key      = path!(bucket, key)
+          target_key      = path!(bucket, copy_key)
+          File.makedirs File.dirname(target_key)
+          FileUtils.cp_r source_key, target_key
+        end
+
+        #
+        # # Fetch information about the object with <tt>key</tt> from <tt>bucket</tt>. Information includes content type, content length,
+        # # last modified time, and others.
+        # #
+        # # If the specified key does not exist, NoSuchKey is raised.
+        # def about(key, bucket = nil, options = {})
+        #   response = head(path!(bucket, key, options), options)
+        #   raise NoSuchKey.new("No such key `#{key}'", bucket) if response.code == 404
+        #   About.new(response.headers)
+        # end
+        #
+
+        def exists?(key, bucket = nil)
+          File.exists?(path!(bucket, key))
+        end
+
+        def delete(key, bucket = nil, options = {})
+          File.unlink path!(bucket, key, options)
+        end
+
+        def store(key, data, bucket = nil, options = {})
+          validate_key!(key)
+          # Must build path before infering content type in case bucket is being used for options
+          path = path!(bucket, key, options)
+          infer_content_type!(key, options)
+
+          File.makedirs File.dirname(path)
+          File.open(path, 'wb') do |f|
+            f.write data
+          end
+        end
+        alias_method :create, :store
+        alias_method :save,   :store
+
+        TEMP_PATH = begin
+          if defined?(::Rails)
+            Rails.root.to_s
+          else
+            '.'
+          end
+        end
+
+        def path!(bucket, name, options = {}) #:nodoc:
+          # We're using the second argument for options
+          if bucket.is_a?(Hash)
+            options.replace(bucket)
+            bucket = nil
+          end
+          TEMP_PATH.clone << File.join('/tmp', 'mock-aws-s3', bucket_name(bucket), name)
+        end
+
+      end
+    end
+  end
+end

data/mock-aws-s3.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mock-aws-s3}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Krall"]
+  s.date = %q{2010-10-01}
+  s.description = %q{A Mock AWS::S3 so you can use it in your tests without hitting the network.}
+  s.email = %q{joshuakrall@pobox.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/mock-aws-s3.rb",
+     "lib/mock/aws/s3/object.rb",
+     "mock-aws-s3.gemspec",
+     "pkg/mock-aws-s3-0.1.0.gem",
+     "spec/mock-aws-s3_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/jkrall/mock-aws-s3}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Mock AWS::S3 so you can use it in your tests without hitting the network}
+  s.test_files = [
+    "spec/mock-aws-s3_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/mock-aws-s3_spec.rb

@@ -0,0 +1,78 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Mock::AWS::S3" do
+
+  describe 'when using S3Object' do
+    def create_test_file(key, bucket='bucket')
+      File.open("./tmp/mock-aws-s3/#{bucket}/#{key}", 'w') {|f| f.write 'test data'}
+    end
+    def remove_test_file(key, bucket='bucket')
+      File.unlink("./tmp/mock-aws-s3/#{bucket}/#{key}")
+    end
+
+    describe '#copy' do
+      before(:each) { create_test_file 'from_key' }
+      after(:each) do
+        remove_test_file 'from_key'
+        remove_test_file 'to_key'
+      end
+      it 'should not do an actual request' do
+        AWS::S3::S3Object.should_not_receive(:put)
+        AWS::S3::S3Object.copy 'from_key', 'to_key', 'bucket'
+      end
+      it 'should copy the file' do
+        AWS::S3::S3Object.copy 'from_key', 'to_key', 'bucket'
+        File.exists?('./tmp/mock-aws-s3/bucket/from_key').should be_true
+        File.exists?('./tmp/mock-aws-s3/bucket/to_key').should be_true
+      end
+    end
+    describe '#exists?' do
+      it 'should not do an actual request' do
+        AWS::S3::S3Object.should_not_receive(:head)
+        AWS::S3::S3Object.exists? 'key', 'bucket'
+      end
+      it 'should return true if the file exists' do
+        create_test_file 'key'
+        AWS::S3::S3Object.exists?('key', 'bucket').should be_true
+        remove_test_file 'key'
+      end
+      it 'should return false if the file does not exist' do
+        remove_test_file 'key' rescue nil
+        AWS::S3::S3Object.exists?('key', 'bucket').should be_false
+      end
+    end
+    describe '#delete' do
+      before(:each) { create_test_file 'key' }
+      it 'should not do an actual request' do
+        AWS::S3::Base.should_not_receive(:delete)
+        AWS::S3::S3Object.delete('key', 'bucket')
+      end
+      it 'should delete the file' do
+        AWS::S3::S3Object.delete('key', 'bucket')
+        File.exists?('./tmp/mock-aws-s3/bucket/key').should be_false
+      end
+    end
+    describe '#store' do
+      it 'should not do an actual request' do
+        AWS::S3::S3Object.should_not_receive(:put)
+        AWS::S3::S3Object.store 'key', 'some data', 'bucket'
+      end
+      it 'should store the data in the file' do
+        AWS::S3::S3Object.store 'key', 'some data', 'bucket'
+        File.open('./tmp/mock-aws-s3/bucket/key') do |f|
+          f.read.should == 'some data'
+        end
+        remove_test_file 'key'
+      end
+    end
+    describe '#value' do
+      before(:each) { create_test_file 'key' }
+      after(:each) { remove_test_file 'key' }
+      it 'should not do an actual request' do
+        AWS::S3::Base.should_not_receive(:get)
+        AWS::S3::S3Object.value('key', 'bucket')
+      end
+    end
+  end
+
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'mock-aws-s3'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: mock-aws-s3
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Joshua Krall
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: A Mock AWS::S3 so you can use it in your tests without hitting the network.
+email: joshuakrall@pobox.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mock-aws-s3.rb
+- lib/mock/aws/s3/object.rb
+- mock-aws-s3.gemspec
+- pkg/mock-aws-s3-0.1.0.gem
+- spec/mock-aws-s3_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jkrall/mock-aws-s3
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Mock AWS::S3 so you can use it in your tests without hitting the network
+test_files: 
+- spec/mock-aws-s3_spec.rb
+- spec/spec_helper.rb