logicbomb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92f1a9a4f607073f429f0d4e0508e44b058d945e973c698cbff89d10c29820d9
+  data.tar.gz: 79a743dda695344e06ecf05a1e76dd52a4b26434bbfe8de1f657c266d799ac1d
+SHA512:
+  metadata.gz: 41eb424231a155121777a4542a5e641b3ac0aa011ae181dd1b3c30d06acecda884459320c7a57ce11d6e49b461a743f875f3d8f2c9dc70f61f07dbfcbf675935
+  data.tar.gz: 833fbda1cb5b70bb85e6a2fba0393d987554897a6ef3532ac6afe16db8e71cc253c76ec6e27a27c193338db20bf5ffc9be107e725edee2d7eafaa5728973c1b4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in LogicBomb.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    logicbomb (0.1.0)
+      thor
+      viewpoint
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httpclient (2.8.3)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    mini_portile2 (2.4.0)
+    multi_json (1.13.1)
+    nokogiri (1.10.1)
+      mini_portile2 (~> 2.4.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubyntlm (0.6.2)
+    thor (0.20.3)
+    viewpoint (1.1.0)
+      httpclient
+      logging
+      nokogiri
+      rubyntlm
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  logicbomb!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ahewins
+
+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,39 @@
+# LogicBomb
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/LogicBomb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'LogicBomb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install LogicBomb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/LogicBomb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logicbomb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/logicbomb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'logicbomb'
+
+LogicBomb::Cli.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logicbomb/cli.rb

@@ -0,0 +1,64 @@
+require 'thor'
+
+module LogicBomb
+  class Cli < Thor
+    include Thor::Actions
+
+    def self.exit_on_failure?
+      true
+    end
+ 
+    desc "config-gen", "Generate the YAML config file to fill out"
+    def config_gen
+      require 'logicbomb/generators/config_gen'
+      LogicBomb::Generators::ConfigGen.start
+    end
+
+    desc "install CONFIG", "Installs this as a systemd Linux service to run the daemon with CONFIG at startup"
+    def install(config)
+      require 'logicbomb/generators/installer'
+      LogicBomb::Generators::Installer.start([config])
+    end
+
+    desc "daemon CONFIG", "Run the daemon with CONFIG"
+    def daemon(config)
+      yaml = load_yaml config
+      mailer = create_mailer yaml
+      create_ping(yaml, mailer).daemon
+    end
+
+    desc "test-email CONFIG", "Send a test email to everyone in the CONFIG's mail-list"
+    def test_email(config)
+      yaml = load_yaml config
+      puts "YAML loaded. Sending email..."
+      create_mailer(yaml).test_email
+      puts "Sent."
+    end
+    
+    private
+    def load_yaml(config)
+      require 'yaml'
+      YAML::load File.open(config)
+    end
+
+    def create_mailer(yaml)
+      require 'logicbomb/mailer'
+      Mailer.new(
+        endpoint: yaml["mail-endpoint"],
+        user: yaml["mail-username"],
+        password: yaml["mail-password"],
+        mail_send_to_list: yaml["mail-to-list"]
+      )
+    end
+
+    def create_ping(yaml, mailer)
+      require 'logicbomb/ping'
+      Ping.new(
+        ping: yaml["ping"],
+        tracert: yaml["tracert"],
+        interval: yaml["interval"],
+        mailer: mailer
+      )
+    end
+  end
+end

data/lib/logicbomb/generators/config_gen.rb

@@ -0,0 +1,21 @@
+require 'thor'
+
+module LogicBomb
+  module Generators
+    class ConfigGen < Thor::Group
+      include Thor::Actions
+
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), '../templates'))
+      end
+
+      def copy_template
+        template("config.yml", "./config.yml")
+        puts "Created your config."
+        puts "It's much smarter to use environment variables for your passwords,"
+        puts "so by default the mail password is retrieved from LOGICBOMB_MAIL_PASSWORD."
+        puts "Export that var and then set up the rest of your config."
+      end
+    end
+  end
+end

data/lib/logicbomb/generators/installer.rb

@@ -0,0 +1,56 @@
+require 'thor'
+
+module LogicBomb
+  module Generators
+    class Installer < Thor::Group
+      include Thor::Actions
+
+      argument :config, type: :string
+
+      def self.source_root
+        File.expand_path(File.join(File.dirname(__FILE__), '../templates'))
+      end
+
+      def install
+        copy_template
+        reload_daemon
+        enable_logicbomb
+        start_logicbomb
+      end
+
+      private
+      def copy_template
+        begin
+          template("logicbomb.service", "/etc/systemd/system/logicbomb.service")
+        rescue Errno::EACCES
+          puts "To install the daemon you need sudo access since we hit systemd."
+          puts "Try again with rvmsudo if you have it, otherwise sudo."
+          exit 1
+        end
+      end
+
+      def reload_daemon
+        puts "Reloading the daemon..."
+        run_command 'sudo systemctl daemon-reload'
+      end
+
+      def enable_logicbomb
+        puts "Success. Enabling logicbomb service..."
+        run_command('sudo systemctl enable logicbomb')
+
+      end
+
+      def start_logicbomb
+        puts "Success. Starting logicbomb..."
+        run_command('sudo systemctl start logicbomb')
+      end
+
+      def run_command(cmd)
+        exit_bool = system(cmd)
+        return if exit_bool
+        puts "Error running `#{cmd}'. Quitting"
+        exit 1
+      end
+    end
+  end
+end

data/lib/logicbomb/mailer.rb

@@ -0,0 +1,42 @@
+require 'viewpoint'
+require 'date'
+
+module LogicBomb
+  class Mailer
+    TEST_EMAIL_SUBJECT = "Test email for logicbomb"
+    TEST_EMAIL_BODY = "You are receiving this email because you are subscribed to alerts when " \
+                      "logicbomb detects an IP failing to ping. You will get an email when the " \
+                      "pings fail."
+    
+    def initialize(endpoint:, user:, password:, mail_send_to_list:)
+      @user, @password = user, password
+      @endpoint, @to_list = endpoint, mail_send_to_list
+    end
+
+    def test_email
+      send_email(
+        subject: TEST_EMAIL_SUBJECT
+        body: TEST_EMAIL_BODY
+      )
+    end
+    
+    def mail(ping, tracert)
+      send_email(
+        subject: "Internet outage #{DateTime.now}",
+        body: compose(ping, tracert)
+      )
+    end
+
+    private
+    def send_email(opts={})
+      opts[:to_recipients] = @to_list unless opts.key?(:to_recipients)
+      Viewpoint::EWSClient.new(@endpoint, @user, @password)
+        .send_message(opts)
+    end
+
+    def compose(ping, tracert)
+      "LogicBomb classified these pings as failures:\n#{ping}" \
+      "And ran traceroutes to help diagnose:\n#{tracert}"
+    end
+  end
+end

data/lib/logicbomb/ping.rb

@@ -0,0 +1,45 @@
+require 'logicbomb/mailer'
+
+module LogicBomb
+  class Ping
+    def initialize(ping:, tracert:, interval:, mailer:)
+      @ping = ping
+      @tracert = tracert
+      @interval = interval
+      @mailer = mailer
+    end
+
+    def daemon
+      while true
+        sleep @interval
+        netconns = ping
+        next if netconns.nil?
+        mailer.mail netconns, tracert
+        sleep 3600
+      end
+    end
+
+    private
+    def ping
+      @ping.each do |ip| 
+        attempt1 = ping ip
+        next if successful_ping?(ip)
+        sleep 5
+        attempt2 = ping ip
+        return "#{attempt1}\n#{attempt2}" unless successful_ping?(attempt2)
+      end
+    end
+
+    def tracert
+      @tracert.map {|ip| "#{ip}:\n" + `traceroute #{ip}`}.join('\n')
+    end
+
+    def ping(ip)
+      `ping -c 1 -s 1 #{ip}`
+    end
+
+    def successful_ping?(stdout)
+      stdout.include?(" 0% packet loss,")
+    end
+  end
+end

data/lib/logicbomb/templates/config.yml

@@ -0,0 +1,23 @@
+ping:
+  # List your IPs you wish to ping here, with '-'
+  # LogicBomb will go off if these IPs fail to respond.
+  - 8.8.8.8
+
+tracert:
+  # List your IPs you wish to tracert
+  # LogicBomb will tracert these IPs and send them in a
+  # report to the emails below if the above pings fail
+  - 8.8.8.8
+
+interval: 1000 # After the pingsweep, sleep(interval)
+
+# The email credentials to login with to send the email report
+# If you wish to obfuscate these values you can always use
+# environment variables that hide behind ERB, like the password
+mail-endpoint: https://domain.com/ews/endpoint.asmx
+mail-username: a@a.com
+mail-password: <%%= ENV["LOGICBOMB_MAIL_PASSWORD"] %>
+
+# Who to send the report to
+mail-to-list:
+  - b@a.com

data/lib/logicbomb/templates/logicbomb.service

@@ -0,0 +1,14 @@
+Description=Ruby script that checks if various services are down, and if so, perform some action.
+
+Wants=network.target
+After=syslog.target network-online.target
+
+[Service]
+Type=simple
+ExecStart=logicbomb daemon <%= config %>
+Restart=on-failure
+RestartSec=10
+KillMode=process
+
+[Install]
+WantedBy=multi-user.target

data/lib/logicbomb/version.rb

@@ -0,0 +1,3 @@
+module LogicBomb
+  VERSION = "0.1.0"
+end

data/lib/logicbomb.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require "logicbomb/version"
+require 'logicbomb/ping'
+require 'logicbomb/mailer'
+require 'logicbomb/cli'
+
+module LogicBomb
+end

data/logicbomb.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "logicbomb/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "logicbomb"
+  spec.version       = LogicBomb::VERSION
+  spec.authors       = ["AnthonyHewins"]
+  spec.email         = ["aahewins@protonmail.com"]
+
+  spec.summary       = %q{Continuously check if the internet is up or not.}
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f)}
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "viewpoint"
+  spec.add_dependency "thor"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: logicbomb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AnthonyHewins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: viewpoint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- aahewins@protonmail.com
+executables:
+- console
+- logicbomb
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/logicbomb
+- bin/setup
+- lib/logicbomb.rb
+- lib/logicbomb/cli.rb
+- lib/logicbomb/generators/config_gen.rb
+- lib/logicbomb/generators/installer.rb
+- lib/logicbomb/mailer.rb
+- lib/logicbomb/ping.rb
+- lib/logicbomb/templates/config.yml
+- lib/logicbomb/templates/logicbomb.service
+- lib/logicbomb/version.rb
+- logicbomb.gemspec
+- pkg/logicbomb-0.1.0.gem
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Continuously check if the internet is up or not.
+test_files: []