lazy_blob_storage 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b711bdc3d1ef7a715b6f749568e99a3051900d955f205abeab52814bebbfa55
+  data.tar.gz: 2d743f678cc1974717852be21d7d06c40a09b9e333967f7b51bb721566c94645
+SHA512:
+  metadata.gz: 64b1b3373ab9158adbfeaf9afc00d4c19c7aecda9ac212508776d21cddcefceba59fdeb4033a4099e3d4fc51624b65028854c43295d70d2f410c1176dab8e2df
+  data.tar.gz: 7563479841938ca4f145aeb0f9fce4317798ed1fcf5b4115f7a7566023b5a73c645ba26ab14782ce9ed0ced1c4245d6f0c78c5022bb9ae05dd03ebec6e725803

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Corey Smedstad
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# LazyBlobStorage
+
+Useful for attaching small (size < 3 MB) database-backed blobs to records. Good
+when you need small file upload support, but don't want to bother with a cloud
+service because you know you'll have low traffic/user counts. Uses a SHA256
+digest to prevent duplicate blob uploads.
+
+Doesn't do anything fancy. Just stores files and allows public access using the
+digest as a key. Respects HTTP Cache headers.
+
+## Note
+
+If it's not obvious. This is for inclusion in a Rails app.
+
+Build with Rails 6. It'll ~probably~ work with Rails 4/5, too.
+
+## Usage
+
+1. Add `gem "lazy_blob_storage" to Gemfile`
+2. Run `rake db:migrate`
+3. Declare `has_lazy_attached :image` in some model
+4. Add `f.file_field :image_upload` to the form template
+5. Use `image_tag @thing.attached_image_path` or `image_tag @thing.image_url`
+
+Note: LazyBlobsController respects HTTP cache directives
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LazyBlobStorage'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/lazy_blobs_controller.rb

@@ -0,0 +1,11 @@
+class LazyBlobsController < ActionController::Base
+  def show
+    @blob = LazyBlob.find_by(digest: params[:digest])
+
+    if stale?(@blob, last_modified: @blob.created_at.utc, public: true)
+      headers['Content-Type'] = @blob.content_type
+      headers['Content-Length'] = @blob.content_length
+      send_data(@blob.content, filename: @blob.filename, disposition: :inline)
+    end
+  end
+end

data/app/models/concerns/lazy_attachable.rb

@@ -0,0 +1,77 @@
+module LazyAttachable
+  extend ActiveSupport::Concern
+
+  class InstanceMethods < Module
+    def initialize(name)
+      define_method("handle_#{name}_upload") do
+        if (send "#{name}_upload").present? && (send "#{name}_upload_size_ok?")
+          blob = LazyBlob.from_upload(send "#{name}_upload")
+
+          if (attached = (send "attached_#{name}"))
+            attached.lazy_blob = blob
+          else
+            attachment = LazyAttachment.new(
+              name: name,
+              record: self,
+              lazy_blob: blob
+            )
+            (send "attached_#{name}=", attachment)
+          end
+        end
+      end
+
+      define_method("#{name}_upload_size_ok?") do
+        (send "#{name}_upload").tempfile.size < 3.megabytes
+      end
+
+      define_method("validate_size_of_#{name}_upload") do
+        if (send "#{name}_upload").present? && !(send "#{name}_upload_size_ok?")
+          errors.add("#{name}_upload", "file too large (limit 3 MB)")
+        end
+      end
+
+      define_method("attached_#{name}_path") do
+        if (send "#{name}_attached?")
+          digest = (send "attached_#{name}").digest
+          Rails.application.routes.url_helpers.lazy_blob_path(digest)
+        else
+          ""
+        end
+      end
+
+      define_method("attached_#{name}_url") do
+        if (send "#{name}_attached?")
+          digest = (send "attached_#{name}").digest
+          Rails.application.routes.url_helpers.lazy_blob_url(digest)
+        else
+          ""
+        end
+      end
+
+      define_method("#{name}_attached?") do
+        (send "attached_#{name}").present?
+      end
+    end
+  end
+
+  class_methods do
+    def has_lazy_attached(name)
+      include InstanceMethods.new(name)
+      attr_accessor "#{name}_upload".to_sym
+
+      has_one "attached_#{name}".to_sym,
+              -> { where(name: name) },
+              class_name: "LazyAttachment",
+              as: :record,
+              autosave: true,
+              dependent: :destroy
+
+      scope "with_attached_#{name}".to_sym, -> {
+        includes("attached_#{name}".to_sym)
+      }
+
+      validate "validate_size_of_#{name}_upload".to_sym
+      before_validation "handle_#{name}_upload".to_sym
+    end
+  end
+end

data/app/models/lazy_attachment.rb

@@ -0,0 +1,10 @@
+class LazyAttachment < ActiveRecord::Base
+  belongs_to :lazy_blob
+  belongs_to :record, polymorphic: true
+  validates :name, presence: true
+  validates :digest, presence: true
+
+  before_validation do
+    self.digest = lazy_blob.digest
+  end
+end

data/app/models/lazy_blob.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class LazyBlob < ActiveRecord::Base
+  has_many :lazy_attachments, dependent: :restrict_with_error
+
+  validates :filename, presence: true
+  validates :content_type, presence: true
+  validates :content_length,
+            presence: true,
+            numericality: { greater_than: 0, less_than: 2.gigabytes }
+  validates :digest, presence: true, uniqueness: true
+  validates :content, presence: true
+
+  def self.from_upload(uploaded_file)
+    file = File.open(uploaded_file.tempfile.path, 'rb')
+    data = file.read
+    digest = Digest::SHA256.new.update(data).hexdigest
+    blob = find_or_initialize_by(digest: digest)
+
+    if blob.new_record?
+      blob.content = data
+      blob.content_length = uploaded_file.tempfile.size
+      blob.filename = uploaded_file.original_filename
+      blob.content_type = uploaded_file.content_type
+    end
+
+    blob
+  ensure
+    file.close
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get "lbs/file/:digest", to: "lazy_blobs#show", as: :lazy_blob
+end

data/db/migrate/20200213161207_create_lazy_blobs.rb

@@ -0,0 +1,12 @@
+class CreateLazyBlobs < ActiveRecord::Migration[6.0]
+  def change
+    create_table :lazy_blobs do |t|
+      t.string :filename
+      t.string :content_type
+      t.integer :content_length
+      t.string :digest
+      t.binary :content
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200213164215_create_lazy_attachments.rb

@@ -0,0 +1,11 @@
+class CreateLazyAttachments < ActiveRecord::Migration[6.0]
+  def change
+    create_table :lazy_attachments do |t|
+      t.references :lazy_blob
+      t.references :record, polymorphic: true
+      t.string :name
+      t.index :name
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20200213212649_add_blob_digest_to_lazy_attachments.rb

@@ -0,0 +1,5 @@
+class AddBlobDigestToLazyAttachments < ActiveRecord::Migration[6.0]
+  def change
+    add_column :lazy_attachments, :digest, :string
+  end
+end

data/lib/lazy_blob_storage/engine.rb

@@ -0,0 +1,17 @@
+module LazyBlobStorage
+  class Engine < ::Rails::Engine
+    initializer :append_migrations do |app|
+      unless app.root.to_s.match root.to_s
+        config.paths["db/migrate"].expanded.each do |expanded_path|
+          app.config.paths["db/migrate"] << expanded_path
+        end
+      end
+    end
+
+    initializer 'mixin_lazy_attachable' do
+      ActiveSupport.on_load(:active_record) do
+        self.include LazyAttachable
+      end
+    end
+  end
+end

data/lib/lazy_blob_storage/version.rb

@@ -0,0 +1,3 @@
+module LazyBlobStorage
+  VERSION = "1.0.0"
+end

data/lib/lazy_blob_storage.rb

@@ -0,0 +1,4 @@
+require "lazy_blob_storage/engine"
+
+module LazyBlobStorage
+end

data/lib/tasks/lazy_blob_storage_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :lazy_blob_storage do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: lazy_blob_storage
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Corey Smedstad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- csmedstad@mreach.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/lazy_blob_storage_manifest.js
+- app/controllers/lazy_blobs_controller.rb
+- app/models/concerns/lazy_attachable.rb
+- app/models/lazy_attachment.rb
+- app/models/lazy_blob.rb
+- config/routes.rb
+- db/migrate/20200213161207_create_lazy_blobs.rb
+- db/migrate/20200213164215_create_lazy_attachments.rb
+- db/migrate/20200213212649_add_blob_digest_to_lazy_attachments.rb
+- lib/lazy_blob_storage.rb
+- lib/lazy_blob_storage/engine.rb
+- lib/lazy_blob_storage/version.rb
+- lib/tasks/lazy_blob_storage_tasks.rake
+homepage: https://git.mreach.com/csmedstad/lazy_blob_storage
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Low traffic site? Small file upload needs? Don't want to setup a cloud service?
+  Lazy Blob Storage is for you!
+test_files: []