presigned_upload 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 651464bf9650c6acb0cbd6da5f0d3e1cb41bcf16c2825e32a64fd102e214917b
+  data.tar.gz: e07b382fd743b259a3196912dbb19eff4069e55381e20eb7b9a20f622b20aa88
+SHA512:
+  metadata.gz: 8b7f57130a706d1d5651652134b152cf51a4dcd6442382c8c608d22d2b3af1380048f6bca891a811559cc94f7bc892a017170962ea23f92f6d2149ccf98ea066
+  data.tar.gz: 9329538342ea4ae88cd2b571e92c6cc87512a2f8f455cf6332267768ebdc9d170da6daed49bad15ad276cf77d801d3210076b82fdb07c1bbaae1dae17598fded

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - "lib/generators/**/templates/*"
+  NewCops: disable
+
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - "lib/generators/presigned_upload/**"
+    - "spec/support/storage/*"
+    - "spec/support/*"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - "spec/**/*"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-11-23
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in presigned_upload.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Denis Stael
+
+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,30 @@
+# PresignedUpload
+
+Gem designed to control file uploads via presigned URLs to cloud storage services.
+
+A presigned URL is generated by a server that grants temporary and controlled access to a specific resource. In the context of file uploads, it allows clients to directly upload files to a designated storage location without the server being directly involved in the transfer process.
+
+## Installation
+
+Add this to your Gemfile and run `bundle install`.
+
+```ruby
+gem 'presigned_upload'
+```
+
+Or install it yourself as:
+```sh
+gem install presigned_upload
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DenisStael/presigned_upload.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/generators/presigned_upload/templates/migration.rb

@@ -0,0 +1,12 @@
+class Create<%= model_name.camelize.pluralize %> < ActiveRecord::Migration[7.0]
+  def change
+    create_table :<%= model_name.underscore.pluralize + migration_id_column %> do |t|
+      t.string :original_name, null: false
+      t.string :content_type, null: false
+      t.string :store_path, null: false
+      t.string :upload_status, null: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/presigned_upload/templates/uploadable_model.rb

@@ -0,0 +1,3 @@
+class <%= model_name.camelize %> < ApplicationRecord
+  presigned_uploadable_model
+end

data/lib/generators/presigned_upload/uploadable_model_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module PresignedUpload
+  class UploadableModelGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("templates", __dir__)
+
+    argument :model_name, type: :string, desc: "Name of presigned uploadable model"
+    class_option :uuid, type: :boolean, default: false, desc: "Use UUID type for primary key"
+
+    def self.next_migration_number(path)
+      ActiveRecord::Generators::Base.next_migration_number(path)
+    end
+
+    def create_model_and_migration
+      generate_model
+      generate_migration
+    end
+
+    private
+
+    def generate_model
+      template "uploadable_model.rb", File.join("app", "models", "#{model_name.underscore}.rb")
+    end
+
+    def migration_id_column
+      options.uuid? ? ", id: :uuid" : ""
+    end
+
+    def generate_migration
+      migration_template "migration.rb", "db/migrate/create_#{model_name.underscore.pluralize}.rb"
+    end
+  end
+end

data/lib/presigned_upload/adapter/aws.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "presigned_upload/adapter/base"
+
+module PresignedUpload
+  module Adapter
+    #
+    # The `Aws` class is an adapter for interacting with the Amazon Simple Storage Service (S3) using the AWS SDK.
+    # It inherits from `Adapter::Base` and implements methods for generating presigned URLs, uploading files,
+    # and deleting files.
+    #
+    # @see Adapter::Base
+    class Aws < Base
+      #
+      # Generates a presigned URL for the specified key, HTTP method, and expiration time.
+      #
+      # @param [String] key The key or identifier of the file in the storage.
+      # @param [Symbol] method The HTTP method for which the presigned URL is generated (e.g., :put, :get).
+      # @param [Integer] expires_in The duration in seconds for which the URL is valid.
+      #
+      # @return [String] The presigned URL for the specified key, method, and expiration time.
+      def presigned_url(key, method, expires_in)
+        bucket.object(key).presigned_url(method, expires_in: expires_in)
+      end
+
+      # Uploads the specified file to the storage with the given key.
+      #
+      # @param [String] file The path to the local file to be uploaded.
+      # @param [String] key The key or identifier for the file in the storage.
+      #
+      # @return [void]
+      def upload_file(file, key)
+        object = bucket.object(key)
+        object.upload_file(file)
+      end
+
+      # Deletes the file with the specified key from the storage.
+      #
+      # @param [String] key The key or identifier of the file to be deleted.
+      #
+      # @return [void]
+      def delete_file(key)
+        bucket.object(key).delete
+      end
+
+      private
+
+      # Returns the AWS S3 client for interacting with the service.
+      #
+      # @return [Aws::S3::Client] The AWS S3 client.
+      def client
+        @client ||= ::Aws::S3::Client.new
+      end
+
+      # Returns the AWS S3 resource for interacting with S3 objects and buckets.
+      #
+      # @return [Aws::S3::Resource] The AWS S3 resource.
+      def resource
+        @resource ||= ::Aws::S3::Resource.new
+      end
+
+      # Returns the name of the S3 bucket configured for storage.
+      #
+      # @return [String] The name of the S3 bucket.
+      def bucket_name
+        @bucket_name ||= storage_options[:bucket]
+      end
+
+      # Returns the S3 bucket resource for the configured bucket name.
+      #
+      # @return [Aws::S3::Bucket] The S3 bucket resource.
+      def bucket
+        @bucket ||= resource.bucket(bucket_name)
+      end
+    end
+  end
+end

data/lib/presigned_upload/adapter/base.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module PresignedUpload
+  #
+  # The `Adapter` module contains classes responsible for interfacing with different storage services.
+  # Each adapter class should inherit from `PresignedUpload::Adapter::Base`.
+  #
+  # @see PresignedUpload::Adapter::Base
+  module Adapter
+    # The `Base` class serves as the base class for all storage adapters in the `PresignedUpload` module.
+    # It provides a common interface for accessing storage configurations.
+    #
+    # @see PresignedUpload::Adapter
+    class Base
+      #
+      # Initializes a new instance of the adapter.
+      #
+      def initialize
+        @storage_options = PresignedUpload.configuration.storage_options
+      end
+
+      protected
+
+      # Returns the storage configuration for the adapter.
+      #
+      # @return [Hash] The storage configuration.
+      attr_reader :storage_options
+    end
+  end
+end

data/lib/presigned_upload/configuration.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module PresignedUpload
+  #
+  # Configuration class
+  #
+  class Configuration
+    AVAILABLE_STORAGES = [:aws].freeze
+
+    attr_accessor :storage, :storage_options
+    attr_reader :adapter_class
+
+    def initialize
+      @storage = nil
+      @storage_options = {}
+    end
+
+    def configure!
+      unless AVAILABLE_STORAGES.include?(storage)
+        raise InvalidStorage, "Invalid storage. Allowed types are: #{AVAILABLE_STORAGES}"
+      end
+
+      raise InvalidStorageConfig, "Empty storage configuration" if storage_options.empty?
+
+      case storage
+      when :aws
+        load_aws
+      end
+
+      self
+    end
+
+    private
+
+    def load_aws
+      require_aws_dependencies!
+
+      required_config_keys = [:bucket]
+      storage_options.each_key { |key| storage_options.except!(key) unless required_config_keys.include?(key) }
+
+      unless required_config_keys.all? { |key| storage_options.key?(key) }
+        raise InvalidStorageConfig, "Missing storage configuration. Required keys are: #{required_config_keys}"
+      end
+
+      @adapter_class = PresignedUpload::Adapter::Aws
+    end
+
+    def require_aws_dependencies!
+      unless defined?(::Aws::S3)
+        raise MissingDependency, "Missing required dependency\n
+            PresignedUpload requires 'aws-sdk-s3' gem to work properly with Aws S3 storage.\n
+            To fix this error, consider adding [gem 'aws-sdk-s3'] into your Gemfile."
+      end
+
+      require "presigned_upload/adapter/aws"
+    end
+  end
+end

data/lib/presigned_upload/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PresignedUpload
+  class InvalidStorage < StandardError; end
+  class InvalidStorageConfig < StandardError; end
+  class MissingDependency < StandardError; end
+end

data/lib/presigned_upload/models.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "presigned_upload/uploadable"
+
+module PresignedUpload
+  #
+  # Module extended by ActiveRecord::Base to allow configuring models with resources of the gem
+  #
+  module Models
+    #
+    # Calling this method in the context of the model class includes Uploadable module, which makes
+    # available the methods for requesting presigned_urls and deleting file from the cloud storage
+    #
+    # @example:
+    #
+    #   UploadLink < ApplicationRecord
+    #     presigned_uploadable
+    #   end
+    #
+    #   upload_link = UploadLink.new
+    #   upload_link.presigned_url('key', :get, expires_in = 3600)
+    #   upload_link.delete_file('key')
+    #
+    def presigned_uploadable
+      include Uploadable
+    end
+
+    # rubocop:disable Metrics/MethodLength
+    #
+    # Calling this method in the context of the model class includes Uploadable::Model module, which includes
+    # all the behavior from the Uploadable module and the Uploadable::Model, including validations and callbacks
+    #
+    # @param [Hash] options Options hash
+    # @option options [Symbol] :store_path The path to the storage location
+    #   Accepts a Symbol value, which will try to call a method with same name
+    #   in model, a String value representing the store path or a Proc to call
+    #
+    # @example
+    #
+    #   UploadLink < ApplicationRecord
+    #     presigned_uploadable_model, store_path: :generate_store_path
+    #   end
+    #
+    def presigned_uploadable_model(options = {})
+      include Uploadable::Model
+
+      store_path = options[:store_path]
+
+      before_create do
+        self.store_path =
+          case store_path
+          when Symbol
+            __send__(store_path)
+          when String
+            store_path
+          when Proc
+            store_path.call
+          else
+            "uploads/#{model_name.plural}/#{original_name}"
+          end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/presigned_upload/railtie.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "presigned_upload/models"
+
+# rubocop:disable Style/Documentation
+
+module PresignedUpload
+  class Railtie < Rails::Railtie
+    initializer "presigned_upload.initialize" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.extend PresignedUpload::Models
+      end
+    end
+  end
+end
+
+# rubocop:enable Style/Documentation

data/lib/presigned_upload/storage.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module PresignedUpload
+  # Storage module that provides a common interface for interacting with different storage adapters.
+  #
+  # @example
+  #   class MyUploader
+  #     include Storage
+  #   end
+  #
+  #   uploader = MyUploader.new
+  #   url = uploader.presigned_url('key', :put, 3600)
+  #   uploader.delete_file('key')
+  #
+  module Storage
+    # Generates a presigned URL for the specified key, HTTP method, and expiration time.
+    #
+    # @param [String] key The key or identifier of the file in the storage.
+    # @param [Symbol] method The HTTP method for which the presigned URL is generated (e.g., :put, :get).
+    # @param [Integer] expires_in The duration in seconds for which the URL is valid (default is 3600 seconds).
+    #
+    # @return [String] The presigned URL for the specified key and method.
+    def presigned_url(key, method, expires_in = 3600)
+      adapter.presigned_url(key, method, expires_in)
+    end
+
+    # Deletes the file with the specified key from the storage.
+    #
+    # @param [String] key The key or identifier of the file to be deleted.
+    #
+    def delete_file(key)
+      adapter.delete_file(key)
+    end
+
+    private
+
+    # Returns the storage adapter based on the configured storage type.
+    #
+    # @return [PresignedUpload::Adapter::Base] An instance of the configured storage adapter.
+    def adapter
+      @adapter ||= PresignedUpload.adapter_class.new
+    end
+  end
+end

data/lib/presigned_upload/uploadable.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "presigned_upload/storage"
+require "active_support/concern"
+
+module PresignedUpload
+  #
+  # The `Uploadable` module integrates storage functionality with a model, allowing handling
+  # file uploads and associated storage operations. It includes the capabilities provided by the
+  # `PresignedUpload::Storage` module.
+  #
+  # This module is designed to be included in ActiveRecord models to facilitate common file upload
+  # operations, such as generating presigned URLs, deleting stored files, and managing upload status.
+  #
+  # @example
+  #
+  #   class MyUploadableModel < ApplicationRecord
+  #     include Uploadable::Model
+  #   end
+  #
+  #   model = MyUploadableModel.new(original_name: 'example.txt', content_type: 'text/plain', upload_status: :initial)
+  #   model.upload_url # Generates a presigned URL for file upload.
+  #   model.url        # Retrieves a presigned URL for accessing the stored file.
+  #
+  # @see PresignedUpload::Storage
+  module Uploadable
+    include PresignedUpload::Storage
+
+    # The `Model` submodule extends ActiveSupport::Concern to provide upload-related functionality
+    # to ActiveRecord models.
+    module Model
+      extend ActiveSupport::Concern
+
+      include Uploadable
+
+      included do
+        attr_readonly :original_name, :content_type, :store_path
+
+        validates :original_name, :content_type, :upload_status, presence: true
+
+        enum upload_status: { initial: "initial", completed: "completed" }
+
+        after_destroy { delete_stored_file }
+      end
+
+      # Returns a presigned URL for accessing the stored file. Returns `nil` if the upload status is not 'completed'.
+      #
+      # @return [String, nil] The presigned URL for accessing the stored file or `nil` if the
+      #   upload status is not completed.
+      #
+      def url
+        return unless completed?
+
+        presigned_url(store_path, :get)
+      end
+
+      # Returns a presigned URL for uploading the file. Returns `nil` if the store path is blank or the
+      # upload status is 'completed'.
+      #
+      # @return [String, nil] The presigned URL for uploading the file or `nil` if the upload status is
+      #   'completed' or store path is not present.
+      #
+      def upload_url
+        return if store_path.blank? || completed?
+
+        presigned_url(store_path, :put)
+      end
+
+      # Deletes the stored file associated with the model.
+      #
+      def delete_stored_file
+        delete_file(store_path)
+      end
+    end
+  end
+end

data/lib/presigned_upload/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PresignedUpload
+  VERSION = "0.1.1"
+end

data/lib/presigned_upload.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "presigned_upload/railtie"
+require "presigned_upload/version"
+require "presigned_upload/configuration"
+require "presigned_upload/errors"
+require "presigned_upload/adapter/base"
+
+# The `PresignedUpload` module serves as the main module for the presigned file upload functionality.
+# It provides configuration options, such as storage type and configuration settings.
+#
+module PresignedUpload
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+
+      yield(configuration)
+
+      configuration.configure!
+    end
+  end
+
+  def self.adapter_class
+    @adapter_class ||= configuration.adapter_class
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: presigned_upload
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Denis Stael
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: '    "This gem provides an easy way to handle direct file uploads to
+  cloud storage services via presigned URL."
+
+  '
+email:
+- denissantistael@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/presigned_upload/templates/migration.rb
+- lib/generators/presigned_upload/templates/uploadable_model.rb
+- lib/generators/presigned_upload/uploadable_model_generator.rb
+- lib/presigned_upload.rb
+- lib/presigned_upload/adapter/aws.rb
+- lib/presigned_upload/adapter/base.rb
+- lib/presigned_upload/configuration.rb
+- lib/presigned_upload/errors.rb
+- lib/presigned_upload/models.rb
+- lib/presigned_upload/railtie.rb
+- lib/presigned_upload/storage.rb
+- lib/presigned_upload/uploadable.rb
+- lib/presigned_upload/version.rb
+homepage: https://github.com/DenisStael/presigned_upload
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DenisStael/presigned_upload
+  source_code_uri: https://github.com/DenisStael/presigned_upload
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Control model associated files uploads via presigned URL to cloud storage
+  services.
+test_files: []