beam_up 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55ab9d14c6fe9bb0bdb38f023f1242f174b538b117c5d0f95fabe6231ad6f745
+  data.tar.gz: 3859429f3775c52781da38cf040ae2cbd4d246a7062255cd0aaee0dd79a8e0c9
+SHA512:
+  metadata.gz: 5f4e221e74c4661c0df1cc5d1287ee69bb6e025762fd8a9e4df1e4739629219195e547cc7742e1b9420ac35d15fcb0208f060f5541a535198bc9eba9fdfb4530
+  data.tar.gz: 4e51baca30f01370cdd292fd3f4ee0bd47dbb67c4800c7416f1b52a644bcd08a535afd0587cd075ccc7180c0fddba2c50c09789d71e37624c00e7bfa1e8bc8da

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Rails Designer
+
+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,124 @@
+# Beam Up
+
+Static site deployment CLI supporting multiple providers. Just run `beam_up ./output`.
+
+
+## Installation
+
+If you have a Ruby environment available, you can install:
+```bash
+gem install beam_up
+```
+
+
+## Configuration
+
+Create a config file:
+```bash
+beam_up init netlify
+```
+
+Or manually create `.beam_up.yml` (or `config/beam_up.yml`):
+```yaml
+provider: netlify
+# path: ./output  # optional
+netlify:
+  api_token: your_token_here
+  project_id: your_project_id
+```
+
+If both files exist, `config/beam_up.yml` takes priority.
+
+
+## Deploy
+
+```bash
+# Deploy using configured provider
+beam_up ./output
+
+# Override provider for this deploy
+beam_up ./output --to bunny
+# or
+beam_up ./output --provider bunny
+```
+
+
+## Supported providers
+
+- aws_s3
+- bunny
+- digital_ocean_spaces
+- hetzner
+- neocities
+- netlify
+- sftp
+- statichost
+
+
+## Usage from Ruby
+
+```ruby
+require "beam_up"
+
+BeamUp.deploy! "./output"
+
+# Deploy with provider override
+BeamUp.deploy! "./output", to: "bunny"
+# or
+BeamUp.deploy! "./output", provider: "bunny"
+```
+
+
+## Hooks
+
+Run commands before and after deployment:
+
+```yaml
+provider: netlify
+before_actions:
+  - npm run build
+after_actions:
+  - echo "Deployment complete ✨"
+netlify:
+  api_token: your_token_here
+  project_id: your_project_id
+```
+
+If a `before_action` fails, deployment is cancelled.
+
+
+## SFTP
+
+Beam Up supports SFTP like the good ol' days. Requires additional gems:
+
+```bash
+gem install net-ssh net-sftp
+```
+
+Configuration:
+
+```yaml
+provider: sftp
+sftp:
+  host: your-server.com
+  username: deploy_user
+  remote_path: /var/www/html
+  # Use either password OR key:
+  password: your_password
+  # key: ~/.ssh/id_rsa
+```
+
+
+## Contributing
+
+This project uses [Standard](https://github.com/testdouble/standard) for formatting. Run `rake` before submitting pull requests.
+
+
+## License
+
+MIT License
+
+
+---
+
+*Fun fact: “Beam me up, Scotty” was never spoken in any Star Trek television episode or film.*

data/lib/beam_up/cli.rb

@@ -0,0 +1,187 @@
+require "optparse"
+require "yaml"
+
+module BeamUp
+  class CLI
+    def self.start(arguments)
+      new(arguments).run
+    end
+
+    def initialize(arguments)
+      @arguments = arguments
+      @provider = nil
+    end
+
+    def run
+      command = @arguments.shift
+
+      case command
+      when "init" then init
+      when "scotty" then scotty
+      when "--help", "-h" then help
+      when nil then deploy_or_help
+      else
+        @arguments.unshift(command)
+
+        deploy
+      end
+    end
+
+    def init
+      provider_name = @arguments.shift&.downcase
+
+      if provider_name.nil? || !PROVIDERS.key?(provider_name)
+        puts "Available providers:"
+
+        PROVIDERS.keys.reject { it == "transporter" }.sort.each { puts "  - #{it}" }
+
+        exit(1)
+      end
+
+      provider_config_class = PROVIDERS[provider_name]::Config
+      config_keys = provider_config_class.config_keys
+      config_file = ["config/beam_up.yml", ".beam_up.yml"].find { File.exist?(it) }
+
+      if config_file
+        existing_config = YAML.safe_load_file(config_file) || {}
+
+        if existing_config.key?(provider_name)
+          puts "Provider '#{provider_name}' already configured in #{config_file}"
+
+          exit(1)
+        end
+
+        provider_section = YAML.dump({provider_name => config_keys.to_h { [it, ""] }}, indent: 2, line_width: 80).sub(/^---\n/, "")
+        File.write(config_file, File.read(config_file) + "\n" + provider_section)
+
+        puts "Updated #{config_file} with #{provider_name} provider"
+      else
+        configuration = YAML.dump({
+          "provider" => provider_name,
+          "path" => nil,
+          provider_name => config_keys.to_h { |key| [key, ""] }
+        }, indent: 2, line_width: 80).gsub(/^path:$/, "# path: ./output # uncomment to set a default folder")
+
+        File.write(".beam_up.yml", configuration)
+        puts "Created .beam_up.yml with #{provider_name} provider"
+      end
+    end
+
+    def deploy_or_help
+      if File.exist?(".beam_up.yml") || File.exist?("config/beam_up.yml")
+        deploy
+      else
+        puts "No .beam_up.yml found. Run `beam_up init PROVIDER` to get started"
+        puts
+
+        help
+      end
+    end
+
+    def deploy
+      input = parse_options
+
+      beamed = BeamUp.deploy! input, provider: @provider
+
+      puts beamed.message
+      puts "Deploy ID: #{beamed.deploy_id}" if beamed.deploy_id
+
+      exit(1) unless beamed.success?
+    end
+
+    def scotty
+      puts <<~STARFLEET
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*+=%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%***++@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%***+++=@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%**+++++++%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@#*+++++++++-%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@***+*++++++++:@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%****++++++++++=@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@@***+*++++++++++++=%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@%***+++++++++++++++=%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@@*****+++++++++++++++=%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@@@%****+++++++++++++++++=%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@@@@@@%+****+++++++++++++++++++=%@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@@@@@@@%%=##%***+++++++++++++++++++++==++*-%%@@@@@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@@@%%%#*+-=#*%%*++++++++++++++++++++++++==*+*#.++**@@@@@@@@@@@@@@@@@@
+        @@@@@@@@@@@@%-*+.#%%#####**++++++++++++++++++++++++++=+++++++*%+*%@@@@@@@@@@@@@@
+        @@@@@@@@%%%*+=#%%%%#%%%%-*+++++++++++++++++++++++++++===++++=+==*:=**@@@@@@@@@@@
+        @@@@@@%%*+-#%%%%%%%%###%*++++++++++++++++++++++++++++==-=++++++====+.+:%@@@@@@@@
+        @@@@@%*+-#%%%%%%%%#%#%#=+++++++++++++++++++++++++++++===:=++++++======*==%@@@@@@
+        @@@@%*:###%%%%%######%%++++++++++++++++++++++++++++======:++++++========*=:%@@@@
+        @@%%+-###############%-++++++++++++++++++++++++++++=======.+++++++========:*%@@@
+        @@#+=#################++++++++++++++++++++++++++++++=======-++++++=+=======:*%@@
+        @%+-**##############%=+++++++++++++++++++++++++++++=========+++++++++=======:*@@
+        %*:*******##########%=++++++++++++++++++++++++++============.+++++++=========.=%
+        **:**+********#####*#+++++++++++++++++++++++++=============== +++++++=========*%
+        =*=++++++**********#.++++++++++++++++++++++++================-=+++++++=======**:
+        +*.+====++++*******#++++++++++++++++++++======================.+++++++=======++:
+        *#:==-====++++++++-.+++++++++++++==+===========================:++++=========+*=
+        %-*+----=====+++++- ++++++=====================================:=++==========%+%
+        @*:*#----=======+=*==========================-++++#.============-===========#*=%
+        @%=:**=---=====+=-#======================-:+++++++++:-=====================*#-@@
+        @@%==*.+---======..=====================:+++++++++++++..=========.========%*-@@@
+        @@@@%--*-=--=====. ===================:++++++++++++++++.:========-======+%+%@@@@
+        @@@@@%=--*-======-.=================:+++++++++++++++++++*.+=======.===+**=%@@@@@
+        @@@@@@@%#- #:*==:%-=================++++++++++++++++++++++ -======-=*%+=%%@@@@@@
+        @@@@@@@@@@%-=:#:% ==============-:+++++++++++++++++++++++++.:====== -%@@@@@@@@@@
+        @@@@@@@@@@@@@%---.=============:++++++++++++++++++++++++++++ +======%@@@@@@@@@@@
+        @@@@@@@@@@@@@@@%-.=============+++++++++++++++++++++++++#**#*--===== @@@@@@@@@@@
+        @@@@@@@@@@@@@@@%=:==========.%%+.:-%*****+*+**#*---%#*+--::*%::-====-%@@@@@@@@@@
+        @@@@@@@@@@@@@@%* :=========*#:::::-=+-::-===+=-:::::+%@@@@@@@%.:-====.@@@@@@@@@@
+        @@@@@@@@@@@@@@@= -=======:%%@@@@@%%%%%%%%%@@@@@@@@@@@@@@@@@@@@@::.===-%@@@@@@@@@
+        @@@@@@@@@@@@@@@= ======:%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@=:--==+@@@@@@@@@
+        @@@@@@@@@@@@@@@=.=====-%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@=-.==-@@@@@@@@@
+        @@@@@@@@@@@@@@%=:====:@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@--+==%@@@@@@@@
+        @@@@@@@@@@@@@@%=:==:%@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@%-===%@@@@@@@@
+        @@@@@@@@@@@@@@@=:=:@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@-:-@@@@@@@@@
+        @@@@@@@@@@@@@@%-:+@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
+      STARFLEET
+      exit
+    end
+
+    private
+
+    def help
+      puts <<~HELP
+        Usage:
+          beam_up init PROVIDER                 # Initialize config file for provider
+          beam_up [FOLDER]                      # Deploy using .beam_up.yml config
+          beam_up [FOLDER] --to PROVIDER        # Deploy with provider override
+          beam_up [FOLDER] --provider PROVIDER  # Alias for --to
+
+        Examples:
+          beam_up init netlify
+          beam_up ./output
+          beam_up ./output --to aws_s3
+      HELP
+
+      exit
+    end
+
+    def parse_options
+      if @arguments.first && !@arguments.first.start_with?("--")
+        input = @arguments.shift
+      end
+
+      OptionParser.new do |options|
+        options.on("--provider PROVIDER", "Override the provider from config") do |value|
+          @provider = value
+        end
+
+        options.on("--to PROVIDER", "Alias for --provider") do |value|
+          @provider = value
+        end
+
+        options.on("--help", "-h", "Show this help") do
+          help
+
+          exit
+        end
+      end.parse!(@arguments)
+
+      input
+    end
+  end
+end

data/lib/beam_up/configuration.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BeamUp
+  class Configuration
+    attr_accessor :provider, :path, :before_actions, :after_actions, :timeout
+
+    DEFAULT_TIMEOUT = 300  # 5 minutes
+
+    def initialize
+      @providers = {}
+      @timeout = DEFAULT_TIMEOUT
+    end
+
+    def self.with(options)
+      new.tap do |config|
+        config.provider = options[:provider]
+        config.provider_config.with(options)
+      end
+    end
+
+    def provider_config
+      raise(ConfigurationError, "Provider must be set") if provider.nil? || provider.empty?
+
+      provider_class = PROVIDERS[provider.to_s]
+      raise(ConfigurationError, "Unknown provider: #{provider}") unless provider_class
+
+      @providers[provider.to_s] ||= provider_class::Config.new
+    end
+
+    def validate!
+      raise ConfigurationError, "Provider must be set" unless provider
+
+      provider_config.validate!
+    end
+
+    def method_missing(method_name, *arguments)
+      if PROVIDERS.key?(method_name.to_s)
+        @providers[method_name.to_s] ||= PROVIDERS[method_name.to_s]::Config.new
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      PROVIDERS.key?(method_name.to_s) || super
+    end
+  end
+end

data/lib/beam_up/core.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module BeamUp
+  class Core
+    class << self
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= configuration_file || raise(ConfigurationError, "No .beam_up.yml found. Run `beam_up init PROVIDER` to create one.")
+      end
+
+      def deploy!(path = nil, provider: nil)
+        config = configuration_file
+        config.provider = provider if provider
+
+        deploy_path = path || config.path || raise(ConfigurationError, "No path specified")
+
+        config.validate!
+
+        execute! config.before_actions
+
+        provider_class = PROVIDERS[config.provider.to_s] || raise(ConfigurationError, "Unknown provider: #{config.provider}")
+        result = provider_class.new(config.provider_config).deploy! deploy_path
+
+        execute! config.after_actions
+
+        result
+      end
+
+      private
+
+      def configuration_file
+        file = ["config/beam_up.yml", ".beam_up.yml"].find { File.exist?(it) }
+        return nil unless file
+
+        data = YAML.safe_load_file(file)
+
+        Configuration.new.tap do |config|
+          config.provider = data["provider"]
+          config.path = data["path"]
+          config.timeout = data["timeout"] || Configuration::DEFAULT_TIMEOUT
+          config.before_actions = data["before_actions"] || []
+          config.after_actions = data["after_actions"] || []
+
+          PROVIDERS.each_key do |provider_name|
+            if (provider_data = data[provider_name])
+              config.send(provider_name).with(provider_data.transform_keys(&:to_sym))
+            end
+          end
+        end
+      end
+
+      def execute!(actions)
+        return if actions.nil? || actions.empty?
+
+        actions.each do |action|
+          result = system(action)
+
+          raise ConfigurationError, "Before action failed: #{action}" unless result
+        end
+      end
+    end
+  end
+end

data/lib/beam_up/errors.rb

@@ -0,0 +1,7 @@
+module BeamUp
+  class Error < StandardError; end
+
+  class ConfigurationError < Error; end
+
+  class DeploymentError < Error; end
+end

data/lib/beam_up/providers/aws_s3.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "beam_up/providers/s3_compatible"
+
+module BeamUp
+  module Providers
+    class AwsS3 < S3Compatible
+      class Config
+        def self.config_keys = %w[access_key secret_key region bucket url]
+
+        attr_accessor :access_key, :secret_key, :region, :bucket, :url
+
+        def with(options)
+          self.access_key = options[:access_key]
+          self.secret_key = options[:secret_key]
+          self.region = options[:region] || "us-east-1"
+          self.bucket = options[:bucket]
+          self.url = options[:url]
+          self
+        end
+
+        def validate!
+          raise ConfigurationError, "Access key must be set" unless access_key
+          raise ConfigurationError, "Secret key must be set" unless secret_key
+          raise ConfigurationError, "Bucket must be set" unless bucket
+        end
+      end
+
+      private
+
+      def bucket_name = @configuration.bucket
+
+      def endpoint
+        "https://s3.#{@configuration.region}.amazonaws.com"
+      end
+
+      def public_url
+        @configuration.url || "https://#{bucket_name}.s3.#{@configuration.region}.amazonaws.com"
+      end
+
+      def provider_name = "AWS S3"
+    end
+  end
+end

data/lib/beam_up/providers/base.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "beam_up/result"
+
+module BeamUp
+  module Providers
+    class Base
+      def initialize(configuration)
+        @configuration = configuration
+
+        configuration.validate!
+      end
+
+      def deploy!
+        raise NotImplementedError, "Subclasses must implement #deploy"
+      end
+
+      private
+
+      def files_to_deploy
+        Dir.glob("#{@path}/**/*").select { File.file?(it) }
+      end
+    end
+  end
+end

data/lib/beam_up/providers/bunny.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "digest"
+
+module BeamUp
+  module Providers
+    class Bunny < Base
+      class Config
+        def self.config_keys = %w[storage_zone_password storage_zone_name region]
+
+        attr_accessor :storage_zone_password, :storage_zone_name, :region
+
+        def with(options)
+          self.storage_zone_password = options[:storage_zone_password]
+          self.storage_zone_name = options[:storage_zone_name]
+          self.region = options[:region] || "de"
+          self
+        end
+
+        def validate!
+          raise ConfigurationError, "Storage zone password must be set" unless storage_zone_password
+          raise ConfigurationError, "Storage zone name must be set" unless storage_zone_name
+        end
+      end
+
+      def deploy!(path)
+        @path = path
+
+        files_to_deploy.each do |file|
+          upload file
+        end
+
+        Result.new(
+          provider: "Bunny",
+          deploy_id: Time.now.to_i.to_s,
+          url: "https://#{@configuration.storage_zone_name}.b-cdn.net"
+        )
+      rescue => error
+        Result.new(provider: "Bunny", error: error.message)
+      end
+
+      private
+
+      STORAGE_HOSTS = {
+        "de" => "storage.bunnycdn.com",
+        "la" => "la.storage.bunnycdn.com",
+        "ny" => "la.storage.bunnycdn.com",
+        "sg" => "sg.storage.bunnycdn.com",
+        "syd" => "syd.storage.bunnycdn.com"
+      }
+
+      def upload(file)
+        relative_path = file.delete_prefix("#{@path}/")
+        uri = URI("https://#{storage_host}/#{@configuration.storage_zone_name}/#{relative_path}")
+
+        request = Net::HTTP::Put.new(uri)
+        request["AccessKey"] = @configuration.storage_zone_password
+
+        File.open(file, "rb") do |file|
+          request.body = file.read
+        end
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+          http.request(request)
+        end
+
+        return if response.code.to_i == 201
+
+        raise DeploymentError, "Bunny upload error: #{response.code} #{response.body}"
+      end
+
+      def storage_host
+        STORAGE_HOSTS[@configuration.region] || STORAGE_HOSTS["de"]
+      end
+    end
+  end
+end

data/lib/beam_up/providers/digital_ocean_spaces.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "beam_up/providers/s3_compatible"
+
+module BeamUp
+  module Providers
+    class DigitalOceanSpaces < S3Compatible
+      class Config
+        def self.config_keys = %w[access_key secret_key region space_name]
+
+        attr_accessor :access_key, :secret_key, :region, :space_name
+
+        def with(options)
+          self.access_key = options[:access_key]
+          self.secret_key = options[:secret_key]
+          self.region = options[:region]
+          self.space_name = options[:space_name]
+          self
+        end
+
+        def validate!
+          raise ConfigurationError, "Access key must be set" unless access_key
+          raise ConfigurationError, "Secret key must be set" unless secret_key
+        end
+      end
+
+      private
+
+      def bucket_name
+        return @configuration.space_name if @configuration.space_name
+        return @created_bucket_name if @created_bucket_name
+
+        name = "#{File.basename(Dir.pwd)}-#{SecureRandom.hex(4)}"
+        s3_client.create_bucket(bucket: name)
+
+        @created_bucket_name = name
+      end
+
+      def endpoint = "https://#{@configuration.region}.digitaloceanspaces.com"
+
+      def public_url = "https://#{bucket_name}.#{@configuration.region}.cdn.digitaloceanspaces.com"
+
+      def provider_name = "DigitalOcean Spaces"
+    end
+  end
+end