s3io 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2ed2b4f30861a161e94ff64ee61e23e71f3419f
+  data.tar.gz: 782818fa50a6db024608171736737493af18ecd2
+SHA512:
+  metadata.gz: f83f11bca34e75b13948011bd474d909dd391837072cc8b79af2b3b81e7fa5d30cf69542d54b5dc6f37acb843b4400a3a5c919765ef7727b2b85dd8a8eba7903
+  data.tar.gz: 29be4366b52738672e4455eb67a79eadd5f341482e364102fbd0372878d138b5303ba651a92df790d38eefda66d5bf858a29ec0cd26888863dbb9188af2997b4

data/README.md

@@ -8,6 +8,10 @@ Amazon's official AWS SDK provides an API for S3 that isn't compatible with Ruby
 
 Currently only reads are supported with writes support coming soon.
 
+## Warning
+
+Reads currently don't guarantee consistency if S3 file changes while being streamed. I plan to solve this, but meanwhile please keep in mind that you may read garbage if you replace S3 file while streaming it.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -61,6 +65,7 @@ It can write:
 ## To do
 
 * Code documentation
+* Fix an issue where S3 file that is updated while read streaming happens may result in garbage being read
 
 ## Contributing
 

data/lib/s3io/read_wrapper.rb

@@ -4,6 +4,10 @@ module S3io
     open(s3object, 'r', options, &block)
   end
 
+  # This error indicates that the object was modified between being opened
+  # and being read.
+  class ReadModifiedError < IOError; end
+
   class ReadWrapper < Wrapper
 
     # Default buffer size for line parser in bytes
@@ -20,6 +24,7 @@ module S3io
       @options = {
         :line_buffer_size => (options[:line_buffer_size] || LINE_BUFFER_SIZE)
       }
+      @last_modified = @s3object.last_modified
     end
 
     # Reads data from S3 object.
@@ -36,6 +41,12 @@ module S3io
       upper_bound = (content_length - 1) if upper_bound >= content_length
 
       data = @s3object.read :range => @pos..upper_bound
+
+      last_modified = @s3object.last_modified
+      unless last_modified == @last_modified
+        fail ReadModifiedError, "S3 object #{@s3object.key} was updated during read, last_modified=#{last_modified.to_s} (was #{@last_modified.to_s})"
+      end
+
       @pos = upper_bound + 1
 
       return data
@@ -81,6 +92,5 @@ module S3io
     end
     alias lines each
     alias each_line each
-
   end
 end

data/lib/s3io/version.rb

@@ -1,3 +1,3 @@
 module S3io
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/test_s3io_read_wrapper.rb

@@ -6,6 +6,7 @@ require 'stringio'
 class S3ObjectReadMock
   def initialize(body = '')
     @body = body
+    @last_modified = Time.now
   end
 
   def read(options = {})
@@ -18,6 +19,19 @@ class S3ObjectReadMock
   def content_length
     @body.size
   end
+
+  def last_modified
+    @last_modified
+  end
+
+  def key
+    'test/file/name'
+  end
+
+  def change_last_modified
+    @last_modified = @last_modified + 1
+  end
+
 end
 
 class S3ioReadWrapperTest < Test::Unit::TestCase
@@ -47,6 +61,16 @@ class S3ioReadWrapperTest < Test::Unit::TestCase
     assert_equal(S3_TEST_DATA[100..100], wrapper.read(1))
   end
 
+  def test_last_modified_check
+    wrapper = S3io::ReadWrapper.new(@s3object)
+
+    wrapper.read(100)
+    @s3object.change_last_modified
+    assert_raise S3io::ReadModifiedError do
+      wrapper.read(1)
+    end
+  end
+
   def test_each
     wrapper = S3io::ReadWrapper.new(@s3object)
 

metadata

@@ -1,46 +1,36 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: s3io
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Arthur Pirogovski
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: aws-sdk
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An IO-compatible wrapper for S3
-email: 
+email:
 - arthur@flyingtealeaf.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -58,38 +48,31 @@ files:
 - test/test_s3io_write_wrapper.rb
 homepage: http://github.com/fiksu/s3io
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+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: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: Amazon's official AWS SDK provides an API for S3 that isn't compatible with Ruby's standard IO class and its derivatives. This gem provides a thin wrapper around AWS SDK that makes it possible to access objects stored on S3 as if they were instances of File or StringIO classes.
-test_files: 
+specification_version: 4
+summary: Amazon's official AWS SDK provides an API for S3 that isn't compatible with
+  Ruby's standard IO class and its derivatives. This gem provides a thin wrapper around
+  AWS SDK that makes it possible to access objects stored on S3 as if they were instances
+  of File or StringIO classes.
+test_files:
 - test/s3_test_data.csv
 - test/test_s3io_read_wrapper.rb
 - test/test_s3io_write_wrapper.rb