open-uri-s3 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc0dd3714641f331f462c21387f42a732b47dd5b
-  data.tar.gz: 7fabe9b95c0425915d13aaba93f65b60eab76297
+  metadata.gz: eae0d4c08066f1be7dd933722005605ef95719c8
+  data.tar.gz: ae125e095656d6d966bcbcabba34da7302d3dfc1
 SHA512:
-  metadata.gz: e4f73d9f4c799bb8e89d6a209f905e030b3f642ffa7b98ce65fa4f6c4b57e7a0aa58a992254b79f364e9cf223ccfcabc6eefc7c8ab2af22296b855e18d512647
-  data.tar.gz: 17b55cc57754912f189687d0d9306c5afe35ed3b06d48e10aab278e3eb78b5ad8dce167abe76daeb477ed83ddbc0cfcc575b07656f3fcf21299ce628c4b54573
+  metadata.gz: 44689a66321b6b5b09e2bc3e782c0a04115862bc1299732dd91bbd2e40e95a1a7acae216351001663abd1788d621da3e0f7aba3c8b6f2b07cae243da22f3e28f
+  data.tar.gz: fe9a45ffc34f80734d388374d9c9bc8c5b6d75a99746d20620e46d15f3502e06d0d780c77ba3e144a8d416b6da621ba74ccb985e38e2a9f2f829a486c3e79fea

data/.rspec

@@ -1 +1,2 @@
 --color
+--format documentation

data/Gemfile

@@ -2,12 +2,12 @@ source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:
 #   gem "activesupport", ">= 2.3.5"
-gem 'aws-sdk'
+gem 'aws-sdk-v1'
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.8.0"
+  gem "rspec", "~> 3.2.0"
   gem "yard", "~> 0.7"
   gem "rdoc", "~> 3.12"
   gem "bundler", "~> 1.0"

data/README.md

@@ -12,6 +12,12 @@ Reading objects:
 open('s3://my.bucket/public/hello') # returns AWS::S3::S3Object (quacks like IO)
 ```
 
+or a safer option (see [this post][open-uri-dangers] on the dangers of using open-uri with user input)
+
+```ruby
+URI('s3://my.bucket/public/hello').read
+```
+
 Writing objects:
 
 ```ruby
@@ -19,7 +25,7 @@ open('s3://my.bucket/public/hello', 'w'){|f| f.write 'Hello world!'}
 ```
 
 ## Contributing to open-uri-s3
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -32,3 +38,6 @@ open('s3://my.bucket/public/hello', 'w'){|f| f.write 'Hello world!'}
 
 Copyright (c) 2013 Erik Terpstra. See LICENSE.txt for
 further details.
+
+[![open-uri-s3 API Documentation](https://dqvhmzwrjy66y.cloudfront.net/assets/badge-d08eb706b0adfe1d16fe2ca9c1e49cbc.png)](https://www.omniref.com/ruby/gems/open-uri-s3)
+[open-uri-dangers]: http://sakurity.com/blog/2015/02/28/openuri.html

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.1.0

data/lib/open-uri-s3.rb

@@ -1,15 +1,16 @@
-require 'aws-sdk'
+require 'aws-sdk-v1'
 require 'open-uri'
 require 'uri'
 
 module URI
   class S3 < Generic
+
     # @return [AWS::S3::S3Object] S3 object (quacks like IO)
     def open(*args)
-      s3 = AWS::S3.new
+      s3 = ::AWS::S3.new
       bucket = s3.buckets[self.hostname]
       if bucket.location_constraint
-        s3 = AWS::S3.new(s3_endpoint: "s3-#{bucket.location_constraint}.amazonaws.com")
+        s3 = ::AWS::S3.new(s3_endpoint: "s3-#{bucket.location_constraint}.amazonaws.com")
         bucket = s3.buckets[self.hostname]
       end
 
@@ -22,6 +23,10 @@ module URI
 
       object
     end
+
+    def read
+      open(to_s).read
+    end
   end
 
   @@schemes['S3'] = S3

data/open-uri-s3.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "open-uri-s3"
-  s.version = "1.0.3"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Erik Terpstra"]
-  s.date = "2013-11-28"
+  s.date = "2015-03-06"
   s.description = "AWS S3 protocol support for open-uri"
   s.email = "erterpstra@gmail.com"
   s.extra_rdoc_files = [
@@ -26,36 +26,35 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/open-uri-s3.rb",
     "open-uri-s3.gemspec",
-    "spec/open-uri-s3_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/lib/open-uri-s3_spec.rb"
   ]
   s.homepage = "http://github.com/eterps/open-uri-s3"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.3"
+  s.rubygems_version = "2.0.14"
   s.summary = "AWS S3 protocol support for open-uri"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<aws-sdk>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_runtime_dependency(%q<aws-sdk-v1>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.2.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.7"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.8"])
     else
-      s.add_dependency(%q<aws-sdk>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<aws-sdk-v1>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 3.2.0"])
       s.add_dependency(%q<yard>, ["~> 0.7"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.8"])
     end
   else
-    s.add_dependency(%q<aws-sdk>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<aws-sdk-v1>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 3.2.0"])
     s.add_dependency(%q<yard>, ["~> 0.7"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])

data/spec/lib/open-uri-s3_spec.rb

@@ -0,0 +1,21 @@
+require 'open-uri-s3'
+
+describe URI::S3 do
+
+  let(:uri) { 's3://some-bucket/key/to/object'}
+  let(:s3) { instance_double('S3', buckets: buckets) }
+  let(:buckets) { {'some-bucket' => bucket} }
+  let(:bucket) { double("bucket", objects: objects, location_constraint: false) }
+  let(:objects) { {'key/to/object' => object} }
+  let(:object) { double('object', read: 'contents') }
+
+  before do
+    allow(AWS::S3).to receive(:new).and_return(s3)
+  end
+
+  describe "#read" do
+    it "reads the object" do
+      expect(URI(uri).read).to eq 'contents'
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: open-uri-s3
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Erik Terpstra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2015-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: aws-sdk-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 3.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -111,8 +111,7 @@ files:
 - VERSION
 - lib/open-uri-s3.rb
 - open-uri-s3.gemspec
-- spec/open-uri-s3_spec.rb
-- spec/spec_helper.rb
+- spec/lib/open-uri-s3_spec.rb
 homepage: http://github.com/eterps/open-uri-s3
 licenses:
 - MIT
@@ -133,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: AWS S3 protocol support for open-uri

data/spec/open-uri-s3_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "OpenUriS3" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end

data/spec/spec_helper.rb

@@ -1,12 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require 'open-uri-s3'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-  
-end