webrelay_scheduler 0.5.1 → 0.6.0

data/bin/webrelay

@@ -5,18 +5,18 @@ require "escort"
 
 Escort::App.create do |app|
   app.version WebrelayScheduler::VERSION
-  app.description "A tool to power on/off a list of webrelays.\n"+
-   "This tool is usually called by a task scheduler, such as cron or Windows Task Scheduler.\n"+
-   "By default, the tool will not power down webrelays if the current day or following day is a public holiday\n"
+  app.description "A tool to power on/off devices connected to ControlByWeb webrelays. "+
+   "This tool is usually called by a task scheduler, such as cron or Windows Task Scheduler."
 
   app.options do |opts|
     opts.opt :ip, "The ip address of the relay to control. This argument can be used multiple times to control more than one relay at a time, eg. '... --ip 10.0.0.1 --ip 10.0.0.2'", :short => '-i', :long => '--ip', :type => :string, :multi => true
     opts.opt :power, "Sets the power on the relays. Accepts either ON or OFF", :short => '-p', :long => '--power', :type => :string, :default => "ON"
     opts.opt :delay, "The delay between sending commands to each relay", :short => '-d', :long => '--delay', :type => :integer, :default => 5
     opts.opt :timeout, "The maximum timeout (in seconds) when sending a command to a relay", :short => '-t', :long => '--timeout', :type => :integer, :default => 5
-    opts.opt :skip_powerdown_on_holidays, "Prevents the system from switching off the relay during holidays. If the current day is a holiday in the current locale, then commands to power off relays will be skipped.", :short => :none, :long => '--skip-powerdown-on-holidays', :type => :flag, :default => true
+    opts.opt :skip_if_today_is_holiday, "Do not run the action if today is a holiday in the current locale", :short => :none, :long => '--skip-if-today-is-holiday', :type => :flag, :default => false
+    opts.opt :skip_if_tomorrow_is_holiday, "Do not run the action if tomorrow is a holiday in the current locale", :short => :none, :long => '--skip-if-tomorrow-is-holiday', :type => :flag, :default => false
     opts.opt :locale_code, "The country/locale code to use when determining if today's date is currently a holiday", :short => '-l', :long => '--locale-code', :type => :string, :default => "au_nsw"
-    opts.opt :relay_name, "The name of the relay to switch. This will be 'relay' for single channel relays, or 'relay1', 'relay2', ... , 'relay<N>' for multi-channel relays", :short => '-n', :long => '--relay-name', :type => :string, :default => "relay"
+    opts.opt :relay_identifier, "The identifier of the relay on each webrelay. This will be 'relay' for single channel relays, or 'relay1', 'relay2', ... , 'relay<N>' for multi-channel relays", :short => '-r', :long => '--relay-identifier', :type => :string, :default => "relay"
   end
   
   app.action do |options, arguments|

data/lib/webrelay_scheduler/command.rb

@@ -1,48 +1,53 @@
 require "escort"
 require "holidays"
-
 module WebrelayScheduler
   class Command < ::Escort::ActionCommand::Base
     def execute
       o = command_options
-
       relays = o[:ip].collect{ |ip| Relay.new(ip, o[:timeout]) }
-      delay = o[:delay]
       
-      if o[:power] == "ON"
-        switch_on(relays,o[:relay_name],delay)
+      Holidays.load_all
+      if o[:skip_if_today_is_holiday] and Date.today.holiday?(o[:locale_code])
+        Escort::Logger.output.warn "Action was skipped for today's holiday: #{holiday_names(Date.today,o[:locale_code])}"
+      elsif o[:skip_if_tomorrow_is_holiday] and (Date.today+1).holiday?(o[:locale_code])
+        Escort::Logger.output.warn "Action was skipped for tomorrow's holiday: #{holiday_names(Date.today+1,o[:locale_code])}"
+      elsif o[:power] == "ON"
+        switch_on(relays,o[:relay_identifier],o[:delay])
       elsif o[:power] == "OFF"
-        unless o[:skip_powerdown_on_holidays] and is_holiday?(o[:locale_code])
-          switch_off(relays,o[:relay_name],delay)
-        end
+        switch_off(relays,o[:relay_identifier],o[:delay])
       end
     end
 
-    # Returns true if either today or tomorrow is a holiday in the specified locale
-    def is_holiday?(locale_code)
-      today = Date.today
-      tomorrow = today + 1
-      Holidays.load_all
-      today.holiday?(locale_code.to_sym) or tomorrow.holiday?(locale_code.to_sym)
+    def holiday_names(date, locale_code)
+      date.holidays(locale_code).collect{|h|h[:name]}.join(",")
     end
 
-    def switch_on(relays,relay_name,delay); send_to_each(relays,relay_name,:on,delay); end
-    def switch_off(relays,relay_name,delay); send_to_each(relays,relay_name,:off,delay); end
+    def switch_on(relays,relay_identifier,delay)
+      send_to_each(relays) do |relay|
+        relay.close relay_identifier
+        sleep delay
+      end
+    end
+
+    def switch_off(relays,relay_identifier,delay)
+      send_to_each(relays) do |relay|
+        relay.open relay_identifier
+        sleep delay
+      end
+    end
 
     # Safely executes a method on each relay
-    def send_to_each(relays,relay_name,method,delay=0)
+    def send_to_each(relays, &block)
       relays.each do |relay|
         begin
-          result = relay.send method, relay_name
-          if result
-            Escort::Logger.output.info "#{relay.to_s} - OK"
+          if yield(relay)
+            Escort::Logger.output.info "#{relay.ip_address} - OK"
           else 
-            Escort::Logger.output.error "#{relay.to_s} - FAILED"
+            Escort::Logger.output.error "#{relay.ip_address} - FAILED"
           end
         rescue Exception => e
-          Escort::Logger.output.error "#{relay.to_s} - FAILED (#{e.message})"
+          Escort::Logger.output.error "#{relay.ip_address} - FAILED (#{e.message})"
         end
-        sleep delay
       end
     end
   end

data/lib/webrelay_scheduler/relay.rb

@@ -10,27 +10,25 @@ module WebrelayScheduler
       @client.receive_timeout = timeout * 1000
     end
 
-    def set(relay_name, value)
-      url = "http://#{ip_address}/state.xml?#{relay_name}State=#{value}"
+    # Sets the specified relay to a value
+    # Returns true if successful, or false if the value was not changed correctly
+    def set(relay_identifier, value)
+      url = "http://#{ip_address}/state.xml?#{relay_identifier}State=#{value}"
       response = @client.get url
       parsed_response = Crack::XML.parse response.body
 
-      parsed_response["datavalues"]["#{relay_name}state"] == value
+      # Check the response shows to see if the value successfully changed
+      parsed_response["datavalues"]["#{relay_identifier}state"] == value.to_s
     end
 
-    # Turns the relay on
-    def on(relay_name="relay")
-      set relay_name, "0"
+    # Close the relay
+    def close(relay_identifier="relay")
+      set relay_identifier, "0"
     end
 
-    # Turns the relay off
-    def off(relay_name="relay")
-      set relay_name, "1"
+    # Opens the relay
+    def open(relay_identifier="relay")
+      set relay_identifier, "1"
     end
-
-    def to_s
-      "Relay #{ip_address}"
-    end
-
   end
 end

data/lib/webrelay_scheduler/version.rb

@@ -1,3 +1,3 @@
 module WebrelayScheduler
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/webrelay_scheduler.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = WebrelayScheduler::VERSION
   spec.authors       = ["Ian Yamey","Jobin Varughese"]
   spec.email         = ["ian.yamey@parkassist.com"]
-  spec.description   = %q{This gem is used to control the power on webrelays}
-  spec.summary       = %q{}
-  spec.homepage      = "http://www.parkassist.com"
+  spec.description   = %q{Set the relay state of ControlByWeb webrelays}
+  spec.summary       = %q{This gem is used to control (open/close) relays. It is used to schedule the shutdown / powerup of hardware devices using Cron, Windows Task Manager or any other automated scheduler.}
+  spec.homepage      = "https://github.com/parkassist/webrelay_tool"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webrelay_scheduler
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: holidays
@@ -108,7 +108,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem is used to control the power on webrelays
+description: Set the relay state of ControlByWeb webrelays
 email:
 - ian.yamey@parkassist.com
 executables:
@@ -127,7 +127,7 @@ files:
 - lib/webrelay_scheduler/relay.rb
 - lib/webrelay_scheduler/version.rb
 - webrelay_scheduler.gemspec
-homepage: http://www.parkassist.com
+homepage: https://github.com/parkassist/webrelay_tool
 licenses:
 - MIT
 post_install_message: 
@@ -142,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1380791654289873620
+      hash: -1726181485213364509
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -151,11 +151,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1380791654289873620
+      hash: -1726181485213364509
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: ''
+summary: This gem is used to control (open/close) relays. It is used to schedule the
+  shutdown / powerup of hardware devices using Cron, Windows Task Manager or any other
+  automated scheduler.
 test_files: []