activestorage-openstack-shamox 0.7.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d91e85cc650d641f99bdec4ec336e024171e41ccde924e1a31a99a121813e18
+  data.tar.gz: c97143273ac456414917b7e7a1a5d3782d479430904ddf27b874e2b475b1d4f5
+SHA512:
+  metadata.gz: 872ec15aaa51d44a55ee894bd1f92d0e4d80c74408340a0c700eb68cfebc93ce8c655080c3556341ca41f58fd75d456ddf654919f74fc5fea9da0dd2c3e51460
+  data.tar.gz: 8f5d505ddb16b08166eb2f81c4920b5fb03f3c52222a1814eb630ad514ed86895ed97cccba9a19b15fc997185c1b55f52194ff57fa16d6525a3c23095de6d36e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 chaadow
+
+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,161 @@
+# ActiveStorage::Openstack
+This rails plugin wraps the OpenStack Swift provider as an Active Storage service.
+
+[![Gem Version](https://badge.fury.io/rb/activestorage-openstack.svg)](https://badge.fury.io/rb/activestorage-openstack)
+[![Build Status](https://travis-ci.com/ShamoX/activestorage-openstack.svg?branch=master)](https://travis-ci.com/ShamoX/activestorage-openstack)
+[![Maintainability](https://api.codeclimate.com/v1/badges/567a1c8e09288db91781/maintainability)](https://codeclimate.com/github/ShamoX/activestorage-openstack/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/567a1c8e09288db91781/test_coverage)](https://codeclimate.com/github/ShamoX/activestorage-openstack/test_coverage)
+
+
+# PLEASE FORGIVE ME
+Few monthes ago, I tried to contact `chaadow` - which seems to be the new maintainer
+of this project - and got no answer. Since I needed updates on this gem and no ones
+seemed to take it back, I decided to create and setup this new version.
+
+For now I call it `activestorage-openstack-shamox`, just because I can't take over
+`activestorage-openstack` from rubygem without a consent of its owner.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activestorage-openstack-shamox'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install activestorage-openstack-shamox
+```
+
+## Usage
+in `config/storage.yml`, in your Rails app, create an entry with the following keys:
+```yaml
+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_project_id: <region>
+    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:
+```ruby
+# 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 :
+```yaml
+openstack_auth_url: https://auth.example.com/v2.0/tokens
+```
+to :
+```yaml
+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.*
+```yaml
+openstack_identity_api_version: v2.0
+```
+
+For further informations, please refer to [fog-openstack's README](https://github.com/fog/fog-openstack/)
+
+## 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](https://docs.openstack.org/swift/latest/api/temporary_url_middleware.html#secret-keys).
+
+To create it and post it you can use `bin/create_and_post_tempurl_key.sh` after having set your environment.
+To set your environment set :
+```shell
+export OS_AUTH_URL "https://auth.cloud.ovh.net"
+export OS_IDENTITY_API_VERSION "3"
+
+export OS_PROJECT_ID="your project id"
+
+# In addition to the owning entity (tenant), openstack stores the entity
+# performing the action as the **user**.
+export OS_USERNAME="your username"
+
+# With Keystone you pass the keystone password.
+export OS_PASSWORD="your secret passwor"
+
+# If your configuration has multiple regions, we set that information here.
+# OS_REGION_NAME is optional and only valid in certain environments.
+export OS_REGION_NAME="BHS1"
+```
+
+To setup travis tests, you need to set `OPENSTACK_TEMP_URL_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)
+```shell
+$ 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.**
+```shell
+$ cp test/configurations.example.yml test/configurations.yml
+$ source ./bin/openrc.sh
+```
+And then run the tests:
+```shell
+$ 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/ShamoX/activestorage-openstack/issues
+
+I use the git flow scheme then, when wanting to merge, please target the `develop`
+branch and not the `master`. I would recommand you to use `git flow` also, and
+use the following configuration (which is the default):
+```
+$ git flow init
+Which branch should be used for bringing forth production releases?
+   - master
+Branch name for production releases: [master]
+Branch name for "next release" development: [develop]
+
+How to name your supporting branch prefixes?
+Feature branches? [feature/]
+Bugfix branches? [bugfix/]
+Release branches? [release/]
+Hotfix branches? [hotfix/]
+Support branches? [support/]
+Version tag prefix? []
+Hooks and filters directory? [/home/rlaures/dev/activestorage-openstack/.git/hooks]
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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::Openstack'
+  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/lib/active_storage/openstack/railtie.rb

@@ -0,0 +1,6 @@
+module ActiveStorage
+  module Openstack
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/active_storage/openstack/version.rb

@@ -0,0 +1,5 @@
+module ActiveStorage
+  module Openstack
+    VERSION = '0.7.0-alpha'
+  end
+end

data/lib/active_storage/service/open_stack_service.rb

@@ -0,0 +1,146 @@
+require 'fog/openstack'
+
+module ActiveStorage
+  class Service::OpenStackService < Service
+    attr_reader :client, :container
+
+    def initialize(container:, credentials:, connection_options: {})
+      settings =
+        if connection_options.present?
+          credentials.reverse_merge(connection_options: connection_options)
+        else
+          credentials
+        end
+
+      @client = Fog::OpenStack::Storage.new(settings)
+      @container = Fog::OpenStack.escape(container)
+    end
+
+    def upload(key, io, checksum: nil, **)
+      instrument :upload, key: key, checksum: checksum do
+        params = {}.merge(etag: convert_base64digest_to_hexdigest(checksum))
+        begin
+          client.put_object(container, key, io, params)
+        rescue Excon::Error::UnprocessableEntity
+          raise ActiveStorage::IntegrityError
+        end
+      end
+    end
+
+    def download(key, &block)
+      if block_given?
+        instrument :streaming_download, key: key do
+          object_for(key, &block).body
+        end
+      else
+        instrument :download, key: key do
+          object_for(key).body
+        end
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        object_for(key).body[range]
+      end
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        begin
+          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)
+
+        client.delete_multiple_objects(container, filtered_files)
+      end
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        begin
+          answer = object_for(key)
+          payload[:exist] = answer
+        rescue Fog::OpenStack::Storage::NotFound
+          payload[:exist] = false
+        end
+      end
+    end
+
+    def url(key, expires_in:, disposition:, filename:, content_type:)
+      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
+          )
+
+        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|
+        expire_at = unix_timestamp_expires_at(expires_in)
+
+        generated_url =
+          client.create_temp_url(
+            container,
+            key,
+            expire_at,
+            'PUT',
+            port: 443,
+            scheme: "https",
+            content_type: content_type,
+            content_length: content_length,
+            etag: convert_base64digest_to_hexdigest(checksum)
+          )
+
+        payload[:url] = generated_url
+        generated_url
+      end
+    end
+
+    def headers_for_direct_upload(key, content_type:, content_length:, checksum:)
+      {
+        'Content-Type' => content_type,
+        'Etag' => convert_base64digest_to_hexdigest(checksum),
+        'Content-Length' => content_length,
+      }
+    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
+      def convert_base64digest_to_hexdigest(base64digest)
+        base64digest.unpack('m0').first.unpack('H*').first if base64digest
+      end
+
+      def unix_timestamp_expires_at(seconds_from_now)
+        Time.current.advance(seconds: seconds_from_now).to_i
+      end
+
+      def format_range(range)
+        " bytes=#{range.begin}-#{range.exclude_end? ? range.end - 1 : range.end}"
+      end
+  end
+end

data/lib/activestorage-openstack.rb

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

data/lib/tasks/activestorage/openstack_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :activestorage_openstack do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-openstack-shamox
+version: !ruby/object:Gem::Version
+  version: 0.7.0.pre.alpha
+platform: ruby
+authors:
+- Chedli Bourguiba
+- Roland Laurès
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog-openstack
+  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: mime-types
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  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: Wraps the OpenStack Swift/Storage service as an Active Storage service
+email:
+- bourguiba.chedli@gmail.com
+- roland@rlaures.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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/shamox/activestorage-openstack
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.11
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: ActiveStorage wrapper for OpenStack Storage (ShamoX version)
+test_files: []