number_station 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ffaf0a85087f356cdd5227039ec8731ff0a89d9cdf7e2a5020bb53cc0be74a6
-  data.tar.gz: 88c9c3a558e45684db5f85e0bf32c02ab55b026f146b6b5d2c2816fa6d01f21c
+  metadata.gz: 28bb32733b0cc2c4dd9a9258985a762e6cf558b9ec3a05d7438a5d4b53332dfe
+  data.tar.gz: dc4f7d34bd69879eb4eda6ac0774f2fa20c65433d6d841a98a7f97968562daf8
 SHA512:
-  metadata.gz: a7757a314e15e2fda90ec3689ff63fa45e93a1e0e840c3c3c1a8e8313bb86a6b98acfa464f6ad2c3ed8f15dfbc4f26433fc8bdd2c0ee7795266bd177a81d9632
-  data.tar.gz: 9e7885c467a9804e10ae8d478e4ee8d5253c999e8e9fdbc6fef0c632ee182689c48a7184e9897f6245182d38b3e66335f1214dfc33874bb159e55c61d1a025d0
+  metadata.gz: a86c1b266dd7d5837bf99d1eafecb545fe36ebb86649013dee3bb9a5cff9d507021f257c8595452a0a0f2c91a96cbb579769cadf0245f3983bf9f31371e82891
+  data.tar.gz: a8be3d5d110b854ac1254c9fdfb38b062dbb7fbbdbc828617c7c63fdfc40426627a6d1f086c772dfe6c6360a4a88f9eefdaea111d0ec1e6d7e98c53d308d236d

data/README.asciidoc

@@ -1,8 +1,143 @@
 == number_station ==
-This gem (WIP) contains a number of utilities to aid in the running of a number station.
+
+This gem contains utilities to aid in the running of a number station.
 
 image:https://badge.fury.io/rb/number_station.svg["Gem Version", link="https://badge.fury.io/rb/number_station"]
 
+=== Installation ===
+
+[source,bash]
+----
+gem install number_station
+----
+
+=== Usage ===
+
+==== Configuration ====
+
+Create the initial configuration:
+
+[source,bash]
+----
+number_station create_config
+----
+
+This creates `~/number_station/conf.yaml` and copies template files (`intro_message.txt`, `outro_message.txt`, `repeat_message.txt`) to the same directory.
+
+==== Agent Management ====
+
+Manage agents using the `agents` subcommand:
+
+*Create an agent:*
+
+[source,bash]
+----
+number_station agents create NAME [--location LOCATION] [--handler HANDLER]
+----
+
+*Activate/Deactivate:*
+
+[source,bash]
+----
+number_station agents activate NAME [--start-date DATE]
+number_station agents deactivate NAME [--end-date DATE]
+----
+
+*Update handler codeword:*
+
+[source,bash]
+----
+number_station agents update-handler NAME HANDLER
+----
+
+*View agents:*
+
+[source,bash]
+----
+number_station agents list              # Active agents only
+number_station agents list-all          # All agents with history
+number_station agents stats             # Detailed statistics
+----
+
+==== One-Time Pads ====
+
+*Create pads:*
+
+[source,bash]
+----
+number_station pad create [--name AGENT] [--numpads NUM] [--length LENGTH]
+----
+
+If `--name` is provided, creates pad in `~/number_station/pads/AGENT/` directory.
+Defaults: 500 pads, 500 characters (rounded up to nearest multiple of 5).
+
+*View pad statistics:*
+
+[source,bash]
+----
+number_station pad stats [--path PATH]
+----
+
+Shows pad statistics grouped by agent, including unconsumed pad counts.
+
+==== Message Encryption/Decryption ====
+
+*Encrypt:*
+
+[source,bash]
+----
+number_station encrypt [MESSAGE] [--file FILE] [--agent AGENT] [--padpath PADPATH] [--numpad NUMPAD]
+----
+
+If `--agent` is provided, searches for oldest pad in agent-specific directory.
+Only active agents can encrypt messages.
+
+*Decrypt:*
+
+[source,bash]
+----
+number_station decrypt [MESSAGE] [--file FILE] [--padpath PADPATH] [--numpad NUMPAD]
+----
+
+==== Phonetic Conversion ====
+
+*Convert to phonetic:*
+
+[source,bash]
+----
+number_station convert_to_phonetic FILE [--intro INTRO_FILE] [--outro OUTRO_FILE] [--repeat REPEAT_FILE]
+----
+
+Converts encrypted message to phonetic alphabet. Output saved as `FILENAME_phonetic.txt`.
+Intro, outro, and repeat messages are included as-is (not converted).
+
+*Convert to espeak XML:*
+
+[source,bash]
+----
+number_station convert_to_espeak PHONETIC_FILE
+----
+
+Generates GLaDOS-style espeak XML file. Output saved as `FILENAME.xml`.
+
+*Generate MP3:*
+
+[source,bash]
+----
+number_station convert_to_mp3 XML_FILE
+----
+
+Converts XML to MP3 using espeak and ffmpeg. Output saved as `FILENAME.mp3`.
+
+*Play audio:*
+
+[source,bash]
+----
+number_station espeak XML_FILE
+----
+
+Plays the XML file using espeak with GLaDOS voice settings.
+
 === Contributing ===
 Contributions are welcome, please fork the repo, create a branch, add your code, and make a PR
 against master on this repo. For more information see _CONTRIBUTING.asciidoc_
@@ -14,5 +149,3 @@ file.
 === Number Station Resources ===
 
 - https://linuxcoffee.com/numbers/
-- http://users.telenet.be/d.rijmenants/en/onetimepad.htm
-- https://www.numbers-stations.com/

data/Rakefile

@@ -21,20 +21,74 @@
 
 require 'bundler'
 require 'fileutils'
+
+# Ensure we load from local lib directory, not installed gem
+# This must happen before requiring number_station/version
+lib = File.expand_path('lib', __FILE__)
+# Remove gem paths that might interfere
+gem_paths = $LOAD_PATH.select { |p| p.include?('gems') && p.include?('number_station') }
+gem_paths.each { |p| $LOAD_PATH.delete(p) }
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Load version from local source
+require_relative 'lib/number_station/version'
+
 Bundler::GemHelper.install_tasks
 
 task :default => :menu
 
+desc "Show available rake tasks"
 task :menu do
-  puts welcomeMsg = <<-MSG
-rake build    # Build number_station-x.x.x.gem into the pkg directory
-rake install  # Build and install number_station-x.x.x.gem into system gems
-rake release  # Create tag vx.x.x and build and push number_station-x.x.x.gem to http://rubygems.org/
+  puts <<-MSG
+Available tasks:
+
+  rake build      # Build number_station-x.x.x.gem into the pkg directory
+  rake install    # Build and install number_station-x.x.x.gem into system gems
+  rake release    # Create tag vx.x.x and build and push number_station-x.x.x.gem to http://rubygems.org/
+  rake clean      # Clean up build artifacts (.gem files and pkg directory)
+  rake version    # Show the current version
+  rake validate   # Validate the gemspec
+  rake console    # Start an interactive console with the gem loaded
+
 MSG
 end
 
 desc "Clean up build artifacts"
 task :clean do
   FileUtils.rm_rf("./pkg/")
+  FileUtils.rm_f(Dir.glob("*.gem"))
+  puts "Cleaned build artifacts"
+end
+
+desc "Show the current version"
+task :version do
+  puts "number_station version: #{NumberStation::VERSION}"
+end
+
+desc "Validate the gemspec"
+task :validate do
+  require 'rubygems/specification'
+  
+  begin
+    spec = Gem::Specification.load('number_station.gemspec')
+    puts "✓ Gemspec is valid"
+    puts "  Name: #{spec.name}"
+    puts "  Version: #{spec.version}"
+    puts "  Dependencies: #{spec.dependencies.map(&:name).join(', ')}"
+  rescue => e
+    puts "✗ Gemspec validation failed: #{e.message}"
+    exit 1
+  end
 end
 
+desc "Start an interactive console"
+task :console do
+  require 'irb'
+  require 'number_station'
+  ARGV.clear
+  IRB.start
+end
+
+# Clean before building
+task :build => :clean
+

data/lib/number_station/GLaDOS_espeak.rb

@@ -1,36 +1,79 @@
-def template(word)
-  sign = randomsign() || ""
-  return "<prosody pitch=\"#{sign + rand(0..80).to_s}\">#{word}</prosody>"
-end
+=begin
+ Ruby Number Station
+ Author: David Kirwan https://gitub.com/davidkirwan
+ Licence: GPL 3.0
+ NumberStation is a collection of utilities to aid in the running of a number station
+    Copyright (C) 2018  David Kirwan
 
-def randomsign()
-  rnum = rand(0..1)
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
 
-  if rnum == 0
-    return "-"
-  else
-    return "+"
-  end
-end
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
 
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+=end
 
-message = "This was a triumph! I'm making a note here, huge success."
+module NumberStation
+  def self.generate_glados_espeak(input_file_path)
+    # Read message from file
+    message = File.read(input_file_path)
+    
+    # Generate output filename: remove .txt extension and append .xml
+    input_basename = File.basename(input_file_path, File.extname(input_file_path))
+    output_filename = "#{input_basename}.xml"
+    output_path = File.join(File.dirname(input_file_path), output_filename)
+    
+    # Process message into GLaDOS-style XML
+    # Split by whitespace but preserve the structure - handle spaces and newlines
+    # Split on whitespace boundaries but keep track of what was between words
+    sentence = "<speak version=\"1.0\" xmlns=\"\" xmlns:xsi=\"\" xsi:schemaLocation=\"\" xml:lang=\"\"><voice gender=\"female\">"
+    sentenceend = "</voice></speak>"
 
-words = message.split(" ")
-sentence = "<speak version=\"1.0\" xmlns=\"\" xmlns:xsi=\"\" xsi:schemaLocation=\"\" xml:lang=\"\"><voice gender=\"female\">"
-sentenceend = "</voice></speak>"
+    # Split message into words, preserving spacing structure
+    # Use a regex that captures words and the whitespace after them
+    parts = message.split(/(\s+)/)
+    
+    parts.each do |part|
+      if part.match?(/^\s+$/)
+        # This is whitespace - preserve it (spaces or newlines)
+        sentence += part
+      elsif !part.empty?
+        # This is a word - wrap it in prosody tags
+        sentence += template(part)
+      end
+    end
 
-words.each do |i|
-  sentence += template(i)
-end
+    final = sentence + sentenceend
 
-final = sentence + sentenceend
+    # Write XML file
+    File.write(output_path, final)
+    if NumberStation.respond_to?(:log) && NumberStation.log
+      NumberStation.log.info "Generated GLaDOS espeak XML: #{output_path}"
+    end
+    
+    output_path
+  end
 
+  private
 
-filename = "GLaDOS_espeak_config.xml"
-f = File.open(filename, "w")
-f.write(final)
-f.close
+  def self.template(word)
+    sign = randomsign() || ""
+    "<prosody pitch=\"#{sign + rand(0..80).to_s}\">#{word}</prosody>"
+  end
+
+  def self.randomsign()
+    rnum = rand(0..1)
 
-cmd = "espeak -ven+f3 -m -p 60 -s 180 -f #{filename}"
-`#{cmd}`
+    if rnum == 0
+      return "-"
+    else
+      return "+"
+    end
+  end
+end