ActiveStorage::Openstack

This rails plugin wraps the OpenStack Swift provider as an Active Storage service.

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 section

Installation

Add this line to your application's Gemfile:

gem 'activestorage-openstack'

And then execute:

$ bundle

Or install it yourself as:

$ gem install activestorage-openstack

Usage

in config/storage.yml, in your Rails app, create an entry with the following keys:

dev_openstack:
  service: OpenStack
  container: <container name> # Container name for your OpenStack provider
  credentials:
    openstack_auth_url: <auth url>
    openstack_username: <username>
    openstack_api_key: <password>
    openstack_region: <region>
    openstack_temp_url_key: <temp url key> # Mandatory, instructions below
  connection_options: # optional
    chunk_size: 2097152 # 2MBs - 1MB is the default

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.

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:

# Store uploaded files on the local file system (see config/storage.yml for options)
config.active_storage.service = :dev_openstack

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 :

openstack_auth_url: https://auth.example.com/v2.0/tokens

to :

openstack_auth_url: https://auth.example.com

==> specifying the version in the openstack_auth_url key would break things

2- Second, specify the Keystone version (default is v3.0, however it is retro-compatible with v2.0 (So for now, adding this key won't affect the normal functioning of this gem, but is highly recommended)

Additionally v2.0 is deprecated.

openstack_identity_api_version: v2.0

For further informations, please refer to fog-openstack's README

Setting up a container

From your OpenStack provider website, create or sign in to your account. Then from your dashboard, create a container, and save the configuration generated.

It is a good practice to create a separate container for each of your environments. Once safely saved, you can add them to your storage configuration in your Rails application.

`temp_url_key` configuration

the openstack_temp_url_key in your configuration is mandatory for generating URLs (expiring ones) as well as for Direct Upload. You can set it up with Swift or with the Fog/OpenStack gem. More instructions on how to set it up with Swift are found HERE

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)

$ bundle

Then, from the root of the plugin, copy the following file and fill in the appropriate credentials. Preferably, set up a container for your testing, separate from production.

$ cp test/configurations.example.yml test/configurations.yml

And then run the tests:

$ bin/test

Contributions

Contributions are welcome. Feel free to open any issues if you encounter any bug, or if you want to suggest a feature by clicking here: https://github.com/chaadow/activestorage-openstack/issues

License

The gem is available as open source under the terms of the MIT License.

enigmatt-pl/activestorage-openstack