sixarm_ruby_blob 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2fbb759d31bb2f54e52e52edd9db4a43f833ebc
-  data.tar.gz: 3e6d068636b9f1dc652ef6284e7295e31600809e
+  metadata.gz: b2498c0f1bc1c1f18d4608c27b90469e5b68218c
+  data.tar.gz: 2db4616404f8bd1df0fa333a7dbfd2342549fd23
 SHA512:
-  metadata.gz: cf0a87ce08854d34b0e9ff3fa6e43c9d4f9d54d8ec5f0204f56b525e8dc8c680b3b7f3e310b2db84dc24724e2804f064831d2bff2c3e4047de8ffb7a787e52d2
-  data.tar.gz: e086df08b5fbbe61526a802d04447fb6cfaf3a19d2c32c1133b7bb5d8361e09fc7a01ac2b5eb7e5160d4a7269d9b1f700e54b3311414f16fec155cd2e3d57937
+  metadata.gz: 33161d97849da4819f3b996362ec2de113c3f7a60d6a1521d43470aa821c5435a5f69b6abbe261da07e91257b123097ff753d0aa86a16b888c7e426a4f3f5ad3
+  data.tar.gz: 9dc6a2e226a9eb1a3d0f738cf8d95d0fb882ffb31f9a360be4d55aeadb4422a95973b30e7fc72cc14e5a7076e49560805fd90ee167b8ab52284e2d246782b8aa

checksums.yaml.gz.sig

@@ -1,2 +1 @@
-
-b@���^��&Y{=��56�<���
���)�Pl�T�D�8?\�FW�I�ۑd�^ޓ1�	��H$
4E�����.�$Ws+B�"�:"��ި�[�E%�[VG%�yPF~�Ɵ����=Կ��䬎9�#S
+-� ��*X/T�ބ��;�Ӟ#U'3���

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/sixarm_ruby_blob/base.rb

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+###
+#
+# Blob abstract model suitable for our
+# typical kinds of data files in our app.
+#
+# We can store the blob on the local file system (see BlobFile),
+# We can make the blob accessible via URI (see BlobURI).
+# We can export the blob to an external system (see BlobExport).
+#
+###
+
+class Blob
+
+  def name; @name; end
+  def name=x; @name=x; end
+
+  def initialize(options = {})
+    @name ||= options[:name]
+  end
+
+  def ==(other)
+    self.name == other.name
+  end
+
+  def eql?(other)
+    self.name.eql?(other.name)
+  end
+
+end

data/lib/sixarm_ruby_blob/dir.rb

@@ -0,0 +1,28 @@
+# Blob methods for accessing a blob via a dir name and base name.
+# Exclusively for the Blob class.
+
+class Blob
+  
+  #attr_accessor :dir   # Dir name of this blob, e.g. "/my/photos"
+  #attr_accessor :base  # Base name of this blob, e.g. "photo.jpg"
+
+  def dir; @dir;  end
+  def dir=(x); @dir=x; end
+
+  def base; @base;  end
+  def base=(x); @base=x; end
+
+  def initialize(options = {})
+    @dir ||= options[:dir]
+    @base ||= options[:base]
+  end
+
+  def name
+    @name ||= "#{dir}/#{base}"
+  end
+
+  def ext
+    base =~ /\.(\w+)$/ ? $1 : nil
+  end
+
+end

data/lib/sixarm_ruby_blob/export.rb

@@ -0,0 +1,50 @@
+# Blob methods for exporting.
+# Exclusively for the Blob class.
+
+class Blob
+
+  # Get the blob export's directory name, e.g. "/my/photos"
+  #
+  # The implementation simply calls #file_dir.
+  # Override this when an export needs a custom directory base.
+  #
+  # @return [String] the blob export's directory name
+  #
+  def export_dir
+    file_dir
+  end
+
+  # Get the blob export's base name, e.g. "photo.jpg"
+  #
+  # The implementation simply calls #file_base.
+  # Override this when an export needs a custom base name.
+  #
+  # @return [String] the blob export's base name
+  #
+  def export_base
+    file_base
+  end
+
+  # Get the blob export's path, e.g. "/my/photos/photo.jpg"
+  #
+  # The implementation simply calls #file_path.
+  # Override this when an export needs a custom path.
+  #
+  # @return [String] the blob export's path
+  #
+  def export_path
+    export_pathname.to_s
+  end
+
+  # Get the blob export's pathname, e.g. Pathname("/my/photos/photo.jpg")
+  #
+  # The implementation simply calls #file_pathname.
+  # Override this when an export needs a custom path.
+  #
+  # @return [String] the file's path suitable for export
+  #
+  def export_pathname
+    Pathname(export_dir) + export_base
+  end
+
+end

data/lib/sixarm_ruby_blob/file.rb

@@ -0,0 +1,73 @@
+# Blob file methods for accessing a blob via the filesystem.
+# Exclusively for the Blob class.
+
+class Blob
+
+  # Get the blob file's dir name e.g. "/my/photos".
+  #
+  # This impl calls #dir which is typically fine.
+  #
+  # Override this if the local storage file dir
+  # name is different than the generic base name.
+  #
+  # @return [String] the blob file's dir name
+  #
+  def file_dir
+    dir
+  end
+
+  # Get the blob file's base name e.g. "photo.jpg".
+  #
+  # This impl calls #base which is typically fine.
+  #
+  # Override this when the local storage file base
+  # name is different than the generic base name.
+  #
+  # @return [String] the blob file's base name
+  #
+  def file_base
+    base
+  end
+
+  # Get the blob file's path e.g. "/my/photos/photo.jpg"
+  #
+  # This impl calls #file_dir and #file_base.
+  # Subclasses can likely use this as-is.
+  #
+  # @return [Pathname] the blob file's path
+  #
+  def file_path
+    file_pathname.to_s
+  end
+
+  # Get the blob file's pathname e.g. Pathname("/my/photos/photo.jpg")
+  #
+  # This impl calls #file_dir and #file_base.
+  # Subclasses can likely use this as-is.
+  #
+  # @return [Pathname] the blob file's pathname
+  #
+  def file_pathname
+    Pathname(file_dir) + file_base
+  end
+
+  # Does the file exist on the local filesystem?
+  #
+  # @return [boolean] iff the file exists
+  #
+  def file_exist?
+    FileTest.exists? file_path
+  end
+
+  # Return true iff the image exists the way we expect.
+  # Currently, this is simply calling file_exist.
+  # 
+  # @deprecated
+  # @return [boolean] iff the file exists
+  #
+  def exist?
+    Rails.logger.warn "DEPRECATED" 
+    FileTest.exists? file_path
+  end
+
+end

data/lib/sixarm_ruby_blob/upload.rb

@@ -0,0 +1,51 @@
+# Blob method to upload from a web page.
+# Exclusively for the Blob class.
+
+class Blob
+
+  # Upload to this blob's file_path from a web form file_field.
+  #
+  # TODO optimize this to move the temp file into place
+  #
+  # @return [Boolean] true iff the upload succeeds
+  #
+  def upload(file_field)
+    self.class.upload(file_path, file_field)
+  end
+
+  # Upload to a file_path from a web form file_field.
+  #
+  # TODO optimize this to move the temp file into place
+  #
+  # @return [Boolean] true iff the upload succeeds
+  #
+  def self.upload(file_path, file_field)
+    if vet_file_field?(file_field)
+      file_field.tempfile.binmode
+      File.open(file_path, "wb") { |f| f.write(file_field.read) }
+      return true
+    end
+    return false
+  end
+
+  # Vet the file field for all the methods that we expect
+  # from a web browser upload; we call this before we upload.
+  #
+  def self.vet_file_field?(file_field)
+    !!(
+      file_field \
+      && file_field.respond_to?(:tempfile) \
+      && file_field.tempfile \
+      && file_field.tempfile.respond_to?(:path) \
+      && file_field.tempfile.respond_to?(:binmode) \
+      && file_field.tempfile.path
+    ) 
+  end
+  
+  # Deprecated
+  #
+  def save(file_field)
+    raise "Deprecated: replace with #upload"
+  end
+
+end

data/lib/sixarm_ruby_blob/uri.rb

@@ -0,0 +1,64 @@
+# Blob URI methods for accessing a blob via the web. 
+# Exclusively for the Blob class.
+
+class Blob
+
+  # Get the blob URI's dir name e.g. "/my/photos".
+  #
+  # This impl calls #dir which is typically fine.
+  #
+  # Override this if the local storage file dir
+  # name is different than the generic base name.
+  #
+  # @return [String] the blob URI's dir name
+  #
+  def uri_dir
+    dir
+  end
+
+  # Get the blob's URI base name e.g. "photo.jpg".
+  #
+  # This impl calls #base which is typically fine.
+  #
+  # Override this when the URI base name
+  # is different than the generic base name.
+  #
+  # @return [String] the blob URI's base name
+  #
+  def uri_base    
+    base
+  end
+
+  # Get the blob's URI to access this blob from the web.
+  #
+  # This impl calls #uri_dir and #uri_base.
+  # Override this e.g. for assets, CDNs, etc.
+  #
+  # @return [String] the blob URI's path
+  #
+  def uri
+    return "/#{uri_dir}/#{uri_base}"
+  end
+
+  # Get the blob's URI to access this blob from the web,
+  # with a random chaff query appended as a cache buster.
+  #
+  # @return [String] the blob URI's path?uuid=chaff
+  #
+  def uri_cacheless
+    return "#{uri}?cacheless=#{SecureRandom.uuid}"
+  end
+
+  # Deprecated
+  #
+  def url
+    raise "Deprecated: replace with #uri"
+  end
+
+  # Deprecated
+  #
+  def url_cacheless
+    raise "Deprecated: replace with #uri_cacheless"
+  end
+
+end

data/test/sixarm_ruby_blob_test/base_test.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+
+describe Blob do
+
+  let(:blob){ Factory.build(:blob, name: FAB.name) }
+
+  describe "equality" do
+
+    before do
+      @a = Blob.new
+      @b = Blob.new
+    end
+
+    describe "#==(other)" do
+
+      it "is true iff names are equal (using ==)" do
+        @a.name = "foo"
+        @b.name = "foo"
+        (@a==@b).must_be_true
+      end
+
+      it "is false when names are inequal (using ==)" do
+        @a.name = "foo"
+        @b.name = "bar"
+        (@a==@b).must_be_false
+      end
+
+    end
+
+    describe "#eql?(other)" do
+      
+      before do
+        @a = Blob.new
+        @b = Blob.new
+      end
+      
+      it "is true iff names are equal (using #eql?)" do
+        @a.name = "foo"
+        @b.name = "foo"
+        (@a.eql?(@b)).must_be_true
+      end
+      
+      it "is false when names are inequal (using #eql?)" do
+        @a.name = "foo"
+        @b.name = "bar"
+        (@a.eql?(@b)).must_be_false
+      end
+
+    end
+
+  end
+  
+end

data/test/sixarm_ruby_blob_test/dir_test.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+
+describe Blob do
+
+  let(:dir){ FAB.dirname }
+  let(:base){ FAB.basename }
+  let(:blob){ Blob.new(dir: dir, base: base) }
+
+  # We choose to use Unix-friendly file names: lowercase a-z and underscores,
+  # always with "/" as a directory separator, typically with a dot extension,
+  # never with non-ASCII characters.
+  #
+  let(:base_match){ /^[0-1a-z\_\.]+$/ }
+  let(:dir_match){ /^[0-1a-z\_\/]+$/ }
+  let(:path_match){ /^[0-1a-z\_\/\.]+$/ }
+
+  describe "#base" do
+    it "uses a good unix name" do
+      blob.base.must_match base_match
+    end
+  end
+
+  describe "#dir" do
+    it "uses a good unix name" do
+      blob.dir.must_match dir_match
+    end
+  end
+
+  describe "#name" do
+    it "concats the name" do
+      blob.name.must_equal "#{dir}/#{base}"
+    end
+  end
+
+  describe "#ext" do
+
+    it "returns the file base name extension, if it exists" do
+      blob.base = "foo.goo.hoo"
+      blob.ext.must_equal "hoo"
+    end
+
+    it "returns nil, if there is no extension" do
+      blob.base = "foogoohoo"
+      blob.ext.must_be_nil
+    end
+
+  end
+
+end

data/test/sixarm_ruby_blob_test/export_test.rb

@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+
+describe Blob do
+
+  let(:dir){ "abc" }
+  let(:base){ "def" }
+  let(:blob){ Blob.new(dir: dir, base: base) }
+
+  describe "#export_dir" do
+
+    it "defaults to the file dir" do
+      blob.export_dir.must_equal blob.file_dir
+      blob.export_dir.must_equal "#{dir}"
+    end
+
+  end
+
+  describe "#export_base" do
+
+    it "it defaults to the file base" do
+      blob.export_base.must_equal blob.file_base
+      blob.export_base.must_match "#{base}"
+    end
+
+  end
+
+  describe "#export_path" do
+
+    it "combines the dir and base" do
+      blob.export_path.must_equal "#{dir}/#{base}"
+    end
+
+  end
+
+end

data/test/sixarm_ruby_blob_test/file_test.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+
+describe Blob do
+
+  let(:dir){ "abc" }
+  let(:base){ "def" }
+  let(:blob){ Blob.new(dir: dir, base: base) }
+
+  # We choose to use Unix-friendly file names: lowercase a-z and underscores,
+  # always with "/" as a directory separator, typically with a dot extension,
+  # never with non-ASCII characters.
+  #
+  let(:base_match){ /^[0-1a-z\_\.]+$/ }
+  let(:dir_match){ /^[0-1a-z\_\/]+$/ }
+  let(:path_match){ /^[0-1a-z\_\/\.]+$/ }
+
+  describe "#file_dir" do
+
+    it "is the dir" do
+      blob.file_dir.must_equal dir
+    end
+
+    it "uses a good unix name" do
+      blob.file_dir.must_match dir_match
+    end
+
+  end
+
+  describe "#file_base" do
+
+    it "is the base" do
+      blob.file_base.must_equal base
+    end
+
+    it "uses a good unix name" do
+      blob.file_base.must_match base_match
+    end
+
+  end
+
+  describe "#file_path" do
+
+    it "combines the dir and base" do
+      blob.file_path.must_equal "#{dir}/#{base}"
+    end
+
+    it "uses a good unix name" do
+      blob.file_path.must_match path_match
+    end
+
+  end
+
+  describe "#file_exist?" do
+
+    it "returns true iff the file exists" do
+      blob.file_exist?  #TODO
+    end
+
+  end
+
+end

data/test/sixarm_ruby_blob_test/samples/upload_input.bin

@@ -0,0 +1 @@
+

data/test/sixarm_ruby_blob_test/upload_test.rb

@@ -0,0 +1,74 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+
+describe Blob do
+
+  DIR = Pathname(__FILE__).dirname + "samples" 
+  BASE = "upload_output.bin"
+  TEMPFILE_PATH = DIR + "upload_input.bin" 
+  TEMPFILE_BINMODE = true
+
+  let(:blob){ Blob.new(dir: DIR, base: BASE) }
+  let(:original_filename){ "hello" }
+  let(:content_type){ "abc/def" }
+
+  # Mocks
+  let(:tempfile){ OpenStruct.new(path: TEMPFILE_PATH, binmode: TEMPFILE_BINMODE) } 
+  let(:file_field){ OpenStruct.new(content_type: content_type, original_filename: original_filename, tempfile: tempfile) }
+
+  describe "upload" do
+
+    before do
+      @file_path = blob.file_path
+
+      # Delete a previously-uploaded file if it exists
+      File.exists?(@file_path) and File.delete(@file_path)
+
+      # Sanity check
+      File.exists?(tempfile.path).must_be_true "Temp file must exist: #{tempfile.path}"
+
+    end
+
+    describe ".upload" do
+      
+      it "uploads" do
+        File.exists?(@file_path).must_be_false "Blob file must not exist: #{@file_path}"
+        blob.upload(file_field).must_be_true
+        File.exists?(@file_path).must_be_true "Blob file must exist: #{@file_path}"
+      end
+
+    end
+
+    describe "#upload" do
+            
+      it "uploads" do
+        File.exists?(@file_path).must_be_false "Blob file must not exist: #{@file_path}"
+        Blob.upload(@file_path, file_field).must_be_true
+        File.exists?(@file_path).must_be_true "Blob file must exist: #{@file_path}"
+      end
+
+    end
+
+    describe "#vet_file_field" do
+
+      before do
+        # Sanity check
+        file_field.must_exist
+        file_field.must_respond_to :tempfile
+        file_field.tempfile.must_be_exist
+        file_field.tempfile.must_respond_to :path
+        file_field.tempfile.must_respond_to :binmode
+        file_field.tempfile.path.must_exist
+      end
+
+      it "vets" do
+        Blob.vet_file_field?(file_field).must_be_true
+      end
+
+    end
+
+  end
+
+end

data/test/sixarm_ruby_blob_test/uri_test.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+require 'minitest/autorun'
+require 'simplecov'
+SimpleCov.start
+
+describe Blob do
+
+  let(:dir){ "foo" }
+  let(:base){ "bar" }
+  let(:blob){ Blob.new(dir: dir, base: base) }
+
+  describe "#uri_dir" do
+
+    it "is the dir" do
+      blob.uri_dir.must_equal dir
+    end
+
+  end
+
+  describe "#uri_base" do
+
+    it "is the base" do
+      blob.uri_base.must_equal base
+    end
+
+  end
+
+  describe "#uri" do
+
+    it "returns a URI that we can parse successfully" do
+      URI.parse(blob.uri)
+    end
+
+  end
+
+  describe "#uri_cacheless" do
+
+    it "gets a URI that we can parse successfully" do
+      URI.parse(blob.uri_cacheless)
+    end
+
+    it "gets a URI that has a unique id appended" do
+      blob.uri_cacheless.must_match /\?cacheless=[-0-9abcdef]{36}$/
+    end
+
+    it "returns a URI that is different each time" do
+      x = blob.uri_cacheless
+      y = blob.uri_cacheless
+      x.wont_equal y
+    end
+
+  end
+
+end

data/test/sixarm_ruby_blob_test.rb

@@ -10,8 +10,6 @@ require 'sixarm_ruby_blob'
 require 'securerandom'
 require 'uri'
 
-
-
 FAB = Fab.new
 
 ['base','dir','file','export','upload','uri'].map{|x|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_blob
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - SixArm
@@ -70,7 +70,20 @@ files:
 - README.md
 - VERSION
 - lib/sixarm_ruby_blob.rb
+- lib/sixarm_ruby_blob/base.rb
+- lib/sixarm_ruby_blob/dir.rb
+- lib/sixarm_ruby_blob/file.rb
+- lib/sixarm_ruby_blob/export.rb
+- lib/sixarm_ruby_blob/upload.rb
+- lib/sixarm_ruby_blob/uri.rb
 - test/sixarm_ruby_blob_test.rb
+- test/sixarm_ruby_blob_test/base_test.rb
+- test/sixarm_ruby_blob_test/dir_test.rb
+- test/sixarm_ruby_blob_test/file_test.rb
+- test/sixarm_ruby_blob_test/export_test.rb
+- test/sixarm_ruby_blob_test/upload_test.rb
+- test/sixarm_ruby_blob_test/uri_test.rb
+- test/sixarm_ruby_blob_test/samples/upload_input.bin
 homepage: http://sixarm.com/
 licenses:
 - BSD
@@ -101,4 +114,11 @@ specification_version: 4
 summary: SixArm.com » Ruby » Blob of data abstract base class
 test_files:
 - test/sixarm_ruby_blob_test.rb
+- test/sixarm_ruby_blob_test/base_test.rb
+- test/sixarm_ruby_blob_test/dir_test.rb
+- test/sixarm_ruby_blob_test/file_test.rb
+- test/sixarm_ruby_blob_test/export_test.rb
+- test/sixarm_ruby_blob_test/upload_test.rb
+- test/sixarm_ruby_blob_test/uri_test.rb
+- test/sixarm_ruby_blob_test/samples/upload_input.bin
 has_rdoc: true