blobby-s3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb92e09ebb4fb6aa87581485a6fb49e926f97746
+  data.tar.gz: 426467d4d7cde0580260e569132c728fff71eea0
+SHA512:
+  metadata.gz: 0c2519c24da67688afb17718f8c9b1b49a4d3bd8be9d50592fab3e79e0f1e9a1e46561bbd3ba9d1c413a60a279b43abe843a8a18a5360453281ba86ae64cfc91
+  data.tar.gz: abaf0b989d2a9ffa8e143fe3b6ac3a9c2898a8a74a5104d50d0bd602f670bddde6fcc7fa9254a33b4028b8f586dd2dc3b7becc5e8bb9daa9d1f973d1ad2a46a3

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rbenv-*
+.ruby-version
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,47 @@
+Eval:
+  Exclude:
+    - "Rakefile"
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+  Exclude:
+    - "spec/**/*"
+
+Style/Documentation:
+  Exclude:
+    - "spec/**/*"
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/Encoding:
+  EnforcedStyle: when_needed
+  Enabled: true
+
+Style/FileName:
+  Exclude:
+    - "bin/*"
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/WordArray:
+  Enabled: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,15 @@
+# Blobby::S3Store
+
+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["key"].write("something big")
+
+Credentials can be provided, if required:
+
+    credentials = { :access_key_id => "KEY, :secret_access_key => "SECRET" }
+    s3_store = Blobby::S3Store.new("mybucket", credentials)
+
+If none are specified, we'll look for them in [the normal places](https://blogs.aws.amazon.com/security/post/Tx3D6U6WSFGOK2H/A-New-and-Standardized-Way-to-Manage-Credentials-in-the-AWS-SDKs).

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+
+require "bundler"
+
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+task "default" => "spec"

data/blobby-s3.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+
+  gem.authors       = ["Mike Williams"]
+  gem.email         = ["mdub@dogbiscuit.org"]
+  gem.summary       = "Store BLOBs in S3"
+  gem.homepage      = "https://github.com/realestate-com.au/blobby-s3"
+
+  gem.name          = "blobby-s3"
+  gem.version       = "1.0.0"
+
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  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"]
+
+  gem.add_runtime_dependency("aws-sdk-resources", "~> 2.1")
+  gem.add_runtime_dependency("blobby")
+
+end

data/lib/blobby/s3_store.rb

@@ -0,0 +1,113 @@
+require "aws-sdk-resources"
+require "blobby/key_constraint"
+
+module Blobby
+
+  # A BLOB store backed by an S3 bucket.
+  #
+  class S3Store
+
+    # Create a new instance.
+    #
+    # bucket_name  - name of the bucket to store things in
+    # s3_options   - options passed to AWS::S3.new
+    #
+    def initialize(bucket_name, s3_options = {})
+      @bucket_name = bucket_name.to_str
+      @s3_options = s3_options.dup
+      @s3_options[:endpoint] = s3_endpoint_for_bucket
+    end
+
+    attr_reader :bucket_name
+    attr_reader :s3_options
+
+    def available?
+      bucket.objects.first
+      true
+    rescue ::Aws::Errors::ServiceError
+      false
+    end
+
+    def [](key)
+      KeyConstraint.must_allow!(key)
+      StoredObject.new(bucket.object(key))
+    end
+
+    class StoredObject
+
+      def initialize(s3_object)
+        @s3_object = s3_object
+      end
+
+      def exists?
+        s3_object.exists?
+      end
+
+      def read
+        body = s3_object.get.body
+        if block_given?
+          body.each_line do |line|
+            yield force_binary(line)
+          end
+          nil
+        else
+          force_binary(body.read)
+        end
+      rescue Aws::S3::Errors::NoSuchKey
+        nil
+      end
+
+      def write(payload)
+        s3_object.put(:body => force_binary(payload))
+        nil
+      end
+
+      def delete
+        return false unless s3_object.exists?
+        s3_object.delete
+        true
+      end
+
+      private
+
+      attr_reader :s3_object
+
+      def force_binary(s)
+        return s unless s.respond_to?(:encoding)
+        return s if s.encoding.name == "ASCII-8BIT"
+        s.dup.force_encoding("ASCII-8BIT")
+      end
+
+    end
+
+    private
+
+    def s3_client
+      ::Aws::S3::Client.new(s3_options)
+    end
+
+    def s3_endpoint_for_bucket
+      location = s3_client.get_bucket_location(:bucket => bucket_name).location_constraint
+      case location
+      when ""
+        "https://s3.amazonaws.com"
+      when "EU"
+        "https://s3-eu-west-1.amazonaws.com"
+      else
+        "https://s3-#{location}.amazonaws.com"
+      end
+    rescue ::Aws::Errors::ServiceError
+      "https://s3.amazonaws.com"
+    end
+
+    def s3_resource
+      ::Aws::S3::Resource.new(s3_options)
+    end
+
+    def bucket
+      s3_resource.bucket(bucket_name)
+    end
+
+  end
+
+end

data/spec/blobby/s3_store_spec.rb

@@ -0,0 +1,96 @@
+require "aws-sdk-resources"
+require "blobby/s3_store"
+
+# Load the abstract "Store" tests from "blobby".
+# This depends on the gem being packaged with "spec" dir intact.
+$LOAD_PATH << Gem.loaded_specs["blobby"].full_gem_path + "/spec"
+
+require "blobby/store_behaviour"
+
+describe Blobby::S3Store, :integration => true do
+
+  before(:all) do
+    unless ENV.key?("AWS_ACCESS_KEY_ID")
+      fail "No AWS credentials provided"
+    end
+  end
+
+  context "with a writable bucket" do
+
+    EXISTING_BUCKET_NAME = "fake-aws-sdk-s3-test"
+
+    let(:s3_resource) { Aws::S3::Resource.new(:region => "us-east-1")}
+    let(:bucket) { s3_resource.bucket(EXISTING_BUCKET_NAME) }
+
+    before do
+      bucket.clear!
+    end
+
+    subject do
+      described_class.new(EXISTING_BUCKET_NAME)
+    end
+
+    it_behaves_like Blobby::Store
+
+    describe "#write" do
+
+      let(:key) { "data/file" }
+      let(:content) { "CONTENT" }
+
+      before do
+        subject[key].write(content)
+      end
+
+      it "stores stuff in S3" do
+        expect(bucket.object(key).get.body.read).to eq(content)
+      end
+
+    end
+
+    describe "#delete" do
+
+      let(:key) { "my_key" }
+
+      before do
+        subject[key].write("content")
+        subject[key].delete
+      end
+
+      it "removes stuff from S3" do
+        expect(bucket.object(key)).to_not exist
+      end
+
+    end
+
+  end
+
+  context "when we can't talk to S3" do
+
+    let(:bogus_credentials) do
+      {
+        :access_key_id => "bogus",
+        :secret_access_key => "bogus"
+      }
+    end
+
+    subject do
+      described_class.new(EXISTING_BUCKET_NAME, bogus_credentials)
+    end
+
+    it { is_expected.not_to be_available }
+
+  end
+
+  context "when the bucket does not exist" do
+
+    BOGUS_BUCKET_NAME = "bogusmcbogusness"
+
+    subject do
+      described_class.new(BOGUS_BUCKET_NAME)
+    end
+
+    it { is_expected.not_to be_available }
+
+  end
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: blobby-s3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: blobby
+  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'
+description: 
+email:
+- mdub@dogbiscuit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- blobby-s3.gemspec
+- lib/blobby/s3_store.rb
+- spec/blobby/s3_store_spec.rb
+homepage: https://github.com/realestate-com.au/blobby-s3
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Store BLOBs in S3
+test_files:
+- spec/blobby/s3_store_spec.rb