solid_storage 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8f89a01c7211be77a1c7dcb74fe3480c419161a94da0361cbfbd41744e5cdfd
+  data.tar.gz: 479ad5ec90754640e64e0f42d75ca8368bb2b6f5c84af394354a1fef7ce8a655
+SHA512:
+  metadata.gz: adc433251f4bdf44454cdc0b541977f909786969beef04c056d96ec6da171852c1c2f695b68a56750f5416273ff83161619c73742aebfa44859769c639875cf0
+  data.tar.gz: 00cab3fcf0359e82363a7f6251f116bd98c4b3699f8ba183982c8739333a1c1ca73cd392dffa8fea5aa361a82dc9d73fe93ae498ea2ac4f71bdd8e9c469f82f6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Nick Pezza
+
+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,14 @@
+# Solid Storage
+
+Active Storage service adapter that stores blobs in the database and serves
+them using X-Sendfile.
+
+## Installation
+
+1. `bundle add solid_storage`
+2. `bin/rails solid_storage:install`
+
+This will configure Solid Storage as an Active Storage adapter by overwritting `config/storage.yml`, create `db/storage_schema.rb`, and set the production adapter to `:solid_storage`.
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/solid_storage/files_controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class SolidStorage::FilesController < ActiveStorage::DiskController
+  include ActiveStorage::FileServer
+
+  def show
+    if key = decode_verified_key
+      @file = named_disk_service(key[:service_name]).find(key[:key])
+      serve_file @file.tempfile, content_type: key[:content_type],
+        disposition: key[:disposition]
+    else
+      head :not_found
+    end
+  end
+
+  def update
+    if token = decode_verified_token
+      if acceptable_content?(token)
+        named_disk_service(token[:service_name]).upload token[:key],
+          request.body, checksum: token[:checksum]
+        head :no_content
+      else
+        head :unprocessable_entity
+      end
+    else
+      head :not_found
+    end
+  rescue ActiveStorage::IntegrityError
+    head :unprocessable_entity
+  end
+end

data/app/models/solid_storage/file.rb

@@ -0,0 +1,16 @@
+class SolidStorage::File < SolidStorage::Record
+  belongs_to :blob, class_name: "ActiveStorage::Blob",
+                    primary_key: :key, foreign_key: :key, optional: true
+
+  def tempfile
+    @tempfile ||= Tempfile.new.tap do |file|
+      file.binmode
+      file.write(data)
+      file.rewind
+    end
+  end
+
+  def io
+    StringIO.new(data)
+  end
+end

data/app/models/solid_storage/record.rb

@@ -0,0 +1,8 @@
+
+module SolidStorage
+  class Record < ActiveRecord::Base
+    self.abstract_class = true
+
+    connects_to(**SolidStorage.connects_to) if SolidStorage.connects_to.present?
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  scope ActiveStorage.routes_prefix do
+    get "/solid_storage/:encoded_key/*filename", to: "solid_storage/files#show", as: :rails_solid_storage_service
+    put "/solid_storage/:encoded_token", to: "solid_storage/files#update", as: :update_rails_solid_storage_service
+  end
+end

data/db/migrate/20241016013117_create_solid_storage_files.rb

@@ -0,0 +1,11 @@
+class CreateSolidStorageFiles < ActiveRecord::Migration[7.2]
+  def change
+    create_table :solid_storage_files do |t|
+      t.binary :data, limit: 536870912
+      t.string :key
+      t.index :key
+
+      t.timestamps
+    end
+  end
+end

data/lib/active_storage/service/solid_storage_service.rb

@@ -0,0 +1,142 @@
+require "active_storage/service"
+
+module ActiveStorage
+  class Service::SolidStorageService < ::ActiveStorage::Service
+    def initialize(public: false, **options)
+      @public = public
+    end
+
+    def find(key)
+      SolidStorage::File.find_by!(key:)
+    end
+
+    def upload(key, io, checksum: nil, **)
+      instrument(:upload, key:, checksum:) do
+        file = SolidStorage::File.create!(key:, data: io.read)
+        ensure_integrity_of(key, checksum) if checksum
+        file
+      end
+    end
+
+    def download(key, &block)
+      io = SolidStorage::File.find_by!(key:).io
+      if block
+        instrument(:streaming_download, key:) do
+          while data = io.read(5.megabytes)
+            yield data
+          end
+        end
+      else
+        instrument(:download, key:) { io.read }
+      end
+    rescue ActiveRecord::RecordNotFound
+      raise ActiveStorage::FileNotFoundError
+    end
+
+    def download_chunk(key, range)
+      instrument(:download_chunk, key:, range:) do
+        args =
+          if sqlite? then "data, #{range.begin + 1}, #{range.size}"
+          else
+           "data FROM #{range.begin + 1} FOR #{range.size}"
+          end
+
+        SolidStorage::File.select("SUBSTRING(#{args}) as chunk").
+          find_by!(key:).chunk
+      rescue ActiveRecord::RecordNotFound
+        raise ActiveStorage::FileNotFoundError
+      end
+    end
+
+    def compose(source_keys, destination_key, **)
+      SolidStorage::File.create(
+        key: destination_key,
+        data: SolidStorage::File.where(key: source_keys).in_order_of(:key, source_keys).map(&:data).join
+      )
+    end
+
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: do
+        SolidStorage::File.where(
+          SolidStorage::File.arel_table[:key].matches("#{prefix}%").to_sql
+        ).destroy_all
+      end
+    end
+
+    def delete(key)
+      instrument(:delete, key:) { SolidStorage::File.where(key:).destroy_all }
+    end
+
+    def exist?(key)
+      instrument(:exist, key:) do |payload|
+        payload[:exist] = SolidStorage::File.exists?(key:)
+      end
+    end
+
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
+      instrument :url, key: do |payload|
+        verified_token_with_expiration = ActiveStorage.verifier.generate(
+          { key:, content_type:, content_length:, checksum:,
+            service_name: name }, expires_in:, purpose: :blob_token
+        )
+
+        payload[:url] = url_helpers.update_rails_solid_storage_service_url(
+          verified_token_with_expiration, url_options
+        )
+      end
+    end
+
+    def headers_for_direct_upload(key, content_type:, **)
+      { "Content-Type" => content_type }
+    end
+
+    private
+
+    def private_url(key, expires_in:, filename:, content_type:, disposition:, **)
+      generate_url(key, expires_in:, filename:, content_type:, disposition:)
+    end
+
+    def public_url(key, filename:, content_type: nil, disposition: :attachment, **)
+      generate_url(key, expires_in: nil, filename:, content_type:, disposition:)
+    end
+
+    def generate_url(key, expires_in:, filename:, content_type:, disposition:)
+      content_disposition = content_disposition_with(type: disposition, filename:)
+      verified_key_with_expiration =
+        generate_key(key:, expires_in:, filename:, content_type: content_type, disposition: content_disposition,
+          purpose: :blob_key)
+
+      if url_options.blank?
+        raise ArgumentError, "Cannot generate URL for #{filename} using Solid Storage, please set ActiveStorage::Current.url_options."
+      end
+
+      url_helpers.rails_solid_storage_service_url(verified_key_with_expiration, filename: filename, **url_options)
+    end
+
+    def generate_key(key:, expires_in:, filename:, content_type:, disposition:, purpose:)
+      verified_key_with_expiration = ActiveStorage.verifier.generate(
+        { key:, disposition:, content_type:,
+          service_name: name }, expires_in:, purpose:
+      )
+    end
+
+    def sqlite?
+      SolidStorage::File.connection.adapter_name.downcase.inquiry.sqlite?
+    end
+
+    def url_helpers
+      @url_helpers ||= Rails.application.routes.url_helpers
+    end
+
+    def url_options
+      ActiveStorage::Current.url_options
+    end
+
+    def ensure_integrity_of(key, checksum)
+      return if OpenSSL::Digest::MD5.base64digest(find(key).data) == checksum
+
+      delete key
+      raise ActiveStorage::IntegrityError
+    end
+  end
+end

data/lib/generators/solid_storage/install/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class SolidStorage::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path("templates", __dir__)
+
+  def copy_files
+    template "db/storage_schema.rb"
+    template "config/storage.yml", force: true
+
+    gsub_file("config/environments/production.rb", /config.active_storage.service = .*$/) do
+      "config.active_storage.service = :solid_storage"
+    end
+  end
+end

data/lib/generators/solid_storage/install/templates/config/storage.yml

@@ -0,0 +1,39 @@
+test:
+  service: Disk
+  root: <%%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%%= Rails.root.join("storage") %>
+  public: true
+  cache_control: "public, max-age=3600"
+
+solid_storage:
+  service: SolidStorage
+
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name-<%= Rails.env %>
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/lib/generators/solid_storage/install/templates/db/storage_schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema[7.1].define(version: 1) do
+  create_table "solid_storage_files", force: :cascade do |t|
+    t.binary "data", limit: 536870912
+    t.string "key"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+    t.index ["key"], name: "index_solid_storage_files_on_key"
+  end
+end

data/lib/solid_storage/engine.rb

@@ -0,0 +1,5 @@
+module SolidStorage
+  class Engine < ::Rails::Engine
+    isolate_namespace SolidStorage
+  end
+end

data/lib/solid_storage/version.rb

@@ -0,0 +1,3 @@
+module SolidStorage
+  VERSION = "0.1.0"
+end

data/lib/solid_storage.rb

@@ -0,0 +1,7 @@
+require "solid_storage/version"
+require "solid_storage/engine"
+require "active_storage/service/solid_storage_service"
+
+module SolidStorage
+  mattr_accessor :connects_to
+end

data/lib/tasks/solid_storage_tasks.rake

@@ -0,0 +1,6 @@
+desc "Copy over migrations"
+namespace :solid_storage do
+  task install: :environment do
+    Rails::Command.invoke :generate, [ "solid_storage:install" ]
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: solid_storage
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Pezza
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+description: Database-backed Active Stroage adapter.
+email:
+- pezza@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/solid_storage/files_controller.rb
+- app/models/solid_storage/file.rb
+- app/models/solid_storage/record.rb
+- config/routes.rb
+- db/migrate/20241016013117_create_solid_storage_files.rb
+- lib/active_storage/service/solid_storage_service.rb
+- lib/generators/solid_storage/install/install_generator.rb
+- lib/generators/solid_storage/install/templates/config/storage.yml
+- lib/generators/solid_storage/install/templates/db/storage_schema.rb
+- lib/solid_storage.rb
+- lib/solid_storage/engine.rb
+- lib/solid_storage/version.rb
+- lib/tasks/solid_storage_tasks.rake
+homepage: http://github.com/npezza93/solid_storage
+licenses:
+- MIT
+metadata:
+  homepage_uri: http://github.com/npezza93/solid_storage
+  source_code_uri: http://github.com/npezza93/solid_storage
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.18
+signing_key:
+specification_version: 4
+summary: Database-backed Active Storage adapter.
+test_files: []