activestorage-storj-s3 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d4db330ebc9a658831d5260f645be98bd62c2ed93c19c9350741617a666192d
+  data.tar.gz: f63a6df7af0c284069c563396df3e05eb92071ffcd4a3d7467181d608885555d
+SHA512:
+  metadata.gz: 8fd9ab82eef8973ea2f93dabe3b9c3088ceb2f5ce30c2f99e0b587fcbca5d69896b59d3c2f3e62b4309b8edd0f9e09392418b32bdbfaa60a1f0f12e87aa21998
+  data.tar.gz: 15a2512ba851bb81d048adc88187e2a98fdbd23ab0f40175c97f8976fc1c900453273c2fbc789ff644097f55bf3c5f89d6fde1aaf6c581b44425b41c1d34b05f

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Your Data
+
+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,72 @@
+# ActiveStorage-Storj-S3
+ActiveStorage-Storj-S3 is a ruby gem extension for [activestorage-storj](https://github.com/Your-Data/activestorage-storj) gem to provide [Storj S3 Compatible Gateway](https://docs.storj.io/dcs/api-reference/s3-compatible-gateway) support for some ActiveStorage features, e.g. [direct upload](https://guides.rubyonrails.org/active_storage_overview.html#direct-uploads) which requires [S3 presigned URL](https://docs.storj.io/dcs/api-reference/s3-compatible-gateway/using-presigned-urls).
+
+## Requirements
+* [activestorage-storj](https://github.com/Your-Data/activestorage-storj) gem installed in a Rails project.
+
+## Installation
+* Add this line to your Rails application's Gemfile:
+
+    ```ruby
+    gem 'activestorage-storj-s3', '~> 1.0'
+    ```
+
+    And then execute:
+    ```bash
+    $ bundle install
+    ```
+
+* Modify Storj configuration in `config/storage.yml`:
+
+    ```yaml
+    storj:
+      service: storj_s3   # change from "storj" to "storj_s3"
+      ...
+      # provide the Storj S3 gateway credentials
+      s3_gateway:
+        access_key_id: ""
+        secret_access_key: ""
+        endpoint: ""
+        region: global
+    ```
+
+  The rest configurations are same as in `activestorage-storj` gem.
+
+## Running the Tests
+
+* Create `configurations.yml` file in `test/dummy/config/environments/service` folder, or copy the existing `configurations.example.yml` as `configurations.yml`.
+
+* Provide Storj configurations for both `storj` and `storj_public` services in `configurations.yml`:
+
+    ```yaml
+    storj:
+      service: storj_s3
+      access_grant: ""
+      bucket: ""
+      auth_service_address: auth.storjshare.io:7777
+      link_sharing_address: https://link.storjshare.io
+      s3_gateway:
+        access_key_id: ""
+        secret_access_key: ""
+        endpoint: ""
+        region: global
+
+    storj_public:
+      service: storj_s3
+      access_grant: ""
+      bucket: ""
+      auth_service_address: auth.storjshare.io:7777
+      link_sharing_address: https://link.storjshare.io
+      s3_gateway:
+        access_key_id: ""
+        secret_access_key: ""
+        endpoint: ""
+        region: global
+      public: true
+    ```
+
+* Run the tests:
+
+    ```bash
+    $ bin/test
+    ```

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/active_storage/service/storj_s3_service.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "active_storage/service/storj_service"
+require "aws-sdk-s3"
+
+module ActiveStorage
+  class Service::StorjS3Service < Service::StorjService
+    class S3GatewayConfigRequiredError < ActiveStorage::Error; end
+
+    attr_reader :s3_bucket
+
+    def initialize(access_grant:, bucket:, upload_chunk_size: nil, download_chunk_size: nil, multipart_upload_threshold: nil,
+      auth_service_address: nil, link_sharing_address: nil, public: false, **config)
+      super(access_grant: access_grant, bucket: bucket, upload_chunk_size: upload_chunk_size, download_chunk_size: download_chunk_size,
+        multipart_upload_threshold: multipart_upload_threshold, auth_service_address: auth_service_address, link_sharing_address: link_sharing_address,
+        public: public, **config)
+
+      s3_config = config[:s3_gateway]
+      raise S3GatewayConfigRequiredError.new, "S3 Gateway configuration is required" if s3_config.blank?
+
+      @s3_client = Aws::S3::Resource.new(
+        access_key_id: s3_config[:access_key_id],
+        secret_access_key: s3_config[:secret_access_key],
+        region: s3_config[:region],
+        endpoint: s3_config[:endpoint]
+      )
+      @s3_bucket = @s3_client.bucket(bucket)
+
+      upload = s3_config[:upload] || {}
+      @s3_upload_options = upload
+      @s3_upload_options[:acl] = "public-read" if public?
+    end
+
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
+      instrument :url, key: key do |payload|
+        generated_url = @s3_bucket.object(key).presigned_url :put, expires_in: expires_in.to_i,
+          content_type: content_type, content_length: content_length, content_md5: checksum,
+          metadata: custom_metadata, whitelist_headers: ["content-length"], **@s3_upload_options
+
+        payload[:url] = generated_url
+
+        generated_url
+      end
+    end
+  end
+end

data/lib/active_storage/storj/s3/railtie.rb

@@ -0,0 +1,8 @@
+module ActiveStorage
+  module Storj
+    module S3
+      class Railtie < ::Rails::Railtie
+      end
+    end
+  end
+end

data/lib/active_storage/storj/s3/version.rb

@@ -0,0 +1,7 @@
+module ActiveStorage
+  module Storj
+    module S3
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/tasks/activestorage/storj_tasks.rake

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

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: activestorage-storj-s3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Your Data
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+description: Providing Storj S3 gateway support for activestorage-storj gem
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_storage/service/storj_s3_service.rb
+- lib/active_storage/storj/s3/railtie.rb
+- lib/active_storage/storj/s3/version.rb
+- lib/tasks/activestorage/storj_tasks.rake
+homepage: https://github.com/Your-Data/activestorage-storj-s3
+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: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: activestorage-storj gem extension to provide Storj S3 gateway support
+test_files: []