blobby-s3 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb92e09ebb4fb6aa87581485a6fb49e926f97746
-  data.tar.gz: 426467d4d7cde0580260e569132c728fff71eea0
+  metadata.gz: 815ee79119fea852e7da5b17a52a0da336e0be7d
+  data.tar.gz: 8e1817e54d7ac8c92e7fe752e14cb1ffb11fdb88
 SHA512:
-  metadata.gz: 0c2519c24da67688afb17718f8c9b1b49a4d3bd8be9d50592fab3e79e0f1e9a1e46561bbd3ba9d1c413a60a279b43abe843a8a18a5360453281ba86ae64cfc91
-  data.tar.gz: abaf0b989d2a9ffa8e143fe3b6ac3a9c2898a8a74a5104d50d0bd602f670bddde6fcc7fa9254a33b4028b8f586dd2dc3b7becc5e8bb9daa9d1f973d1ad2a46a3
+  metadata.gz: 43ba0af1954d399a279969035cfc8480f998cd74e74cd71125cacdfe131e929113d16ff2516cb073abe39603a0d3fefc03f65549e7d676c64bb37ec0a7f216ad
+  data.tar.gz: 4504c6c2ba203320779a0374088c3dd00544a7ea73bdea31fa84d874b93ac548a7142112cd5423d3da4db1a3a547d08be72a6ef669f91d9238ecb7164bb49492

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.2.2
+env:
+  global:
+    - AWS_DEFAULT_REGION=us-east-1
+    - BLOBBY_S3_TEST_BUCKET=fake-aws-sdk-s3-test
+    - AWS_ACCESS_KEY_ID=AKIAJ6LW4DFV3RH4Z6OQ
+    - secure: RozEwNe8txMO8jqo/hFWnusfiUSpvz2yN6bDe1G/8bW3pOmjYT319qL5jAIHBxQFohHpUsJMxwsjS07yNq1rlBDuiDJsNnZW6RGzOuVTztaxgjeauo8X4vV3PkZU6Ln0qoYPQiCsIwQfczBpno2Eor0E1BuOXcZGtHsFoQQxWiBG9RkCelGx+ZeMuP/v8EuV4Fd5YOJgzTqWGuaFXEONqeeTVmUoObltJnPCcdpYMzI/+Wn2/dU2gnpRxTJHGrgmVKRWn/M0I7aIEQ9FeJuPVahcdkCPHfzoceTySdl/YVMcjsu6PsHPAQywo6qo4MShV/VI0cUw6hWOf9X9tzdZamyKnaeY1EaIw0C/sZ2dn7dsbRzIn9ls+mI2y32khMX/AG8hze2udKhq3Ai1gREYjo0vvU6q/i2DAoDETaP/Ig3qJshzz1XntBx9NAGkzad3xbkRB9p/e60pfB9E4ZxZG+OSkUi7AGu68ZlI2ceSus46QkG6ya9FNUnJTQEuaUvrg7EASiuKBjQia8Ce9GwzujAxZWVRwWDjvTg3Wo5oGxfVmHWEleVVTFtuuvkroChyetgr/1iLXOigvssHRYFPlDhWKH/bJ9gjyYequEJxoBREwW/Qe3u4kCGgR0vz0CWcVP9RRejTm4RDUpmcreun423WTmq5UWmb9Pj5Fd1f3wM=

data/CHANGES.md

@@ -0,0 +1,8 @@
+## 1.1.0 (2016-05-22)
+
+* Add support for streaming reads.
+* Implement `Blobby.store("s3://bucket/prefix")`
+
+## 1.0.0 (2015-10-02)
+
+* Initial release.

data/Gemfile

@@ -3,6 +3,5 @@ source "https://rubygems.org"
 # Runtime dependencies in *.gemspec
 gemspec
 
-gem "blobby", :path => "../blobby"
 gem "rake"
 gem "rspec", "~> 3.1"

data/README.md

@@ -1,10 +1,12 @@
 # Blobby::S3Store
 
+[![Build Status](https://travis-ci.org/realestate-com-au/blobby-s3.svg?branch=master)](https://travis-ci.org/realestate-com-au/blobby-s3)
+
 This gem provides an S3-based implementation of the "store" interface defined by the ["blobby"](https://github.com/realestate-com-au/blobby) gem.  It's been packaged separately, to avoid adding dependencies to the core gem.
 
 The simplest use-case is writing to a single bucket:
 
-    s3_store = Blobby::S3Store.new("mybucket")
+    s3_store = Blobby.store("s3://mybucket")
     s3_store["key"].write("something big")
 
 Credentials can be provided, if required:

data/Rakefile

@@ -6,4 +6,6 @@ Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
+
 task "default" => "spec"

data/blobby-s3.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/realestate-com.au/blobby-s3"
 
   gem.name          = "blobby-s3"
-  gem.version       = "1.0.0"
+  gem.version       = "1.1.0"
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency("aws-sdk-resources", "~> 2.1")
-  gem.add_runtime_dependency("blobby")
+  gem.add_runtime_dependency("blobby", "~> 1.1.0")
 
 end

data/lib/blobby-s3.rb

@@ -0,0 +1 @@
+require "blobby/s3_store"

data/lib/blobby/s3_store.rb

@@ -1,5 +1,7 @@
 require "aws-sdk-resources"
-require "blobby/key_constraint"
+require "blobby"
+require "blobby/key_transforming_store"
+require "uri"
 
 module Blobby
 
@@ -7,6 +9,19 @@ module Blobby
   #
   class S3Store
 
+    def self.from_uri(uri)
+      uri = URI(uri)
+      raise ArgumentError, "invalid S3 address: #{uri}" unless uri.scheme == "s3"
+      bucket_name = uri.host
+      prefix = uri.path.sub(%r{\A/}, "").sub(%r{/\Z}, "")
+      raise ArgumentError, "no bucket specified" if bucket_name.nil?
+      store = new(bucket_name)
+      unless prefix.empty?
+        store = KeyTransformingStore.new(store) { |key| prefix + "/" + key }
+      end
+      store
+    end
+
     # Create a new instance.
     #
     # bucket_name  - name of the bucket to store things in
@@ -44,14 +59,13 @@ module Blobby
       end
 
       def read
-        body = s3_object.get.body
         if block_given?
-          body.each_line do |line|
-            yield force_binary(line)
+          s3_object.get do |chunk|
+            yield force_binary(chunk)
           end
           nil
         else
-          force_binary(body.read)
+          force_binary(s3_object.get.body.read)
         end
       rescue Aws::S3::Errors::NoSuchKey
         nil
@@ -110,4 +124,6 @@ module Blobby
 
   end
 
+  register_store_factory "s3", S3Store
+
 end

data/spec/blobby/s3_store_spec.rb

@@ -7,6 +7,62 @@ $LOAD_PATH << Gem.loaded_specs["blobby"].full_gem_path + "/spec"
 
 require "blobby/store_behaviour"
 
+describe Blobby::S3Store do
+
+  describe ".from_uri" do
+
+    context "with s3://bucket" do
+
+      let(:store) { described_class.from_uri("s3://bucket") }
+
+      it "creates an S3Store" do
+        expect(store).to be_a(described_class)
+      end
+
+      it "maps objects to the specified bucket" do
+        expect(store["object"].send(:s3_object).bucket.name).to eql("bucket")
+      end
+
+      it "maps objects with the specified names" do
+        expect(store["object"].send(:s3_object).key).to eql("object")
+      end
+
+    end
+
+    context "with s3://bucket/prefix/" do
+
+      let(:store) { described_class.from_uri("s3://bucket/prefix/") }
+
+      it "maps objects with the specified prefix" do
+        expect(store["object"].send(:s3_object).key).to eql("prefix/object")
+      end
+
+    end
+
+    context "with non-S3 uri" do
+
+      it "raises ArgumentError" do
+        expect {
+          described_class.from_uri("http://bucket")
+        }.to raise_error(ArgumentError)
+      end
+
+    end
+
+    context "without a bucket" do
+
+      it "raises ArgumentError" do
+        expect {
+          described_class.from_uri("s3://")
+        }.to raise_error(ArgumentError)
+      end
+
+    end
+
+  end
+
+end
+
 describe Blobby::S3Store, :integration => true do
 
   before(:all) do
@@ -17,7 +73,7 @@ describe Blobby::S3Store, :integration => true do
 
   context "with a writable bucket" do
 
-    EXISTING_BUCKET_NAME = "fake-aws-sdk-s3-test"
+    EXISTING_BUCKET_NAME = ENV.fetch("BLOBBY_S3_TEST_BUCKET", "fake-aws-sdk-s3-test")
 
     let(:s3_resource) { Aws::S3::Resource.new(:region => "us-east-1")}
     let(:bucket) { s3_resource.bucket(EXISTING_BUCKET_NAME) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blobby-s3
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-resources
@@ -28,16 +28,16 @@ dependencies:
   name: blobby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
 description: 
 email:
 - mdub@dogbiscuit.org
@@ -48,10 +48,13 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
+- CHANGES.md
 - Gemfile
 - README.md
 - Rakefile
 - blobby-s3.gemspec
+- lib/blobby-s3.rb
 - lib/blobby/s3_store.rb
 - spec/blobby/s3_store_spec.rb
 homepage: https://github.com/realestate-com.au/blobby-s3
@@ -73,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Store BLOBs in S3