beam_up 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ab9d14c6fe9bb0bdb38f023f1242f174b538b117c5d0f95fabe6231ad6f745
-  data.tar.gz: 3859429f3775c52781da38cf040ae2cbd4d246a7062255cd0aaee0dd79a8e0c9
+  metadata.gz: 4a72e817350e2432e79027289ca5838cb36c749adce555c34054015ae39ae30d
+  data.tar.gz: 6c1716a0ef1fac860312c479da279987771f5ce3ce2d2d9e7cb999aa287d39b2
 SHA512:
-  metadata.gz: 5f4e221e74c4661c0df1cc5d1287ee69bb6e025762fd8a9e4df1e4739629219195e547cc7742e1b9420ac35d15fcb0208f060f5541a535198bc9eba9fdfb4530
-  data.tar.gz: 4e51baca30f01370cdd292fd3f4ee0bd47dbb67c4800c7416f1b52a644bcd08a535afd0587cd075ccc7180c0fddba2c50c09789d71e37624c00e7bfa1e8bc8da
+  metadata.gz: 982c69b88f7b3bf0132bd8c5926216a656a087d63c2df506434dc411573df08749e6af1f73b717e6c59b7c38943a839df9ecfbac865a1583e2829fc52fa49fc5
+  data.tar.gz: 3e509ff7e4f81aacf39b93ee12fe23428c3234489245d95e9bfa5ea18ee6e574fc54617843bf890a43d9b5fb7e7efea98b66b4d9a602d611f3e5df597d5f1fb8

data/README.md

@@ -13,12 +13,16 @@ gem install beam_up
 
 ## Configuration
 
-Create a config file:
+Create a config file interactively:
 ```bash
 beam_up init netlify
+# api_token:
+# project_id:
 ```
 
-Or manually create `.beam_up.yml` (or `config/beam_up.yml`):
+Or specify values programmatically (see [Usage from Ruby](#usage-from-ruby) for details).
+
+You can also manually create `.beam_up.yml` (or `config/beam_up.yml`):
 ```yaml
 provider: netlify
 # path: ./output  # optional
@@ -51,6 +55,7 @@ beam_up ./output --provider bunny
 - hetzner
 - neocities
 - netlify
+- [Seal Static](https://sealstatic.com/)
 - sftp
 - statichost
 
@@ -60,6 +65,10 @@ beam_up ./output --provider bunny
 ```ruby
 require "beam_up"
 
+# Configure a provider interactively
+BeamUp.init! "netlify"
+
+# Deploy
 BeamUp.deploy! "./output"
 
 # Deploy with provider override
@@ -75,6 +84,7 @@ Run commands before and after deployment:
 
 ```yaml
 provider: netlify
+
 before_actions:
   - npm run build
 after_actions:

data/lib/beam_up/cli.rb

@@ -10,6 +10,7 @@ module BeamUp
     def initialize(arguments)
       @arguments = arguments
       @provider = nil
+      @config_file = nil
     end
 
     def run
@@ -38,33 +39,13 @@ module BeamUp
         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) }
+      path = BeamUp.init!(provider_name)
 
-      if config_file
-        existing_config = YAML.safe_load_file(config_file) || {}
+      puts "Configured #{provider_name} in #{path}"
+    rescue ConfigurationError => error
+      puts error.message
 
-        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
+      exit(1)
     end
 
     def deploy_or_help
@@ -81,12 +62,14 @@ module BeamUp
     def deploy
       input = parse_options
 
-      beamed = BeamUp.deploy! input, provider: @provider
+      BeamUp.with_progress do
+        beamed = BeamUp.deploy! input, provider: @provider, config_file: @config_file
 
-      puts beamed.message
-      puts "Deploy ID: #{beamed.deploy_id}" if beamed.deploy_id
+        puts beamed.message
+        puts "Deploy ID: #{beamed.deploy_id}" if beamed.deploy_id
 
-      exit(1) unless beamed.success?
+        exit(1) unless beamed.success?
+      end
     end
 
     def scotty
@@ -150,11 +133,13 @@ module BeamUp
           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
+          beam_up [FOLDER] --config FILE        # Use a specific config file
 
         Examples:
           beam_up init netlify
           beam_up ./output
           beam_up ./output --to aws_s3
+          beam_up ./output --config /path/to/config.yml
       HELP
 
       exit
@@ -174,6 +159,10 @@ module BeamUp
           @provider = value
         end
 
+        options.on("--config FILE", "Use a specific config file") do |value|
+          @config_file = value
+        end
+
         options.on("--help", "-h", "Show this help") do
           help
 

data/lib/beam_up/configuration.rb

@@ -2,7 +2,7 @@
 
 module BeamUp
   class Configuration
-    attr_accessor :provider, :path, :before_actions, :after_actions, :timeout
+    attr_accessor :provider, :path, :before_actions, :after_actions, :timeout, :config_file
 
     DEFAULT_TIMEOUT = 300  # 5 minutes
 

data/lib/beam_up/core.rb

@@ -1,20 +1,28 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "tty-prompt"
 
 module BeamUp
   class Core
     class << self
-      def configure
+      def configure(&block)
         yield(configuration)
       end
 
-      def configuration
-        @configuration ||= configuration_file || raise(ConfigurationError, "No .beam_up.yml found. Run `beam_up init PROVIDER` to create one.")
+      attr_writer :config_file
+
+      def configuration(config_file: nil)
+        @configuration ||= begin
+          custom_path = config_file || @config_file || ((@configuration&.config_file && File.exist?(@configuration.config_file)) ? @configuration.config_file : nil)
+          config = custom_path ? configuration_file(custom_path) : configuration_file
+
+          config || raise(ConfigurationError, "No .beam_up.yml found. Run `beam_up init PROVIDER` to create one.")
+        end
       end
 
-      def deploy!(path = nil, provider: nil)
-        config = configuration_file
+      def deploy!(path = nil, provider: nil, config_file: nil)
+        config = configuration(config_file: config_file)
         config.provider = provider if provider
 
         deploy_path = path || config.path || raise(ConfigurationError, "No path specified")
@@ -31,11 +39,51 @@ module BeamUp
         result
       end
 
+      def init!(provider, config_file: nil, values: {})
+        raise ConfigurationError, "Unknown provider: #{provider}" unless PROVIDERS.key?(provider)
+
+        config_file ||= ["config/beam_up.yml", ".beam_up.yml"].find { File.exist?(it) }
+        config_file ||= ".beam_up.yml"
+
+        if File.exist?(config_file)
+          data = YAML.safe_load_file(config_file) || {}
+
+          raise ConfigurationError, "Provider '#{provider}' already configured in #{config_file}" if data.key?(provider)
+        end
+
+        config_keys = PROVIDERS[provider]::Config.config_keys
+
+        if values.empty? && $stdout.tty? && !ENV["TTY_TEST"]
+          prompt = TTY::Prompt.new
+
+          values = config_keys.to_h { |key| [key, prompt.ask("#{key}:") { it.required false }.to_s] }
+        end
+
+        configured_values = config_keys.to_h { [it, values[it].to_s] }
+
+        if File.exist?(config_file)
+          section = YAML.dump({provider => configured_values}, indent: 2, line_width: 80).sub(/^---\n/, "")
+
+          File.write(config_file, File.read(config_file) + "\n" + section)
+        else
+          yaml = YAML.dump({
+            "provider" => provider,
+            "path" => nil,
+            provider => configured_values
+          }, indent: 2, line_width: 80).gsub(/^path:$/, "# path: ./output # uncomment to set a default folder")
+
+          File.write(config_file, yaml)
+        end
+
+        config_file
+      end
+
       private
 
-      def configuration_file
-        file = ["config/beam_up.yml", ".beam_up.yml"].find { File.exist?(it) }
-        return nil unless file
+      def configuration_file(custom_path = nil)
+        file = custom_path || ["config/beam_up.yml", ".beam_up.yml"].find { File.exist?(it) }
+
+        return nil unless file && File.exist?(file)
 
         data = YAML.safe_load_file(file)
 

data/lib/beam_up/progress.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module BeamUp
+  class Progress
+    def initialize
+      @mutex = Thread::Mutex.new
+      @current = 0
+      @total = nil
+      @type = nil
+      @spinner_index = 0
+    end
+    attr_reader :total, :current, :type
+
+    def start(type:, total:)
+      @mutex.synchronize do
+        @type = type
+        @total = total
+        @current = 0
+        @spinner_index = 0
+
+        render
+      end
+    end
+
+    def tick(bytes: nil)
+      @mutex.synchronize do
+        @current += (@type == :bytes) ? bytes.to_i : 1
+
+        render
+      end
+    end
+
+    def finish
+      @mutex.synchronize do
+        return if @total.nil?
+
+        stop_render
+
+        @total = nil
+        @current = nil
+        @type = nil
+      end
+    end
+
+    private
+
+    SPINNERS = %w[⠋ ⠙ ⠹ ⠸ ⠼ ⠴ ⠦ ⠧ ⠇]
+
+    def render
+      return unless tty?
+
+      spinner = SPINNERS[@spinner_index % SPINNERS.length]
+      @spinner_index += 1
+
+      line = if @type == :bytes
+        "#{spinner} #{formatted(@current)} of #{formatted(@total)}"
+      else
+        "#{spinner} #{@current} of #{@total}"
+      end
+
+      $stdout.write("\r#{line}")
+
+      $stdout.flush
+    end
+
+    def stop_render
+      $stdout.write("\r#{" " * 80}\r")
+
+      $stdout.flush
+    end
+
+    def tty? = $stdout.tty?
+
+    def formatted(bytes)
+      return format("%.1fGB", bytes.to_f / 1_073_741_824) if bytes >= 1_073_741_824
+      return format("%.1fMB", bytes.to_f / 1_048_576) if bytes >= 1_048_576
+      return format("%.1fKB", bytes.to_f / 1024) if bytes >= 1024
+
+      "#{bytes}B"
+    end
+  end
+end

data/lib/beam_up/providers/neocities.rb

@@ -28,6 +28,9 @@ module BeamUp
       def deploy!(path)
         @path = path
 
+        files = files_to_deploy
+        BeamUp.progress&.start(type: :files, total: files.count)
+
         upload_files
 
         Result.new(
@@ -37,6 +40,8 @@ module BeamUp
         )
       rescue => error
         Result.new(provider: "Neocities", error: error.message)
+      ensure
+        BeamUp.progress&.finish
       end
 
       private

data/lib/beam_up/providers/netlify.rb

@@ -62,7 +62,9 @@ module BeamUp
         required_shas = response["required"] || []
         return if required_shas.empty?
 
-        required_shas.each.with_index(1) do |sha, index|
+        BeamUp.progress&.start(type: :files, total: required_shas.count)
+
+        required_shas.each do |sha|
           file_path = file_map_from(files)[sha]
           next if file_path.nil? || file_path.empty?
 
@@ -70,7 +72,10 @@ module BeamUp
           escaped_path = CGI.escape(relative_path.delete_prefix("/"))
 
           put("/deploys/#{response["id"]}/files/#{escaped_path}", File.read(file_path))
+          BeamUp.progress&.tick
         end
+      ensure
+        BeamUp.progress&.finish
       end
 
       def message

data/lib/beam_up/providers/s3_compatible.rb

@@ -8,8 +8,12 @@ module BeamUp
       def deploy!(path)
         @path = path
 
-        files_to_deploy.each do |file|
+        files = files_to_deploy
+        BeamUp.progress&.start(type: :files, total: files.count)
+
+        files.each do |file|
           upload file.delete_prefix("#{@path}/"), file
+          BeamUp.progress&.tick
         end
 
         Result.new(
@@ -19,6 +23,8 @@ module BeamUp
         )
       rescue => error
         Result.new(provider: provider_name, error: error.message)
+      ensure
+        BeamUp.progress&.finish
       end
 
       private

data/lib/beam_up/providers/seal_static.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "json"
+require "zip"
+require "tempfile"
+
+module BeamUp
+  module Providers
+    class SealStatic < Base
+      BASE_URL = "https://app.sealstatic.com/api"
+
+      class Config
+        def self.config_keys = %w[api_key]
+
+        attr_accessor :api_key
+
+        def with(options)
+          self.api_key = options[:api_key]
+          self
+        end
+
+        def validate!
+          raise ConfigurationError, "API key must be set" if api_key.nil? || api_key.empty?
+        end
+      end
+
+      def deploy!(path)
+        @path = path
+
+        zipped_file = create_zip(path)
+        BeamUp.progress&.start(type: :bytes, total: zipped_file.size)
+        response = upload zipped_file
+
+        return Result.new(provider: "Seal Static", error: response["error"]) if response["error"]
+
+        Result.new(
+          provider: "Seal Static",
+          url: response["url"]
+        )
+      rescue => error
+        Result.new(provider: "Seal Static", error: error.message)
+      ensure
+        BeamUp.progress&.finish
+        zipped_file&.close!
+      end
+
+      private
+
+      def create_zip(path)
+        temporary_file = Tempfile.new(["seal_static", ".zip"], binmode: true)
+
+        Zip::OutputStream.open(temporary_file) do |zip|
+          files_to_deploy.each do |file|
+            relative_path = file.delete_prefix("#{path}/")
+
+            zip.put_next_entry(relative_path)
+            zip.write(File.read(file))
+          end
+        end
+
+        temporary_file.rewind
+        temporary_file
+      end
+
+      def upload(zipped_file)
+        uri = URI("#{BASE_URL}/uploads")
+
+        boundary = "----BeamUpBoundary#{SecureRandom.hex(16)}"
+        body = multipart_body(boundary, zipped_file)
+
+        request = Net::HTTP::Post.new(uri)
+        request["Authorization"] = "Bearer #{@configuration.api_key}"
+        request["Content-Type"] = "multipart/form-data; boundary=#{boundary}"
+        request["Accept"] = "application/json"
+        request.body = body
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
+
+        case response.code.to_i
+        when 200..299
+          response.body.empty? ? {} : JSON.parse(response.body)
+        else
+          raise DeploymentError, "Seal Static API error: #{response.code} #{response.body}"
+        end
+      end
+
+      def multipart_body(boundary, zipped_file)
+        content = zipped_file.read
+        filename = "site.zip"
+
+        parts = []
+        parts << "--#{boundary}\r\n"
+        parts << "Content-Disposition: form-data; name=\"file\"; filename=\"#{filename}\"\r\n"
+        parts << "Content-Type: application/zip\r\n"
+        parts << "\r\n"
+        parts << content
+        parts << "\r\n"
+        parts << "--#{boundary}--\r\n"
+        parts.join
+      end
+    end
+  end
+end

data/lib/beam_up/providers/sftp.rb

@@ -38,9 +38,13 @@ module BeamUp
         }
         options[:keys] = [@configuration.key] if @configuration.key
 
+        files = files_to_deploy
+        BeamUp.progress&.start(type: :files, total: files.count)
+
         Net::SFTP.start(@configuration.host, @configuration.username, options) do |sftp|
-          files_to_deploy.each do |file|
+          files.each do |file|
             upload sftp, file
+            BeamUp.progress&.tick
           end
         end
 
@@ -53,6 +57,8 @@ module BeamUp
         raise ConfigurationError, "SFTP requires net-sftp gem. Install with: gem install net-sftp (or add to Gemfile)"
       rescue => error
         Result.new(provider: "SFTP", error: error.message)
+      ensure
+        BeamUp.progress&.finish
       end
 
       private

data/lib/beam_up/providers/statichost.rb

@@ -30,6 +30,7 @@ module BeamUp
         @path = path
 
         zipped_file = create_zip path
+        BeamUp.progress&.start(type: :bytes, total: zipped_file.size)
         response = upload zipped_file
 
         Result.new(
@@ -41,6 +42,7 @@ module BeamUp
         Result.new(provider: "Statichost", error: error.message)
       ensure
         zipped_file&.close!
+        BeamUp.progress&.finish
       end
 
       private

data/lib/beam_up/providers/transporter.rb

@@ -24,8 +24,7 @@ module BeamUp
         @path = path
         files = files_to_deploy
 
-        puts "Energizing… 🚀"
-        puts "Matter stream detected: #{files.length} files"
+        BeamUp.progress&.start(type: :files, total: files.length)
 
         FileUtils.mkdir_p(@configuration.target_directory)
 
@@ -36,7 +35,7 @@ module BeamUp
           FileUtils.mkdir_p(File.dirname(target_path))
           FileUtils.cp(file, target_path)
 
-          puts "  Beaming: #{relative_path}"
+          BeamUp.progress&.tick
         end
 
         puts "Transport complete. Files materialized at: #{@configuration.target_directory}"
@@ -48,6 +47,8 @@ module BeamUp
         )
       rescue => error
         Result.new(provider: "Transporter", error: error.message)
+      ensure
+        BeamUp.progress&.finish
       end
     end
   end

data/lib/beam_up/providers.rb

@@ -7,6 +7,8 @@ require "beam_up/providers/digital_ocean_spaces"
 require "beam_up/providers/hetzner"
 require "beam_up/providers/neocities"
 require "beam_up/providers/netlify"
+require "beam_up/providers/s3_compatible"
+require "beam_up/providers/seal_static"
 require "beam_up/providers/sftp"
 require "beam_up/providers/statichost"
 require "beam_up/providers/transporter"

data/lib/beam_up/result.rb

@@ -2,13 +2,14 @@
 
 module BeamUp
   class Result
-    attr_reader :deploy_id, :error, :provider
+    attr_reader :deploy_id, :error, :provider, :api_key
 
-    def initialize(provider:, deploy_id: nil, url: nil, error: nil)
+    def initialize(provider:, deploy_id: nil, url: nil, error: nil, api_key: nil)
       @provider = provider
       @deploy_id = deploy_id
       @url = url
       @error = error
+      @api_key = api_key
     end
 
     def success? = @error.nil?

data/lib/beam_up/version.rb

@@ -1,3 +1,3 @@
 module BeamUp
-  VERSION = "0.5.0"
+  VERSION = "0.7.0"
 end

data/lib/beam_up.rb

@@ -5,6 +5,7 @@ require "beam_up/errors"
 require "beam_up/providers"
 require "beam_up/configuration"
 require "beam_up/result"
+require "beam_up/progress"
 require "beam_up/core"
 require "beam_up/cli"
 
@@ -16,16 +17,35 @@ module BeamUp
     "hetzner" => Providers::Hetzner,
     "neocities" => Providers::Neocities,
     "netlify" => Providers::Netlify,
+    "seal_static" => Providers::SealStatic,
     "sftp" => Providers::SFTP,
     "statichost" => Providers::Statichost,
     "transporter" => Providers::Transporter
   }
 
   class << self
+    attr_accessor :progress
+
+    def with_progress
+      self.progress = Progress.new
+
+      yield
+    ensure
+      progress&.finish
+
+      self.progress = nil
+    end
+
     def configure(&block) = Core.configure(&block)
 
-    def configuration = Core.configuration
+    def config_file=(path)
+      Core.config_file = path
+    end
+
+    def configuration(config_file: nil) = Core.configuration(config_file: config_file)
+
+    def deploy!(path = nil, provider: nil, to: nil, config_file: nil) = Core.deploy!(path, provider: (to || provider)&.to_s, config_file: config_file)
 
-    def deploy!(path = nil, provider: nil, to: nil) = Core.deploy!(path, provider: (to || provider)&.to_s)
+    def init!(provider, config_file: nil, values: {}) = Core.init!(provider, config_file: config_file, values: values)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beam_up
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rails Designer
@@ -51,8 +51,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
 description: Beam Up is a deployment CLI for static sites that works with popular
-  hosting providers like Netlify, AWS S3, Bunny, DigitalOcean Spaces and Hetzner.
+  hosting providers like Netlify, AWS S3, Seal Static, statichost.eu and Hetzner.
   Configure it once, then deploy your site to any provider with a single command.
   Use it from the command line, embed it in your Ruby scripts or integrate it into
   your CI/CD pipeline.
@@ -69,6 +83,7 @@ files:
 - lib/beam_up/configuration.rb
 - lib/beam_up/core.rb
 - lib/beam_up/errors.rb
+- lib/beam_up/progress.rb
 - lib/beam_up/providers.rb
 - lib/beam_up/providers/aws_s3.rb
 - lib/beam_up/providers/base.rb
@@ -78,6 +93,7 @@ files:
 - lib/beam_up/providers/neocities.rb
 - lib/beam_up/providers/netlify.rb
 - lib/beam_up/providers/s3_compatible.rb
+- lib/beam_up/providers/seal_static.rb
 - lib/beam_up/providers/sftp.rb
 - lib/beam_up/providers/statichost.rb
 - lib/beam_up/providers/transporter.rb
@@ -86,7 +102,9 @@ files:
 homepage: https://railsdesigner.com/open-source/beam-up/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://railsdesigner.com/open-source/beam-up/
+  source_code_uri: https://github.com/Rails-Designer/beam_up/
 rdoc_options: []
 require_paths:
 - lib
@@ -101,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.14
 specification_version: 4
 summary: A CLI tool that deploys your static sites to multiple hosting providers from
   a single command.