s3-light 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c5fee12967ac56da5d7bbe3311bf53f3ba296090663048797f2459f1dea048c
+  data.tar.gz: b8693107cd81c5a9df4c55ea96fb1080fd1ab9d21320b8d12179e581051b19f5
+SHA512:
+  metadata.gz: 984f369925150fe8f7bf3a0a0327af7f81587699c5ca3b7bb7f348f3bea585b4b1da9209fb6d30ab8879cbc113363e66664eeeb46e74a7f992b9b4936bd845c8
+  data.tar.gz: 79f1f21475df7c1d86ee537969c486baca5528e81f873b3a38289249b833e4d330085e9f59f3d6594b7f737017e9ee2fd9fa297d4b795a0bc9c34d1a88d50601

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Lint/Debugger:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 sebi
+
+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,184 @@
+# S3::Light 🚀
+
+S3::Light is a fast, lightweight Ruby gem for interacting with S3-compatible storage services. It's designed to be simple, efficient, and powerful! 💪
+
+## Features 🌟
+
+- 🚄 Lightning-fast performance
+- 🪶 Lightweight design
+- 🔧 Easy to use and integrate
+- 📦 Batch operations support
+- 🔄 Concurrent processing
+- 🔌 Compatible with S3 and S3-like services (e.g., MinIO)
+- 🔁 Connection reuse and keep-alive
+- 🧵 Thread-safe connection management
+
+## Installation 📥
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3-light'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install s3-light
+
+## Usage 🛠️
+
+### Basic Operations
+
+```ruby
+# Initialize the client
+client = S3Light::Client.new(
+  access_key_id: 'your_access_key',
+  secret_access_key: 'your_secret_key',
+  region: 'us-east-1'
+)
+
+# List all buckets
+buckets = client.buckets.all
+
+# Create a new bucket
+new_bucket = client.buckets.new(name: 'my-awesome-bucket').save!
+
+# Upload an object
+object = new_bucket.objects.new(key: 'hello.txt', input: 'Hello, World!').save!
+
+# Download an object
+downloaded_content = object.download(to: '/tmp/hello.txt')
+
+# Delete an object
+object.destroy!
+
+# Delete a bucket
+new_bucket.destroy!
+```
+
+### Batch Operations 🎛️
+
+S3::Light shines when it comes to batch operations! Here are some examples:
+
+```ruby
+# Create multiple buckets at once
+new_buckets = client.buckets.create_batch(names: ['bucket1', 'bucket2', 'bucket3'])
+
+# Check if multiple buckets exist
+existence = client.buckets.exists_batch?(names: ['bucket1', 'bucket2', 'nonexistent-bucket'])
+
+# Upload multiple objects concurrently
+bucket = client.buckets.find_by(name: 'my-bucket')
+objects = bucket.objects.create_batch(
+  input: {
+    'file1.txt' => 'Content 1',
+    'file2.txt' => 'Content 2',
+    'file3.txt' => File.open('path/to/file3.txt')
+  },
+  concurrency: 5
+)
+
+# Download multiple objects concurrently
+downloads = bucket.objects.download_batch(
+  keys: ['file1.txt', 'file2.txt', 'file3.txt'],
+  to: '/tmp',
+  concurrency: 5
+)
+```
+
+## Performance 🏎️
+
+S3::Light is designed to be fast and efficient. Here's how it achieves its high performance:
+
+# S3::Light 🚀
+
+... [previous content remains the same] ...
+
+## Performance Benchmarks 📊
+
+We've conducted benchmarks comparing S3::Light with the Amazon S3 gem. The benchmark tests include uploading and downloading a 50MB file 50 times individually.
+
+Here's a summary of the benchmark results:
+
+| Operation         | S3::Light | Amazon S3 Gem | Performance Difference |
+|-------------------|-----------|---------------|------------------------|
+| Individual Upload | 22.56s    | 37.98s        | 41% faster             |
+| Individual Download | 27.24s  | 28.38s        | 4% faster              |
+
+These results demonstrate that S3::Light offers significant performance improvements for individual upload operations and is slightly faster for individual downloads.
+
+S3::Light shows its strength in:
+- Individual file uploads (41% faster)
+- Individual file downloads (4% faster)
+
+It's important to note that performance can vary depending on factors such as network conditions, server load, and specific use cases. We recommend running benchmarks in your own environment to get the most accurate results for your specific use case.
+
+### Key Observations:
+
+1. **Individual Uploads**: S3::Light significantly outperforms the Amazon S3 gem, completing the task in about 59% of the time taken by the Amazon S3 gem.
+
+2. **Individual Downloads**: S3::Light is slightly faster than the Amazon S3 gem, with a small but noticeable performance advantage.
+
+These results highlight S3::Light's efficiency in handling individual file operations, particularly uploads, which could be beneficial for applications that frequently deal with single-file transfers.
+
+You can find the full benchmark script in the `benchmark` directory of this repository. Feel free to run it yourself and compare the results in your specific environment.
+
+... [rest of the content remains the same] ...
+
+### Connection Reuse and Keep-Alive 🔁
+
+S3::Light implements connection reuse and keep-alive strategies to minimize the overhead of establishing new connections for each request. This significantly reduces latency, especially for applications that make frequent API calls.
+
+```ruby
+# The client automatically reuses connections
+client.buckets.all  # First request establishes a connection
+client.buckets.all  # Subsequent requests reuse the same connection
+```
+
+### Connection Pooling 🏊
+
+For concurrent operations, S3::Light uses a connection pool. This allows multiple threads to work simultaneously without the overhead of creating new connections for each thread.
+
+```ruby
+# Connection pooling is automatically used in batch operations
+bucket.objects.download_batch(keys: large_list_of_keys, concurrency: 10)
+```
+
+### Thread-Safe Connection Management 🧵
+
+S3::Light ensures thread-safe connection management, allowing you to use it safely in multi-threaded environments without worrying about race conditions or data corruption.
+
+### Efficient Batch Processing 📦
+
+Batch operations in S3::Light are designed to maximize throughput by processing multiple items concurrently while efficiently managing resources.
+
+## Best Practices 🏆
+
+To get the most out of S3::Light's performance features:
+
+1. Reuse client instances when possible to take advantage of connection reuse.
+2. Use batch operations for handling multiple items instead of processing them one by one.
+3. Experiment with the `concurrency` parameter in batch operations to find the optimal setting for your use case and infrastructure.
+4. Remember to call `S3Light::Client.close_all_connections` when your application is shutting down to properly release all resources.
+
+## Development 🛠️
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing 🤝
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sebyx07/s3-light. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/sebyx07/s3-light/blob/master/CODE_OF_CONDUCT.md).
+
+## License 📄
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct 🤓
+
+Everyone interacting in the S3::Light project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/sebyx07/s3-light/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lefthook.yml

@@ -0,0 +1,7 @@
+pre-commit:
+  commands:
+    rubocop:
+      run: bundle exec rubocop -A
+      skip:
+        - merge
+        - rebase

data/lib/s3-light/bucket.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module S3Light
+  Bucket = Struct.new(:client, :name, :persisted) do
+    def initialize(client, name, persisted = false)
+      super(client, name, persisted)
+    end
+
+    def save!
+      if persisted
+        raise S3Light::Error, 'Bucket already exists'
+      end
+
+      if name.nil? || name.empty?
+        raise S3Light::Error, 'Bucket name is required'
+      end
+
+      self.client.with_connection do |connection|
+        __save!(connection)
+      end
+
+      self.persisted = true
+      self
+    end
+
+    def destroy!
+      unless persisted
+        raise S3Light::Error, 'Bucket does not exist'
+      end
+
+      self.client.with_connection do |connection|
+        __destroy!(connection)
+      rescue S3Light::Connection::HttpError => e
+        raise e unless e.code == 404
+      end
+
+      self.persisted = false
+      true
+    end
+
+    def objects
+      @objects ||= S3Light::Client::ObjectsList.new(client, self)
+    end
+
+    def __destroy!(connection)
+      connection.make_request(:delete, "/#{name}")
+    end
+
+    def __save!(connection)
+      connection.make_request(:put, "/#{name}")
+    end
+
+    def persisted?
+      persisted
+    end
+
+    def inspect
+      "#<#{self.class.name} @name=#{name} @persisted=#{persisted}>"
+    end
+  end
+end

data/lib/s3-light/client/buckets_list.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module S3Light
+  class Client
+    class BucketsList
+      def initialize(client)
+        @client = client
+      end
+
+      def all
+        response = @client.with_connection do |connection|
+          connection.make_request(:get, '/')
+        end
+
+        response.xml.remove_namespaces!.xpath('//Bucket').map do |bucket|
+          S3Light::Bucket.new(@client, bucket.xpath('Name').text, true)
+        end
+      end
+
+      def exists?(name:)
+        response = @client.with_connection do |connection|
+          connection.make_request(:head, "/#{name}")
+        end
+
+        response.code == 200
+      end
+
+      def create_batch(names:, concurrency: 10)
+        result = ConcurrentResult.new
+
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        names.each do |name|
+          thread_poll.with_connection do |connection|
+            bucket = S3Light::Bucket.new(@client, name, true)
+            bucket.__save!(connection)
+            result.add(name, bucket)
+          rescue Exception => e
+            thread_poll.kill
+            current_thread.raise(e)
+          end
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll.close
+      end
+
+      def destroy_batch(names:, concurrency: 10)
+        result = ConcurrentResult.new
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        names.each do |name|
+          thread_poll.with_connection do |connection|
+            new(name: name).__destroy!(connection)
+            result.add(name, true)
+
+          rescue Exception => e
+            thread_poll.kill
+            current_thread.raise(e)
+          end
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll.close
+      end
+
+      def exists_batch?(names:, concurrency: 10)
+        result = ConcurrentResult.new
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        names.each do |name|
+          thread_poll.with_connection do |connection|
+            result.add(name, connection.make_request(:head, "/#{name}"))
+          end
+        rescue Exception => e
+          thread_poll.kill
+          current_thread.raise(e)
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll.close
+      end
+
+      def find_by(name:)
+        @client.with_connection do |connection|
+          connection.make_request(:get, "/#{name}")
+        end
+
+        S3Light::Bucket.new(@client, name, true)
+
+      rescue S3Light::Connection::HttpError => e
+        return nil if e.code == 404
+
+        raise e
+      end
+
+      def new(name: nil)
+        S3Light::Bucket.new(@client, name, false)
+      end
+
+      def inspect
+        "#<#{self.class.name} @buckets=#{all.size}>"
+      end
+    end
+  end
+end

data/lib/s3-light/client/objects_list.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module S3Light
+  class Client
+    class ObjectsList
+      def initialize(client, bucket)
+        @client = client
+        @bucket = bucket
+      end
+
+      def all
+        response = @client.with_connection do |connection|
+          connection.make_request(:get, "/#{@bucket.name}")
+        end
+
+        response.xml.remove_namespaces!.xpath('//Contents').map do |object|
+          S3Light::Object.new(@client, @bucket, object.xpath('Key').text, nil, true)
+        end
+      end
+
+      def find_by(key:)
+        @client.with_connection do |connection|
+          connection.make_request(:head, "/#{@bucket.name}/#{key}")
+        end
+
+        S3Light::Object.new(@client, @bucket, key, nil, true)
+
+      rescue S3Light::Connection::HttpError => e
+        return nil if e.code == 404
+
+        raise e
+      end
+
+      def exists?(key:)
+        @client.with_connection do |connection|
+          connection.make_request(:head, "/#{@bucket.name}/#{key}")
+        end
+
+        true
+      rescue S3Light::Connection::HttpError => e
+        return false if e.code == 404
+
+        raise e
+      end
+
+      def new(key:, input: nil)
+        S3Light::Object.new(@client, @bucket, key, input, false)
+      end
+
+      def create_batch(input:, concurrency: 10)
+        result = ConcurrentResult.new
+
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        input.each do |key, input|
+          thread_poll.with_connection do |connection|
+            object = S3Light::Object.new(@client, @bucket, key, input, true)
+
+            object.__save!(connection)
+
+            result.add(key, object)
+          rescue Exception => e
+            thread_poll.kill
+            current_thread.raise(e)
+          end
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll.close
+      end
+
+      def destroy_batch(keys:, concurrency: 10)
+        result = ConcurrentResult.new
+
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        keys.each do |key|
+          thread_poll.with_connection do |connection|
+            object = S3Light::Object.new(@client, @bucket, key, nil, true)
+
+            object.__destroy!(connection)
+
+            result.add(key, true)
+          rescue S3Light::Connection::HttpError => e
+            if e.code == 404
+              result.add(key, true)
+            else
+              thread_poll.kill
+              current_thread.raise(e)
+            end
+          rescue Exception => e
+            thread_poll.kill
+            current_thread.raise(e)
+          end
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll.close
+      end
+
+      def exists_batch?(keys:, concurrency: 10)
+        result = ConcurrentResult.new
+
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        keys.each do |key|
+          thread_poll.with_connection do |connection|
+            result.add(key, connection.make_request(:head, "/#{@bucket.name}/#{key}"))
+
+          rescue S3Light::Connection::HttpError => e
+            if e.code == 404
+              result.add(key, false)
+            else
+              thread_poll.kill
+              current_thread.raise(e)
+            end
+          rescue Exception => e
+            thread_poll.kill
+            current_thread.raise(e)
+          end
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll.close
+      end
+
+      def find_by_batch(keys:, concurrency: 10)
+        result = ConcurrentResult.new
+
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        keys.each do |key|
+          thread_poll.with_connection do |connection|
+            connection.make_request(:head, "/#{@bucket.name}/#{key}")
+
+            result.add(key, S3Light::Object.new(@client, @bucket, key, nil, true))
+          rescue S3Light::Connection::HttpError => e
+            if e.code == 404
+              result.add(key, nil)
+            else
+              thread_poll.kill
+              current_thread.raise(e)
+            end
+          rescue Exception => e
+            thread_poll.kill
+            current_thread.raise(e)
+          end
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll.close
+      end
+
+      def download_batch(keys:, to: '/tmp', concurrency: 10)
+        raise S3Light::Error, 'Invalid download path' unless File.directory?(to)
+        to_path = Pathname.new(to)
+
+        result = ConcurrentResult.new
+
+        thread_poll = @client.build_thread_poll(concurrency)
+        current_thread = Thread.current
+
+        keys.each do |key|
+          thread_poll.with_connection do |connection|
+            download_path = to_path.join("#{SecureRandom.hex}-#{key}").to_s
+            connection.download_file("/#{@bucket.name}/#{key}", download_path)
+
+            result.add(key, download_path)
+          rescue S3Light::Connection::HttpError => e
+            if e.code == 404
+              result.add(key, nil)
+            else
+              thread_poll.kill
+              current_thread.raise(e)
+            end
+          rescue Exception => e
+            thread_poll.kill
+            current_thread.raise(e)
+          end
+        end
+
+        thread_poll.wait_to_finish
+
+        result.to_h
+      ensure
+        thread_poll&.close
+      end
+    end
+  end
+end

data/lib/s3-light/client.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module S3Light
+  class Client
+    attr_reader :access_key_id, :secret_access_key, :region, :ssl_context, :endpoint
+    def initialize(endpoint: nil, access_key_id:, secret_access_key:, region: 'us-east-1', ssl_context: nil)
+      @access_key_id = access_key_id
+      @secret_access_key = secret_access_key
+      @region = region
+      @ssl_context = ssl_context
+      @endpoint = endpoint || amazon_default_endpoint
+    end
+
+    def buckets
+      @buckets ||= BucketsList.new(self)
+    end
+
+    def connection
+      return @connection if @connection
+
+      @connection = Connection.new(
+        endpoint: @endpoint, access_key_id: @access_key_id, secret_access_key: @secret_access_key,
+        ssl_context: @ssl_context
+      )
+    end
+
+    def with_connection(&block)
+      self.class.main_connections_manager.yield_connection(self, &block)
+    end
+
+    def build_thread_poll(concurrency)
+      S3Light::ConnectionsManager::Threaded.new(self, concurrency)
+    end
+
+    class << self
+      def main_connections_manager
+        @main_connections_manager ||= ConnectionsManager::Main.new
+      end
+
+      def close_all_connections
+        main_connections_manager.close_all_connections
+      end
+    end
+
+    private
+      def amazon_default_endpoint
+        "https://s3.#{@region}.amazonaws.com"
+      end
+  end
+end
+
+at_exit do
+  S3Light::Client.close_all_connections
+end