blobby 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfbc91822c372d6508fd42ac40e333e6b1bb3a22
-  data.tar.gz: 2ced865cbd5b4ba8ca886bbcccd9259b48be8c32
+  metadata.gz: 0910a3f2446d9f9eb7cad9f724c8df57cc5d85ac
+  data.tar.gz: 2c26dc843a4a15c5894209b590f5b4d01078af14
 SHA512:
-  metadata.gz: c7f1eab54fa6f82f9b201b387fe4f7424dd2b4b6148aae03b786fe062ddbb169e38e1e84f05ad07d88f10469ff242629d85e2b06032c3d193da7a921c95192e0
-  data.tar.gz: 410875dc9fb89abfa8172f762c10f5add5a610de9b3868223675621938e21522ab77ce167d23633e504c32f486f653c252a7fca45d3cf084f34b782e2af3c4ca
+  metadata.gz: 9c49f221a912ebbc99a8fadfa2e3643d98c004c1e040e0c0a87368a69c6050bd7a2581ce6824841a91343a8ec67ef8f915a91f16c28a97d5f8830d4d51661304
+  data.tar.gz: 86eeb3dd9fdfecd3864dc92d16ef087c38947cec898be4cdc5e02483b86eb6e108a0227121fafb40d1206126f9e10fe5d733c59a37c9bbe794e394081a1378ed

data/.rubocop.yml

@@ -1,6 +1,7 @@
 Eval:
   Exclude:
     - "Rakefile"
+    - "**/version.rb"
 
 Metrics/AbcSize:
   Enabled: false
@@ -40,8 +41,14 @@ Style/FileName:
 Style/HashSyntax:
   EnforcedStyle: hash_rockets
 
+Style/SignalException:
+  EnforcedStyle: semantic
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/RegexpLiteral:
+  Enabled: false
+
 Style/WordArray:
   Enabled: false

data/CHANGES.md

@@ -0,0 +1,7 @@
+## 1.1.0 (2016-05-22)
+
+* Add `Blobby.store` factory-method.
+
+## 1.0.0 (2015-06-15)
+
+* Initial release.

data/README.md

@@ -39,5 +39,16 @@ This gem provides several "store" implementations:
 
 Other gems provide additional implementations:
 
-    # gem "blobby-s3"
-    Blobby::S3Store.new("mybucket")
+  * ["blobby-s3"](https://github.com/realestate-com-au/blobby-s3)
+
+`Blobby.store` provides a convenient way to construct an appropriate
+implementation, given a URI (or psuedo-URI):
+
+    Blobby.store("file:///tmp")
+    # => #<Blobby::FilesystemStore ...>
+
+    Blobby.store("mem:")
+    # => #<Blobby::InMemoryStore ...>
+
+    Blobby.store("http://storage.com/mystuff/")
+    # => #<Blobby::HttpStore ...>

data/blobby.gemspec

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 $LOAD_PATH << File.expand_path("../lib", __FILE__)
 require "blobby/version"
 

data/lib/blobby.rb

@@ -0,0 +1,45 @@
+require "blobby/filesystem_store"
+require "blobby/http_store"
+require "blobby/in_memory_store"
+require "blobby/version"
+require "uri"
+
+# BLOB storage.
+#
+module Blobby
+
+  class << self
+
+    # Instantiate a BLOB-store based on a storage-address URI.
+    # An appropriate store impementation will be selected, based on
+    # URI-scheme.
+    #
+    # @param uri [URI] storage address
+    #
+    def store(uri)
+      uri = URI(uri)
+      factory = store_factories[uri.scheme]
+      fail ArgumentError, "unknown store type: #{uri}" if factory.nil?
+      factory.from_uri(uri)
+    end
+
+    def register_store_factory(uri_scheme, factory)
+      store_factories[uri_scheme] = factory
+    end
+
+    private
+
+    def store_factories
+      @store_factories ||= {}
+    end
+
+  end
+
+  register_store_factory nil, FilesystemStore
+  register_store_factory "file", FilesystemStore
+  register_store_factory "http", HttpStore
+  register_store_factory "https", HttpStore
+  register_store_factory "in-memory", InMemoryStore
+  register_store_factory "mem", InMemoryStore
+
+end

data/lib/blobby/abstract_store.rb

@@ -0,0 +1,69 @@
+require "blobby/key_constraint"
+
+module Blobby
+
+  # A store of BLOBs.
+  # @abstract
+  class AbstractStore
+
+    # @return true if the store is available for use
+    def available?
+      true
+    end
+
+    # Access an object in the store.
+    # @param key [String] object address
+    # @return [StoredObject] a handle to the addressed object
+    def [](key)
+      KeyConstraint.must_allow!(key)
+      StoredObject.new
+    end
+
+    # A handle to an object in the BLOB-store.
+    # @abstract
+    class StoredObject
+
+      # Check for existence.
+      # @return true if the object exists
+      def exists?
+        false
+      end
+
+      # @overload read
+      #   Read BLOB data.
+      #   @return [String] data if the object exists
+      #   @return [nil] if the object doesn't exist
+      # @overload read
+      #   Stream BLOB data in chunks.
+      #   @yield [chunk] each chunk of data
+      #   @return [void]
+      def read
+        content = @hash[key]
+        if block_given?
+          yield content
+          nil
+        else
+          content
+        end
+      end
+
+      def write(content)
+        if content.respond_to?(:read)
+          content = content.read
+        else
+          content = content.to_str.dup
+        end
+        content = content.force_encoding("BINARY") if content.respond_to?(:force_encoding)
+        @hash[key] = content
+        nil
+      end
+
+      def delete
+        !@hash.delete(key).nil?
+      end
+
+    end
+
+  end
+
+end

data/lib/blobby/fake_success_store.rb

@@ -25,7 +25,7 @@ module Blobby
         image_path = Pathname(File.dirname(__FILE__)) + "placeholder.png"
         image_path.open("rb") do |io|
           if block_given?
-            while chunk = io.read(512)
+            while (chunk = io.read(512))
               yield chunk
             end
             nil

data/lib/blobby/filesystem_store.rb

@@ -10,6 +10,10 @@ module Blobby
   #
   class FilesystemStore
 
+    def self.from_uri(uri)
+      new(uri.path)
+    end
+
     def initialize(dir, options = {}, &sharding_strategy)
       @dir = Pathname(dir)
       @umask = options[:umask] || File.umask
@@ -23,6 +27,7 @@ module Blobby
       dir.directory? && dir.readable? && dir.writable?
     end
 
+    # (see AbstractStore#[])
     def [](key)
       KeyConstraint.must_allow!(key)
       relative_path = @sharding_strategy.call(key)
@@ -49,7 +54,7 @@ module Blobby
       def read
         @path.open("rb") do |io|
           if block_given?
-            while chunk = io.read(512)
+            while (chunk = io.read(512))
               yield chunk
             end
             nil
@@ -73,7 +78,8 @@ module Blobby
       end
 
       def delete
-        !!FileUtils.rm(@path)
+        FileUtils.rm(@path)
+        true
       rescue Errno::ENOENT
         false
       end
@@ -91,7 +97,7 @@ module Blobby
       RAND_MAX = ("F" * 10).to_i(16)
 
       def tmp_name
-        sprintf("tmp-%X", rand(RAND_MAX))
+        format("tmp-%X", rand(RAND_MAX))
       end
 
       def atomic_create(store_path)
@@ -102,7 +108,7 @@ module Blobby
         begin
           tmp = tmp_path.open(File::CREAT | File::EXCL | File::WRONLY, 0666)
           tmp.binmode
-        rescue Errno::ENOENT => e
+        rescue Errno::ENOENT
           FileUtils.mkdir_p(store_dir.to_s, :mode => apply_umask(0777))
           retry
         end
@@ -117,7 +123,7 @@ module Blobby
         first_try = true
         begin
           tmp_path.rename(store_path)
-        rescue Errno::ESTALE => e
+        rescue Errno::ESTALE
           raise unless first_try
           first_try = false
           now = Time.now

data/lib/blobby/http_store.rb

@@ -7,13 +7,18 @@ module Blobby
   #
   class HttpStore
 
-    def initialize(base_url, options = {})
-      @base_url = base_url
-      @base_url += "/" unless @base_url.end_with?("/")
+    def self.from_uri(uri)
+      new(uri)
+    end
+
+    def initialize(uri, options = {})
+      uri = URI(uri)
+      uri = URI("#{uri}/") unless uri.to_s.end_with?("/")
+      @base_uri = uri
       @max_retries = options.fetch(:max_retries, 2)
     end
 
-    attr_reader :base_url
+    attr_reader :base_uri
     attr_reader :max_retries
 
     def available?
@@ -29,10 +34,6 @@ module Blobby
       StoredObject.new(self, key)
     end
 
-    def base_uri
-      URI(base_url)
-    end
-
     def with_http_connection
       remaining_retry_intervals = retry_intervals(max_retries)
       begin
@@ -93,7 +94,11 @@ module Blobby
       end
 
       def write(content)
-        content = content.read if content.respond_to?(:read)
+        if content.respond_to?(:read)
+          content = content.read
+        else
+          content = content.dup
+        end
         with_http_connection do |http, path|
           put = Net::HTTP::Put.new(path)
           put.body = content

data/lib/blobby/in_memory_store.rb

@@ -6,6 +6,10 @@ module Blobby
   #
   class InMemoryStore
 
+    def self.from_uri(_uri)
+      new
+    end
+
     def initialize(hash = {})
       @hash = hash
     end
@@ -54,7 +58,7 @@ module Blobby
       end
 
       def delete
-        !!@hash.delete(key)
+        !@hash.delete(key).nil?
       end
 
     end

data/lib/blobby/key_constraint.rb

@@ -8,8 +8,6 @@ module Blobby
   #
   module KeyConstraint
 
-    extend self
-
     BAD_PATTERNS = [
       %r{\A\Z}, # blank
       %r{\A/}, # leading slash
@@ -18,6 +16,8 @@ module Blobby
       %r{:} # colon
     ].freeze
 
+    module_function
+
     def allows?(key)
       BAD_PATTERNS.none? { |pattern| pattern =~ key } &&
         URI.parse(key).path == key

data/lib/blobby/logging_store.rb

@@ -15,9 +15,10 @@ module Blobby
     end
 
     def [](key)
-      StoredObject.new(store[key],
-                       :on_write => -> { logger.info(%(wrote to #{key.inspect} in #{store_name})) },
-                       :on_delete => -> { logger.info(%(deleted #{key.inspect} from #{store_name})) }
+      StoredObject.new(
+        store[key],
+        :on_write => -> { logger.info(%(wrote to #{key.inspect} in #{store_name})) },
+        :on_delete => -> { logger.info(%(deleted #{key.inspect} from #{store_name})) }
       )
     end
 

data/lib/blobby/version.rb

@@ -1,3 +1,3 @@
 module Blobby
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/spec/blobby/composite_store_spec.rb

@@ -1,3 +1,5 @@
+require "spec_helper"
+
 require "blobby/composite_store"
 require "blobby/in_memory_store"
 require "blobby/store_behaviour"

data/spec/blobby/fake_success_store_spec.rb

@@ -1,5 +1,7 @@
 # encoding: UTF-8
 
+require "spec_helper"
+
 require "blobby/fake_success_store"
 require "blobby/store_behaviour"
 

data/spec/blobby/filesystem_store_spec.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+require "spec_helper"
 
 require "blobby/filesystem_store"
 require "blobby/store_behaviour"
@@ -38,11 +38,15 @@ describe Blobby::FilesystemStore do
   describe "#write" do
 
     it "writes to the file-system" do
-      expect { subject[key].write(content) }.to change { expected_file_path.exist? }.from(false).to(true)
+      expect do
+        subject[key].write(content)
+      end.to change { expected_file_path.exist? }.from(false).to(true)
     end
 
     it "should have correct contents" do
-      expect { subject[key].write(content) }.to change { File.read(expected_file_path) rescue nil }.from(nil).to(content)
+      expect do
+        subject[key].write(content)
+      end.to change { File.read(expected_file_path) rescue nil }.from(nil).to(content)
     end
 
     it "retries if renaming throws an ESTALE" do

data/spec/blobby/http_store_spec.rb

@@ -1,3 +1,5 @@
+require "spec_helper"
+
 require "ostruct"
 require "blobby/http_store"
 require "blobby/in_memory_store"
@@ -41,9 +43,7 @@ describe Blobby::HttpStore do
 
     def key
       params[:captures].first.tap do |key|
-        if key =~ /FAIL/ # simulate failure
-          fail "hell"
-        end
+        fail "hell" if key =~ /FAIL/ # simulate failure
       end
     end
 
@@ -102,7 +102,7 @@ describe Blobby::HttpStore do
       it "raises an exception" do
         expect do
           subject[key].read
-        end.to raise_error
+        end.to raise_error("hell")
       end
 
     end
@@ -112,7 +112,7 @@ describe Blobby::HttpStore do
       it "raises an exception" do
         expect do
           subject[key].write("something")
-        end.to raise_error
+        end.to raise_error("hell")
       end
 
     end
@@ -179,7 +179,7 @@ describe Blobby::HttpStore do
 
   end
 
-  context "when the base_url does not include a trailing slash" do
+  context "when the base_uri does not include a trailing slash" do
 
     subject do
       described_class.new("http://#{http_storage_host}/prefix")
@@ -191,7 +191,7 @@ describe Blobby::HttpStore do
 
   end
 
-  context "when the base_url does include a trailing slash" do
+  context "when the base_uri does include a trailing slash" do
 
     subject do
       described_class.new("http://#{http_storage_host}/prefix/")
@@ -203,4 +203,9 @@ describe Blobby::HttpStore do
 
   end
 
+  it "can be created with a URI" do
+    store = described_class.new(URI("http://#{http_storage_host}/prefix/"))
+    expect(store.base_uri.to_s).to eq("http://#{http_storage_host}/prefix/")
+  end
+
 end

data/spec/blobby/in_memory_store_spec.rb

@@ -1,3 +1,5 @@
+require "spec_helper"
+
 require "blobby/in_memory_store"
 require "blobby/store_behaviour"
 

data/spec/blobby/key_transforming_store_spec.rb

@@ -1,3 +1,5 @@
+require "spec_helper"
+
 require "blobby/filesystem_store"
 require "blobby/key_transforming_store"
 require "blobby/store_behaviour"

data/spec/blobby/logging_store_spec.rb

@@ -1,7 +1,9 @@
-require "logger"
+require "spec_helper"
+
 require "blobby/in_memory_store"
 require "blobby/logging_store"
 require "blobby/store_behaviour"
+require "logger"
 require "stringio"
 
 describe Blobby::LoggingStore do

data/spec/blobby/store_behaviour.rb

@@ -1,5 +1,7 @@
 # encoding: UTF-8
 
+require "spec_helper"
+
 require "rspec"
 
 module Blobby
@@ -98,7 +100,7 @@ shared_examples_for Blobby::Store do
 
       context "for UTF-8 content" do
 
-        let(:content) { "SN☃WMAN" }
+        let(:content) { "SN☃WMAN".freeze }
 
         before do
           stored_object.write(content)
@@ -107,7 +109,9 @@ shared_examples_for Blobby::Store do
         describe "#read" do
 
           it "returns binary data" do
-            expect(stored_object.read.encoding.name).to eq("ASCII-8BIT")
+            stored_content = stored_object.read
+            expect(stored_content.encoding.name).to eq("ASCII-8BIT")
+            expect(stored_content.force_encoding("UTF-8")).to eq(content)
           end
 
         end

data/spec/blobby_spec.rb

@@ -0,0 +1,63 @@
+require "spec_helper"
+
+require "blobby"
+
+describe Blobby do
+
+  describe ".store" do
+
+    context "with an absolute file path" do
+
+      it "creates a FilesystemStore" do
+        store = Blobby.store("/data")
+        expect(store).to be_a(Blobby::FilesystemStore)
+        expect(store.dir.to_s).to eq("/data")
+      end
+
+    end
+
+    context "with a file:// URI" do
+
+      it "creates a FilesystemStore" do
+        store = Blobby.store("file:///data")
+        expect(store).to be_a(Blobby::FilesystemStore)
+        expect(store.dir.to_s).to eq("/data")
+      end
+
+    end
+
+    context "with an http:// URI" do
+
+      it "creates a HttpStore" do
+        store = Blobby.store("http://storage.com/data/")
+        expect(store).to be_a(Blobby::HttpStore)
+        expect(store.base_uri.host).to eq("storage.com")
+        expect(store.base_uri.path).to eq("/data/")
+      end
+
+    end
+
+    context "with an https:// URI" do
+
+      it "creates a HttpStore" do
+        store = Blobby.store("https://storage.com/data/")
+        expect(store).to be_a(Blobby::HttpStore)
+        expect(store.base_uri.scheme).to eq("https")
+        expect(store.base_uri.host).to eq("storage.com")
+        expect(store.base_uri.path).to eq("/data/")
+      end
+
+    end
+
+    context "with 'in-memory:/'" do
+
+      it "creates an InMemoryStore" do
+        store = Blobby.store("in-memory:/")
+        expect(store).to be_a(Blobby::InMemoryStore)
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+ENV["RACK_ENV"] = "test"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blobby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Mike Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -21,10 +21,13 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGES.md
 - Gemfile
 - README.md
 - Rakefile
 - blobby.gemspec
+- lib/blobby.rb
+- lib/blobby/abstract_store.rb
 - lib/blobby/composite_store.rb
 - lib/blobby/fake_success_store.rb
 - lib/blobby/filesystem_store.rb
@@ -43,6 +46,8 @@ files:
 - spec/blobby/key_transforming_store_spec.rb
 - spec/blobby/logging_store_spec.rb
 - spec/blobby/store_behaviour.rb
+- spec/blobby_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/realestate-com-au/blobby
 licenses: []
 metadata: {}
@@ -62,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Various ways of storing BLOBs
@@ -75,3 +80,5 @@ test_files:
 - spec/blobby/key_transforming_store_spec.rb
 - spec/blobby/logging_store_spec.rb
 - spec/blobby/store_behaviour.rb
+- spec/blobby_spec.rb
+- spec/spec_helper.rb