s3io 1.1.1 → 1.1.4

data/.travis.yml

@@ -1,11 +1,13 @@
 language: ruby
 rvm:
   - ree
-  - ruby-head
   - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
   - jruby-18mode # JRuby in 1.8 mode
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-18mode
   - rbx-19mode
+

data/Gemfile

@@ -4,10 +4,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem "rake"
+gem 'nokogiri', '< 1.6' if RUBY_VERSION < '1.9'
 
-group :development do
-  platforms :ruby do
-    gem "yard"
-    gem "redcarpet"
-  end
-end
+gem "test-unit", :group => :test if RUBY_VERSION >= '2.2'

data/README.md

@@ -4,13 +4,13 @@
 
 An IO-compatible wrapper for S3.
 
-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.
+Amazon's official AWS SDK (version 1) 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 (version 1) that makes it possible to access objects stored on S3 as if they were instances of File or StringIO classes.
 
-Currently only reads are supported with writes support coming soon.
+Both streamed reads and writes are supported.
 
 ## 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.
+Reads guarantee consistency if S3 file changes while being streamed, but only if versioning has been enabled for that file. S3io always reads from the same version of the file it read the first chunk from. If a non-versioned file is changed during the read process, an ```S3io::ReadModifiedError``` is thrown. To protect against this, enable versioning for the bucket where file is located. Lifecycle policy can be used to automatically delete older versions based on their age.
 
 ## Installation
 
@@ -62,9 +62,6 @@ It can write:
       io.write 'def'
     end
 
-If the file is being changed during the read process, an ```S3io::ReadModifiedError``` is thrown.
-
-
 ## To do
 
 * Code documentation

data/lib/s3io/read_wrapper.rb

@@ -30,30 +30,30 @@ module S3io
     # Reads data from S3 object.
     #
     # @param [Integer] bytes number of bytes to read
-    def read(bytes = nil)
-      content_length = @s3object.content_length
+    def read(bytes = nil, outbuf = nil)
+      @content_length ||= @s3object.content_length
 
-      return '' if (@pos >= content_length) || (bytes == 0)
+      return '' if (@pos >= @content_length) || (bytes == 0)
 
-      bytes ||= content_length
+      bytes ||= @content_length
 
       upper_bound = @pos + bytes - 1
-      upper_bound = (content_length - 1) if upper_bound >= content_length
+      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
+      data = @s3object.read :range => @pos..upper_bound, :if_unmodified_since => @last_modified
 
       @pos = upper_bound + 1
 
+      outbuf.replace data if outbuf 
+
       return data
+
+    rescue ::AWS::S3::Errors::PreconditionFailed
+      fail ReadModifiedError, "S3 object #{@s3object.key} was updated during read (modified since #{@last_modified.to_s})"
     end
 
     def eof?
-      @pos >= @s3object.content_length
+      (@content_length = @s3object.content_length) && (@pos >= @content_length)
     end
 
     # Rewinds position to the very beginning of S3 object.
@@ -92,5 +92,15 @@ module S3io
     end
     alias lines each
     alias each_line each
+
+    # Returns one string at a time.
+    #
+    # @param [String] separator line separator string
+    def gets(separator = $/)
+      @_gets ||= enum_for(:each, separator)
+      @_gets.next
+    rescue StopIteration
+      nil
+    end
   end
 end

data/lib/s3io/version.rb

@@ -1,3 +1,3 @@
 module S3io
-  VERSION = "1.1.1"
+  VERSION = "1.1.4"
 end

data/s3io.gemspec

@@ -12,10 +12,13 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{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.}
   gem.homepage      = "http://github.com/fiksu/s3io"
 
-  gem.add_dependency('aws-sdk')
+  gem.add_dependency('aws-sdk', "~> 1.64.0")
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+  if RUBY_VERSION >= '2.2'
+    gem.add_development_dependency "test-unit", "~> 3.0.8"
+  end
 end

data/test/test_s3io_read_wrapper.rb

@@ -11,7 +11,10 @@ class S3ObjectReadMock
 
   def read(options = {})
     range = options[:range]
+    if_unmodified_since = options[:if_unmodified_since]
+
     fail "The mock should be called with a :range option" unless range
+    fail AWS::S3::Errors::PreconditionFailed if if_unmodified_since && if_unmodified_since != @last_modified
 
     return @body[range]
   end
@@ -54,6 +57,16 @@ class S3ioReadWrapperTest < Test::Unit::TestCase
     assert_equal(0, wrapper.pos)
   end
 
+  def test_zero_outbuf_read
+    wrapper = S3io::ReadWrapper.new(@s3object)
+    data = String.new
+
+    wrapper.read(0,data)
+
+    assert_equal('', data)
+    assert_equal(0, wrapper.pos)
+  end
+
   def test_partial_read
     wrapper = S3io::ReadWrapper.new(@s3object)
 
@@ -71,6 +84,17 @@ class S3ioReadWrapperTest < Test::Unit::TestCase
     end
   end
 
+  def test_partial_outbuf_read
+    wrapper = S3io::ReadWrapper.new(@s3object)
+    data = String.new
+
+    wrapper.read(100, data)
+    assert_equal(S3_TEST_DATA[0..99], data)
+
+    wrapper.read(1, data)
+    assert_equal(S3_TEST_DATA[100..100], data)
+  end
+
   def test_each
     wrapper = S3io::ReadWrapper.new(@s3object)
 
@@ -166,4 +190,15 @@ class S3ioReadWrapperTest < Test::Unit::TestCase
 
     assert_equal('', wrapper.read)
   end
+
+  def test_gets
+    wrapper = S3io::ReadWrapper.new(@s3object)
+
+    lines = []
+    while line = wrapper.gets
+      lines << line
+    end
+
+    assert_equal(S3_TEST_DATA.lines.to_a, lines)
+  end
 end

metadata

@@ -1,36 +1,48 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: s3io
-version: !ruby/object:Gem::Version
-  version: 1.1.1
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 1
+  - 1
+  - 4
+  version: 1.1.4
 platform: ruby
-authors:
+authors: 
 - Arthur Pirogovski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2015-06-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: aws-sdk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 279
+        segments: 
+        - 1
+        - 64
+        - 0
+        version: 1.64.0
+  type: :runtime
+  version_requirements: *id001
 description: An IO-compatible wrapper for S3
-email:
+email: 
 - arthur@flyingtealeaf.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -48,32 +60,38 @@ 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
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+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"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.24
 signing_key: 
-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:
+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: 
 - test/s3_test_data.csv
 - test/test_s3io_read_wrapper.rb
 - test/test_s3io_write_wrapper.rb
-has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 7a2e6b77b5d02864c35705178a360b3fe22e5708
-  data.tar.gz: cfae25b66b0488f008dbbde0cba612a07bb1a31c
-SHA512:
-  metadata.gz: e9f64f80951bf058fbd12458f5a0f6e4c39a019d683e486df5ac80a55f3d3abb26f24de04f059a68726e2bf64bf08f788bee40ddba8a3cab1161cf474ab4e569
-  data.tar.gz: ff4cdd6ed29cba34834fc571df4c01d979910fd62effc8162872cdcc4456b32921d4b1a9db710ca5b140b0b0cdd638af722199da0e5260c4db4e38ce75566d4b