ruby-bepasty-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e832e4200ea4decc2a800db7a43ad8deb8c0049000c29c0cb45679e9f62698d8
+  data.tar.gz: 1e0bcf99dc68452e83d4daec6913190dae4ecb715046c10318ffbee4c61600e9
+SHA512:
+  metadata.gz: 3ea2c4da75e919b9a353b2084b5558f8916fc99b070ba9d904fabd4f39fdec682a783f78831b48dff83d10fdf56d82486818d9aa29ae6c78d6a7f0db3cb1ca1b
+  data.tar.gz: ae41da0e6fb739c7aec2b04fc848f3e64583495acb4051ffa7458719f4c03703a2bb3d4554d139037a231cefacd04d5bc8005e3dfcf9444417d460f80ed720e2

data/.editorconfig

@@ -0,0 +1,11 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_size = 2
+indent_style = space

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+pkg
+man/style.css
+man/*.html
+man/**/*.html
+man/man?/*.?
+html_doc
+.gems
+.yardoc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jakub Skokan
+
+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,5 @@
+# ruby-bepasty-client
+Ruby client and CLI for [bepasty-server](https://bepasty-server.readthedocs.org/).
+
+## Usage
+See [bepastyrb.1.md](./man/man1/bepastyrb.1.md).

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'md2man/rakefile'
+require 'md2man/roff/engine'
+require 'md2man/html/engine'
+
+# Override markdown engine to add extra parameter
+[Md2Man::Roff, Md2Man::HTML].each do |mod|
+  mod.send(:remove_const, :ENGINE)
+  mod.send(:const_set, :ENGINE, Redcarpet::Markdown.new(mod.const_get(:Engine),
+    tables: true,
+    autolink: true,
+    superscript: true,
+    strikethrough: true,
+    no_intra_emphasis: false,
+    fenced_code_blocks: true,
+  ))
+end

data/bin/bepastyrb

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'bepasty-client'
+require 'bepasty-client/cli'
+BepastyClient::Cli.run

data/lib/bepasty-client/cli.rb

@@ -0,0 +1,162 @@
+require 'optparse'
+require 'yaml'
+
+module BepastyClient
+  class Cli
+    def self.run
+      cli = new
+      cli.run
+    end
+
+    def run
+      parse
+      load_config
+
+      if @server.nil?
+        warn 'Specify server URL using option --server or via config file'
+        exit(false)
+      end
+
+      client = Client.new(@server, password: @password, verbose: @verbose)
+      client.setup
+
+      if @files.empty?
+        puts client.upload_io(STDIN, **@upload_opts)
+      else
+        @files.each do |path|
+          file_loc = File.open(path, 'r') do |f|
+            client.upload_io(f, **@upload_opts)
+          end
+
+          if @files.length > 1
+            puts "#{path}: #{file_loc}"
+          else
+            puts file_loc
+          end
+        end
+      end
+
+    rescue Error => e
+      warn "Error occurred: #{e.message}"
+      exit(false)
+    end
+
+    protected
+    def parse
+      @upload_opts = {}
+
+      OptionParser.new do |parser|
+        parser.banner = "Usage: #{$0} [options] FILE..."
+
+        parser.on('-h', '--help', 'Show help message and exit') do |v|
+          puts parser
+          exit
+        end
+
+        parser.on('-v', '--verbose', 'Enable verbose output') do |v|
+          @verbose = true
+        end
+
+        parser.on('-s', '--server=SERVER', 'bepasty server URL') do |v|
+          @server = v
+        end
+
+        parser.on('-p', '--password=PASSWORD', 'bepasty server password') do |v|
+          @password = v
+        end
+
+        parser.on('--password-file=FILE', 'Read bepasty server password from a file') do |v|
+          @password = File.read(v).strip
+        end
+
+        parser.on('-f', '--filename=NAME', 'File name including extension') do |v|
+          @upload_opts[:filename] = v
+        end
+
+        parser.on('-t', '--content-type=TYPE', 'Content mime type') do |v|
+          @upload_opts[:content_type] = v
+        end
+
+        parser.on(
+          '--minute=[N]',
+          OptionParser::DecimalInteger,
+          'Keep the file for N minutes, defaults to 30 minutes',
+        ) do |v|
+          @upload_opts[:max_life] = {unit: :minutes, value: v || 30}
+        end
+
+        parser.on(
+          '--hour=[N]',
+          OptionParser::DecimalInteger,
+          'Keep the file for N hours, defaults to 1 hour',
+        ) do |v|
+          @upload_opts[:max_life] = {unit: :hours, value: v || 1}
+        end
+
+        parser.on(
+          '--day=[N]',
+          OptionParser::DecimalInteger,
+          'Keep the file for N days, defaults to 1 day',
+        ) do |v|
+          @upload_opts[:max_life] = {unit: :days, value: v || 1}
+        end
+
+        parser.on(
+          '--week=[N]',
+          OptionParser::DecimalInteger,
+          'Keep the file for N weeks, defaults to 1 week',
+        ) do |v|
+          @upload_opts[:max_life] = {unit: :weeks, value: v || 1}
+        end
+
+        parser.on(
+          '--month=[N]',
+          OptionParser::DecimalInteger,
+          'Keep the file for N months, defaults to 1 month',
+        ) do |v|
+          @upload_opts[:max_life] = {unit: :months, value: v || 1}
+        end
+
+        parser.on(
+          '--forever',
+          'Keep the file as long as possible',
+        ) do |v|
+          @upload_opts[:max_life] = {unit: :forever, value: 1}
+        end
+      end.parse!
+
+      @files = ARGV.empty? ? [] : ARGV
+    end
+
+    def load_config
+      cfg = load_config_file('/etc/bepastyrb.yml')
+
+      conf_dir = ENV.fetch('XDG_CONFIG_HOME', '')
+      conf_dir = File.join(Dir.home, '.config') if conf_dir.empty?
+
+      cfg.update(load_config_file(File.join(conf_dir, 'bepastyrb.yml')))
+
+      @verbose = true if cfg[:verbose]
+      @server ||= cfg[:server]
+      @password ||= cfg[:password]
+      @max_life ||= cfg[:max_life]
+    end
+
+    def load_config_file(path)
+      cfg = YAML.load_file(path)
+      puts "Reading config at #{path}" if @verbose
+
+      {
+        verbose: cfg.fetch('verbose', false),
+        server: cfg['server'],
+        password: cfg['password_file'] ? File.read(cfg['password_file']).strip : cfg['password'],
+        max_life: {
+          unit: cfg.fetch('max_life', {}).fetch('unit', 'days').to_sym,
+          value: cfg.fetch('max_life', {}).fetch('value', 1),
+        },
+      }
+    rescue Errno::ENOENT
+      {}
+    end
+  end
+end

data/lib/bepasty-client/client.rb

@@ -0,0 +1,131 @@
+require 'base64'
+require 'json'
+require 'net/http'
+require 'stringio'
+
+module BepastyClient
+  class Error < StandardError ; end
+
+  class Client
+    BODY_SIZE = 128*1024
+
+    # @param server [String] bepasty server URL
+    # @param password [String, nil]
+    # @param verbose [Boolean]
+    def initialize(server, password: nil, verbose: false)
+      @server = server
+      @password = password
+      @verbose = verbose
+    end
+
+    # Fetch server settings
+    def setup
+      http_start('/apis/rest') do |uri, http|
+        res = http.get(uri)
+
+        case res
+        when Net::HTTPSuccess
+          settings = JSON.parse(res.body)
+
+          @max_file_size = settings['MAX_ALLOWED_FILE_SIZE']
+          @max_body_size = settings.fetch('MAX_BODY_SIZE', BODY_SIZE)
+
+          if @verbose
+            puts "Max file size = #{@max_file_size}"
+            puts "Max body size = #{@max_body_size}"
+          end
+        else
+          raise Error, "Failed to query server settings: HTTP #{res.code}, #{res.message}"
+        end
+      end
+    end
+
+    # Upload file
+    # @param io [IO]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    # @param max_life [Hash, nil]
+    # @raise [Error]
+    # @return [String] file URL
+    def upload_io(io, filename: nil, content_type: nil, max_life: nil)
+      if filename.nil? && io.respond_to?(:path)
+        filename = File.basename(io.path)
+      end
+
+      max_life ||= {unit: :days, value: 1}
+
+      sent_bytes = 0
+      transaction_id = nil
+      file_location = nil
+
+      if io.respond_to?(:size)
+        send_io = io
+      else
+        send_io = StringIO.new(io.read)
+      end
+
+      if @max_file_size && send_io.size > @max_file_size
+        raise Error, "File size #{send_io.size} exceeds server max file size of #{@max_file_size} bytes"
+      end
+
+      http_start('/apis/rest/items') do |uri, http|
+        until send_io.eof?
+          chunk = send_io.read(@max_body_size)
+
+          req = Net::HTTP::Post.new(uri)
+          req.basic_auth('bepasty', @password) if @password
+          req['Content-Range'] = "bytes #{sent_bytes}-#{sent_bytes + chunk.size - 1}/#{send_io.size}"
+          req['Transaction-ID'] = transaction_id if transaction_id
+          req['Content-Type'] = content_type || ''
+          req['Content-Filename'] = filename || ''
+          req['Content-Length'] = send_io.size
+          req['Maxlife-Unit'] = max_life[:unit].to_s.upcase
+          req['Maxlife-Value'] = max_life[:value]
+
+          req.body = Base64.encode64(chunk)
+
+          if @verbose
+            puts "Uploading chunk, Content-Range=#{req['Content-Range']}, Transaction-ID=#{transaction_id}"
+          end
+
+          res = http.request(req)
+
+          case res
+          when Net::HTTPSuccess
+            if transaction_id.nil? && res['Transaction-ID']
+              transaction_id = res['Transaction-ID']
+            end
+
+            file_location = res['Content-Location'] if res['Content-Location']
+          else
+            if res['Content-Type'] == 'application/json'
+              err = JSON.parse(res.body)['error']
+              raise Error, "bepasty error: code=#{err['code']}, message=#{err['message']}"
+            else
+              raise Error, "HTTP #{res.code}: #{res.message}"
+            end
+          end
+
+          sent_bytes += chunk.size
+        end
+      end
+
+      if file_location.nil?
+        raise Error, 'Server did not disclose file location'
+      end
+
+      # bepasty returns REST item URL, we want web URL instead
+      File.join(@server, file_location.split('/').last)
+    end
+
+    protected
+    def http_start(path)
+      uri = URI(File.join(@server, path))
+      args = [uri.hostname, uri.port] + Array.new(5, nil) + [{use_ssl: uri.scheme == 'https'}]
+
+      Net::HTTP.start(*args) do |http|
+        yield(uri, http)
+      end
+    end
+  end
+end

data/lib/bepasty-client/version.rb

@@ -0,0 +1,3 @@
+module BepastyClient
+  VERSION = '1.0.0'
+end

data/lib/bepasty-client.rb

@@ -0,0 +1,4 @@
+module BepastyClient ; end
+
+require_relative 'bepasty-client/client'
+require_relative 'bepasty-client/version'

data/man/man1/bepastyrb.1.md

@@ -0,0 +1,83 @@
+# bepastyrb 8                       2023-05-14                             1.0.0
+
+## NAME
+`bepastyrb` - upload files to bepasty servers
+
+## SYNOPSIS
+`bepastyrb` [*options*] [*file*...]
+
+## DESCRIPTION
+`bepastyrb` uploads one or more files to bepasty servers. If no *file* is given
+as an argument, `bepastyrb` will read from standard input.
+
+bepasty server URL needs to be given using option `-s`, `--server` or can be
+set in a config file, see `CONFIG FILES`.
+
+If no life time is set, it defaults to one day.
+
+## OPTIONS
+`-v`, `--verbose`
+  Enable verbose output.
+
+`-s`, `--server`=*SERVER*
+  bepasty server URL.
+
+`-p`, `--password`=*PASSWORD*
+  bepasty server password.
+
+`--password-file`=*FILE*
+  Read bepasty server password from a file.
+
+`-f`, `--filename`=*NAME*
+  File name including extension. Can be used to provide name for files read
+  from standard input or to override given file name.
+
+`-t`, `--content-type`=*TYPE*
+  Content mime type. If not given, the mime type is guessed by the bepasty server
+  based on file name.
+
+`--minute`=[*N*]
+  Keep the file for *N* minutes, defaults to 30 minutes.
+
+`--hour`=[*N*]
+  Keep the file for *N* hours, defaults to 1 hour.
+
+`--day`=[*N*]
+  Keep the file for *N* days, defaults to 1 day.
+
+`--week`=[*N*]
+  Keep the file for *N* weeks, defaults to 1 week.
+
+`--month`=[*N*]
+  Keep the file for *N* months, defaults to 1 month.
+
+`--forever`
+  Keep the file as long as possible.
+
+## CONFIG FILES
+Config files can be used to provide default values for certain options.
+Command-line options override settings found in config files. Config files are
+read from the following locations:
+
+  - `/etc/bepastyrb.yml`
+  - `$XDG_CONFIG_HOME/bepastyrb.yml` or `~/.config/bepastyrb.yml`
+
+Settings from user's config will override settings in `/etc`.
+
+Example configuration:
+
+```
+# bepasty config file in YAML
+server: https://bepasty.yourserver.tld
+# password: optional password if the server uses it
+# password_file: read password from a file
+# max_life:
+#   unit: minutes|hours|days|weeks|months|forever
+#   value: 14
+```
+
+## SEE ALSO
+bepasty server: https://bepasty-server.readthedocs.org/
+
+## BUGS
+Report bugs to https://github.com/aither64/ruby-bepasty-client.

data/ruby-bepasty-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bepasty-client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-bepasty-client'
+  spec.version       = BepastyClient::VERSION
+  spec.authors       = ['Jakub Skokan']
+  spec.email         = ['jakub.skokan@vpsfree.cz']
+  spec.summary       =
+  spec.description   = 'Ruby client and CLI for bepasty'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'md2man'
+  spec.add_development_dependency 'rake'
+end

data/shell.nix

@@ -0,0 +1,21 @@
+let
+  pkgs = import <nixpkgs> {};
+  stdenv = pkgs.stdenv;
+
+in stdenv.mkDerivation rec {
+  name = "ruby-bepasty-client";
+
+  buildInputs = with pkgs;[
+    ruby
+    git
+    openssl
+  ];
+
+  shellHook = ''
+    export GEM_HOME=$(pwd)/.gems
+    export PATH="$GEM_HOME/bin:$PATH"
+    export MANPATH="$(pwd)/man:$(man --path)"
+    gem install bundler
+    bundle install
+  '';
+}

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ruby-bepasty-client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jakub Skokan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: md2man
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Ruby client and CLI for bepasty
+email:
+- jakub.skokan@vpsfree.cz
+executables:
+- bepastyrb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bepastyrb
+- lib/bepasty-client.rb
+- lib/bepasty-client/cli.rb
+- lib/bepasty-client/client.rb
+- lib/bepasty-client/version.rb
+- man/man1/bepastyrb.1.md
+- ruby-bepasty-client.gemspec
+- shell.nix
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.20
+signing_key:
+specification_version: 4
+summary: Ruby client and CLI for bepasty
+test_files: []