number_station 0.0.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87052778b344b664ebdbb4e7d9634064c5c3afa4d3b8b20e9d1ab77895c0d493
-  data.tar.gz: 4fe01f004ed3dae32e9f245815e0c3db2833ea63f4d3a5dbd8253021b2482d2e
+  metadata.gz: 9ffaf0a85087f356cdd5227039ec8731ff0a89d9cdf7e2a5020bb53cc0be74a6
+  data.tar.gz: 88c9c3a558e45684db5f85e0bf32c02ab55b026f146b6b5d2c2816fa6d01f21c
 SHA512:
-  metadata.gz: f283b7f691d168924c99f8a388a82322dc5ea6600d1cdea14772563189bb91752243a249c716c09e7c394316c63e02061f1313822a4220f336d5cf2706ffebbc
-  data.tar.gz: ac8f1a34e6797f617389ab8f18e3f53ffd7c62f8498a63e434f4a8f07fa17b59fb26db402297248d4a7a5700189845238e9a24bb62e81dee4bd1224a26548c50
+  metadata.gz: a7757a314e15e2fda90ec3689ff63fa45e93a1e0e840c3c3c1a8e8313bb86a6b98acfa464f6ad2c3ed8f15dfbc4f26433fc8bdd2c0ee7795266bd177a81d9632
+  data.tar.gz: 9e7885c467a9804e10ae8d478e4ee8d5253c999e8e9fdbc6fef0c632ee182689c48a7184e9897f6245182d38b3e66335f1214dfc33874bb159e55c61d1a025d0

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+# What
+
+
+
+# Why
+
+
+
+
+# How
+
+
+
+# Verification Steps
+
+
+
+## Checklist:
+
+- [ ] Code has been tested locally by PR requester
+- [ ] Changes have been successfully verified by another team member 

data/{CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.asciidoc}

@@ -1,6 +1,4 @@
-# Contributor Code of Conduct
-
+== Contributor Code of Conduct ==
 This project adheres to No Code of Conduct.  We are all adults.  We accept anyone's contributions.  Nothing else matters.
 
 For more information please visit the [No Code of Conduct](https://github.com/domgetter/NCoC) homepage.
-

data/CONTRIBUTING.asciidoc

@@ -0,0 +1,2 @@
+== Contributing ==
+Contributions are welcome, please fork the repo, create a branch, add your code, and make a PR against master on this repo.

data/README.asciidoc

@@ -5,9 +5,14 @@ image:https://badge.fury.io/rb/number_station.svg["Gem Version", link="https://b
 
 === Contributing ===
 Contributions are welcome, please fork the repo, create a branch, add your code, and make a PR
-against master on this repo.
+against master on this repo. For more information see _CONTRIBUTING.asciidoc_
 
 === Licence ===
-number_station is distributed under the GPL 3.0 licence. For more information see the _COPYING_
+number_station is distributed under the GPL 3.0 licence. For more information see the _COPYING.asciidoc_
 file.
 
+=== Number Station Resources ===
+
+- https://linuxcoffee.com/numbers/
+- http://users.telenet.be/d.rijmenants/en/onetimepad.htm
+- https://www.numbers-stations.com/

data/lib/number_station/GLaDOS_espeak.rb

@@ -0,0 +1,36 @@
+def template(word)
+  sign = randomsign() || ""
+  return "<prosody pitch=\"#{sign + rand(0..80).to_s}\">#{word}</prosody>"
+end
+
+def randomsign()
+  rnum = rand(0..1)
+
+  if rnum == 0
+    return "-"
+  else
+    return "+"
+  end
+end
+
+
+message = "This was a triumph! I'm making a note here, huge success."
+
+words = message.split(" ")
+sentence = "<speak version=\"1.0\" xmlns=\"\" xmlns:xsi=\"\" xsi:schemaLocation=\"\" xml:lang=\"\"><voice gender=\"female\">"
+sentenceend = "</voice></speak>"
+
+words.each do |i|
+  sentence += template(i)
+end
+
+final = sentence + sentenceend
+
+
+filename = "GLaDOS_espeak_config.xml"
+f = File.open(filename, "w")
+f.write(final)
+f.close
+
+cmd = "espeak -ven+f3 -m -p 60 -s 180 -f #{filename}"
+`#{cmd}`

data/lib/number_station/cli.rb

@@ -24,76 +24,83 @@ require 'fileutils'
 
 module NumberStation
   class CLI < Thor
-    
+
 
     # create_config
     desc "create_config [--path PATH]", "copy the sample config to current directory."
     long_desc <<-CREATE_CONFIG_LONG_DESC
       `create_config` will copy the sample config from config/config.json to the current directory. If the
-      optional parameter `--path PATH` is passed then this file is copied to the location specified by the 
+      optional parameter `--path PATH` is passed then this file is copied to the location specified by the
       PATH parameter.
+      Sample Intro and Outro messages are also copied to this directory. If you wish to automatically append
+      these messages, change the conf.json boolean.
     CREATE_CONFIG_LONG_DESC
     option :path, :type => :string
     def create_config()
+      config_file_path = File.join(File.dirname(__FILE__), "../../resources/conf.json")
+      intro_file_path = File.join(File.dirname(__FILE__), "../../resources/intro_message.txt")
+      outro_file_path = File.join(File.dirname(__FILE__), "../../resources/outro_message.txt")
+
+      options[:path] ? path = options[:path] : path = File.join(Dir.home, "/number_station")
+
+      unless Dir.exist?(path) then FileUtils.mkdir(path) end
+      unless File.file?(File.join(path, "conf.json")) then FileUtils.cp(config_file_path, File.join(path, "conf.json")) end
+      unless File.file?(File.join(path, "intro_message.txt")) then FileUtils.cp(intro_file_path, File.join(path, "intro_message.txt")) end
+      unless File.file?(File.join(path, "outro_message.txt")) then FileUtils.cp(outro_file_path, File.join(path, "outro_message.txt")) end
       NumberStation::ConfigReader.read_config()
-      config_file_path = File.join(File.dirname(__FILE__), "../../config/conf.json")
-
-      if options[:path]
-        path = options[:path]
-        unless File.file?(File.join(path, "/conf.json"))
-          #write config to path
-          NumberStation.log.debug "Copying sample config to #{path}"
-          FileUtils.cp(config_file_path, path)
-        else
-          NumberStation.log.debug "File already exists at #{File.join(path, "/conf.json")}"
-        end
-      else
-        path = Dir.pwd
-        unless File.file?(File.join(path, "/conf.json"))
-          #write config to local directory the binary was called from
-          NumberStation.log.debug "Copying sample config to #{path}"
-          FileUtils.cp(config_file_path, path)
-        else
-          NumberStation.log.debug "File already exists at #{File.join(path, "/conf.json")}"
-        end
-      end
+      NumberStation.log.debug "create_config completed"
     end
 
 
     # convert_to_phonetic
-    desc "convert_to_phonetic [MESSAGE]", "Convert a message to phonetic output."
+    desc "convert_to_phonetic [MESSAGE_PATH]", "Convert a message to phonetic output."
     long_desc <<-CONVERT_MESSAGE_LONG_DESC
       convert_message takes a parameter which should point to a text file containing a message.
+        MESSAGE_PATH\n
       Optional parameters:\n
-        MESSAGE\n
-        --intro [INTRO] should be a text file containing intro message.\n
-        --outro [OUTRO] should be a text file containing the outro message.\n
+        --intro [INTRO_PATH] should be a text file containing intro message. Overrides value in conf.json\n
+        --outro [OUTRO_PATH] should be a text file containing the outro message. Overrides value in conf.json\n
         --mp3 [MP3] output message as an mp3 file.
-     
+
       Final message will be created from intro + message + outro
     CONVERT_MESSAGE_LONG_DESC
     option :intro, :type => :string
     option :outro, :type => :string
     option :mp3, :type => :string
-    def convert_to_phonetic(message)
+    def convert_to_phonetic(message_path)
       NumberStation::ConfigReader.read_config()
 
-      intro_path = options[:intro]
-      message_path = message
-      outro_path = options[:outro]
-      mp3_path = options[:mp3]
-      NumberStation.log.debug "intro_path: #{intro_path}" if options[:intro]
+      if options[:intro]
+        intro_path = options[:intro]
+        intro = NumberStation.to_phonetic(intro_path)
+      elsif NumberStation.data["resources"]["intro"]["enabled"]
+        intro_path = NumberStation.data["resources"]["intro"]["template"]
+        intro = NumberStation.to_phonetic(intro_path)
+      else
+        intro_path = ""
+      end
+
+      if options[:outro]
+        outro_path = options[:outro]
+        outro = NumberStation.to_phonetic(outro_path)
+      elsif NumberStation.data["resources"]["outro"]["enabled"]
+        outro_path = NumberStation.data["resources"]["outro"]["template"]
+        outro = NumberStation.to_phonetic(outro_path)
+      else
+        outro_path = ""
+        outro = ""
+      end
+      NumberStation.log.debug "intro enabled: #{NumberStation.data["resources"]["intro"]["enabled"]} path: #{intro_path}"
       NumberStation.log.debug "message_path: #{message_path}"
-      NumberStation.log.debug "outro_path: #{outro_path}" if options[:outro]
-      NumberStation.log.debug "mp3_path: #{mp3_path}" if options[:mp3]
+      NumberStation.log.debug "outro enabled: #{NumberStation.data["resources"]["outro"]["enabled"]} path: #{outro_path}"
 
-      output = ""
-      output += NumberStation.to_phonetic(intro_path) if options[:intro]
-      output += NumberStation.to_phonetic(message_path)
-      output += NumberStation.to_phonetic(outro_path) if options[:outro]
+      message = NumberStation.to_phonetic(message_path)
+      output = intro + message + outro
       NumberStation.log.info "output: #{output}"
 
       if options[:mp3]
+        mp3_path = options[:mp3]
+        NumberStation.log.debug "mp3_path: #{mp3_path}" if options[:mp3]
         NumberStation.log.debug "Generating mp3 output: #{mp3_path}"
         NumberStation.write_mp3(output, mp3_path)
       end
@@ -110,7 +117,7 @@ module NumberStation
       --numpads NUM\n
       --length LENGTH
 
-    If no parameters are passed it will generate 5 one time pads in the current 
+    If no parameters are passed it will generate 5 one time pads in the current
     directory of size 250 characters.
     MAKE_ONE_TIME_PAD_LONG_DESC
     option :length, :type => :numeric
@@ -189,5 +196,18 @@ module NumberStation
     end
 
 
+    # version
+    desc "version", "Print the version of the Number Stations gem."
+    long_desc <<-VERSION_LONG_DESC
+    Prints the version of the Number Stations gem.
+    VERSION_LONG_DESC
+    def version()
+      NumberStation::ConfigReader.read_config()
+      NumberStation.log.debug "Version: #{NumberStation::VERSION}"
+    end
+
+    def self.exit_on_failure?()
+      false
+    end
   end
 end

data/lib/number_station/config_reader.rb

@@ -24,7 +24,7 @@ module NumberStation
 
     def self.read_config()
       begin
-        config_file_path = File.join(Dir.pwd, "conf.json")
+        config_file_path = File.join(Dir.home, "number_station/conf.json")
         NumberStation.set_data( JSON.parse(File.read(config_file_path)) )
         NumberStation.set_log( Logger.new(STDOUT) )
         NumberStation.log.level = NumberStation.data["logging"]["level"]

data/lib/number_station/decrypt_message.rb

@@ -34,6 +34,10 @@ module NumberStation
     end
 
     crypto_hex_str = pad_data["pads"][pad_num]["key"]
+    if message.size > crypto_hex_str.size
+      NumberStation.log.error "Error: The message length is greater than pad length. Unable to continue decryption."
+      exit
+    end
     NumberStation.log.debug "message length less than pad length: #{message.size <= crypto_hex_str.size}"
 
     crypto_byte_array = crypto_hex_str.scan(/.{1}/).each_slice(2).map { |f, l| (Integer(f,16) << 4) + Integer(l,16) }
@@ -44,7 +48,17 @@ module NumberStation
     end
 
     decrypted_string = decrypted_byte_array.pack('U*').force_encoding('utf-8')
+
+    begin
+      f_name = "#{pad_data["id"]}_#{pad_num}_#{Time.now.to_i}_decrypted.txt"
+      NumberStation.log.info "Writing decrypted message to file #{f_name}"
+      f = File.open(f_name, "w")
+      f.write(decrypted_string)
+      f.close
+    rescue Exception => e
+      raise e
+    end
     return decrypted_string
   end
 
-end
+end

data/lib/number_station/encrypt_message.rb

@@ -33,8 +33,15 @@ module NumberStation
       raise e
     end
 
+    crypto_hex_str = pad_data["pads"][pad_num]["key"]
+
+    if message.size > crypto_hex_str.size
+      NumberStation.log.error "Exception: message length is larger than pad length. Break the message into smaller parts."
+      exit
+    end
+    NumberStation.log.debug "message length less than pad length"
+
     unless pad_data["pads"][pad_num]["consumed"]
-      crypto_hex_str = pad_data["pads"][pad_num]["key"]
       NumberStation.log.debug "Marking key as consumed"
       pad_data["pads"][pad_num]["epoch_date"] = Time.now.to_i
       pad_data["pads"][pad_num]["consumed"] = true
@@ -47,7 +54,6 @@ module NumberStation
        exit
     end
 
-    NumberStation.log.debug "message length less than pad length: #{message.size <= crypto_hex_str.size}"
     crypto_byte_array = crypto_hex_str.scan(/.{1}/).each_slice(2).map { |f, l| (Integer(f,16) << 4) + Integer(l,16) }
 
     encrypted_byte_array = []
@@ -59,7 +65,7 @@ module NumberStation
 
     begin
       f_name = "#{pad_data["id"]}_#{pad_num}_#{Time.now.to_i}.txt"
-      NumberStation.log.debug "Writing encrypted message to file #{f_name}"
+      NumberStation.log.info "Writing encrypted message to file #{f_name}"
       f = File.open(f_name, "w")
       f.write(encrypted_byte_str)
       f.close
@@ -70,4 +76,4 @@ module NumberStation
     return encrypted_byte_str
   end
 
-end
+end

data/lib/number_station/phonetic_conversion.rb

@@ -95,7 +95,11 @@ module NumberStation
 
 
   def self.call_espeak(input_file_path, output_file_path)
-    cmd = "espeak -ven+f3 -m -p 60 -s 180 -f #{input_file_path} --stdout | ffmpeg -i - -ar 44100 -ac 2 -ab 192k -f mp3 #{output_file_path}"
+    if NumberStation.data["resources"]["espeak"]["glados"]
+      cmd = "espeak -ven+f3 -m -p 60 -s 180 -f #{input_file_path} --stdout | ffmpeg -i - -ar 44100 -ac 2 -ab 192k -f mp3 #{output_file_path}"
+    else
+      cmd = "espeak -m -p 60 -s 180 -f #{input_file_path} --stdout | ffmpeg -i - -ar 44100 -ac 2 -ab 192k -f mp3 #{output_file_path}"
+    end
 
     unless NumberStation.command?('espeak') || NumberStation.command?('ffmpeg')
       NumberStation.log.error "number_station requires the espeak and ffmpeg utilities are installed in order to output an mp3 file."
@@ -106,8 +110,12 @@ module NumberStation
 
 
   def self.write_mp3(message, output_file_path)
-    filename = NumberStation.data["resources"]["espeak_sentence_template"]
-    sentence = NumberStation.generate_sentence(message)
+    filename = NumberStation.data["resources"]["espeak"]["sentence_template"]
+    if NumberStation.data["resources"]["espeak"]["glados"]
+      sentence = NumberStation.generate_sentence(message)
+    else
+      sentence = message
+    end
     NumberStation.write_espeak_template_file(filename, sentence)
     NumberStation.call_espeak(filename, output_file_path)
   end
@@ -115,19 +123,16 @@ module NumberStation
 
   def self.to_phonetic(file_name)
     message = ''
-
+    puts file_name
     f = File.open(file_name)
-    raw_message = f.readlines()
+    raw_message = f.read()
     f.close()
 
-    raw_message.each do |i|
-      # puts i
-      i.gsub!(/\n/, "").strip.each_char do |c|
-        message += NumberStation.lookup_phonetic(c)
-      end
+    raw_message.each_char do |c|
+      message += NumberStation.lookup_phonetic(c)
     end
-    return message + "\n"
+    return message
   end
 
 
-end
+end

data/lib/number_station/version.rb

@@ -20,5 +20,5 @@
 =end
 
 module NumberStation
-  VERSION = "0.0.4"
+  VERSION = "0.2.0"
 end

data/lib/number_station.rb

@@ -32,23 +32,10 @@ require 'number_station/version'
 
 module NumberStation
 
-  def self.hexlify(s)
-    a = []
-    s.each_byte do |b|
-      a << sprintf('%02X', b)
-    end
-    a.join
-  end
- 
-  def self.unhexlify(s)
-    a = s.split
-    return a.pack('H*')
-  end
-
   def self.command?(name)
     `which #{name}`
     $?.success?
-  end  
+  end
 
   def self.set_log(log)
     @log = log

data/number_station.gemspec

@@ -26,7 +26,7 @@ require "number_station/version"
 Gem::Specification.new do |spec|
   spec.name          = "number_station"
   spec.version       = NumberStation::VERSION
-  spec.date          = "2018-10-23"
+  spec.date          = "2018-11-29"
   spec.authors       = ["David Kirwan"]
   spec.email         = ["davidkirwanirl@gmail.com"]
   spec.license       = "GPL 3.0"
@@ -56,6 +56,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "pastel"
   spec.add_dependency "thor"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake"
 end

data/resources/conf.json

@@ -0,0 +1,14 @@
+{
+  "logging":{
+    "level":0
+  },
+  "server":{
+    "host":"0.0.0.0",
+    "port":8080
+  },
+  "resources":{
+    "espeak": {"sentence_template": "/tmp/espeak_tmp.xml", "glados":false},
+    "intro": {"template":"intro_message.txt", "enabled":true},
+    "outro": {"template":"outro_message.txt", "enabled":true}
+  }
+}

data/resources/intro_message.txt

@@ -1 +1 @@
-ei7htb ei7htb
+sample intro message

data/resources/outro_message.txt

@@ -1 +1 @@
-ei7htb ei7htb
+sample outro message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: number_station
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.2.0
 platform: ruby
 authors:
 - David Kirwan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2018-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -38,34 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: "(WIP) A collection of utilities to aid in running your own number station!"
 email:
 - davidkirwanirl@gmail.com
@@ -77,15 +63,17 @@ files:
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/custom.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
-- CODE_OF_CONDUCT.md
-- COPYING
+- CODE_OF_CONDUCT.asciidoc
+- CONTRIBUTING.asciidoc
+- COPYING.asciidoc
 - Gemfile
 - README.asciidoc
 - Rakefile
 - bin/number_station
-- config/conf.json
 - lib/number_station.rb
+- lib/number_station/GLaDOS_espeak.rb
 - lib/number_station/cli.rb
 - lib/number_station/config_reader.rb
 - lib/number_station/decrypt_message.rb
@@ -94,7 +82,7 @@ files:
 - lib/number_station/phonetic_conversion.rb
 - lib/number_station/version.rb
 - number_station.gemspec
-- resources/body_message.txt
+- resources/conf.json
 - resources/intro_message.txt
 - resources/outro_message.txt
 homepage: https://rubygems.org/gems/number_station
@@ -102,7 +90,7 @@ licenses:
 - GPL 3.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,9 +105,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: "(WIP) Run your own number station!"
 test_files: []

data/config/conf.json

@@ -1,16 +0,0 @@
-{
-  "logging":{
-    "level":0
-  },
-  "server":{
-    "host":"localhost",
-    "port":8080
-  },
-  "resources":{
-    "espeak_sentence_template":"/tmp/GLaDOS_template.xml",
-    "path":"resources",
-    "intro":"intro.txt",
-    "message":"message.txt",
-    "outro":"outro.txt"
-  } 
-}

data/resources/body_message.txt

@@ -1 +0,0 @@
-1234abcd 5678efgh