fake_aws 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52ba91fe2a0a18c2caad357a8ee0274630c6972e
+  data.tar.gz: 707bac260246499571d40d34877a7a2d17524129
+SHA512:
+  metadata.gz: 5c065a73d8850ae6109ef0ce90ad70bde721b426aa1ee130f4c916cd19a70d47ea961cae2d5814241c0f17f6a43404b77722a231f2b2dfb3d675a7ebed793fe2
+  data.tar.gz: 1765e4c189c2b74a1ce88d9d499fb76a2ceebf3242574806771678ea29005e82f2b8f2a47e33ddaece740bfbb515939ac36c9d7c926d253f27818bdadd0f5452

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.railscamp.org'
+
+# Specify your gem's dependencies in fake_aws.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Envato, Pete Yandell & Luke Arndt
+
+MIT License
+
+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.md

@@ -0,0 +1,43 @@
+# FakeAWS
+
+A minimal implementation of AWS as a Rack app, for testing and development.
+
+This is still in the very early stages of development.
+
+So far there's only a tiny bit of S3 implemented, but it's well tested and
+designed to be easy to extend. Pull requests for more features are welcome.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fake_aws'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fake_aws
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## To Do
+
+- Split up the rack app tests into separate files for the different operations
+- Handle bucket names in the host as well as the path
+- Spit out a properly formatted response on a successful PUT object operation
+- Complete the missing fields in XML error responses
+- Check signing of requests
+- Handle PUT Object copy requests

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/fake_aws.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fake_aws/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake_aws"
+  spec.version       = FakeAWS::VERSION
+  spec.authors       = ["Pete Yandell", "Luke Arndt"]
+  spec.email         = ["pete@notahat.com", "luke@arndt.io"]
+  spec.description   = %q{A subset of AWS as a Rack app, for dev and testing}
+  spec.summary       = %q{A subset of AWS (so far just a small proportion of S3) implemented as a Rack app, useful for development and testing.}
+  spec.homepage      = "https://github.com/envato/fake_aws"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "faraday"
+  spec.add_development_dependency "rack-test"
+end

data/lib/fake_aws/s3/object_store.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+module FakeAWS
+  module S3
+
+    # Read and write S3 objects and metadata about them in the filesystem.
+    class ObjectStore
+
+      def initialize(root_directory, path_info)
+        @root_directory = root_directory
+        @path_info = path_info
+
+        path_components = @path_info.split("/")
+        _, @bucket, *@directories, @file_name = path_components
+      end
+
+      attr_reader :bucket
+
+      def bucket_exists?
+        Dir.exists?(bucket_path)
+      end
+
+      def object_exists?
+        File.exists?(file_path)
+      end
+
+      def write_object(content, metadata)
+        FileUtils.mkdir_p(directory_path)
+        File.write(file_path, content)
+        File.write(metadata_file_path, metadata.to_json)
+      end
+
+      def read_object
+        File.new(file_path)
+      end
+
+      def read_metadata
+        if File.exists?(metadata_file_path)
+          JSON.parse(File.read(metadata_file_path))
+        else
+          {}
+        end
+      end
+
+    private
+
+      def bucket_path
+        @bucket_path ||= File.join(@root_directory, @bucket)
+      end
+
+      def file_path
+        @file_path ||= File.join(@root_directory, @path_info)
+      end
+
+      def metadata_file_path
+        "#{file_path}.metadata.json"
+      end
+
+      def directory_path
+        @directory_path ||= File.join(@root_directory, @bucket, *@directories)
+      end
+
+    end
+
+  end
+end

data/lib/fake_aws/s3/operations/get_object.rb

@@ -0,0 +1,53 @@
+module FakeAWS
+  module S3
+    module Operations
+
+      class GetObject
+        def initialize(root_directory, env)
+          @root_directory = root_directory
+          @env            = env
+        end
+
+        def call
+          if object_store.object_exists?
+            success_response
+          else
+            no_such_key_response
+          end
+        end
+
+      private
+
+        def success_response
+          [
+            200,
+            { "Content-Type" => content_type },
+            object_store.read_object
+          ]
+        end
+
+        def no_such_key_response
+          [
+            404,
+            { "Content-Type" => "application/xml" },
+            # TODO: need to figure out what the resource should be here.
+            XMLErrorResponse.new("NoSuchKey", "The specified key does not exist.", "")
+          ]
+        end
+
+        def content_type
+          metadata["Content-Type"] || "application/octet-stream"
+        end
+
+        def metadata
+          @metadata ||= object_store.read_metadata
+        end
+
+        def object_store
+          @object_store ||= ObjectStore.new(@root_directory, @env["PATH_INFO"])
+        end
+      end
+
+    end
+  end
+end

data/lib/fake_aws/s3/operations/put_object.rb

@@ -0,0 +1,67 @@
+module FakeAWS
+  module S3
+    module Operations
+
+      class PutObject
+        def initialize(root_directory, env)
+          @root_directory = root_directory
+          @env            = env
+        end
+
+        def call
+          # TODO: Bit of a tell-don't-ask violation here. Can it be fixed?
+          if object_store.bucket_exists?
+            object_store.write_object(content, metadata)
+            success_response
+          else
+            no_such_bucket_response
+          end
+        end
+
+      private
+
+        def success_response
+          [
+            200,
+            { "Content-Type" => "application/xml" },
+            ["hello world"]  # TODO: Uh huh.
+          ]
+        end
+
+        def no_such_bucket_response
+          [
+            404,
+            { "Content-Type" => "application/xml" },
+            XMLErrorResponse.new(
+              "NoSuchBucket",
+              "The specified bucket does not exist.",
+              "/#{object_store.bucket}"
+            )
+          ]
+        end
+
+        def content
+          @env["rack.input"].read
+        end
+
+        def metadata
+          @metadata ||= {}.tap do |metadata|
+            metadata["Content-Type"] = @env['CONTENT_TYPE']
+
+            user_metadata_env_keys = @env.keys.select {|key| key =~ /^HTTP_X_AMZ_META_/ }
+            user_metadata_env_keys.each do |env_key|
+              metadata_key = env_key.sub(/^HTTP_/, "").gsub("_", "-").downcase
+              metadata[metadata_key] = @env[env_key]
+            end
+          end
+        end
+
+        def object_store
+          @object_store ||= ObjectStore.new(@root_directory, @env["PATH_INFO"])
+        end
+
+      end
+
+    end
+  end
+end

data/lib/fake_aws/s3/rack_app.rb

@@ -0,0 +1,25 @@
+module FakeAWS
+  module S3
+
+    class RackApp
+      def initialize(directory)
+        @directory = directory
+      end
+
+      def call(env)
+        operation_class = case env["REQUEST_METHOD"]
+          when "PUT"
+            Operations::PutObject
+          when "GET"
+            Operations::GetObject
+          else
+            raise "Unhandled request method"  # TODO: Make a proper exception for this.
+        end
+
+        operation = operation_class.new(@directory, env)
+        operation.call
+      end
+    end
+
+  end
+end

data/lib/fake_aws/s3/xml_error_response.rb

@@ -0,0 +1,29 @@
+module FakeAWS
+  module S3
+
+    class XMLErrorResponse
+      def initialize(code, message, resource)
+        @code = code
+        @message = message
+        @resource = resource
+      end
+
+      def to_str
+        # TODO: Fill out the bits of the XML response that we haven't yet.
+        "".tap do |xml|
+          xml << %q{<?xml version="1.0" encoding="UTF-8"?>\n}
+          xml << %q{<Error>}
+
+          xml << "  <Code>#{@code}</Code>"
+          xml << "  <Message>#{@message}</Message>"
+          xml << "  <Resource>#{@resource}</Resource>"
+          xml << "  <RequestId></RequestId>"
+
+          xml << %q{</Error>}
+        end
+      end
+
+    end
+
+  end
+end

data/lib/fake_aws/version.rb

@@ -0,0 +1,3 @@
+module FakeAWS
+  VERSION = "0.0.1"
+end

data/lib/fake_aws.rb

@@ -0,0 +1,6 @@
+require "fake_aws/version"
+require "fake_aws/s3/object_store"
+require "fake_aws/s3/rack_app"
+require "fake_aws/s3/xml_error_response"
+require "fake_aws/s3/operations/get_object"
+require "fake_aws/s3/operations/put_object"

data/spec/s3/object_store_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe FakeAWS::S3::ObjectStore do
+  let(:root_directory)     { "tmp" }
+  let(:path_info)          { "/mah-bucket/mah-file.txt" }
+
+  subject { described_class.new(root_directory, path_info) }
+
+  let(:bucket_path)        { "tmp/mah-bucket" }
+  let(:object_file_path)   { "tmp/mah-bucket/mah-file.txt" }
+  let(:metadata_file_path) { "tmp/mah-bucket/mah-file.txt.metadata.json" }
+
+  before do
+    FileUtils.rm_r(root_directory) rescue Errno::ENOENT
+    FileUtils.mkdir_p(bucket_path)
+  end
+
+  describe "#bucket_exists?" do
+    it "returns true if the bucket directory exists" do
+      expect(subject.bucket_exists?).to be_true
+    end
+
+    it "returns false if the bucket directory doesn't exist" do
+      FileUtils.rmdir(bucket_path)
+      expect(subject.bucket_exists?).to be_false
+    end
+  end
+
+  describe "#object_exists?" do
+    it "returns true if the object file exists" do
+      File.write(object_file_path, "Hello, world!")
+      expect(subject.object_exists?).to be_true
+    end
+
+    it "returns file if the object file doesn't exist" do
+      expect(subject.object_exists?).to be_false
+    end
+  end
+
+  describe "#write_object" do
+    it "writes the content to the object file" do
+      subject.write_object("Hello, world!", { "bunnies" => "scary" })
+
+      expect(File.read(object_file_path)).to eq("Hello, world!")
+    end
+
+    it "writes the metadata to the metadata file as JSON" do
+      subject.write_object("Hello, world!", { "bunnies" => "scary" })
+
+      expect(File.read(metadata_file_path)).to eq('{"bunnies":"scary"}')
+    end
+  end
+
+  describe "#read_object" do
+    it "reads the contents of the object file" do
+      File.write(object_file_path, "Hello, world!")
+
+      expect(subject.read_object.read).to eq("Hello, world!")
+    end
+  end
+
+  describe "#read_metadata" do
+    it "returns an empty hash if there's no metadata file" do
+      expect(subject.read_metadata).to eq({})
+    end
+
+    it "returns the JSON from the metadata file converted to a hash" do
+      File.write(metadata_file_path, '{"bunnies":"scary"}')
+
+      expect(subject.read_metadata).to eq("bunnies" => "scary")
+    end
+  end
+
+end
+

data/spec/s3/rack_app_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+require 'faraday'
+require 'rack/test'
+require 'json'
+
+describe FakeAWS::S3::RackApp do
+  let(:s3_path)       { "tmp" }
+  let(:bucket)        { "mah-bucket" }
+  let(:file_name)     { "mah-file.txt"}
+  let(:file_contents) { "Hello, world!" }
+  subject { described_class.new(s3_path) }
+
+  let(:connection) do
+    Faraday.new do |connection|
+      connection.adapter :rack, subject
+    end
+  end
+
+  before do
+    FileUtils.rm_r(s3_path) rescue Errno::ENOENT
+    FileUtils.mkdir(s3_path)
+  end
+
+  context "PUT object" do
+    def put_example_file(key)
+      connection.put do |request|
+        request.url(File.join(bucket, key))
+        request.headers["Content-Type"] = "text/plain"
+        request.headers["x-amz-meta-example"] = "example metadata"
+        request.body = file_contents
+      end
+    end
+
+    def read_example_metadata(key)
+      metadata_file_path = File.join(s3_path, "/#{bucket}/#{key}.metadata.json")
+      JSON.parse(File.read(metadata_file_path))
+    end
+
+    context "with an existing bucket" do
+      before do
+        Dir.mkdir(File.join(s3_path, bucket))
+      end
+
+      it "returns a 200" do
+        response = put_example_file(file_name)
+        expect(response.status).to eq(200)
+      end
+
+      it "returns a correctly constructed response"
+
+      it "creates a file" do
+        put_example_file(file_name)
+        expect(File.read(File.join(s3_path, "/#{bucket}/#{file_name}"))).to eq(file_contents)
+      end
+
+      it "stores the content-type" do
+        put_example_file(file_name)
+
+        metadata = read_example_metadata(file_name)
+        expect(metadata["Content-Type"]).to eq("text/plain")
+      end
+
+      it "stores user-defined metadata" do
+        put_example_file(file_name)
+
+        metadata = read_example_metadata(file_name)
+        expect(metadata["x-amz-meta-example"]).to eq("example metadata")
+      end
+
+      it "creates sub-directories for paths that contain them" do
+        put_example_file("foo/bar/#{file_name}")
+        expect(File.read(File.join(s3_path, "/#{bucket}/foo/bar/#{file_name}"))).to eq(file_contents)
+      end
+
+      it "handles sub-directories that already exist" do
+        FileUtils.mkdir_p(File.join(s3_path, "#{bucket}/foo/bar"))
+        put_example_file("foo/bar/#{file_name}")
+        expect(File.read(File.join(s3_path, "/#{bucket}/foo/bar/#{file_name}"))).to eq(file_contents)
+      end
+    end
+
+    context "without an existing bucket" do
+      it "returns a 404" do
+        response = put_example_file(file_name)
+        expect(response.status).to eq(404)
+      end
+
+      it "returns the correct XML response"
+    end
+  end
+
+  context "GET object" do
+    def get_example_file(key)
+      connection.get(File.join(bucket, key))
+    end
+
+    context "with a file that exists" do
+      before do
+        FileUtils.mkdir(File.join(s3_path, bucket))
+        File.write(File.join(s3_path, bucket, file_name), file_contents)
+      end
+
+      it "returns a 200" do
+        response = get_example_file(file_name)
+        expect(response.status).to eq(200)
+      end
+
+      it "returns a correctly constructed response"
+
+      it "returns the contents of the file" do
+        response = get_example_file(file_name)
+        expect(response.body).to eq(file_contents)
+      end
+
+      it "returns the right content type" do
+        file_metadata = {
+          "Content-Type" => "text/plain"
+        }.to_json
+        File.write(File.join(s3_path, bucket, "#{file_name}.metadata.json"), file_metadata)
+
+        response = get_example_file(file_name)
+        expect(response.headers["Content-Type"]).to eq("text/plain")
+      end
+    end
+
+    context "with a file that doesn't exist" do
+      before do
+        FileUtils.mkdir(File.join(s3_path, bucket))
+      end
+
+      it "returns a 404" do
+        response = get_example_file(file_name)
+        expect(response.status).to eq(404)
+      end
+
+      it "returns the correct XML response"
+    end
+
+    context "with a bucket that doesn't exist" do
+      it "returns the right sort of error" do
+        pending "Need to figure out what error AWS actually returns for this case"
+      end
+    end
+  end
+
+end
+

data/spec/s3/xml_error_response_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe FakeAWS::S3::XMLErrorResponse do
+
+  it "puts the code in the response"
+  it "puts the message in the response"
+  it "puts the resource in the response"
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'fake_aws'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: fake_aws
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pete Yandell
+- Luke Arndt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A subset of AWS as a Rack app, for dev and testing
+email:
+- pete@notahat.com
+- luke@arndt.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fake_aws.gemspec
+- lib/fake_aws.rb
+- lib/fake_aws/s3/object_store.rb
+- lib/fake_aws/s3/operations/get_object.rb
+- lib/fake_aws/s3/operations/put_object.rb
+- lib/fake_aws/s3/rack_app.rb
+- lib/fake_aws/s3/xml_error_response.rb
+- lib/fake_aws/version.rb
+- spec/s3/object_store_spec.rb
+- spec/s3/rack_app_spec.rb
+- spec/s3/xml_error_response_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/envato/fake_aws
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A subset of AWS (so far just a small proportion of S3) implemented as a Rack
+  app, useful for development and testing.
+test_files:
+- spec/s3/object_store_spec.rb
+- spec/s3/rack_app_spec.rb
+- spec/s3/xml_error_response_spec.rb
+- spec/spec_helper.rb