onetime-up 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: daf373c819502e6a34a5a85fe033e39323cec0d5136af81b394fcd597171601f
+  data.tar.gz: 9c5408c3eed4b30065a4093a0e2302fd41f96a127607feaef0e72200b534c3de
+SHA512:
+  metadata.gz: a3149a2f9bfe3112ebcdcbaedabb184d42e0849781b589a8bfaf54a001b5f1b97437d922b59b31911c087563b2182f69761c4e1b34325637c9a0a4090132733d
+  data.tar.gz: 5032db644622b154dfd770a974befb924a9bed99c2f0548e3f4f1abf417a9296355b89b09b241d28f3ee645dfb69e1042205fd4abb6bf005bc3ac4819c87d12c

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## [0.6.0] - 2026-01-18
+
+### Added
+
+Major/breaking changes:
+
+- Upgrade to API v2
+- Rename command "metadata" to "receipt"
+
+Other changes:
+
+- Remove Rakefile, signing data and Jeweler references
+- Simplified and modernized gemspec (set minimum Ruby to 3.2)
+- Add Gemfile
+- Remove json gem dependency
+- Api: Deduplicate any number of consecutive slashes
+- Add RSpec and test suites
+- Upgrade dependencies
+- Update gem metadata and README following project rename
+- Upgrade version, and simplify its handling

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2011,2012 Delano Mandelbaum
+
+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,9 @@
+# Onetime-up
+
+Fork of the Ruby program [`One-Time Secret`](https://github.com/onetimesecret/onetime-ruby), using the API v2.
+
+See the original website for usage (commands are unchanged).
+
+## Breaking changes
+
+The command `metadata` has been renamed `receipt` for consistency with the API.

data/bin/onetime

@@ -0,0 +1,214 @@
+#!/usr/bin/ruby
+
+base_path = File.expand_path File.join(File.dirname(__FILE__), '..')
+$:.unshift File.join(base_path, 'lib')
+
+require 'uri'
+require 'onetime/api'
+require 'drydock'
+
+class Onetime::CLI
+  class Definition
+    extend Drydock
+
+    default :share
+
+    global :H, String, "Base URI (e.g. https://onetimesecret.com/api)"
+    global :c, :custid, String, "Customer ID (e.g. you@yourcompany.com)"
+    global :k, :apikey, String, "API key (e.g. 4eb33c6340006d6607c813fc7e707a32f8bf5342)"
+
+    global :r, :recipient, Array, "Email address to deliver the secret link"
+
+    global :f, :format, String, "Output format (json or yaml)"
+    global :j, :json, "Shorthand for -f json"
+    global :y, :yaml, "Shorthand for -f yaml"
+    global :s, :string, "Shorthand for -f string (default)"
+
+    global :D, :debug do
+      OT::API.debug_output STDERR
+    end
+
+    global :V, :version do
+      puts OT::VERSION
+      exit 0
+    end
+
+    before do |obj|
+      OT::API.base_uri obj.global.H if obj.global.H
+      @api = OT::API.new obj.global.custid, obj.global.apikey
+      obj.global.format = 'yaml' if obj.global.yaml
+      obj.global.format = 'json' if obj.global.json
+      obj.global.format = 'string' if obj.global.string
+      obj.global.format = nil if obj.global.format == 'string'
+      if obj.global.format && !['json', 'yaml', 'csv'].member?(obj.global.format)
+        raise RuntimeError, "Unsupported format: #{obj.global.format}"
+      end
+    end
+
+    usage "onetime status"
+    command :status do |obj|
+      @res = @api.get '/status'
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request'
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
+      case obj.global.format
+      when 'json'
+        puts @res.to_json
+      when 'yaml'
+        puts @res.to_yaml
+      else
+        msg = @api.anonymous ? 'Anonymous' : @api.custid
+        STDERR.puts '# Host: %s' % OT::API.base_uri
+        STDERR.puts '# Account: %s' % msg
+        puts 'Service Status: %s' % @res[:status]
+      end
+    end
+
+    argv :key
+    usage "onetime receipt <KEY>"
+    command :receipt do |obj|
+      raise RuntimeError, "csv not supported" if obj.global.format == 'csv'
+      raise RuntimeError, "Usage: #{$0} receipt <KEY>" unless obj.argv.key
+      @res = @api.get '/receipt/%s' % obj.argv.key
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request'
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
+      case obj.global.format
+      when 'json'
+        puts @res.to_json
+      when 'yaml'
+        puts @res.to_yaml
+      else
+        puts @res.to_yaml
+      end
+    end
+
+    option :p, :passphrase, String, "Passphrase to decrypt the secret (only required if one was provided to you)"
+    argv :key
+    usage "onetime secret <KEY>"
+    usage "onetime secret [-p PASSPHRASE] <KEY>"
+    command :secret do |obj|
+      raise RuntimeError, "csv not supported" if obj.global.format == 'csv'
+      raise RuntimeError, "Usage: #{$0} secret <KEY>" unless obj.argv.key
+      opts = {}
+      opts[:passphrase] = obj.option.passphrase if obj.option.passphrase
+      base_uri = URI.parse Onetime::API.base_uri
+      if obj.argv.key =~ /#{base_uri.hostname}\/secret\/([a-zA-Z0-9]+)/
+        obj.argv.key = $1
+      end
+      @res = @api.post '/secret/%s/reveal' % [obj.argv.key], opts
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request'
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
+      case obj.global.format
+      when 'json'
+        puts @res.to_json
+      when 'yaml'
+        puts @res.to_yaml
+      else
+        value = @res['record'] && @res['record']['value']
+        puts value if value
+      end
+    end
+    command_alias :secret, :get
+
+    usage "onetime share"
+    usage "onetime share [-t 3600] [-p PASSPHRASE]"
+    usage "echo 'your secret' | onetime share"
+    usage "<path/2/file onetime share"
+    option :t, :ttl, Integer, "Time-to-live in seconds"
+    option :p, :passphrase, String, "Passphrase to encrypt the secret (something only you and recipient know)"
+    option :r, :recipient, Array, "Email address to deliver the secret link"
+    command :share do |obj|
+      recipients = [obj.option.recipient, obj.global.recipient].flatten.compact.uniq
+      begin
+        if Kernel.select [$stdin], nil, nil, 0
+          secret_value = STDIN.read
+        else
+          STDERR.puts "Paste message here (hit control-D to continue):"
+          secret_value = ARGF.read
+          STDERR.puts # new line to let the person know we got it.
+        end
+      rescue Interrupt => ex
+        puts "Exiting..."
+        exit 0
+      end
+      raise RuntimeError, "No secret provided" if secret_value.chomp.empty?
+      opts = { :secret => secret_value, :ttl => obj.option.ttl, :recipient => recipients }
+      opts[:passphrase] = obj.option.passphrase if obj.option.passphrase
+      @res = @api.post '/secret/conceal', opts
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request'
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
+      secret_key = @res['record']['secret']['key']
+      uri = OT::API.web_uri('secret', secret_key)
+      case obj.global.format
+      when 'json'
+        puts @res.to_json
+      when 'yaml'
+        puts @res.to_yaml
+      else
+        recipient = @res['details']['recipient']
+        if recipient && !recipient.compact.empty?
+          STDERR.puts '# Secret link sent to: %s' % recipient.join(',')
+        else
+          puts uri
+        end
+      end
+    end
+
+    usage "onetime generate"
+    usage "onetime generate [-t 3600] [-p PASSPHRASE]"
+    option :t, :ttl, Integer, "Time-to-live in seconds"
+    option :p, :passphrase, String, "Passphrase to encrypt the secret (something only you and recipient know)"
+    option :r, :recipient, Array, "Email address to deliver the secret link"
+    command :generate do |obj|
+      recipients = [obj.option.recipient, obj.global.recipient].flatten.compact.uniq
+      opts = { :ttl => obj.option.ttl, :recipient => recipients }
+      opts[:passphrase] = obj.option.passphrase if obj.option.passphrase
+      @res = @api.post '/secret/generate', opts
+      if @res.nil?
+        raise RuntimeError, 'Could not complete request'
+      elsif @api.response.code != 200
+        raise RuntimeError, @res['message']
+      end
+      secret_key = @res['record']['secret']['key']
+      uri = OT::API.web_uri('secret', secret_key)
+      case obj.global.format
+      when 'json'
+        puts @res.to_json
+      when 'yaml'
+        puts @res.to_yaml
+      when 'csv'
+        puts uri
+      else
+        recipient = @res['details']['recipient']
+        if recipient && !recipient.compact.empty?
+          STDERR.puts '# Secret link sent to: %s' % recipient.join(',')
+        else
+          puts uri
+        end
+      end
+    end
+
+  end
+end
+
+begin
+  Drydock.run! ARGV, STDIN
+rescue RuntimeError => ex
+  STDERR.puts ex.message
+  exit 1
+rescue => ex
+  puts ex.message
+  puts ex.backtrace
+  exit 1
+end

data/lib/onetime/api.rb

@@ -0,0 +1,134 @@
+
+
+require 'httparty'
+require 'uri'
+require_relative 'version'
+
+begin
+  require 'yajl-ruby'
+rescue LoadError => ex
+  require 'json'
+end
+
+begin
+  require 'yaml'
+rescue LoadError => ex
+end
+
+
+# Onetime::API - v0.3
+#
+# A basic client library for the onetimesecret.com API.
+#
+# Usage:
+#
+#     api = OT::API.new 'delano@onetimesecret.com', '4eb33c6340006d6607c813fc7e707a32f8bf5342'
+#
+#     api.get '/status'
+#       # => {'status' => 'nominal'}
+#
+#     api.post '/generate', :passphrase => 'yourspecialpassphrase'
+#       # => {'value' => '3Rg8R2sfD3?a', 'metadata_key' => '...', 'secret_key' => '...'}
+#
+module Onetime
+  class API
+    unless defined?(Onetime::API::HOME)
+      HOME = File.expand_path File.join(File.dirname(__FILE__), '..', '..')
+    end
+  end
+  class API
+    include HTTParty
+    base_uri 'https://eu.onetimesecret.com/api'
+    format :json
+    headers 'X-Onetime-Client' => 'ruby: %s/%s' % [RUBY_VERSION, Onetime::VERSION]
+    attr_reader :opts, :response, :custid, :key, :default_params, :anonymous
+    def initialize custid=nil, key=nil, opts={}
+      unless ENV['ONETIME_HOST'].to_s.empty?
+        self.class.base_uri ENV['ONETIME_HOST']
+      end
+      @opts = opts
+      @default_params = {}
+      @custid = custid || ENV['ONETIME_CUSTID']
+      @key = key || ENV['ONETIME_APIKEY']
+      if @custid.to_s.empty? && @key.to_s.empty?
+        @anonymous = true
+      elsif @custid.to_s.empty? || @key.to_s.empty?
+        raise RuntimeError, "You provided a custid without an apikey" if @key.to_s.empty?
+        raise RuntimeError, "You provided an apikey without a custid" if @custid.to_s.empty?
+      else
+        @anonymous = false
+        opts[:basic_auth] ||= { :username => @custid, :password => @key }
+      end
+    end
+    def get path, params=nil
+      opts = self.opts.clone
+      opts[:query] = (params || {}).merge default_params
+      execute_request :get, path, opts
+    end
+    def post path, params=nil
+      opts = self.opts.clone
+      body_params = (params || {}).merge default_params
+
+      # V2 API uses JSON format
+      opts[:headers] = (opts[:headers] || {}).merge({
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      })
+
+      # Only /secret/conceal and /secret/generate wrap params in "secret" key
+      # Other endpoints (reveal, burn, etc.) do NOT wrap
+      if path =~ /\/secret\/(conceal|generate)$/
+        body_params = { secret: body_params }
+      end
+
+      opts[:body] = body_params.to_json
+
+      execute_request :post, path, opts
+    end
+    def api_path *args
+      args.unshift ['', 'v2'] # force leading slash and v2 version
+      path = args.flatten.join('/')
+      path.gsub(/\/+/, '/')
+    end
+    private
+    def execute_request meth, path, opts
+      path = api_path [path]
+      @response = self.class.send meth, path, opts
+      result = self.class.indifferent_params @response.parsed_response
+      result
+    end
+    class << self
+      def web_uri *args
+        uri = URI.parse(OT::API.base_uri)
+        uri.path = web_path *args
+        uri
+      end
+      def web_path *args
+        args.unshift [''] # force leading slash
+        path = args.flatten.join('/')
+        path.gsub(/\/+/, '/')
+      end
+      def indifferent_params(params)
+        if params.is_a?(Hash)
+          params = indifferent_hash.merge(params)
+          params.each do |key, value|
+            next unless value.is_a?(Hash) || value.is_a?(Array)
+            params[key] = indifferent_params(value)
+          end
+        elsif params.is_a?(Array)
+          params.collect! do |value|
+            if value.is_a?(Hash) || value.is_a?(Array)
+              indifferent_params(value)
+            else
+              value
+            end
+          end
+        end
+      end
+      def indifferent_hash
+        Hash.new {|hash,key| hash[key.to_s] if Symbol === key }
+      end
+    end
+  end
+end
+OT = Onetime unless defined?(OT)

data/lib/onetime/version.rb

@@ -0,0 +1,3 @@
+module Onetime
+  VERSION = "0.6.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: onetime-up
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Delano Mandelbaum
+- Saverio Miroddi
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: drydock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Ruby library and command-line tool for sharing secrets securely using
+  the onetimesecret.com API. Create and retrieve one-time secret links for sensitive
+  information.
+email:
+- delano@onetimesecret.com
+- saverio.pub2@gmail.com
+executables:
+- onetime
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bin/onetime
+- lib/onetime/api.rb
+- lib/onetime/version.rb
+homepage: https://github.com/onetimesecret/onetime-ruby-up
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/onetimesecret/onetime-ruby-up
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Command-line tool and library for onetimesecret.com API (API v2)
+test_files: []