check_host 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c448d06ac3895bb4e27358cd5fde364f66e79f3e
-  data.tar.gz: 1e9d6ebf03586bcb831baa09b13b05d6c56c0ac6
+  metadata.gz: 46d50b552dfe87c5da4658c7a60b5e5dd7c7a9e8
+  data.tar.gz: e493e95dded3d92ea715dc6407b7bbce6e52a5fa
 SHA512:
-  metadata.gz: 0efbd6bb1f23e8f947a98c9e5165a1c897bc89279e3777d73fbfb2cc32775069aac110f452f201e09b7fe952b4e8075aea3203f1e31f099333075cda8f46d0cc
-  data.tar.gz: e5a861d8bd8432fa9a2ca9b3f6355af8c3fe3fb95f0d8883b0202342d51cfb12fc9f970711b32edfa7e0504db3790b958961c7bb67ec60da849086b46b663425
+  metadata.gz: 409927f6e8a2f408426bf61f92feeda93ebb1cbd43565c382a71edb9143bf89d2e4ac8f843963e751e85ac1b0e5c7b6def0e07bf6bfc0150b0eede6f6c7e17a9
+  data.tar.gz: 2fc591e520b7d5f0aa81ca754a02ee580cc099bdfea57dad88ed9bca904a7bd12d990a1aee40cbd1a412bfcbffd161d016b125a50f669e37f43bf2f8b489fd8d

data/lib/check_host.rb

@@ -1,9 +1,12 @@
 require 'check_host/check_host_ip'
 
 class CheckHost
+  # run
+  # @param: host [String] the host name
+  # @param: ip [String] the host IP address
+  # @return [Boolean] true if notification has taken place, otherwise returns false
   def self.run(host, ip)
     c = CheckHostIp.new(host, ip)
     c.notify
-    true
   end
 end

data/lib/check_host/check_host_ip.rb

@@ -2,29 +2,18 @@ require "check_host/send_mail"
 
 class CheckHostIp
 
+  # @!attribute
   attr_accessor :host, :ip
 
+  # @param: host (String) The host name
+  # @param: ip (String) The host IP
   def initialize(host, ip)
     @host = host
     @ip   = ip
   end
 
-  # Runs the host cmd and returns just the A record
-  # @return String
-  # example: "fawazalhokairfashion.com has address 91.109.13.176\n"
-  def cmd
-    `host -t A #{host}`
-  end
-
-  # Checks whether a string contains the ip address
-  # @return Boolean
-  def result?
-    !cmd.include? ip
-  end
-
   # Sends an email if result? is true
   # @return Boolean
-  # If result? is true then SendMail
   def notify
     if result?
       SendMail.new
@@ -33,4 +22,18 @@ class CheckHostIp
       false
     end
   end
+
+  private
+    # Runs the host cmd and returns just the A record
+    # example: "fawazalhokairfashion.com has address 91.109.13.176\\n"
+    # @return String
+    def cmd
+      `host -t A #{host}`
+    end
+
+    # Checks whether a string contains the ip address
+    # @return Boolean
+    def result?
+      !cmd.include? ip
+    end
 end

data/lib/check_host/send_mail.rb

@@ -6,10 +6,12 @@ class SendMail
   end
 
   private
+    # @return [Mail::Message]
     def send
       message
     end
 
+    # @return [Mail::Message]
     def message
       recipient = 'mike@smswmedia.com'
       mail = Mail.new do
@@ -21,6 +23,5 @@ class SendMail
 
       mail.delivery_method :sendmail
       mail.deliver
-      `echo 'Email sent'`
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: check_host
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Michael Watts