lightswitch-schedules 0.0.1

data/lib/lightswitch/constants.rb

@@ -0,0 +1,9 @@
+module Lightswitch
+  module Constants
+
+    END_OF_DAY_HOURS = nil
+    END_OF_DAY_MINUTES = nil
+    DEFAULT_TIME_OFFSET = [5, :minutes]
+
+  end
+end

data/lib/lightswitch/models.rb

@@ -0,0 +1,34 @@
+require 'data_mapper'
+require_relative 'schedule_mixins'
+
+module Lightswitch
+
+  class ScheduleCollection
+    include DataMapper::Resource, ScheduleCollectionMixin
+
+    property :id, Serial
+    property :name, String, :required => true
+
+    has n, :schedules
+
+    def to_s
+      "Schedule collection #{name}" + (schedules.empty? ? "" : " with schedules: " + schedules.collect(&:to_s).join("\n"))
+    end
+
+  end
+
+
+  class Schedule
+    include DataMapper::Resource, ScheduleMixin
+
+    property :id, Serial
+    property :start_hour, Integer, :required => true
+    property :start_minutes, Integer, :required => true
+    property :end_hour, Integer
+    property :end_minutes, Integer
+
+    belongs_to :schedule_collection, :required => false
+
+  end
+
+end

data/lib/lightswitch/schedule_creation.rb

@@ -0,0 +1,42 @@
+require_relative 'constants'
+
+module Lightswitch
+  module ScheduleCreation
+
+
+    def get_hours_and_minutes(tod_string)
+      raise ArgumentError, "Please specify a time of day as 'hhmm', was given '#{tod_string}' instead" unless (tod_string and tod_string.length == 4)
+
+      hours = tod_string.slice(0, 2).to_i
+      raise ArgumentError, "Please specify a time in hours ranging from 0 to 23, was given '#{hours}' in '#{tod_string}' instead" unless (0..23).include? hours
+
+      minutes = tod_string.slice(2, 2).to_i
+      raise ArgumentError, "Please specify a time in minutes ranging from 0 to 59, was given '#{minutes}' in '#{tod_string}' instead" unless (0..59).include? minutes
+
+      [hours, minutes]
+    end
+
+
+    def from_h(schedule_description)
+      start_time_of_day = schedule_description[:start]
+      start_hour, start_minutes = get_hours_and_minutes(start_time_of_day)
+
+      end_time_of_day = schedule_description[:end]
+
+      if end_time_of_day
+        end_hour, end_minutes = get_hours_and_minutes(end_time_of_day)
+
+        raise ArgumentError, "Ending time cannot precede start time" unless start_hour <= end_hour
+        if (start_hour == end_hour)
+          raise ArgumentError, "Ending time must follow start time" unless start_minutes < end_minutes
+        end
+      end
+
+      end_hour, end_minutes = end_time_of_day ? [end_hour, end_minutes] : [Constants::END_OF_DAY_HOURS, Constants::END_OF_DAY_MINUTES]
+
+      {start_hour: start_hour, start_minutes: start_minutes, end_hour: end_hour, end_minutes: end_minutes}
+    end
+
+
+  end
+end

data/lib/lightswitch/schedule_mixins.rb

@@ -0,0 +1,107 @@
+module Lightswitch
+  module ScheduleCommon
+
+    def encode_state(up_boolean)
+      up_boolean ? 'up' : 'down'
+    end
+
+    def decode_state(state_string)
+      state_string == 'up'
+    end
+
+    def get_schedule_state_change(reference_state, at_time)
+      scheduled_state_encoded = encode_state(up?(at_time))
+      if (scheduled_state_encoded != reference_state)
+        StateChange.new(scheduled_state_encoded, at_time)
+      else
+        nil
+      end
+    end
+
+  end
+
+
+  module ScheduleCollectionMixin
+    include ScheduleCommon
+
+
+    def up?(at_time)
+      !(schedules.any? { |schedule| schedule.down?(at_time) })
+    end
+
+
+    def down?(at_time)
+      !up?(at_time)
+    end
+
+
+  end
+
+
+  class StateChange
+    attr_accessor :state, :at_time
+
+    def initialize(state_string, at_time)
+      @state, @at_time = state_string, at_time
+    end
+
+    def to_h
+      {state: state, at_time: at_time}
+    end
+
+    def to_s; "State change to #{state} at #{at_time}"; end
+
+    def equal?(other)
+      other.is_a? StateChange and (other.state == state and other.at_time == at_time)
+    end
+  end
+
+
+  module ScheduleMixin
+    include ScheduleCommon
+
+    def up?(at_time)
+      time_hour, time_minutes = at_time.hour, at_time.min
+
+      unless (end_hour and end_minutes)
+        return after_start_time(time_hour, time_minutes)
+      else
+
+        if (start_hour..end_hour).include? time_hour
+          return (start_minutes <= time_minutes) if (start_hour == time_hour)
+          return (time_minutes <= end_minutes) if (end_hour == time_hour)
+          true
+        else
+          false
+        end
+
+      end
+    end
+
+
+    def after_start_time(hour, minutes)
+      (hour > start_hour) or ((hour == start_hour) and (minutes >= start_minutes))
+    end
+
+
+    def down?(at_time)
+      !up?(at_time)
+    end
+
+
+    def to_s
+      "Daily uptime schedule: #{start_time_of_day} to #{end_time_of_day}"
+    end
+
+
+    def start_time_of_day
+      "#{start_hour.to_s.rjust(2, '0')}:#{start_minutes.to_s.rjust(2, '0')}"
+    end
+
+
+    def end_time_of_day
+      (end_hour and end_minutes) ? "#{end_hour.to_s.rjust(2, '0')}:#{end_minutes.to_s.rjust(2, '0')}" : "end of day"
+    end
+
+  end
+end

data/lib/lightswitch/schedules.rb

@@ -0,0 +1,57 @@
+require_relative 'schedule_creation'
+require_relative 'models'
+require_relative 'constants'
+
+module Lightswitch
+
+  class Schedules
+    include ScheduleCreation
+
+    def make_schedule(schedule_description)
+      Lightswitch::Schedule.new(from_h(schedule_description))
+    end
+
+
+    def create_schedule_collection(schedules_description)
+      schedule_collection = Lightswitch::ScheduleCollection.new({name: schedules_description[:name]})
+
+      schedules = schedules_description[:schedules]
+      uptime_schedules = schedules.collect { |schedule_description|
+        make_schedule(schedule_description)
+      }
+
+      uptime_schedules.each { |schedule|
+        schedule_collection.schedules << schedule
+      }
+
+      schedule_collection.save
+      schedule_collection.id
+    end
+
+
+    def get_schedule_collection(id)
+      Lightswitch::ScheduleCollection.get(id)
+    end
+
+
+    def get_scheduled_state_changes(state, from_time, to_time, schedules_id)
+      at_from_time = get_scheduled_state_change_at_time(state, from_time, schedules_id)
+
+      state_for_to_time = at_from_time.nil? ? state : at_from_time.state
+      at_to_time = get_scheduled_state_change_at_time(state_for_to_time, to_time, schedules_id)
+
+      state_changes = []
+      state_changes << at_from_time if at_from_time
+      state_changes << at_to_time if at_to_time
+
+      state_changes
+    end
+
+
+    def get_scheduled_state_change_at_time(state, at_time, schedules_id)
+      schedule_collection = get_schedule_collection(schedules_id)
+      schedule_collection.get_schedule_state_change(state, at_time)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: lightswitch-schedules
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Krishnan M
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-19 00:00:00.000000000 Z
+dependencies: []
+description: Create and persist schedules (such as daily and weekly) that lightswitch
+  can use to turn instances on and off
+email: km@krishnanm.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lightswitch/constants.rb
+- lib/lightswitch/models.rb
+- lib/lightswitch/schedule_creation.rb
+- lib/lightswitch/schedule_mixins.rb
+- lib/lightswitch/schedules.rb
+homepage: http://rubygems.org/gems/lightswitch-schedules
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Create schedules for use in lightswitch
+test_files: []