fake_aws 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52ba91fe2a0a18c2caad357a8ee0274630c6972e
-  data.tar.gz: 707bac260246499571d40d34877a7a2d17524129
+  metadata.gz: ed97453747d15331d9d037d50c15f413163facea
+  data.tar.gz: f51891713197c2413b3b5a7ad3f7d98261e47c5b
 SHA512:
-  metadata.gz: 5c065a73d8850ae6109ef0ce90ad70bde721b426aa1ee130f4c916cd19a70d47ea961cae2d5814241c0f17f6a43404b77722a231f2b2dfb3d675a7ebed793fe2
-  data.tar.gz: 1765e4c189c2b74a1ce88d9d499fb76a2ceebf3242574806771678ea29005e82f2b8f2a47e33ddaece740bfbb515939ac36c9d7c926d253f27818bdadd0f5452
+  metadata.gz: 6eff8dacdb4d9d42b025debebf69b7bc3c83556c767f71925be8c05c96150be68bdde518ce545ec7d0662a1d3ff83a7576644bab832fcc93e79b34bd36d877fd
+  data.tar.gz: 31d7f4ae800966929807971739dff4b2b50bd01ab93680a1f7859028c556ab105d584f3e4c3c0c35afe5901e71a0b081a6261c5f5c03190263d8718491c39260

data/Gemfile

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

data/README.md

@@ -2,10 +2,8 @@
 
 A minimal implementation of AWS as a Rack app, for testing and development.
 
-This is still in the very early stages of development.
+This is designed to pair nicely with [AWSRaw](https://github.com/envato/awsraw).
 
-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
 
@@ -21,9 +19,52 @@ Or install it yourself as:
 
     $ gem install fake_aws
 
+
+## Status
+
+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
+fairly easy to extend. Pull requests for more features are welcome.
+
+The S3 implementation only supports basic PUT Object and GET Object requests.
+The bucket name must be in the path, not the host.  No authentication or
+security is implemented.  `Content-Type` and `x-amz-metadata` headers are
+stored and returned. Responses may or may not be properly formatted.
+
+
 ## Usage
 
-TODO: Write usage instructions here
+The easiest way to try this out is with [Faraday](https://github.com/lostisland/faraday):
+
+```ruby
+connection = Faraday.new do |faraday|
+  faraday.adapter :rack, FakeAWS::S3::RackApp.new('root_directory')
+end
+```
+
+The root directory you provide is used to store S3 objects and metadata.
+
+For example, the following PUT Object request:
+
+```ruby
+connection.put do |request|
+  request.url("http://s3.amazonaws.com/test_bucket/test_path/test_file.txt")
+  request.headers["Content-Type"] = "text/plain"
+  request.body = "Hello, world!"
+end
+```
+
+will create a file `root_directory/test_bucket/test_path/test_file.txt`.
+
+(Note: `root_directory/test_bucket` must already exist! As there's no
+implementation of the Create Bucket operation yet, you'll need to make the
+directory for the bucket yourself before doing a PUT Object.)
+
+It will also create
+`root_directory/test_bucket/test_path/test_file.txt.metadata.json`, which holds
+the metadata for the file as a JSON hash.
+
 
 ## Contributing
 
@@ -35,7 +76,6 @@ TODO: Write usage instructions here
 
 ## 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

data/lib/fake_aws/version.rb

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

data/spec/integration/s3/get_object_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe "S3 GET Object operation" do
+  include S3IntegrationSpecHelpers
+
+  let(:bucket)        { "mah-bucket" }
+  let(:file_name)     { "mah-file.txt"}
+  let(:file_contents) { "Hello, world!" }
+
+  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

data/spec/integration/s3/put_object_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe "S3 PUT Object operation" do
+  include S3IntegrationSpecHelpers
+
+  let(:bucket)        { "mah-bucket" }
+  let(:file_name)     { "mah-file.txt"}
+  let(:file_contents) { "Hello, world!" }
+
+  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
+

data/spec/spec_helper.rb

@@ -1,2 +1,20 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'fake_aws'
+require 'faraday'
+
+module S3IntegrationSpecHelpers
+  def self.included(base)
+    base.let(:s3_path) { "tmp" }
+
+    base.let(:connection) do
+      Faraday.new do |connection|
+        connection.adapter :rack, FakeAWS::S3::RackApp.new(s3_path)
+      end
+    end
+
+    base.before do
+      FileUtils.rm_r(s3_path) rescue Errno::ENOENT
+      FileUtils.mkdir(s3_path)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fake_aws
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pete Yandell
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-05 00:00:00.000000000 Z
+date: 2013-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,10 +104,11 @@ files:
 - 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/integration/s3/get_object_spec.rb
+- spec/integration/s3/put_object_spec.rb
 - spec/spec_helper.rb
+- spec/unit/s3/object_store_spec.rb
+- spec/unit/s3/xml_error_response_spec.rb
 homepage: https://github.com/envato/fake_aws
 licenses:
 - MIT
@@ -134,7 +135,8 @@ 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/integration/s3/get_object_spec.rb
+- spec/integration/s3/put_object_spec.rb
 - spec/spec_helper.rb
+- spec/unit/s3/object_store_spec.rb
+- spec/unit/s3/xml_error_response_spec.rb

data/spec/s3/rack_app_spec.rb

@@ -1,147 +0,0 @@
-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
-