activestorage-openstack 1.4.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f68dff9e3fe5b903629fd687a0597303d5e8d4d0d89e9854cbb6c7e0804e95ae
-  data.tar.gz: ea0b21d646385009d55e8a663d3ebf2621757078fa381f84c234dbbfba646d98
+  metadata.gz: 43f1f0f286ce5f4af4fbaf238a64ed7a1bce8cd2913308704f06240b85d0857a
+  data.tar.gz: 26bec142d446126347874a9aa08a35d4bf2a7d9658ae91c86772dc8848e52043
 SHA512:
-  metadata.gz: e94402316fc53986b02519dd98c4c7b1bc2df8704f63366816c19a231ee7d4ecf79fd798f0fce62b4b0e6b9b464b79ee0a260d19669228cab04b96009dc03030
-  data.tar.gz: ac46642d66e201967f32a89f6b22b28d89c6f627f42e6896c52f2c2028881b9e9c40256edad2b0d3d5a5566e407ba8af46c5aa2558127d19fabe14320ce14358
+  metadata.gz: 14a8c709f352ee499ae0897c60d4fecd2c4f3e127a3c8c942a47698170f20f883a2a5ce0d1f4d0f82baaee19eea2bf75c4360c5c3a88c58a6a3f7c0a65e81786
+  data.tar.gz: 7955689218deaff559a3ab46e6357206c7b6d0fc87d23a05c805e0613d73c52b06fbdfd8e2aca4c6ae16b62c07e085ce5955310aefc5e9399ef9859050212225

data/README.md

@@ -5,8 +5,6 @@ This rails plugin wraps the OpenStack Swift provider as an Active Storage servic
 [![Build Status](https://travis-ci.com/chaadow/activestorage-openstack.svg?branch=master)](https://travis-ci.com/chaadow/activestorage-openstack)
 [![Maintainability](https://api.codeclimate.com/v1/badges/4c070c101f86a579516f/maintainability)](https://codeclimate.com/github/chaadow/activestorage-openstack/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/4c070c101f86a579516f/test_coverage)](https://codeclimate.com/github/chaadow/activestorage-openstack/test_coverage)
-
-
 Starting from version `0.4`, this gem enforces version `>= 0.2.2` of `fog-openstack` which introduces breaking changes to the configuration keys in `config/storage.yml`. Please read the [MIGRATING from `0.1.x` to `0.2.x`](#migrating-from-fog-openstack-01x-to-02x) section
 
 **This gem currently supports `fog-openstack` version `~ 1.0`**
@@ -29,11 +27,15 @@ $ gem install activestorage-openstack
 ```
 
 ## Usage
-in `config/storage.yml`, in your Rails app, create an entry with the following keys:
+in `config/storage.yml`, in your Rails app, you can create as many entries as
+you wish. Here is an example with rails 6.1 new support for public containers
+
 ```yaml
-dev_openstack:
+
+# Here you can have the common authentication credentials and config
+# by defining a YAML anchor
+default_config: &default_config
   service: OpenStack
-  container: <container name> # Container name for your OpenStack provider
   credentials:
     openstack_auth_url: <auth url>
     openstack_username: <username>
@@ -42,19 +44,32 @@ dev_openstack:
     openstack_temp_url_key: <temp url key> # Mandatory, instructions below
   connection_options: # optional
     chunk_size: 2097152 # 2MBs - 1MB is the default
+
+# starting from rails 6.1, you can have a public container generating public
+# URLs
+public_openstack:
+  <<: *default_config # we include the anchor defined above
+  public: true # important ; to tell rails that this is a public container
+  container: <container name> # Container name for your public OpenStack provider
+
+# this config will generate signed/expired URLs (aka. private URLs)
+private_openstack:
+  <<: *default_config # we include the anchor defined above
+  public: false # Optional in this case, because false is the default value
+  container: <container name> # Container name for your private OpenStack provider
 ```
 
-You can create as many entries as you would like for your different environments. For instance: `dev_openstack` for development, `test_openstack` for test environment, and `prod_openstack` for production. This way you can choose the appropriate container for each scenario.
+You can create as many entries as you would like for your different environments. For instance: `public_openstack` for development, `test_openstack` for test environment, and `prod_openstack` for production. This way you can choose the appropriate container for each scenario.
 
 Then register the provider in your `config/{environment}.rb` (`config/development.rb`/`config/test.rb`/`config/production.rb`)
 
-For example, for the `dev_openstack` entry above, change the `config` variable in `config/development.rb` like the following:
+For example, for the `public_openstack` entry above, change the `config` variable in `config/development.rb` like the following:
 ```ruby
 # Store uploaded files on the local file system (see config/storage.yml for options)
-config.active_storage.service = :dev_openstack
+config.active_storage.service = :public_openstack
 ```
 
-## Migrating from fog-openstack `0.1.x` to `0.2.x`
+## Migrating from fog-openstack `~> 0.1.x` to `>= 0.2.x`
 
 1- From your configuration file (`config/storage.yml`) change the `openstack_auth_uri` from :
 ```yaml
@@ -89,9 +104,16 @@ The next version of this plugin, will add a rails generator, or expose a method
 
 ## `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.
+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 can be
+wrong in some edge cases (e.g. you use direct upload and the browser provides
+a wrong mime type).
+Thankfully, by implementing the rails hook `#update_metadata`
+this will update the object in your container by setting the new content type
+after it's been uploaded.
 
 ## Testing
 First, run `bundle` to install the gem dependencies (both development and production)

data/lib/active_storage/openstack/version.rb

@@ -1,5 +1,5 @@
 module ActiveStorage
   module Openstack
-    VERSION = '1.4.1'
+    VERSION = '1.5.2'
   end
 end

data/lib/active_storage/service/open_stack_service.rb

@@ -1,166 +1,191 @@
+# frozen_string_literal: true
+
 require 'fog/openstack'
 
 module ActiveStorage
-  class Service::OpenStackService < Service
-    attr_reader :client, :container
-
-    def initialize(container:, credentials:, connection_options: {})
-      settings = credentials.reverse_merge(connection_options: connection_options)
+  class Service
+    # ActiveStorage provider for OpenStack
+    class OpenStackService < Service
+      attr_reader :settings, :container
 
-      @client = Fog::OpenStack::Storage.new(settings)
-      @container = Fog::OpenStack.escape(container)
-    end
+      def initialize(container:, credentials:, public: false, connection_options: {})
+        super()
+        @settings = credentials.reverse_merge(connection_options: connection_options)
 
-    def upload(key, io, checksum: nil, disposition: nil, content_type: nil, filename: nil, **)
-      instrument :upload, key: key, checksum: checksum do
-        params = { 'Content-Type' => content_type || guess_content_type(io) }
-        params['ETag'] = convert_base64digest_to_hexdigest(checksum) if checksum
-        if disposition && filename
-          params['Content-Disposition'] =
-            content_disposition_with(type: disposition, filename: filename)
-        end
+        @public = public
+        @container = Fog::OpenStack.escape(container)
+      end
 
-        begin
-          client.put_object(container, key, io, params)
-        rescue Excon::Error::UnprocessableEntity
-          raise ActiveStorage::IntegrityError
+      def upload(key, io, checksum: nil, disposition: nil, content_type: nil, filename: nil, **)
+        instrument :upload, key: key, checksum: checksum do
+          params = { 'Content-Type' => content_type || guess_content_type(io) }
+          params['ETag'] = convert_base64digest_to_hexdigest(checksum) if checksum
+          if disposition && filename
+            params['Content-Disposition'] =
+              content_disposition_with(type: disposition, filename: filename)
+          end
+
+          begin
+            client.put_object(container, key, io, params)
+          rescue Excon::Error::UnprocessableEntity
+            raise ActiveStorage::IntegrityError
+          end
         end
       end
-    end
 
-    def download(key, &block)
-      if block_given?
-        instrument :streaming_download, key: key do
-          object_for(key, &block)
-        end
-      else
-        instrument :download, key: key do
-          object_for(key).body
+      def download(key, &block)
+        if block_given?
+          instrument :streaming_download, key: key do
+            object_for(key, &block)
+          end
+        else
+          instrument :download, key: key do
+            object_for(key).body
+          end
         end
+      rescue Fog::OpenStack::Storage::NotFound
+        raise ActiveStorage::FileNotFoundError if defined?(ActiveStorage::FileNotFoundError)
       end
-    rescue Fog::OpenStack::Storage::NotFound
-      raise ActiveStorage::FileNotFoundError if defined?(ActiveStorage::FileNotFoundError)
-    end
 
-    def download_chunk(key, range)
-      instrument :download_chunk, key: key, range: range do
-        chunk_buffer = []
+      def download_chunk(key, range)
+        instrument :download_chunk, key: key, range: range do
+          chunk_buffer = []
 
-        object_for(key) do |chunk|
-          chunk_buffer << chunk
-        end
+          object_for(key) do |chunk|
+            chunk_buffer << chunk
+          end
 
-        chunk_buffer.join[range]
-      rescue Fog::OpenStack::Storage::NotFound
-        raise ActiveStorage::FileNotFoundError if defined?(ActiveStorage::FileNotFoundError)
+          chunk_buffer.join[range]
+        rescue Fog::OpenStack::Storage::NotFound
+          raise ActiveStorage::FileNotFoundError if defined?(ActiveStorage::FileNotFoundError)
+        end
       end
-    end
 
-    def delete(key)
-      instrument :delete, key: key do
-        client.delete_object(container, key)
-      rescue Fog::OpenStack::Storage::NotFound
-        false
+      def delete(key)
+        instrument :delete, key: key do
+          client.delete_object(container, key)
+        rescue Fog::OpenStack::Storage::NotFound
+          false
+        end
       end
-    end
 
-    def delete_prefixed(prefix)
-      instrument :delete, prefix: prefix do
-        directory = client.directories.get(container)
-        filtered_files = client.files(directory: directory, prefix: prefix)
-        filtered_files = filtered_files.map(&:key)
+      def delete_prefixed(prefix)
+        instrument :delete, prefix: prefix do
+          directory = client.directories.get(container)
+          filtered_files = client.files(directory: directory, prefix: prefix)
+          filtered_files = filtered_files.map(&:key)
 
-        client.delete_multiple_objects(container, filtered_files)
+          client.delete_multiple_objects(container, filtered_files)
+        end
       end
-    end
 
-    def exist?(key)
-      instrument :exist, key: key do |payload|
-        answer = object_for(key)
-        payload[:exist] = answer.present?
-      rescue Fog::OpenStack::Storage::NotFound
-        payload[:exist] = false
+      def exist?(key)
+        instrument :exist, key: key do |payload|
+          answer = head_for(key)
+          payload[:exist] = answer.present?
+        rescue Fog::OpenStack::Storage::NotFound
+          payload[:exist] = false
+        end
       end
-    end
 
-    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(
+      def url(key, **options)
+        if ActiveStorage.version < Gem::Version.new('6.1-alpha')
+          instrument :url, key: key do |payload|
+            private_url(key, **options).tap do |generated_url|
+              payload[:url] = generated_url
+            end
+          end
+        else
+          super
+        end
+      end
+
+      def url_for_direct_upload(key, expires_in:, filename: nil, **)
+        instrument :url, key: key do |payload|
+          expire_at = unix_timestamp_expires_at(expires_in)
+          generated_url = client.create_temp_url(
             container,
             key,
             expire_at,
-            filename: filename
+            'PUT',
+            port: 443,
+            **(filename ? { filename: ActiveStorage::Filename.wrap(filename).to_s } : {}),
+            scheme: 'https'
           )
-        generated_url += '&inline' if disposition.to_s != 'attachment'
-        # 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
+          payload[:url] = generated_url
+
+          generated_url
+        end
       end
-    end
 
-    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,
-                                               key,
-                                               expire_at,
-                                               'PUT',
-                                               port: 443,
-                                               scheme: 'https')
+      def headers_for_direct_upload(_key, content_type:, checksum:, **)
+        {
+          'Content-Type' => content_type,
+          'ETag' => convert_base64digest_to_hexdigest(checksum)
+        }
+      end
 
-        payload[:url] = generated_url
+      def update_metadata(key, content_type:, disposition: nil, filename: nil, **)
+        instrument :update_metadata, key: key, content_type: content_type, disposition: disposition do
+          params = { 'Content-Type' => content_type }
+          if disposition && filename
+            params['Content-Disposition'] =
+              content_disposition_with(
+                type: disposition,
+                filename: ActiveStorage::Filename.wrap(filename)
+              )
+          end
+          client.post_object(container, key, params)
+          true
+        rescue Fog::OpenStack::Storage::NotFound
+          raise ActiveStorage::FileNotFoundError if defined?(ActiveStorage::FileNotFoundError)
+        end
+      end
 
-        generated_url
+      private
+
+      def client
+        @client ||= Fog::OpenStack::Storage.new(settings)
       end
-    end
 
-    def headers_for_direct_upload(_key, content_type:, checksum:, **)
-      {
-        'Content-Type' => content_type,
-        'ETag' => convert_base64digest_to_hexdigest(checksum)
-      }
-    end
+      def head_for(key)
+        client.head_object(container, key)
+      end
 
-    def update_metadata(key, content_type:, disposition: nil, filename: nil, **)
-      instrument :update_metadata, key: key, content_type: content_type, disposition: disposition do
-        params = { 'Content-Type' => content_type }
-        if disposition && filename
-          params['Content-Disposition'] =
-            content_disposition_with(type: disposition, filename: ActiveStorage::Filename.wrap(filename))
-        end
-        client.post_object(container,
-                           key,
-                           params)
-        true
-      rescue Fog::OpenStack::Storage::NotFound
-        raise ActiveStorage::FileNotFoundError if defined?(ActiveStorage::FileNotFoundError)
+      def object_for(key, &block)
+        client.get_object(container, key, &block)
       end
-    end
 
-  private
+      # ActiveStorage sends a `Digest::MD5.base64digest` checksum
+      # OpenStack expects a `Digest::MD5.hexdigest` ETag
+      def convert_base64digest_to_hexdigest(base64digest)
+        base64digest.unpack1('m0').unpack1('H*')
+      end
 
-    def object_for(key, &block)
-      client.get_object(container, key, &block)
-    end
+      def unix_timestamp_expires_at(seconds_from_now)
+        Time.current.advance(seconds: seconds_from_now).to_i
+      end
 
-    # ActiveStorage sends a `Digest::MD5.base64digest` checksum
-    # OpenStack expects a `Digest::MD5.hexdigest` ETag
-    def convert_base64digest_to_hexdigest(base64digest)
-      base64digest.unpack1('m0').unpack1('H*')
-    end
+      def guess_content_type(io)
+        Marcel::MimeType.for io,
+                             name: io.try(:original_filename),
+                             declared_type: io.try(:content_type)
+      end
 
-    def unix_timestamp_expires_at(seconds_from_now)
-      Time.current.advance(seconds: seconds_from_now).to_i
-    end
+      def private_url(key, expires_in:, filename:, disposition:, **)
+        expire_at = unix_timestamp_expires_at(expires_in)
+        generated_url = client.get_object_https_url(container, key, expire_at, filename: filename.sanitized)
+        generated_url += '&inline' if disposition.to_s != 'attachment'
+        # unfortunately OpenStack Swift cannot overwrite the content type of an object via a temp url
+        # so we just ignore the content_type argument here
 
-    def guess_content_type(io)
-      Marcel::MimeType.for io,
-                           name: io.try(:original_filename),
-                           declared_type: io.try(:content_type)
+        generated_url
+      end
+
+      def public_url(key, **)
+        client.public_url(container, key)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activestorage-openstack
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Chedli Bourguiba
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2021-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-openstack
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.2
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +127,7 @@ homepage: https://github.com/chaadow/activestorage-openstack
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,8 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: ActiveStorage wrapper for OpenStack Storage
 test_files: []