active_storage-postgresql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 02204d5bc6e8a8e41d30c3d38ae5308345dce145c9b80f98127dacd8c74ac3ba
+  data.tar.gz: 2e15d75e150d8d3be1634f21f7c75b6018fa6a4b75f079aa301de2a526ff3f43
+SHA512:
+  metadata.gz: 0f94e2258f91ef67cba241bca7936225f9f11076b307114a81df7b6f9b5d20aa7d126dd136c94d31813e045395635f3ad6de36b5f8eaf638d4b1c91d319db28a
+  data.tar.gz: c244fed09f914b4ce819577949ae12a33f80c8d4f0cee9987d3efd0952eb8a9048a52ba5aaaec959e1ef1b51d1045585313fb0ca63a1827d6684605a1853b5fe

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Lachlan Sylvester
+
+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,51 @@
+# ActiveStorage::PostgreSQL
+
+ActiveStorage Service to store files PostgeSQL.
+
+Files are stored in PostgreSQL as Large Objects, which provide streaming style access.
+More information about Large Objects can be found [here](https://www.postgresql.org/docs/current/static/largeobjects.html).
+
+This allows use of ActiveStorage on hosting platforms with ephemeral file systems such as Heroku without relying on third party storage services.
+
+There are [some limits](https://dba.stackexchange.com/questions/127270/what-are-the-limits-of-postgresqls-large-object-facility) to the storage of Large Objects in PostgerSQL, so this is only recommended for prototyping and very small sites. 
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_storage-postgresql', git: "https://github.com/lsylvester/active_storage-postgresql"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+In config/storage.yml set PostgreSQL as the service
+
+```yaml
+local:
+  service: PostgreSQL
+```
+
+Copy over the migrations:
+
+```
+rails active_storage:install
+rails active_storage:postgresql:install
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lsylvester/active_storage-postgresql. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Acknowledgments
+
+Special thanks to [diogob](https://github.com/diogob) whos work on  [carrierwave-postgresql](https://github.com/diogob/carrierwave-postgresql) inspired this.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveStorage::PostgreSQL project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/lsylvester/active_storage-postgresql/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'Activestorage::PostgreSQL'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+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/db/migrate/20180530020601_create_active_storage_postgresql_tables.rb

@@ -0,0 +1,10 @@
+class CreateActiveStoragePostgresqlTables < ActiveRecord::Migration[5.2]
+  def change
+    create_table :active_storage_postgresql_files do |t|
+      t.oid :oid
+      t.string :key
+
+      t.index :key, unique: true
+    end
+  end
+end

data/lib/active_storage/postgresql.rb

@@ -0,0 +1,7 @@
+require "active_storage/postgresql/engine"
+
+module ActiveStorage
+  module PostgreSQL
+    # Your code goes here...
+  end
+end

data/lib/active_storage/postgresql/engine.rb

@@ -0,0 +1,9 @@
+module ActiveStorage
+  module PostgreSQL
+    class Engine < ::Rails::Engine
+      isolate_namespace ActiveStorage::PostgreSQL
+
+      railtie_name 'active_storage_postgresql'
+    end
+  end
+end

data/lib/active_storage/postgresql/file.rb

@@ -0,0 +1,58 @@
+class ActiveStorage::PostgreSQL::File < ActiveRecord::Base
+  self.table_name = "active_storage_postgresql_files"
+
+  before_create do
+    self.oid ||= lo_creat
+  end
+
+  def self.open(key, &block)
+    find_by!(key: key).open(&block)
+  end
+
+  def open(*args)
+    transaction do
+      begin
+        @lo = lo_open(oid, *args)
+        yield(self)
+      ensure
+        lo_close(@lo) if @lo
+      end
+    end
+  end
+
+  def write(content)
+    lo_write(@lo, content)
+  end
+
+  def read(bytes=size)
+    lo_read(@lo, bytes)
+  end
+
+  def seek(position)
+    lo_seek(@lo, position, 0)
+  end
+
+  def import(path)
+    transaction do
+      self.oid = lo_import(path)
+    end
+  end
+
+  def size
+    current_position = lo_tell(@lo)
+    lo_seek(@lo, 0,2)
+    lo_tell(@lo).tap do
+      lo_seek(@lo, current_position,0)
+    end
+  end
+
+  before_destroy do
+    self.class.connection.raw_connection.lo_unlink(oid)
+  end
+
+  delegate :lo_seek, :lo_tell, :lo_import, :lo_read, :lo_write, :lo_open,
+      :lo_unlink, :lo_close, :lo_creat, to: 'self.class.connection.raw_connection'
+
+  scope :prefixed_with, -> prefix { where("key like ?", "#{prefix}%") }
+
+end

data/lib/active_storage/postgresql/version.rb

@@ -0,0 +1,5 @@
+module ActiveStorage
+  module PostgreSQL
+    VERSION = '0.1.0'
+  end
+end

data/lib/active_storage/service/postgre_sql_service.rb

@@ -0,0 +1 @@
+require 'active_storage/service/postgresql_service'

data/lib/active_storage/service/postgresql_service.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+require 'active_storage/postgresql/file'
+
+module ActiveStorage
+  # Wraps a PostgreSQL database as an Active Storage service. See ActiveStorage::Service for the generic API
+  # documentation that applies to all services.
+  class Service::PostgreSQLService < Service
+    def initialize(**options)
+    end
+
+    def upload(key, io, checksum: nil)
+      instrument :upload, key: key, checksum: checksum do
+        if io.respond_to?(:to_path)
+          ActiveStorage::PostgreSQL::File.create!(key: key) do |file|
+            file.import(io.to_path)
+          end
+          if checksum
+            unless Digest::MD5.file(io.to_path).base64digest == checksum
+              delete key
+              raise ActiveStorage::IntegrityError
+            end
+          end
+        else
+          md5 = Digest::MD5.new
+          ActiveStorage::PostgreSQL::File.create!(key: key).open(::PG::INV_WRITE) do |file|
+            while data = io.read(5.megabytes)
+              md5.update(data)
+              file.write(data)
+            end
+          end
+          if checksum
+            unless md5.base64digest == checksum
+              delete key
+              raise ActiveStorage::IntegrityError
+            end
+          end
+        end
+      end
+    end
+
+    def download(key)
+      if block_given?
+        instrument :streaming_download, key: key do
+          ActiveStorage::PostgreSQL::File.open(key) do |file|
+            while data = file.read(5.megabytes)
+              yield data
+            end
+          end
+        end
+      else
+        instrument :download, key: key do
+          ActiveStorage::PostgreSQL::File.open(key) do |file|
+            file.read
+          end
+        end
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        ActiveStorage::PostgreSQL::File.open(key) do |file|
+          file.seek(range.first)
+          file.read(range.size)
+        end
+      end
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        ActiveStorage::PostgreSQL::File.find_by(key: key).try(&:destroy)
+      end
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        answer = ActiveStorage::PostgreSQL::File.where(key: key).exists?
+        payload[:exist] = answer
+        answer
+      end
+    end
+
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        ActiveStorage::PostgreSQL::File.prefixed_with(prefix).destroy_all
+      end
+    end
+
+    def url(key, expires_in:, filename:, disposition:, content_type:)
+      instrument :url, key: key do |payload|
+        verified_key_with_expiration = ActiveStorage.verifier.generate(key, expires_in: expires_in, purpose: :blob_key)
+
+        generated_url =
+          url_helpers.rails_disk_service_url(
+            verified_key_with_expiration,
+            host: current_host,
+            filename: filename,
+            disposition: content_disposition_with(type: disposition, filename: filename),
+            content_type: content_type
+          )
+
+        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_rails_disk_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
+
+    protected
+
+    def url_helpers
+      @url_helpers ||= Rails.application.routes.url_helpers
+    end
+
+    def current_host
+      ActiveStorage::Current.host
+    end
+  end
+end

data/lib/tasks/active_storage/postgresql_tasks.rake

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+namespace :active_storage do
+  namespace :postgresql do
+    desc "Copy over the migration needed to the application"
+    task install: :environment do
+      if Rake::Task.task_defined?("active_storage_postgresql:install:migrations")
+        Rake::Task["active_storage_postgresql:install:migrations"].invoke
+      else
+        Rake::Task["app:active_storage_postgresql:install:migrations"].invoke
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: active_storage-postgresql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lachlan Sylvester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: 
+email:
+- lachlan.sylvester@hypothetical.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- db/migrate/20180530020601_create_active_storage_postgresql_tables.rb
+- lib/active_storage/postgresql.rb
+- lib/active_storage/postgresql/engine.rb
+- lib/active_storage/postgresql/file.rb
+- lib/active_storage/postgresql/version.rb
+- lib/active_storage/service/postgre_sql_service.rb
+- lib/active_storage/service/postgresql_service.rb
+- lib/tasks/active_storage/postgresql_tasks.rake
+homepage: https://github.com/lsylvester/active_storage-postgresql
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: PostgreSQL Adapter for Active Storage
+test_files: []