minio 0.1.0-arm64-darwin → 0.2.0-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271275a8aada1f5e3e9b36d74e54fce29713f732e391d4e1ee289106f15b20d8
-  data.tar.gz: f9711301ad00093ec87548b0a4863fcdf692c76a77dea288e88e2c8885282fa9
+  metadata.gz: a3bb93482e026b60649d03eea5a004526953ef755a22e601a145901acf5f9993
+  data.tar.gz: f011b064863ecb5b8dc4e9add2a970cc31069ca9d9d0a7c6bf040625ee182238
 SHA512:
-  metadata.gz: ba62abfc01af697c33a1df7a9ac0c4eb6f03a66b25a9b6b320f585e739f0b93052947b6d368ec0d7b5cdab2cb12b9bf25c9f5a4c3fc1e39ebf70a7f79285185f
-  data.tar.gz: bacffdca1ae6aeb2ec3ce196a1b82701628a5fbf62f1054e94acafc6e95021fb8b7a1a12add9758697b77c82868c18a0e3474bf6617a7660a66e970f20b7f137
+  metadata.gz: 45d41475bec45f189c32bf1d51acbe31dc120602fe76fb6720be4426870d2e8d92b67310999f85f480ce4723c21f1353297f90084ca1fbdaa0b37ef7f990c5db
+  data.tar.gz: 05d8e18c2728bfd2c9b1b3c14bff14515660a4a1d3e5633b3cc1b23ee43310f92919fd4222d17d8886c3a27ea51f4aaa456d26ea6d80fad9d830a42c1c24a876

data/README.md

@@ -2,6 +2,30 @@
 
 [MinIO](https://min.io) is an open-source S3-compatible object store. This gem provides a Ruby interface to MinIO.
 
+<p>
+  <a href="https://rubygems.org/gems/minio">
+  <img alt="GEM Version" src="https://img.shields.io/gem/v/minio?color=168AFE&include_prereleases&logo=ruby&logoColor=FE1616">
+  </a>
+  <a href="https://rubygems.org/gems/minio">
+    <img alt="GEM Downloads" src="https://img.shields.io/gem/dt/minio?color=168AFE&logo=ruby&logoColor=FE1616">
+  </a>
+  <a href="https://github.com/testdouble/standard">
+    <img alt="Ruby Style" src="https://img.shields.io/badge/style-standard-168AFE?logo=ruby&logoColor=FE1616" />
+  </a>
+  <a href="https://github.com/fractaledmind/minio-ruby/actions/workflows/main.yml">
+    <img alt="Tests" src="https://github.com/fractaledmind/minio-ruby/actions/workflows/main.yml/badge.svg" />
+  </a>
+  <a href="https://github.com/sponsors/fractaledmind">
+    <img alt="Sponsors" src="https://img.shields.io/github/sponsors/fractaledmind?color=eb4aaa&logo=GitHub%20Sponsors" />
+  </a>
+  <a href="https://ruby.social/@fractaledmind">
+    <img alt="Ruby.Social Follow" src="https://img.shields.io/mastodon/follow/109291299520066427?domain=https%3A%2F%2Fruby.social&label=%40fractaledmind&style=social">
+  </a>
+  <a href="https://twitter.com/fractaledmind">
+    <img alt="Twitter Follow" src="https://img.shields.io/twitter/url?label=%40fractaledmind&style=social&url=https%3A%2F%2Ftwitter.com%2Ffractaledmind">
+  </a>
+</p>
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -16,14 +40,6 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install minio
 ```
 
-Supported platforms are:
-
-* arm64-darwin (darwin-arm64)
-* arm64-linux (linux-arm64)
-* x86_64-darwin (darwin-amd64)
-* x86_64-linux (linux-amd64)
-* x86_64-windows (windows-amd64)
-
 ### Using a local installation of `minio`
 
 If you are not able to use the vendored standalone executables (for example, if you're on an unsupported platform), you can use a local installation of the `minio` executable by setting an environment variable named `MINIO_INSTALL_DIR` to the directory containing the executable.
@@ -42,32 +58,99 @@ MINIO_INSTALL_DIR=.bin
 
 ## Usage
 
-```shell
-$ minio --help
-NAME:
-  minio - High Performance Object Storage
+### Configuration
+
+You can configure (if needed, this is optional) the `username` and `password` to secure the MinIO web dashboard. This Ruby interface permits you to use any method of storing secrets that you prefer. For example, you could store these secrets in Rails' encrypted credentials:
+
+```ruby
+# config/initializers/minio.rb
+minio_credentials = Rails.application.credentials.minio
+Litestream.configure do |config|
+  config.username = minio_credentials.username
+  config.password = minio_credentials.password
+end
+```
+
+The default credentials that MinIO uses are `minioadmin` for both the username and password. If you are using the default credentials, you do not need to configure the `username` and `password` in the initializer, but you should absolutely change the default credentials in a production environment.
 
-DESCRIPTION:
-  Build high performance data infrastructure for machine learning, analytics and application data workloads with MinIO
+If you want, you can also configure the username and password via environment variables:
 
-USAGE:
-  minio [FLAGS] COMMAND [ARGS...]
+```sh
+export MINIO_ROOT_USER=frodo
+export MINIO_ROOT_PASSWORD=ikeptmysecrets
+```
+
+### Running the server
+
+You can start the MinIO server via the gem's rake task:
+
+```sh
+bin/rails minio:server
+# or
+bundle exec rake minio:server
+```
+
+If you need to pass arguments through the rake task to the underlying `minio` command, that can be done with argument forwarding:
+
+```sh
+bin/rails minio:server -- --directory /mnt/data
+```
 
-COMMANDS:
-  server  start object storage server
+This example shows the special `--directory` option available on [the `server` command](https://min.io/docs/minio/linux/reference/minio-server/minio-server.html), which allows you to specify the directory where MinIO will store its data. By default, the gem will use the `storage/minio` directory in your Rails app.
 
-FLAGS:
-  --certs-dir value, -S value  path to certs directory
-  --quiet                      disable startup and info messages
-  --anonymous                  hide sensitive information from logging
-  --json                       output logs in JSON format
-  --help, -h                   show help
-  --version, -v                print the version
+The MinIO `server` command supports various additional options, which can be passed through the rake task:
 
-VERSION:
-  RELEASE.2024-04-18T19-09-19Z
+```sh
+--config value               specify server configuration via YAML configuration [$MINIO_CONFIG]
+--address value              bind to a specific ADDRESS:PORT, ADDRESS can be an IP or hostname (default: ":9000") [$MINIO_ADDRESS]
+--console-address value      bind to a specific ADDRESS:PORT for embedded Console UI, ADDRESS can be an IP or hostname [$MINIO_CONSOLE_ADDRESS]
+--ftp value                  enable and configure an FTP(Secure) server
+--sftp value                 enable and configure an SFTP server
+--certs-dir value, -S value  path to certs directory (default: "~/.minio/certs")
+--quiet                      disable startup and info messages
+--anonymous                  hide sensitive information from logging
+--json                       output logs in JSON format
+--help, -h                   show help
 ```
 
+## Troubleshooting
+
+Some common problems experienced by users ...
+
+### `ERROR: Cannot find the minio executable` for supported platform
+
+Some users are reporting this error even when running on one of the supported native platforms:
+
+* arm64-darwin (darwin-arm64)
+* arm64-linux (linux-arm64)
+* x86_64-darwin (darwin-amd64)
+* x86_64-linux (linux-amd64)
+* x86_64-windows (windows-amd64)
+
+#### Check Bundler PLATFORMS
+
+A possible cause of this is that Bundler has not been told to include native gems for your current platform. Please check your `Gemfile.lock` file to see whether your native platform is included in the `PLATFORMS` section. If necessary, run:
+
+``` sh
+bundle lock --add-platform <platform-name>
+```
+
+and re-bundle.
+
+#### Check BUNDLE_FORCE_RUBY_PLATFORM
+
+Another common cause of this is that Bundler is configured to always use the "ruby" platform via the `BUNDLE_FORCE_RUBY_PLATFORM` config parameter being set to `true`. Please remove this configuration:
+
+``` sh
+bundle config unset force_ruby_platform
+# or
+bundle config set --local force_ruby_platform false
+```
+
+and re-bundle.
+
+See https://bundler.io/man/bundle-config.1.html for more information.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/minio

@@ -10,4 +10,4 @@ begin
 rescue MinIO::Commands::UnsupportedPlatformException, MinIO::Commands::ExecutableNotFoundException => e
   warn("ERROR: " + e.message)
   exit 1
-end
+end

data/lib/minio/commands.rb

@@ -17,61 +17,85 @@ module MinIO
     class DirectoryNotFoundException < StandardError
     end
 
-    def self.platform
-      [:cpu, :os].map { |m| Gem::Platform.local.send(m) }.join("-")
-    end
+    class << self
+      def platform
+        [:cpu, :os].map { |m| Gem::Platform.local.send(m) }.join("-")
+      end
 
-    def self.executable(exe_path: DEFAULT_DIR)
-      minio_install_dir = ENV["MINIO_INSTALL_DIR"]
-      if minio_install_dir
-        if File.directory?(minio_install_dir)
-          warn "NOTE: using MINIO_INSTALL_DIR to find minio executable: #{minio_install_dir}"
-          exe_path = minio_install_dir
-          exe_file = File.expand_path(File.join(minio_install_dir, "minio"))
+      def executable(exe_path: DEFAULT_DIR)
+        minio_install_dir = ENV["MINIO_INSTALL_DIR"]
+        if minio_install_dir
+          if File.directory?(minio_install_dir)
+            warn "NOTE: using MINIO_INSTALL_DIR to find minio executable: #{minio_install_dir}"
+            exe_path = minio_install_dir
+            exe_file = File.expand_path(File.join(minio_install_dir, "minio"))
+          else
+            raise DirectoryNotFoundException, <<~MESSAGE
+              MINIO_INSTALL_DIR is set to #{minio_install_dir}, but that directory does not exist.
+            MESSAGE
+          end
         else
-          raise DirectoryNotFoundException, <<~MESSAGE
-            MINIO_INSTALL_DIR is set to #{minio_install_dir}, but that directory does not exist.
-          MESSAGE
-        end
-      else
-        if Minio::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), GEM_NAME) }
-          raise UnsupportedPlatformException, <<~MESSAGE
-            minio-ruby does not support the #{platform} platform
-            Please install minio following instructions at https://min.io/download?license=agpl
-          MESSAGE
+          if MinIO::Upstream::NATIVE_PLATFORMS.keys.none? { |p| Gem::Platform.match_gem?(Gem::Platform.new(p), GEM_NAME) }
+            raise UnsupportedPlatformException, <<~MESSAGE
+              minio-ruby does not support the #{platform} platform
+              Please install minio following instructions at https://min.io/download?license=agpl
+            MESSAGE
+          end
+
+          exe_file = Dir.glob(File.expand_path(File.join(exe_path, "*", "minio"))).find do |f|
+            Gem::Platform.match_gem?(Gem::Platform.new(File.basename(File.dirname(f))), GEM_NAME)
+          end
         end
 
-        exe_file = Dir.glob(File.expand_path(File.join(exe_path, "*", "minio"))).find do |f|
-          Gem::Platform.match_gem?(Gem::Platform.new(File.basename(File.dirname(f))), GEM_NAME)
-        end
-      end
+        if exe_file.nil? || !File.exist?(exe_file)
+          raise ExecutableNotFoundException, <<~MESSAGE
+            Cannot find the minio executable for #{platform} in #{exe_path}
 
-      if exe_file.nil? || !File.exist?(exe_file)
-        raise ExecutableNotFoundException, <<~MESSAGE
-          Cannot find the minio executable for #{platform} in #{exe_path}
+            If you're using bundler, please make sure you're on the latest bundler version:
 
-          If you're using bundler, please make sure you're on the latest bundler version:
+                gem install bundler
+                bundle update --bundler
 
-              gem install bundler
-              bundle update --bundler
+            Then make sure your lock file includes this platform by running:
 
-          Then make sure your lock file includes this platform by running:
+                bundle lock --add-platform #{platform}
+                bundle install
 
-              bundle lock --add-platform #{platform}
-              bundle install
+            See `bundle lock --help` output for details.
 
-          See `bundle lock --help` output for details.
+            If you're still seeing this message after taking those steps, try running
+            `bundle config` and ensure `force_ruby_platform` isn't set to `true`. See
+            https://github.com/fractaledmind/minio-ruby#check-bundle_force_ruby_platform
+            for more details.
+          MESSAGE
+        end
 
-          If you're still seeing this message after taking those steps, try running
-          `bundle config` and ensure `force_ruby_platform` isn't set to `true`. See
-          https://github.com/fractaledmind/minio-ruby#check-bundle_force_ruby_platform
-          for more details.
-        MESSAGE
+        exe_file
       end
 
-      exe_file
-    end
+      def server(directory, async: false, **argv)
+        if MinIO.configuration
+          ENV["MINIO_ROOT_USER"] ||= MinIO.configuration.username
+          ENV["MINIO_ROOT_PASSWORD"] ||= MinIO.configuration.password
+        end
+
+        cmd = [executable, "server", *argv, directory].flatten.compact
+        puts cmd.inspect if ENV["DEBUG"]
+
+        run(cmd, async: async)
+      end
+
+      private
 
-    "MINIO_ROOT_USER=admin MINIO_ROOT_PASSWORD=password ./minio server /mnt/data --console-address ":9001""
+      def run(cmd, async: false)
+        if async
+          # To release the resources of the Ruby process, just fork and exit.
+          # The forked process executes litestream and replaces itself.
+          exec(*cmd) if fork.nil?
+        else
+          `#{cmd.join(" ")}`
+        end
+      end
+    end
   end
 end

data/lib/minio/railtie.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+
+module MinIO
+  class Railtie < ::Rails::Railtie
+    # Load the `minio:*` Rake task into the host Rails app
+    rake_tasks do
+      load "tasks/minio_tasks.rake"
+    end
+  end
+end

data/lib/minio/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module MinIO
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/minio.rb

@@ -1,6 +1,24 @@
 # frozen_string_literal: true
 
 require_relative "minio/version"
+require_relative "minio/commands"
+require_relative "minio/upstream"
+require_relative "minio/railtie" if defined?(::Rails::Railtie)
 
 module MinIO
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :username, :password
+
+    def initialize
+    end
+  end
 end

data/lib/tasks/minio_tasks.rake

@@ -0,0 +1,28 @@
+namespace :minio do
+  desc "Print the ENV variables set for the MinIO commands, if any"
+  task env: :environment do
+    if MinIO.configuration.nil?
+      warn "You have not configured the MinIO gem with any values to generate ENV variables"
+      next
+    end
+
+    puts "MINIO_ROOT_USER=#{MinIO.configuration.username}"
+    puts "MINIO_ROOT_PASSWORD=#{MinIO.configuration.password}"
+
+    true
+  end
+
+  desc "Start the MinIO object storage server, e.g. rake minio:server -- --directory=storage/minio"
+  task server: :environment do
+    options = {}
+    if (separator_index = ARGV.index("--"))
+      ARGV.slice(separator_index + 1, ARGV.length)
+        .map { |pair| pair.split("=") }
+        .each { |opt| options[opt[0]] = opt[1] || nil }
+    end
+    directory = options.delete("--directory") || options.delete("-directory") || "storage/minio"
+    options.symbolize_keys!
+
+    MinIO::Commands.server(directory, async: true, **options)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: arm64-darwin
 authors:
 - Stephen Margheim
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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:
 email:
 - stephen.margheim@gmail.com
@@ -40,8 +54,10 @@ files:
 - exe/minio
 - lib/minio.rb
 - lib/minio/commands.rb
+- lib/minio/railtie.rb
 - lib/minio/upstream.rb
 - lib/minio/version.rb
+- lib/tasks/minio_tasks.rake
 homepage: https://github.com/fractaledmind/minio-ruby
 licenses:
 - MIT