webrelay_scheduler 0.5.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ian Yamey
+
+MIT License
+
+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,25 @@
+# WebrelayScheduler
+
+A tool to power on/off a list of webrelays. 
+This tool is usually called by a task scheduler, such as cron or Windows Task Scheduler.
+By default, the tool will not power down webrelays if the current day or following day is a public holiday
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'webrelay_scheduler'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webrelay_scheduler
+
+## Usage
+
+The gem is distributed with a binary. For usage details, run
+
+    $ webrelay --help

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/webrelay

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'webrelay_scheduler'
+require "pry"
+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.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 :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"
+  end
+  
+  app.action do |options, arguments|
+    WebrelayScheduler::Command.new(options, arguments).execute
+  end
+end

data/lib/webrelay_scheduler.rb

@@ -0,0 +1,3 @@
+require "webrelay_scheduler/relay"
+require "webrelay_scheduler/command"
+require "webrelay_scheduler/version"

data/lib/webrelay_scheduler/command.rb

@@ -0,0 +1,49 @@
+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)
+      elsif o[:power] == "OFF"
+        unless o[:skip_powerdown_on_holidays] and is_holiday?(o[:locale_code])
+          switch_off(relays,o[:relay_name],delay)
+        end
+      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)
+    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
+
+    # Safely executes a method on each relay
+    def send_to_each(relays,relay_name,method,delay=0)
+      relays.each do |relay|
+        begin
+          result = relay.send method, relay_name
+          if result
+            Escort::Logger.output.info "#{relay.to_s} - OK"
+          else 
+            Escort::Logger.output.error "#{relay.to_s} - FAILED"
+          end
+        rescue Exception => e
+          Escort::Logger.output.error "#{relay.to_s} - FAILED (#{e.message})"
+        end
+        sleep delay
+      end
+    end
+  end
+end

data/lib/webrelay_scheduler/relay.rb

@@ -0,0 +1,36 @@
+require 'httpclient'
+require 'crack'
+module WebrelayScheduler
+  class Relay
+    attr_accessor :ip_address
+
+    def initialize(ip_address, timeout=5)
+      @ip_address = ip_address
+      @client = HTTPClient.new
+      @client.receive_timeout = timeout * 1000
+    end
+
+    def set(relay_name, value)
+      url = "http://#{ip_address}/state.xml?#{relay_name}State=#{value}"
+      response = @client.get url
+      parsed_response = Crack::XML.parse response.body
+
+      parsed_response["datavalues"]["#{relay_name}state"] == value
+    end
+
+    # Turns the relay on
+    def on(relay_name="relay")
+      set relay_name, "0"
+    end
+
+    # Turns the relay off
+    def off(relay_name="relay")
+      set relay_name, "1"
+    end
+
+    def to_s
+      "Relay #{ip_address}"
+    end
+
+  end
+end

data/lib/webrelay_scheduler/version.rb

@@ -0,0 +1,3 @@
+module WebrelayScheduler
+  VERSION = "0.5.0"
+end

data/webrelay_scheduler.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webrelay_scheduler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webrelay_scheduler"
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "holidays"
+  spec.add_dependency "escort"
+  spec.add_dependency "crack"
+  spec.add_dependency "httpclient"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: webrelay_scheduler
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Ian Yamey
+- Jobin Varughese
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: holidays
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escort
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: crack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is used to control the power on webrelays
+email:
+- ian.yamey@parkassist.com
+executables:
+- webrelay
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/webrelay
+- lib/webrelay_scheduler.rb
+- lib/webrelay_scheduler/command.rb
+- lib/webrelay_scheduler/relay.rb
+- lib/webrelay_scheduler/version.rb
+- webrelay_scheduler.gemspec
+homepage: http://www.parkassist.com
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2193386232894529438
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2193386232894529438
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []