activestorage-openstack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 679f589974232f4e10a8668beca5099273e6f5a1f2595eb2f4d3298cef4a4dcf
+  data.tar.gz: b67c2107534d6208a65b867e98559738ce2bb8ec32854f0b1582f33cf9d03929
+SHA512:
+  metadata.gz: bdc68784986e569e426386d2f9da663766ea9b0ab56b577d85fb9d1fbb4094f322a361017900b51b9886c6d5e2b29fd1cddf35cc218f182b4344cff5e62ae45f
+  data.tar.gz: f27590fc1462ed17c7681032dbc84734ce7a98b65fa839bd9e2a843d7dab390949f8c680d75d32076b9fac3e1d0a1c0f7d782c3db31e380ffa85977e216b7e4a

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,79 @@
+# ActiveStorage::Openstack
+This rails plugin wraps the OpenStack Swift provider as an Active Storage service.
+It is a rewrite/refactor of [activestorage-openstack](https://github.com/jeffreyguenther/activestorage-openstack).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activestorage-openstack'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install activestorage-openstack
+```
+
+## 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_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
+```
+## 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)
+
+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.
+
+## Testing
+First, run `bundle` to install the gem dependencies (both development and production)
+```bash
+$ 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.**
+```bash
+$ cp test/configurations.example.yml test/configurations.yml
+```
+And then run the tests:
+```bash
+$ 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](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.rb

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

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.1.0'
+  end
+end

data/lib/active_storage/service/open_stack_service.rb

@@ -0,0 +1,141 @@
+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::Storage::OpenStack.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::Storage::OpenStack::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::Storage::OpenStack::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/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,108 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-openstack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chedli Bourguiba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog-openstack
+  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: 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
+description: Wraps the OpenStack Swift/Storage service as an Active Storage service
+email:
+- bourguiba.chedli@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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/tasks/activestorage/openstack_tasks.rake
+homepage: https://github.com/chaadow/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: ActiveStorage wrapper for OpenStack Storage
+test_files: []