fake_aws 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed97453747d15331d9d037d50c15f413163facea
-  data.tar.gz: f51891713197c2413b3b5a7ad3f7d98261e47c5b
+  metadata.gz: fcacd66d77b727c137301c6de05fa146cb88a507
+  data.tar.gz: 614b3b3159d8b544a7826d224bf444c35383db95
 SHA512:
-  metadata.gz: 6eff8dacdb4d9d42b025debebf69b7bc3c83556c767f71925be8c05c96150be68bdde518ce545ec7d0662a1d3ff83a7576644bab832fcc93e79b34bd36d877fd
-  data.tar.gz: 31d7f4ae800966929807971739dff4b2b50bd01ab93680a1f7859028c556ab105d584f3e4c3c0c35afe5901e71a0b081a6261c5f5c03190263d8718491c39260
+  metadata.gz: 9213550b7d286db1f0f7a62efc0488aa17d637a1e0a20f08c283854dbcb8a2c4a0a9fa31e13f1b288260deaaab9ed6d42930ba604199191f2287e5b91b80f5b7
+  data.tar.gz: d20fed38db8168dbf9c9588c3d4ecb198547a74f503f04ce856031b85c9c17e40e8c8d8cafa752cb2dcf91b7d87ae9d4e75d3aa80585f1413492e6a7d1c01151

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+tags

data/.travis.yml

@@ -1,3 +1,5 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.0.0
+  - 2.1.0

data/README.md

@@ -20,18 +20,11 @@ Or install it yourself as:
     $ gem install fake_aws
 
 
-## Status
-
-This is still in the very early stages of development.
+## Status [![Build Status](https://travis-ci.org/envato/fake_aws.png)](https://travis-ci.org/envato/fake_aws) [![Code Climate](https://codeclimate.com/github/envato/fake_aws.png)](https://codeclimate.com/github/envato/fake_aws)
 
 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
 
@@ -57,15 +50,29 @@ 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.
 
 
+## Implemented Operations
+
+### S3
+
+Path-style, virtual-hosted-style, and CNAME-style requests are supported for
+all operations.
+
+No authentication or security is implemented.
+
+`Content-Type` and `x-amz-metadata` headers are stored and returned.
+
+- [GET Object](http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html)
+- [PUT Bucket](http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUT.html)
+- [PUT Object](http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html)
+
+Pull requests for other operations are welcome!
+
+
 ## Contributing
 
 1. Fork it
@@ -76,8 +83,9 @@ the metadata for the file as a JSON hash.
 
 ## To Do
 
-- 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
+- Implement [GET Bucket](http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGET.html) requests
+- Improve the [response headers](http://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html) (Content-Length, ETag, etc.)
 - Check signing of requests
-- Handle PUT Object copy requests
+- Handle PUT Object Copy requests
+
+

data/fake_aws.gemspec

@@ -18,9 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "finer_struct", "~> 0.0.5"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
   spec.add_development_dependency "faraday"
   spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "nori", "~> 2.3.0"
 end

data/lib/fake_aws.rb

@@ -1,6 +1,14 @@
 require "fake_aws/version"
-require "fake_aws/s3/object_store"
+require "fake_aws/error"
+require "fake_aws/s3/bucket_on_disk"
+require "fake_aws/s3/error_index"
+require "fake_aws/s3/object_on_disk"
 require "fake_aws/s3/rack_app"
-require "fake_aws/s3/xml_error_response"
+require "fake_aws/s3/request"
 require "fake_aws/s3/operations/get_object"
+require "fake_aws/s3/operations/put_bucket"
 require "fake_aws/s3/operations/put_object"
+require "fake_aws/s3/responses/common"
+require "fake_aws/s3/responses/empty"
+require "fake_aws/s3/responses/error"
+require "fake_aws/s3/responses/success"

data/lib/fake_aws/error.rb

@@ -0,0 +1,16 @@
+module FakeAWS
+  class Error < RuntimeError
+  end
+
+  class UnknownResponseErrorCode < Error
+    def initialize
+      super("Attempting to look up an AWS error code that doesn't exist. This is probably a bug in FakeAWS.")
+    end
+  end
+
+  class UnsupportedRequestError < Error
+    def initialize
+      super("FakeAWS doesn't (yet) support this type of AWS request.")
+    end
+  end
+end

data/lib/fake_aws/s3/bucket_on_disk.rb

@@ -0,0 +1,26 @@
+module FakeAWS
+  module S3
+
+    class BucketOnDisk
+
+      def initialize(root_directory, bucket)
+        @root_directory = root_directory
+        @bucket         = bucket
+      end
+
+      def exists?
+        Dir.exists?(path)
+      end
+
+      def create
+        FileUtils.mkdir_p(path)
+      end
+
+      def path
+        @path ||= File.join(@root_directory, @bucket)
+      end
+
+    end
+
+  end
+end

data/lib/fake_aws/s3/error_index.rb

@@ -0,0 +1,37 @@
+require 'finer_struct'
+
+module FakeAWS
+  module S3
+
+    # S3 error information, extracted from:
+    #
+    # http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html
+    module ErrorIndex
+      class Error < FinerStruct::Immutable(:description, :status_code); end
+
+      def self.error_for_code(error_code)
+        errors[error_code] || raise(FakeAWS::UnknownResponseErrorCode)
+      end
+
+    private
+
+      def self.errors
+        @errors ||= {
+          "NoSuchBucket" => Error.new(
+            :description => "The specified bucket does not exist.",
+            :status_code => 404
+          ),
+          "NoSuchKey" => Error.new(
+            :description => "The specified key does not exist.",
+            :status_code => 404
+          ),
+          "BucketAlreadyExists" => Error.new(
+            :description => "The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.",
+            :status_code => 409
+          )
+        }
+      end
+    end
+
+  end
+end

data/lib/fake_aws/s3/object_on_disk.rb

@@ -0,0 +1,50 @@
+require 'json'
+
+module FakeAWS
+  module S3
+
+    class ObjectOnDisk
+
+      def initialize(bucket_on_disk, key = nil)
+        @bucket_on_disk = bucket_on_disk
+        @key            = key
+      end
+
+      def exists?
+        File.exists?(object_path)
+      end
+
+      def write(content, metadata)
+        FileUtils.mkdir_p(directory_path)
+        File.write(object_path, content)
+        File.write(metadata_path, metadata.to_json)
+      end
+
+      def read_content
+        File.new(object_path)
+      end
+
+      def read_metadata
+        if File.exists?(metadata_path)
+          JSON.parse(File.read(metadata_path))
+        else
+          {}
+        end
+      end
+
+      def object_path
+        @object_path ||= File.join(@bucket_on_disk.path, @key)
+      end
+
+      def metadata_path
+        @metadata_path ||= File.join("#{object_path}.metadata.json")
+      end
+
+      def directory_path
+        @directory_path ||= File.dirname(object_path)
+      end
+
+    end
+
+  end
+end

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

@@ -3,49 +3,56 @@ module FakeAWS
     module Operations
 
       class GetObject
-        def initialize(root_directory, env)
+        def initialize(root_directory, request)
           @root_directory = root_directory
-          @env            = env
+          @request        = request
         end
 
         def call
-          if object_store.object_exists?
-            success_response
-          else
-            no_such_key_response
-          end
+          return no_such_bucket_response unless bucket_on_disk.exists?
+          return no_such_key_response    unless object_on_disk.exists?
+
+          success_response
         end
 
       private
 
         def success_response
-          [
-            200,
-            { "Content-Type" => content_type },
-            object_store.read_object
-          ]
+          Responses::Success.new(headers, object_on_disk.read_content)
+        end
+
+        def no_such_bucket_response
+          Responses::Error.new("NoSuchBucket", "BucketName" => @request.bucket)
         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.", "")
-          ]
+          Responses::Error.new("NoSuchKey", "Resource" => @request.key)
+        end
+
+        def headers
+          [content_type_header, user_headers].inject(:merge)
         end
 
-        def content_type
-          metadata["Content-Type"] || "application/octet-stream"
+        def user_headers
+          metadata.select {|key, _| key.start_with?("x-amz-meta-") }
+        end
+
+        def content_type_header
+          { "Content-Type" => metadata["Content-Type"] || "application/octet-stream" }
         end
 
         def metadata
-          @metadata ||= object_store.read_metadata
+          @metadata ||= object_on_disk.read_metadata
         end
 
-        def object_store
-          @object_store ||= ObjectStore.new(@root_directory, @env["PATH_INFO"])
+        def object_on_disk
+          @object_on_disk ||= ObjectOnDisk.new(bucket_on_disk, @request.key)
         end
+
+        def bucket_on_disk
+          @bucket_on_disk ||= BucketOnDisk.new(@root_directory, @request.bucket)
+        end
+
       end
 
     end

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

@@ -0,0 +1,38 @@
+module FakeAWS
+  module S3
+
+    module Operations
+
+      class PutBucket
+        def initialize(root_directory, request)
+          @root_directory = root_directory
+          @request        = request
+        end
+
+        def call
+          return bucket_already_exists_response if bucket_on_disk.exists?
+
+          bucket_on_disk.create
+          success_response
+        end
+
+      private
+
+        def success_response
+          Responses::Empty.new
+        end
+
+        def bucket_already_exists_response
+          Responses::Error.new("BucketAlreadyExists", "BucketName" => @request.bucket)
+        end
+
+        def bucket_on_disk
+          @bucket_on_disk ||= BucketOnDisk.new(@root_directory, @request.bucket)
+        end
+
+      end
+
+    end
+
+  end
+end

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

@@ -1,63 +1,49 @@
 module FakeAWS
   module S3
+
     module Operations
 
       class PutObject
-        def initialize(root_directory, env)
+        def initialize(root_directory, request)
           @root_directory = root_directory
-          @env            = env
+          @request        = request
         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
+          return no_such_bucket_response unless bucket_on_disk.exists?
+
+          object_on_disk.write(@request.content, metadata)
+          success_response
         end
 
       private
 
         def success_response
-          [
-            200,
-            { "Content-Type" => "application/xml" },
-            ["hello world"]  # TODO: Uh huh.
-          ]
+          Responses::Empty.new
         end
 
         def no_such_bucket_response
-          [
-            404,
-            { "Content-Type" => "application/xml" },
-            XMLErrorResponse.new(
-              "NoSuchBucket",
-              "The specified bucket does not exist.",
-              "/#{object_store.bucket}"
-            )
-          ]
+          Responses::Error.new("NoSuchBucket", "BucketName" => @request.bucket)
         end
 
-        def content
-          @env["rack.input"].read
+        def metadata
+          @metadata ||= [content_type_metadata, user_metadata].inject(:merge)
         end
 
-        def metadata
-          @metadata ||= {}.tap do |metadata|
-            metadata["Content-Type"] = @env['CONTENT_TYPE']
+        def content_type_metadata
+          { "Content-Type" => @request.content_type }
+        end
+
+        def user_metadata
+          @request.http_headers.select {|key, _| key.start_with?("x-amz-meta-") }
+        end
 
-            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
+        def object_on_disk
+          @object_on_disk ||= ObjectOnDisk.new(bucket_on_disk, @request.key)
         end
 
-        def object_store
-          @object_store ||= ObjectStore.new(@root_directory, @env["PATH_INFO"])
+        def bucket_on_disk
+          @bucket_on_disk ||= BucketOnDisk.new(@root_directory, @request.bucket)
         end
 
       end