active_storage_db 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6159ecad022c402fd439ccb18c5acd208a6158817f8e4f6b98f3f63b0d2a8d97
+  data.tar.gz: 588c92f89efdb609b4127ae4f37183f97133feab7db3be798a971c769bbe1266
+SHA512:
+  metadata.gz: 89f0b63ec3b310f68fefc448b8dd5d03409d19bac1a5f9fc15ae58eaea3b1276b3431f2f6a685756c724e0c77e094b0e141ad9c3e4f767de05d771c0111bcf03
+  data.tar.gz: fd416152e2fbc2fd13161b4929b261753262571a6b76e3fd54dcaeae2faa7e7d83729c0a4049724c0b09efce63649e9186ac8625e434837ad915070f67db7577

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Mattia Roccoberton
+
+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,31 @@
+# Active Storage DB
+An Active Storage service upload/download plugin that stores files in a PostgreSQL or MySQL database.
+
+Main features:
+- all service methods implemented;
+- data is saved using a binary field (or blob);
+- RSpec tests.
+
+## Installation
+- Setup Active Storage in your Rails application
+- Add this line to your Gemfile: `gem 'active_storage_db'`
+- And execute: `bundle`
+- Install gem migrations: `bin/rails active_storage_db:install:migrations`
+- And execute: `bin/rails db:migrate`
+- Add to your `config/routes.rb`: `mount ActiveStorageDB::Engine => '/active_storage_db'`
+- Change Active Storage service in *config/environments/development.rb* to: `config.active_storage.service = :db`
+- Add to *config/storage.yml*:
+```
+db:
+  service: DB
+```
+
+## Do you like it? Star it!
+If you use this component just star it. A developer is more motivated to improve a project when there is some interest.
+
+## Contributors
+- [Mattia Roccoberton](https://blocknot.es/): author
+- Inspired by [activestorage-database-service](https://github.com/TitovDigital/activestorage-database-service) project
+
+## 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,34 @@
+# frozen_string_literal: true
+
+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    = 'ActiveStorageDB'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('spec/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 << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/active_storage_db/files_controller.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module ActiveStorageDB
+  class FilesController < ActiveStorage::BaseController
+    skip_forgery_protection
+
+    def show
+      if (key = decode_verified_key)
+        serve_file(key[:key], content_type: key[:content_type], disposition: key[:disposition])
+      else
+        head :not_found
+      end
+    rescue ActiveStorage::FileNotFoundError
+      head :not_found
+    end
+
+    def update
+      if (token = decode_verified_token)
+        if acceptable_content?(token)
+          db_service.upload(token[:key], request.body, checksum: token[:checksum])
+        else
+          head :unprocessable_entity
+        end
+      else
+        head :not_found
+      end
+    rescue ActiveStorage::IntegrityError
+      head :unprocessable_entity
+    end
+
+    private
+
+    def db_service
+      ActiveStorage::Blob.service
+    end
+
+    def decode_verified_key
+      ActiveStorage.verifier.verified(params[:encoded_key], purpose: :blob_key)
+    end
+
+    def serve_file(key, content_type:, disposition:)
+      options = {
+        type: content_type || DEFAULT_SEND_FILE_TYPE,
+        disposition: disposition || DEFAULT_SEND_FILE_DISPOSITION
+      }
+      send_data db_service.download(key), options
+    end
+
+    def decode_verified_token
+      ActiveStorage.verifier.verified(params[:encoded_token], purpose: :blob_token)
+    end
+
+    def acceptable_content?(token)
+      token[:content_type] == request.content_mime_type && token[:content_length] == request.content_length
+    end
+  end
+end

data/app/models/active_storage_db/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorageDB
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/active_storage_db/file.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module ActiveStorageDB
+  class File < ApplicationRecord
+    validates :ref,
+              presence: true,
+              allow_blank: false,
+              uniqueness: { case_sensitive: false }
+  end
+end

data/config/initializers/inflections.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym 'DB'
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+ActiveStorageDB::Engine.routes.draw do
+  get '/files/:encoded_key/*filename', to: 'files#show', as: :service
+  put '/files/:encoded_token', to: 'files#update', as: :update_service
+end

data/db/migrate/20200702202022_create_active_storage_db_files.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateActiveStorageDBFiles < ActiveRecord::Migration[6.0]
+  def change
+    create_table :active_storage_db_files do |t|
+      t.string :ref, null: false
+      t.binary :data, null: false
+      t.datetime :created_at, null: false
+
+      t.index [:ref], unique: true
+    end
+  end
+end

data/lib/active_storage/service/db_service.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module ActiveStorage
+  class Service::DBService < Service # rubocop:disable Style/ClassAndModuleChildren
+    def initialize(**_config)
+      @chunk_size = ENV.fetch('ASDB_CHUNK_SIZE') { 1.megabytes }
+    end
+
+    def upload(key, io, checksum: nil, **)
+      instrument :upload, key: key, checksum: checksum do
+        file = ::ActiveStorageDB::File.create!(ref: key, data: io.read)
+        ensure_integrity_of(key, checksum) if checksum
+        file
+      end
+    end
+
+    def download(key, &block)
+      if block_given?
+        instrument :streaming_download, key: key do
+          stream(key, &block)
+        end
+      else
+        instrument :download, key: key do
+          record = ::ActiveStorageDB::File.find_by(ref: key)
+          record&.data || raise(ActiveStorage::FileNotFoundError)
+        end
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        chunk_select = "SUBSTRING(data FROM #{range.begin + 1} FOR #{range.size}) AS chunk"
+        ::ActiveStorageDB::File.select(chunk_select).find_by(ref: key)&.chunk ||
+          raise(ActiveStorage::FileNotFoundError)
+      end
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        ::ActiveStorageDB::File.find_by(ref: key)&.destroy
+      end
+    end
+
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        ::ActiveStorageDB::File.where('ref LIKE ?', "#{prefix}%").destroy_all
+      end
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        answer = ::ActiveStorageDB::File.where(ref: key).exists?
+        payload[:exist] = answer
+        answer
+      end
+    end
+
+    def url(key, expires_in:, filename:, disposition:, content_type:)
+      instrument :url, key: key do |payload|
+        content_disposition = content_disposition_with(type: disposition, filename: filename)
+        verified_key_with_expiration = ActiveStorage.verifier.generate(
+          {
+            key: key,
+            disposition: content_disposition,
+            content_type: content_type
+          },
+          expires_in: expires_in,
+          purpose: :blob_key
+        )
+        current_uri = URI.parse(current_host)
+        generated_url = url_helpers.service_url(
+          verified_key_with_expiration,
+          protocol: current_uri.scheme,
+          host: current_uri.host,
+          port: current_uri.port,
+          disposition: content_disposition,
+          content_type: content_type,
+          filename: filename
+        )
+        payload[:url] = generated_url
+
+        generated_url
+      end
+    end
+
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:)
+      instrument :url, key: key do |payload|
+        verified_token_with_expiration = ActiveStorage.verifier.generate(
+          {
+            key: key,
+            content_type: content_type,
+            content_length: content_length,
+            checksum: checksum
+          },
+          expires_in: expires_in,
+          purpose: :blob_token
+        )
+        generated_url = url_helpers.update_service_url(
+          verified_token_with_expiration,
+          host: current_host
+        )
+        payload[:url] = generated_url
+
+        generated_url
+      end
+    end
+
+    def headers_for_direct_upload(_key, content_type:, **)
+      { 'Content-Type' => content_type }
+    end
+
+    private
+
+    def current_host
+      ActiveStorage::Current.host
+    end
+
+    def ensure_integrity_of(key, checksum)
+      file = ::ActiveStorageDB::File.find_by(ref: key)
+      return if Digest::MD5.base64digest(file.data) == checksum
+
+      delete(key)
+      raise ActiveStorage::IntegrityError
+    end
+
+    def stream(key)
+      size =
+        ::ActiveStorageDB::File.select('OCTET_LENGTH(data) AS size').find_by(ref: key)&.size ||
+        raise(ActiveStorage::FileNotFoundError)
+      (size / @chunk_size.to_f).ceil.times.each do |i|
+        range = (i * @chunk_size..(i + 1) * @chunk_size - 1)
+        yield download_chunk(key, range)
+      end
+    end
+
+    def url_helpers
+      @url_helpers ||= ::ActiveStorageDB::Engine.routes.url_helpers
+    end
+  end
+end

data/lib/active_storage_db.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'active_storage_db/engine'
+require 'active_storage/service/db_service'
+
+module ActiveStorageDB
+end

data/lib/active_storage_db/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ActiveStorageDB
+  class Engine < ::Rails::Engine
+    isolate_namespace ActiveStorageDB
+  end
+end

data/lib/active_storage_db/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveStorageDB
+  VERSION = '0.1.0'
+end

data/lib/tasks/active_storage_db_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# desc 'ActiveStorageDB sync'
+# task :active_storage_db do
+# end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: active_storage_db
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mattia Roccoberton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activestorage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.33.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.33.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.89.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+description: An ActiveStorage service plugin to store files in database.
+email:
+- mattiaroccoberton@nebulab.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/active_storage_db/files_controller.rb
+- app/models/active_storage_db/application_record.rb
+- app/models/active_storage_db/file.rb
+- config/initializers/inflections.rb
+- config/routes.rb
+- db/migrate/20200702202022_create_active_storage_db_files.rb
+- lib/active_storage/service/db_service.rb
+- lib/active_storage_db.rb
+- lib/active_storage_db/engine.rb
+- lib/active_storage_db/version.rb
+- lib/tasks/active_storage_db_tasks.rake
+homepage: https://blocknot.es
+licenses:
+- MIT
+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: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: ActiveStorage DB Service
+test_files: []