active_storage-postgresql 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02204d5bc6e8a8e41d30c3d38ae5308345dce145c9b80f98127dacd8c74ac3ba
-  data.tar.gz: 2e15d75e150d8d3be1634f21f7c75b6018fa6a4b75f079aa301de2a526ff3f43
+  metadata.gz: 1212a9c234be19bf6444a03c0bdf66ab92397ad4527ac9e0ce029d0440724a34
+  data.tar.gz: 7ca4cb2634cac459ee8caf886887293f69d00f989128a41d108b3023bf6ee7e0
 SHA512:
-  metadata.gz: 0f94e2258f91ef67cba241bca7936225f9f11076b307114a81df7b6f9b5d20aa7d126dd136c94d31813e045395635f3ad6de36b5f8eaf638d4b1c91d319db28a
-  data.tar.gz: c244fed09f914b4ce819577949ae12a33f80c8d4f0cee9987d3efd0952eb8a9048a52ba5aaaec959e1ef1b51d1045585313fb0ca63a1827d6684605a1853b5fe
+  metadata.gz: 6773b507eae6af885133918d77876e310b946f19221aeeea2a4b122805b852699350d86556a0b04e0dbdd3dda98def4580756e51af0bc44f2611afe45209b04d
+  data.tar.gz: 6b1617c425df194ae4bcf2b415e11fd8cb16eb76698677036a7a981188120dd71ece4a6307654a336a74d86327cb94bb7fc223347f4db973f9f9e87aff8be944

data/README.md

@@ -1,5 +1,8 @@
 # ActiveStorage::PostgreSQL
 
+[![Gem Version](https://badge.fury.io/rb/active_storage-postgresql.svg)](https://badge.fury.io/rb/active_storage-postgresql)
+[![Build Status](https://travis-ci.com/lsylvester/active_storage-postgresql.svg?branch=master)](https://travis-ci.com/lsylvester/active_storage-postgresql)
+
 ActiveStorage Service to store files PostgeSQL.
 
 Files are stored in PostgreSQL as Large Objects, which provide streaming style access.
@@ -7,13 +10,13 @@ More information about Large Objects can be found [here](https://www.postgresql.
 
 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. 
+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"
+gem 'active_storage-postgresql'
 ```
 
 And then execute:

data/app/controllers/active_storage/postgresql_controller.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Serves files stored with the disk service in the same way that the cloud services do.
+# This means using expiring, signed URLs that are meant for immediate access, not permanent linking.
+# Always go through the BlobsController, or your own authenticated controller, rather than directly
+# to the service url.
+
+class ActiveStorage::PostgresqlController < ActiveStorage::BaseController
+
+  skip_forgery_protection
+
+  def show
+    if key = decode_verified_key
+      response.headers["Content-Type"] = params[:content_type] || DEFAULT_SEND_FILE_TYPE
+      response.headers["Content-Disposition"] = params[:disposition] || DEFAULT_SEND_FILE_DISPOSITION
+      size = ActiveStorage::PostgreSQL::File.open(key[:key], &:size)
+
+      ranges = Rack::Utils.get_byte_ranges(request.get_header('HTTP_RANGE'), size)
+
+      if ranges.nil? || ranges.length > 1
+        # # No ranges, or multiple ranges (which we don't support):
+        # # TODO: Support multiple byte-ranges
+        self.status = :ok
+        range = 0..size-1
+
+      elsif ranges.empty?
+        head 416, content_range: "bytes */#{size}"
+        return
+      else
+        range = ranges[0]
+        self.status = :partial_content
+        response.headers["Content-Range"] = "bytes #{range.begin}-#{range.end}/#{size}"
+      end
+      self.response_body = postgresql_service.download_chunk(key[:key], range)
+    else
+      head :not_found
+    end
+  rescue ActiveRecord::RecordNotFound
+    head :not_found
+  end
+
+  def update
+    if token = decode_verified_token
+      if acceptable_content?(token)
+        postgresql_service.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
+
+  private
+    def postgresql_service
+      ActiveStorage::Blob.service
+    end
+
+
+    def decode_verified_key
+      ActiveStorage.verifier.verified(params[:encoded_key], purpose: :blob_key)
+    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

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  get  "/rails/active_storage/postgresql/:encoded_key/*filename" => "active_storage/postgresql#show", as: :rails_postgresql_service
+  put  "/rails/active_storage/postgresql/:encoded_token" => "active_storage/postgresql#update", as: :update_rails_postgresql_service
+end

data/lib/active_storage/postgresql/file.rb

@@ -1,8 +1,31 @@
 class ActiveStorage::PostgreSQL::File < ActiveRecord::Base
   self.table_name = "active_storage_postgresql_files"
 
-  before_create do
-    self.oid ||= lo_creat
+  attribute :oid, :integer, default: ->{ connection.raw_connection.lo_creat }
+  attr_accessor :checksum, :io
+  attr_writer :digest
+
+  def digest
+    @digest ||= Digest::MD5.new
+  end
+
+  before_create :write_or_import, if: :io
+  before_create :verify_checksum, if: :checksum
+
+  def write_or_import
+    if io.respond_to?(:to_path)
+      import(io.to_path)
+    else
+      open(::PG::INV_WRITE) do |file|
+        while data = io.read(5.megabytes)
+          write(data)
+        end
+      end
+    end
+  end
+
+  def verify_checksum
+    raise ActiveStorage::IntegrityError unless digest.base64digest == checksum
   end
 
   def self.open(key, &block)
@@ -22,34 +45,40 @@ class ActiveStorage::PostgreSQL::File < ActiveRecord::Base
 
   def write(content)
     lo_write(@lo, content)
+    digest.update(content)
   end
 
   def read(bytes=size)
     lo_read(@lo, bytes)
   end
 
-  def seek(position)
-    lo_seek(@lo, position, 0)
+  def seek(position, whence=PG::SEEK_SET)
+    lo_seek(@lo, position, whence)
   end
 
   def import(path)
-    transaction do
-      self.oid = lo_import(path)
-    end
+    self.oid = lo_import(path)
+    self.digest = Digest::MD5.file(path)
+  end
+
+  def tell
+    lo_tell(@lo)
   end
 
   def size
-    current_position = lo_tell(@lo)
-    lo_seek(@lo, 0,2)
-    lo_tell(@lo).tap do
-      lo_seek(@lo, current_position,0)
+    current_position = tell
+    seek(0, PG::SEEK_END)
+    tell.tap do
+      seek(current_position)
     end
   end
 
-  before_destroy do
-    self.class.connection.raw_connection.lo_unlink(oid)
+  def unlink
+    lo_unlink(oid)
   end
 
+  before_destroy :unlink
+
   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'
 

data/lib/active_storage/postgresql/version.rb

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

data/lib/active_storage/service/postgresql_service.rb

@@ -6,36 +6,13 @@ 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)
+    def initialize(public: false, **options)
+      @public = public
     end
 
-    def upload(key, io, checksum: nil)
+    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
+        ActiveStorage::PostgreSQL::File.create!(key: key, io: io, checksum: checksum)
       end
     end
 
@@ -86,26 +63,50 @@ module ActiveStorage
       end
     end
 
-    def url(key, expires_in:, filename:, disposition:, content_type:)
+    def private_url(key, expires_in:, filename:, content_type:, disposition:, **)
+      generate_url(key, expires_in: expires_in, filename: filename, content_type: content_type, disposition: disposition)
+    end
+
+    def public_url(key, filename:, content_type: nil, disposition: :attachment, **)
+      generate_url(key, expires_in: nil, filename: filename, content_type: content_type, disposition: disposition)
+    end
+
+    def url(key, **options)
+      super
+    rescue NotImplementedError, ArgumentError
+      if @public
+        public_url(key, **options)
+      else
+        private_url(key, **options)
+      end
+    end
+
+    def generate_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_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
+        )
 
+        generated_url = url_helpers.rails_postgresql_service_url(verified_key_with_expiration,
+          **url_options,
+          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:)
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
       instrument :url, key: key do |payload|
         verified_token_with_expiration = ActiveStorage.verifier.generate(
           {
@@ -114,11 +115,11 @@ module ActiveStorage
             content_length: content_length,
             checksum: checksum
           },
-          { expires_in: expires_in,
-          purpose: :blob_token }
+          expires_in: expires_in,
+          purpose: :blob_token
         )
 
-        generated_url = url_helpers.update_rails_disk_service_url(verified_token_with_expiration, host: current_host)
+        generated_url = url_helpers.update_rails_postgresql_service_url(verified_token_with_expiration, **url_options)
 
         payload[:url] = generated_url
 
@@ -136,8 +137,12 @@ module ActiveStorage
       @url_helpers ||= Rails.application.routes.url_helpers
     end
 
-    def current_host
-      ActiveStorage::Current.host
+    def url_options
+      if ActiveStorage::Current.respond_to?(:url_options)
+        ActiveStorage::Current.url_options
+      else
+        { host: ActiveStorage::Current.host }
+      end
     end
   end
 end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: active_storage-postgresql
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Lachlan Sylvester
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2022-01-25 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'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !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
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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:
 - lachlan.sylvester@hypothetical.com.au
@@ -76,6 +90,8 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/controllers/active_storage/postgresql_controller.rb
+- config/routes.rb
 - db/migrate/20180530020601_create_active_storage_postgresql_tables.rb
 - lib/active_storage/postgresql.rb
 - lib/active_storage/postgresql/engine.rb
@@ -103,8 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: PostgreSQL Adapter for Active Storage