fakes3 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d83222d27c571e62955e1dfd70da24ddd57e99ab
-  data.tar.gz: 61ff18d5ee0928f416abfda19b5757408c8f67c5
+  metadata.gz: a7c7f31dbcec54846627f3c63f998eb7fa82fa56
+  data.tar.gz: e0f13efeb4b223f9094360a42837ba8c4830f7b0
 SHA512:
-  metadata.gz: 8a7cdeb5938b8a010920b1fb5d68fd0cff80401165787c570d9d624da84de65ac21a5e493c682e520a51af5159e1977e8b62470468b54388da9304b3a8f9c2bf
-  data.tar.gz: 68d355177a175eca39f54273bf96d8b56246a5428f3b7aa3d1584dbe8151a8b6f3f5cdfb36e62ba3aa4ac409ffe51fb283c2fbe9e7410f1192652219dca91a07
+  metadata.gz: fb67ce99ae0fa4eb1948584e338b6ccebeb542154f2f1c606632614283b5d950d4d9056a118972c20ac623436c7ed3685b05dd41672fd7183d923e068e724910
+  data.tar.gz: ce6b1e73a3ab5464dcaad3285200b51e9eb4e16ddd8f153196a0dff80381d5e370f4c5c6b97f2fa67149f3c5c4709d36260de9cc58167f10450a2847bb2548ab

data/.gitignore

@@ -12,3 +12,5 @@ test_root
 
 # Don't check in the Gemfile.lock
 Gemfile.lock
+
+.DS_Store

data/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+## Contributing to Fake S3
+
+Contributions in the form of pull requests, bug reports, documentation, or anything else are welcome! We do have a few small rules to follow:
+
+- Ensure tests pass before making a pull request. (You can read the Testing section below for how to set up your development environment and run tests)
+
+- Please use a coding style similar to the rest of the file(s) you change. This isn't a hard rule but if it's too different, it will stand out.
+
+- Unless your contributions fall under the trivial exemption policy (below), contributors must sign our Contributor License Agreement (CLA) to be eligible to contribute. Read more in section is below.
+
+
+## Testing
+
+There are some prerequisites to actually being able to run the unit/integration tests.
+
+On macOS, edit your /etc/hosts and add the following line:
+
+    127.0.0.1 posttest.localhost
+
+Then ensure that the following packages are installed (boto, s3cmd):
+
+    > pip install boto
+    > brew install s3cmd
+
+
+Start the test server using:
+
+    rake test_server
+
+Finally, in another terminal window run:
+
+    rake test
+
+
+## Signing the Contributor License agreement
+
+We have a contributor license agreement (CLA) based off of Google and Apache's CLA. If you would feel comfortable contributing to, say, Angular.js, you should feel comfortable with this CLA.
+
+To sign the CLA:
+
+[Click here and fill out the form.](https://docs.google.com/forms/d/e/1FAIpQLSeKKSKNNz5ji1fd5bbu5RaGFbhD45zEaCnAjzBZPpzOaXQsvQ/viewform)
+
+If you're interested, [this blog post](https://julien.ponge.org/blog/in-defense-of-contributor-license-agreements/) discusses why to use a CLA, and even goes over the text of the CLA we based ours on.
+
+
+## Trivial Exemption Policy
+
+The Trivial Exemption Policy exempts contributions that would not be sufficiently robust or creative to enjoy copyright protection, and therefore do not need to sign the CLA. This would generally be changes that don't involve much creativity.
+
+Contributions considered trivial are generally fewer than 10 lines of actual code. (It may be longer than 10 lines, for example these would often be larger: blank lines, changes in indentation, formatting, simple comments, logging messages, changes to metadata like Gemfiles or gitignore, reordering, breaking or combining files, renaming files, or other unoriginal changes)

data/DEPLOY_README.md

@@ -0,0 +1,18 @@
+# Helpful things to remember when deploying to RubyGems
+
+Ensure the version number is updated (lib/fakes3/version.rb)
+
+Ensure the tests pass
+```
+  rake test_server followed by rake test
+```
+
+Build the Gem
+```
+  gem build fakes3.gemspec
+```
+
+Push to RubyGems
+```
+  gem push fakes3-VERSION.gem
+```

data/README.md

@@ -1,15 +1,13 @@
 ## Introduction
-FakeS3 is a lightweight server that responds to the same calls Amazon S3 responds to.
-It is extremely useful for testing of S3 in a sandbox environment without actually
-making calls to Amazon, which not only require network, but also cost you precious dollars.
+
+Fake S3 is a lightweight server that responds to the same API of Amazon S3.
+
+It is extremely useful for testing of S3 in a sandbox environment without actually making calls to Amazon, which not only requires a network connection, but also costs money with every use.
 
 The goal of Fake S3 is to minimize runtime dependencies and be more of a
-development tool to test S3 calls in your code rather than a production server
-looking to duplicate S3 functionality.  Trying RiakCS, ParkPlace/Boardwalk, or
-Ceph might be a place to start if that is your goal.
+development tool to test S3 calls in your code rather than a production server looking to duplicate S3 functionality.
 
-FakeS3 doesn't support all of the S3 command set, but the basic ones like put, get,
-list, copy, and make bucket are supported.  More coming soon.
+Many commands are supported, including put, get, list, copy, and make bucket.
 
 ## Installation
 
@@ -17,46 +15,20 @@ list, copy, and make bucket are supported.  More coming soon.
 
 ## Running
 
-To run a fakes3 server, you just specify a root and a port.
+To run the server, you just specify a root and a port.
 
     fakes3 -r /mnt/fakes3_root -p 4567
 
-## Connecting to FakeS3
+## Connecting to Fake S3
 
-Take a look at the test cases to see client example usage.  For now, FakeS3 is
+Take a look at the test cases to see client example usage.  For now, Fake S3 is
 mainly tested with s3cmd, aws-s3 gem, and right_aws.  There are plenty more
 libraries out there, and please do mention if other clients work or not.
 
 Here is a running list of [supported clients](https://github.com/jubos/fake-s3/wiki/Supported-Clients "Supported Clients")
 
-## Running Tests
-
-There are some pre-requesites to actually being able to run the unit/integration tests
-
-### On OSX
-
-Edit your /etc/hosts and add the following line:
-
-    127.0.0.1 posttest.localhost
-
-Then ensure that the following packages are installed (boto, s3cmd)
-
-    > pip install boto
-    > brew install s3cmd
-
-
-Start the test server using
-
-    rake test_server
-
-Then in another terminal window run
-
-    rake test
-
-It is a still a TODO to get this to be just one command
-
-## More Information
+## Contributing
 
-Check out the [wiki](https://github.com/jubos/fake-s3/wiki)
+Contributions in the form of pull requests, bug reports, documentation, or anything else are welcome! Please read the CONTRIBUTING.md file for more info:
 
-[![Join the chat at https://gitter.im/jubos/fake-s3](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jubos/fake-s3?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+(https://github.com/jubos/fake-s3/CONTRIBUTING.md)[https://github.com/jubos/fake-s3/CONTRIBUTING.md]

data/fakes3.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Curtis Spencer"]
   s.email       = ["thorin@gmail.com"]
   s.homepage    = "https://github.com/jubos/fake-s3"
-  s.summary     = %q{FakeS3 is a server that simulates S3 commands so you can test your S3 functionality in your projects}
-  s.description = %q{Use FakeS3 to test basic S3 functionality without actually connecting to S3}
+  s.summary     = %q{Fake S3 is a server that simulates S3 commands so you can test your S3 functionality in your projects}
+  s.description = %q{Use Fake S3 to test basic S3 functionality without actually connecting to S3}
   s.license     = "MIT"
 
   s.rubyforge_project = "fakes3"
@@ -19,8 +19,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency "right_aws"
   s.add_development_dependency "rest-client"
   s.add_development_dependency "rake"
+  s.add_development_dependency "aws-sdk", "~> 2"
   s.add_development_dependency "aws-sdk-v1"
   s.add_development_dependency "test-unit"
+  s.add_development_dependency "mocha"
   #s.add_development_dependency "ruby-debug"
   #s.add_development_dependency "debugger"
   s.add_dependency "thor"

data/lib/fakes3/cli.rb

@@ -11,6 +11,7 @@ module FakeS3
     method_option :port, :type => :numeric, :aliases => '-p', :required => true
     method_option :address, :type => :string, :aliases => '-a', :required => false, :desc => "Bind to this address. Defaults to 0.0.0.0"
     method_option :hostname, :type => :string, :aliases => '-H', :desc => "The root name of the host.  Defaults to s3.amazonaws.com."
+    method_option :quiet, :type => :boolean, :aliases => '-q', :desc => "Quiet; do not write anything to standard output."
     method_option :limit, :aliases => '-l', :type => :string, :desc => 'Rate limit for serving (ie. 50K, 1.0M)'
     method_option :sslcert, :type => :string, :desc => 'Path to SSL certificate'
     method_option :sslkey, :type => :string, :desc => 'Path to SSL certificate key'
@@ -52,8 +53,8 @@ module FakeS3
         abort "If you specify an SSL certificate you must also specify an SSL certificate key"
       end
 
-      puts "Loading FakeS3 with #{root} on port #{options[:port]} with hostname #{hostname}"
-      server = FakeS3::Server.new(address,options[:port],store,hostname,ssl_cert_path,ssl_key_path)
+      puts "Loading FakeS3 with #{root} on port #{options[:port]} with hostname #{hostname}" unless options[:quiet]
+      server = FakeS3::Server.new(address,options[:port],store,hostname,ssl_cert_path,ssl_key_path, quiet: !!options[:quiet])
       server.serve
     end
 

data/lib/fakes3/server.rb

@@ -77,7 +77,7 @@ module FakeS3
           query = {
             :marker => s_req.query["marker"] ? s_req.query["marker"].to_s : nil,
             :prefix => s_req.query["prefix"] ? s_req.query["prefix"].to_s : nil,
-            :max_keys => s_req.query["max_keys"] ? s_req.query["max_keys"].to_s : nil,
+            :max_keys => s_req.query["max-keys"] ? s_req.query["max-keys"].to_i : nil,
             :delimiter => s_req.query["delimiter"] ? s_req.query["delimiter"].to_s : nil
           }
           bq = bucket_obj.query_for_range(query)
@@ -161,7 +161,7 @@ module FakeS3
       end
     end
 
-    def do_PUT(request,response)
+    def do_PUT(request, response)
       s_req = normalize_request(request)
       query = CGI::parse(request.request_uri.query || "")
 
@@ -258,7 +258,7 @@ module FakeS3
 
         response.body = XmlAdapter.complete_multipart_result real_obj
       elsif request.content_type =~ /^multipart\/form-data; boundary=(.+)/
-        key=request.query['key']
+        key = request.query['key']
 
         success_action_redirect = request.query['success_action_redirect']
         success_action_status   = request.query['success_action_status']
@@ -300,7 +300,7 @@ module FakeS3
       response['Access-Control-Expose-Headers'] = 'ETag'
     end
 
-    def do_DELETE(request,response)
+    def do_DELETE(request, response)
       s_req = normalize_request(request)
 
       case s_req.type
@@ -326,7 +326,7 @@ module FakeS3
 
     private
 
-    def normalize_delete(webrick_req,s_req)
+    def normalize_delete(webrick_req, s_req)
       path = webrick_req.path
       path_len = path.size
       query = webrick_req.query
@@ -353,7 +353,7 @@ module FakeS3
       end
     end
 
-    def normalize_get(webrick_req,s_req)
+    def normalize_get(webrick_req, s_req)
       path = webrick_req.path
       path_len = path.size
       query = webrick_req.query
@@ -382,7 +382,7 @@ module FakeS3
       end
     end
 
-    def normalize_put(webrick_req,s_req)
+    def normalize_put(webrick_req, s_req)
       path = webrick_req.path
       path_len = path.size
       if path == "/"
@@ -432,11 +432,10 @@ module FakeS3
       path_len = path.size
 
       s_req.path = webrick_req.query['key']
-
       s_req.webrick_request = webrick_req
 
       if s_req.is_path_style
-        elems = path[1,path_len].split("/")
+        elems = path[1, path_len].split("/")
         s_req.bucket = elems[0]
         s_req.object = elems[1..-1].join('/') if elems.size >= 2
       else
@@ -478,7 +477,7 @@ module FakeS3
       return s_req
     end
 
-    def parse_complete_multipart_upload request
+    def parse_complete_multipart_upload(request)
       parts_xml   = ""
       request.body { |chunk| parts_xml << chunk }
 
@@ -506,7 +505,7 @@ module FakeS3
 
 
   class Server
-    def initialize(address,port,store,hostname,ssl_cert_path,ssl_key_path)
+    def initialize(address, port, store, hostname, ssl_cert_path, ssl_key_path, extra_options={})
       @address = address
       @port = port
       @store = store
@@ -526,12 +525,22 @@ module FakeS3
           }
         )
       end
+
+      if extra_options[:quiet]
+        webrick_config.merge!(
+          :Logger => WEBrick::Log.new("/dev/null"),
+          :AccessLog => []
+        )
+      end
+
       @server = WEBrick::HTTPServer.new(webrick_config)
     end
 
     def serve
-      @server.mount "/", Servlet, @store,@hostname
-      trap "INT" do @server.shutdown end
+      @server.mount "/", Servlet, @store, @hostname
+      shutdown = proc { @server.shutdown }
+      trap "INT", &shutdown
+      trap "TERM", &shutdown
       @server.start
     end
 

data/lib/fakes3/version.rb

@@ -1,3 +1,3 @@
 module FakeS3
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/test/aws_sdk_v2_commands_test.rb

@@ -0,0 +1,65 @@
+require 'test/test_helper'
+require 'aws-sdk'
+
+class AwsSdkV2CommandsTest < Test::Unit::TestCase
+  def setup
+    @creds = Aws::Credentials.new('123', 'abc')
+    @s3    = Aws::S3::Client.new(credentials: @creds, region: 'us-east-1', endpoint: 'http://localhost:10453/')
+    @resource = Aws::S3::Resource.new(client: @s3)
+    @bucket = @resource.create_bucket(bucket: 'v2_bucket')
+
+    # Delete all objects to avoid sharing state between tests
+    @bucket.objects.each(&:delete)
+  end
+
+  def test_create_bucket
+    bucket = @resource.create_bucket(bucket: 'v2_create_bucket')
+    assert_not_nil bucket
+
+    bucket_names = @resource.buckets.map(&:name)
+    assert(bucket_names.index("v2_create_bucket") >= 0)
+  end
+
+  def test_destroy_bucket
+    @bucket.delete
+
+    begin
+      @s3.head_bucket(bucket: 'v2_bucket')
+      assert_fail("Shouldn't succeed here")
+    rescue
+    end
+  end
+
+  def test_create_object
+    object = @bucket.object('key')
+    object.put(body: 'test')
+
+    assert_equal 'test', object.get.body.string
+  end
+
+  def test_delete_object
+    object = @bucket.object('exists')
+    object.put(body: 'test')
+
+    assert_equal 'test', object.get.body.string
+
+    object.delete
+
+    assert_raise Aws::S3::Errors::NoSuchKey do
+      object.get
+    end
+  end
+
+  # TODO - get this test working
+  #
+  #def test_copy_object
+  #  object = @bucket.object("key_one")
+  #  object.put(body: 'asdf')
+
+  #  # TODO: explore why 'key1' won't work but 'key_one' will
+  #  object2 = @bucket.object('key_two')
+  #  object2.copy_from(copy_source: 'testing_copy/key_one')
+
+  #  assert_equal 2, @bucket.objects.count
+  #end
+end

data/test/cli_test.rb

@@ -0,0 +1,18 @@
+require 'test/test_helper'
+require 'test/minitest_helper'
+require 'fakes3/cli'
+
+
+class CLITest < Test::Unit::TestCase
+  def setup
+    super
+    FakeS3::Server.any_instance.stubs(:serve)
+  end
+
+  def test_quiet_mode
+    script = FakeS3::CLI.new([], :root => '.', :port => 4567, :quiet => true)
+    assert_output('') do
+      script.invoke(:server)
+    end
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,46 @@
+# LICENSE:
+#
+# (The MIT License)
+#
+# Copyright © Ryan Davis, seattle.rb
+#
+# 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.
+
+# The following is from minitest:
+# TODO - decide whether to switch to minitest or what to do about these:
+
+def capture_io
+  require 'stringio'
+
+  captured_stdout, captured_stderr = StringIO.new, StringIO.new
+
+  orig_stdout, orig_stderr = $stdout, $stderr
+  $stdout, $stderr         = captured_stdout, captured_stderr
+
+  begin
+    yield
+  ensure
+    $stdout = orig_stdout
+    $stderr = orig_stderr
+  end
+
+  return captured_stdout.string, captured_stderr.string
+end
+
+def assert_output stdout = nil, stderr = nil
+  out, err = capture_io do
+    yield
+  end
+
+  err_msg = Regexp === stderr ? :assert_match : :assert_equal if stderr
+  out_msg = Regexp === stdout ? :assert_match : :assert_equal if stdout
+
+  y = send err_msg, stderr, err, "In stderr" if err_msg
+  x = send out_msg, stdout, out, "In stdout" if out_msg
+
+  (!stdout || x) && (!stderr || y)
+end

data/test/right_aws_commands_test.rb

@@ -77,7 +77,7 @@ class RightAWSCommandsTest < Test::Unit::TestCase
     assert_equal ["delimited/"], common_prefixes
 
     common_prefixes = []
-    @s3.incrementally_list_bucket("s3media", {:prefix => "delimited/", :delimiter => '/', "max-keys" => 5}) do |currentResponse|
+    @s3.incrementally_list_bucket("s3media", {:prefix => "delimited/", :delimiter => '/', "max-keys" => 100}) do |currentResponse|
       key_names += currentResponse[:contents].map do |key|
         key[:key]
       end

data/test/s3cmd_test.rb

@@ -24,7 +24,7 @@ class S3CmdTest < Test::Unit::TestCase
       end
     end
     output = `#{@s3cmd} put /tmp/fakes3_upload s3://s3cmd_bucket/upload`
-    assert_match(/stored/,output)
+    assert_match(/upload/,output)
 
     FileUtils.rm("/tmp/fakes3_upload")
   end
@@ -36,7 +36,7 @@ class S3CmdTest < Test::Unit::TestCase
       end
     end
     output = `#{@s3cmd} put /tmp/fakes3_acl_upload s3://s3cmd_bucket/acl_upload`
-    assert_match(/stored/,output)
+    assert_match(/upload/,output)
 
     output = `#{@s3cmd} --force setacl -P s3://s3cmd_bucket/acl_upload`
   end

data/test/test_helper.rb

@@ -1,4 +1,6 @@
 require 'test/unit'
+require 'test/unit/assertions'
+require 'mocha/test_unit'
 require 'rubygems'
 require 'bundler/setup'
 require 'fakes3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fakes3
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Curtis Spencer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-v1
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Use FakeS3 to test basic S3 functionality without actually connecting
+description: Use Fake S3 to test basic S3 functionality without actually connecting
   to S3
 email:
 - thorin@gmail.com
@@ -146,7 +174,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CONTRIBUTING.md
+- DEPLOY_README.md
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -166,9 +197,12 @@ files:
 - lib/fakes3/version.rb
 - lib/fakes3/xml_adapter.rb
 - test/aws_sdk_commands_test.rb
+- test/aws_sdk_v2_commands_test.rb
 - test/boto_test.rb
 - test/botocmd.py
+- test/cli_test.rb
 - test/local_s3_cfg
+- test/minitest_helper.rb
 - test/post_test.rb
 - test/right_aws_commands_test.rb
 - test/s3_commands_test.rb
@@ -194,16 +228,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: fakes3
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: FakeS3 is a server that simulates S3 commands so you can test your S3 functionality
+summary: Fake S3 is a server that simulates S3 commands so you can test your S3 functionality
   in your projects
 test_files:
 - test/aws_sdk_commands_test.rb
+- test/aws_sdk_v2_commands_test.rb
 - test/boto_test.rb
 - test/botocmd.py
+- test/cli_test.rb
 - test/local_s3_cfg
+- test/minitest_helper.rb
 - test/post_test.rb
 - test/right_aws_commands_test.rb
 - test/s3_commands_test.rb