activestorage-openstack 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 679f589974232f4e10a8668beca5099273e6f5a1f2595eb2f4d3298cef4a4dcf
-  data.tar.gz: b67c2107534d6208a65b867e98559738ce2bb8ec32854f0b1582f33cf9d03929
+  metadata.gz: 983a4b66788932c6fa1e5af33b72ba32385e5b2e9b3664e353d6a8bdc30ea70a
+  data.tar.gz: 54a1176eb547289bd43dd8510cdc235c9e257cb2a208024744e9651b54ac2df4
 SHA512:
-  metadata.gz: bdc68784986e569e426386d2f9da663766ea9b0ab56b577d85fb9d1fbb4094f322a361017900b51b9886c6d5e2b29fd1cddf35cc218f182b4344cff5e62ae45f
-  data.tar.gz: f27590fc1462ed17c7681032dbc84734ce7a98b65fa839bd9e2a843d7dab390949f8c680d75d32076b9fac3e1d0a1c0f7d782c3db31e380ffa85977e216b7e4a
+  metadata.gz: d0653477a4bae7e3d31cc81400c440906939a574e3ad6e07cbd545fe9c9574edd08cff487b8071d5cba9f103691069cd17ac7f65eef6b76ae510a47c7e4dd024
+  data.tar.gz: 2f4c2d22fb3f5087870b44a2348c2a8bd8dcda8d373f690202a642670fd37f543f5869b2a629fe649f2a401de7691424865f50d6af0dc1856f5efc544a33acee

data/README.md

@@ -57,6 +57,12 @@ the `openstack_temp_url_key` in your configuration is mandatory for generating U
 
 The next version of this plugin, will add a rails generator, or expose a method that would use the built-in method from `Fog::OpenStack::Real` to generate the key.
 
+## `ActiveStorage::Openstack`'s Content-Type handling
+
+OpenStack Swift handles the Content-Type of an object differently from other object storage services. You cannot overwrite the Content-Type via a temp URL. This gem will try very hard to set the right Content-Type for an object at object creation (either via server upload or direct upload) but this is wrong in some edge cases (e.g. you use direct upload and the browser provides a wrong mime type).
+
+For these edge cases `ActiveStorage::Blob::Identifiable` downloads the first 4K of a file, identifies the content type and saves the result in the database. For `ActiveStorage::Openstack` we also need to update the Content-Type of the object. This is done automatically with a little monkey patch.
+
 ## Testing
 First, run `bundle` to install the gem dependencies (both development and production)
 ```bash

data/lib/active_storage/openstack/railtie.rb

@@ -1,6 +1,18 @@
 module ActiveStorage
   module Openstack
     class Railtie < ::Rails::Railtie
+      initializer "active_storage_openstack.blob" do
+        ActiveSupport.on_load(:active_storage_blob) do |klass|
+          klass.after_commit do |blob|
+            # overwrite content type if identification run and
+            # the service responds to change_content_type
+            if blob.identified? && !blob.content_type.blank? &&
+               blob.service.respond_to?(:change_content_type)
+              blob.service.change_content_type(blob.key, blob.content_type)
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/active_storage/openstack/version.rb

@@ -1,5 +1,5 @@
 module ActiveStorage
   module Openstack
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/active_storage/service/open_stack_service.rb

@@ -16,7 +16,10 @@ module ActiveStorage
 
     def upload(key, io, checksum: nil)
       instrument :upload, key: key, checksum: checksum do
-        params = {}.merge(etag: convert_base64digest_to_hexdigest(checksum))
+        params = {
+          'Content-Type' => guess_content_type(io),
+          'ETag' => convert_base64digest_to_hexdigest(checksum)
+        }
         begin
           client.put_object(container, key, io, params)
         rescue Excon::Error::UnprocessableEntity
@@ -28,7 +31,7 @@ module ActiveStorage
     def download(key, &block)
       if block_given?
         instrument :streaming_download, key: key do
-          object_for(key, &block).body
+          object_for(key, &block)
         end
       else
         instrument :download, key: key do
@@ -39,17 +42,21 @@ module ActiveStorage
 
     def download_chunk(key, range)
       instrument :download_chunk, key: key, range: range do
-        object_for(key).body[range]
+        chunk_buffer = []
+
+        object_for(key) do |chunk|
+          chunk_buffer << chunk
+        end
+
+        chunk_buffer.join[range]
       end
     end
 
     def delete(key)
       instrument :delete, key: key do
-        begin
-          client.delete_object(container, key)
-        rescue Fog::Storage::OpenStack::NotFound
-          false
-        end
+        client.delete_object(container, key)
+      rescue Fog::Storage::OpenStack::NotFound
+        false
       end
     end
 
@@ -65,31 +72,28 @@ module ActiveStorage
 
     def exist?(key)
       instrument :exist, key: key do |payload|
-        begin
-          answer = object_for(key)
-          payload[:exist] = answer
-        rescue Fog::Storage::OpenStack::NotFound
-          payload[:exist] = false
-        end
+        answer = object_for(key)
+        payload[:exist] = answer.present?
+      rescue Fog::Storage::OpenStack::NotFound
+        payload[:exist] = false
       end
     end
 
-    def url(key, expires_in:, disposition:, filename:, content_type:)
+    def url(key, expires_in:, disposition:, filename:, **)
       instrument :url, key: key do |payload|
         expire_at = unix_timestamp_expires_at(expires_in)
-        generated_url = client.get_object_https_url(container,
-                                                    key,
-                                                    expire_at,
-                                                    disposition: disposition,
-                                                    filename: filename,
-                                                    content_type: content_type)
+        generated_url = client.get_object_https_url(container, key, expire_at)
+        generated_url += '&inline' if disposition.to_s != 'attachment'
+        generated_url += "&filename=#{Fog::OpenStack.escape(filename.to_s)}" unless filename.nil?
+        # unfortunately OpenStack Swift cannot overwrite the content type of an object via a temp url
+        # so we just ignore the content_type argument here
         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:, **)
       instrument :url, key: key do |payload|
         expire_at = unix_timestamp_expires_at(expires_in)
         generated_url = client.create_temp_url(container,
@@ -97,10 +101,7 @@ module ActiveStorage
                                                expire_at,
                                                'PUT',
                                                port: 443,
-                                               scheme: "https",
-                                               content_type: content_type,
-                                               content_length: content_length,
-                                               etag: convert_base64digest_to_hexdigest(checksum))
+                                               scheme: 'https')
 
         payload[:url] = generated_url
 
@@ -108,24 +109,33 @@ module ActiveStorage
       end
     end
 
-    def headers_for_direct_upload(key, content_type:, content_length:, checksum:)
+    def headers_for_direct_upload(_key, content_type:, checksum:, **)
       {
         'Content-Type' => content_type,
-        'Etag' => convert_base64digest_to_hexdigest(checksum),
-        'Content-Length' => content_length
+        'ETag' => convert_base64digest_to_hexdigest(checksum)
       }
     end
 
-    private
+    # Non-standard method to change the content type of an existing object
+    def change_content_type(key, content_type)
+      client.post_object(container,
+                         key,
+                         'Content-Type' => content_type)
+      true
+    rescue Fog::Storage::OpenStack::NotFound
+      false
+    end
+
+  private
 
     def object_for(key, &block)
       client.get_object(container, key, &block)
     end
 
     # ActiveStorage sends a `Digest::MD5.base64digest` checksum
-    # OpenStack expects a `Digest::MD5.hexdigest` Etag
+    # OpenStack expects a `Digest::MD5.hexdigest` ETag
     def convert_base64digest_to_hexdigest(base64digest)
-      base64digest.unpack('m0').first.unpack('H*').first if base64digest
+      base64digest&.unpack1('m0')&.unpack1('H*')
     end
 
     def unix_timestamp_expires_at(seconds_from_now)
@@ -136,6 +146,10 @@ module ActiveStorage
       " bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}"
     end
 
-
+    def guess_content_type(io)
+      Marcel::MimeType.for io,
+                           name: io.try(:original_filename),
+                           declared_type: io.try(:content_type)
+    end
   end
 end

data/lib/activestorage-openstack.rb

@@ -0,0 +1,2 @@
+require "active_storage/openstack/version"
+require "active_storage/openstack/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-openstack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chedli Bourguiba
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-23 00:00:00.000000000 Z
+date: 2018-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-openstack
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: marcel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -76,10 +90,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/active_storage/openstack.rb
 - lib/active_storage/openstack/railtie.rb
 - lib/active_storage/openstack/version.rb
 - lib/active_storage/service/open_stack_service.rb
+- lib/activestorage-openstack.rb
 - lib/tasks/activestorage/openstack_tasks.rake
 homepage: https://github.com/chaadow/activestorage-openstack
 licenses:

data/lib/active_storage/openstack.rb

@@ -1,7 +0,0 @@
-require "active_storage/openstack/railtie"
-
-module ActiveStorage
-  module Openstack
-    # Your code goes here...
-  end
-end