knocker 0.2.3 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b4289625cc8b8ca43224fc4529d4472a91a2aeb
-  data.tar.gz: eeda48021083930707232a70ead8f0d268d0aca4
+  metadata.gz: 4c96c78688e9f396b6164a1b2df98f3585d3b119
+  data.tar.gz: 80c5747c69c7d14e0a92ca187d17ccc0f8576772
 SHA512:
-  metadata.gz: 70096d1ec8d32d66acee9e44f3a2b640d214f4ca61e7c8352dc7338f65d7048ec2acd964fb9ad9a7feaf50a9dee0ce1116ad78c588afe87336fdbd2c39a97f86
-  data.tar.gz: 67a4544b1cc2c67de4e647b1d56ae498e7692399c61ce04d455a3ddce214b538324fc4cc0cc8810b87f33582d804df8654e010fd91e53265910f38fbfed6fe2e
+  metadata.gz: fc689efb5d4d067b0ffc275916a4ea37d952f705c86601764ad5720cbbc560e576e737525bd0b736914701f7a571b8b178e75be30434968f727a85f3567f4c51
+  data.tar.gz: e214473038ff51930d4adde2790d26a03b0308f8369428bed685a0469be4cbc62a9d81b63f21cd7f7e94659257340e54ec1047ba2b50eb603467955bb72efbe5

data/README.md

@@ -49,7 +49,7 @@ pattern pvtchatops
   u 5445
   t 4456
   t 63854
-  c xchat --url=irc://myvps.example.com:36777/chatops
+  c xchat --url=irc://$host:36777/chatops
 ```
 
 So when you run `nkr pvtchatops` it actually runs two commands:
@@ -63,10 +63,12 @@ Easy!
 
 As you saw, the config syntax is simple.
 
+* use pattern and a name to name the pattern
 * h and then the hostname/ip to connect to
 * t and the port number for a tcp knock (multiples allowed)
 * u and the port number for a udp knock (multiples allowed)
 * c and the command to run after knocking (multiples allowed)
+* on command lines use $host to use host defined for the pattern
 
 **Mix this with SSH config files and you will an unstoppable sysadmin!**
 

data/bin/nkr

@@ -1,11 +1,23 @@
 #!/usr/bin/env ruby
 
 require 'knocker'
-require 'fileutils'
 
 name = ARGV[0]
 
+def usage
+  <<-EOF
+Usage: nkr <--edit|pattern-name>
+  EOF
+end
+
+if name == "--edit" or name == "-e"
+  system "#{ENV["EDITOR"]} #{Knocker.config}"
+  exit
+end
+
 begin
+  raise ArgumentError, "Must provide pattern name" if name.nil? or name.empty?
+
   pattern = Knocker.pattern(name)
   system pattern.knock_command
   
@@ -14,15 +26,24 @@ begin
   end
 rescue Knocker::Errors::ConfigNotFound
   print "No config found, create one at #{Knocker.config}? [y/n]: "
-  FileUtils.touch Knocker.config if STDIN.gets.match /y/i
+  
+  if STDIN.gets.match /y/i
+    Knocker.create_config
+    puts "Created knocker config file (use --edit to edit it)"
+  else
+    abort "No config file... quitting"
+  end
+rescue ArgumentError => e
+  puts "ERROR: #{e.message}"
+  abort usage
 rescue Knocker::Errors::PatternNotFound
-  abort "No such pattern #{name}"
+  abort "ERROR: No such pattern #{name}"
 rescue Knocker::Errors::NoHostSpecified
-  abort "No host specified in pattern #{name}"
+  abort "ERROR: No host specified in pattern #{name}"
 rescue Knocker::Errors::NoKnockSpecified
-  abort "No port-knocks specified in pattern #{name}"
+  abort "ERROR: No port-knocks specified in pattern #{name}"
 rescue Knocker::Errors::InvalidProtocol => e
-  abort "Invalid protocol #{e.message} in pattern #{name}"
+  abort "ERROR: Invalid protocol #{e.message} in pattern #{name}"
 rescue Knocker::Errors::InvalidPort => e
-  abort "Invalid port #{e.message} in pattern #{name}"
+  abort "ERROR: Invalid port #{e.message} in pattern #{name}"
 end

data/lib/knocker.rb

@@ -2,6 +2,7 @@ require "knocker/version"
 require "knocker/errors"
 require "knocker/parser"
 require "knocker/pattern"
+require 'fileutils'
 
 module Knocker
   class << self
@@ -10,7 +11,21 @@ module Knocker
     end
 
     def pattern(name)
-      Knocker::Parser.new(config).find(name).to_hash
+      config_exists!
+      Knocker::Parser.new(File.read(config)).find(name)
+    end
+
+    def config_exists?
+      File.exist? config
+    end
+
+    def config_exists!
+      raise Knocker::Errors::ConfigNotFound unless config_exists?
+    end
+
+    def create_config
+      FileUtils.mkdir_p File.dirname(Knocker.config)
+      FileUtils.touch Knocker.config
     end
   end
 end

data/lib/knocker/parser.rb

@@ -1,8 +1,9 @@
 module Knocker
   class Parser
     def initialize(config)
-      raise Knocker::Errors::ConfigNotFound unless File.exist? config
-      @config = File.read(config).reject! {|line| line.start_with? "#"}
+      @config = config.lines.reject { |line|
+        line.start_with? "#"
+      }.join("")
     end
 
     def find(name)
@@ -13,15 +14,16 @@ module Knocker
     private
 
     def has_pattern!(name)
-      raise Knocker::Errors::PatterNotFound unless 
+      raise Knocker::Errors::PatternNotFound unless 
         @config.include? "pattern #{name}"
     end
 
     def extract(name)
-      start = @config.lines.index("pattern #{name}")
+      start = @config.split("\n").index("pattern #{name}")
+      start+= 1
       
-      @config.lines[start..-1].collect { |line|
-        break if line.blank?
+      @config.split("\n")[start..-1].collect { |line|
+        break if line.empty?
         line
       }.join("\n")
     end

data/lib/knocker/pattern.rb

@@ -17,7 +17,8 @@ module Knocker
 
     def host
       host = @text.scan(/  h (.*)/).flatten.first
-      raise Knocker::Errors::NoHostSpecified if host.nil? or host.blank?
+      raise Knocker::Errors::NoHostSpecified if host.nil? or host.empty?
+      host
     end
 
     def knock_command
@@ -34,9 +35,9 @@ module Knocker
     end
 
     def post_commands
-      cmds = @text.scan(/^  c (.*)$/)
+      cmds = @text.scan(/^  c (.*)$/).flatten
       cmds.map! do |cmd|
-        cmd.gsub! /\$host/, host
+        cmd.gsub(/\$host/, host)
       end
     end
 

data/lib/knocker/version.rb

@@ -1,3 +1,3 @@
 module Knocker
-  VERSION = "0.2.3"
+  VERSION = "0.3.3"
 end

data/spec/lib/knocker/parser_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Knocker::Parser do
+  let(:parser) { Knocker::Parser.new(config) }
+
+  it "should recognise a pattern" do
+    expect { parser.find("pvtchatops") }.to_not raise_error
+  end
+
+  it "should return a pattern object" do
+    expect(parser.find("pvtchatops")).to be_a Knocker::Pattern
+  end
+
+  it "should return a pattern object with the correct name" do
+    expect(parser.find("pvtchatops").name).to eq "pvtchatops"
+  end
+
+  it "should raise PatternNotFound for non-existent pattern" do
+    expect{parser.find("wut!")}.to raise_error Knocker::Errors::PatternNotFound
+  end
+
+end

data/spec/lib/knocker/pattern_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Knocker::Pattern do
+  let(:pattern) { Knocker::Pattern.new("pvtchatops", pattern_text) }
+
+  it "should return the host" do
+    expect(pattern.host).to eq "myvps.example.com"
+  end
+
+  it "should return the knock command" do
+    expect(pattern.knock_command).to eq "knock myvps.example.com 5445:udp 4456:tcp 63854:tcp"
+  end
+
+  it "should return the commands in an array" do
+    expect(pattern.post_commands).to be_an Array
+  end
+
+  it "should substitute $host for the host name in commands" do
+    expect(pattern.post_commands.first).to include(pattern.host)
+  end
+
+  it "should return the correct post commands" do
+    expect(pattern.post_commands).to eq ["xchat --url=irc://myvps.example.com:36777/chatops"]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'knocker'
+
+def config
+  <<-EOF
+# Knocker config file
+# keep this secret, knock patterns are almost like passwords
+pattern pvtchatops
+  h myvps.example.com
+  u 5445
+  t 4456
+  t 63854
+  c xchat --url=irc://$host:36777/chatops
+  EOF
+end
+
+def pattern_text
+    <<-EOF
+  h myvps.example.com
+  u 5445
+  t 4456
+  t 63854
+  c xchat --url=irc://$host:36777/chatops
+    EOF
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knocker
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.3
 platform: ruby
 authors:
 - Robert McLeod
@@ -74,6 +74,9 @@ files:
 - lib/knocker/parser.rb
 - lib/knocker/pattern.rb
 - lib/knocker/version.rb
+- spec/lib/knocker/parser_spec.rb
+- spec/lib/knocker/pattern_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/penguinpowernz/knocker
 licenses:
 - MIT
@@ -98,4 +101,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Uses stored config to knocks on knock daemons
-test_files: []
+test_files:
+- spec/lib/knocker/parser_spec.rb
+- spec/lib/knocker/pattern_spec.rb
+- spec/spec_helper.rb